Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Eng 6888 dotnet 3.0.x documentation #409

Draft
wants to merge 23 commits into
base: master
Choose a base branch
from
Draft

Eng 6888 dotnet 3.0.x documentation #409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
d98837b
Applications documentation
greathouse Jul 1, 2024
45be835
Redo Applications documentation
greathouse Jul 1, 2024
a08d85c
Permissions
greathouse Jul 1, 2024
ca6348c
Sessions
greathouse Jul 1, 2024
0f3b8b2
Logs
greathouse Jul 1, 2024
108988e
Pre-configured proxies
greathouse Jul 1, 2024
381a66a
Reactors
greathouse Jul 1, 2024
1e461cd
Reactor Formulas
greathouse Jul 1, 2024
9200d07
Use Guid.Parse
greathouse Jul 1, 2024
ce8cb0a
Tenants
greathouse Jul 1, 2024
7814650
Tenant Members (with object property documentation)
greathouse Jul 1, 2024
533fcf5
Tokens
greathouse Jul 1, 2024
b1abdbd
Tokenize
greathouse Jul 1, 2024
de521eb
Search
greathouse Jul 2, 2024
9198fa8
3ds sessions
greathouse Jul 2, 2024
b74a4ac
Applications (new format)
greathouse Jul 2, 2024
6c2606c
Sessions
greathouse Jul 2, 2024
3d4cbe9
Preconfigured Proxies and Tenants
greathouse Jul 2, 2024
348e952
Authentication
greathouse Jul 9, 2024
0c3529f
Request Correlation
greathouse Jul 9, 2024
abc546c
Pagination
greathouse Jul 9, 2024
e9d0854
Errors
greathouse Jul 9, 2024
2bed8d5
Idempotency
greathouse Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 59 additions & 37 deletions docs/api/3ds/sessions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,18 @@ const session = await bt.threeds.getSessionById("c06d0789-0a38-40be-b7cc-c28a718
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.ThreeDS;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

var client = new ThreeDSClient("<PRIVATE_API_KEY>");
Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var session = await client.GetSessionByIdAsync("c06d0789-0a38-40be-b7cc-c28a718f76f1");
var apiInstance = new ThreeDSApi(config);
var id = Guid.Parse("");

ThreeDSSession result = apiInstance.ThreeDSGetSessionById(id);
```

</TabItem>
Expand Down Expand Up @@ -281,37 +288,45 @@ const authentication = await bt.threeds.authenticateSession("c06d0789-0a38-40be-
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.ThreeDS;
using BasisTheory.net.ThreeDS.Requests;

var client = new ThreeDSClient("<API_KEY>");

var authentication = await client.AuthenticateThreeDSSessionAsync("c06d0789-0a38-40be-b7cc-c28a718f76f1", new AuthenticateThreeDSSessionRequest {
AuthenticationCategory = "payment",
AuthenticationType = "payment-transaction",
PurchaseInfo = new ThreeDSPurchaseInfo {
Amount = "80000",
Currency = "826",
Exponent = "2",
Date = "20240109141010"
},
RequestorInfo = new ThreeDSRequestorInfo {
Id = "example-3ds-merchant",
Name = "Example 3DS Merchant",
Url = "https://www.example.com/example-merchant"
},
MerchantInfo = new ThreeDSMerchantInfo {
Mid = "9876543210001",
AcquirerBin = "000000999",
Name = "Example 3DS Merchant",
CategoryCode = "7922",
CountryCode = "826"
},
CardholderInfo = new ThreeDSCardholderInfo {
Name = "John Doe",
Email = "john@me.com"
}
});
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var apiInstance = new ThreeDSApi(config);
var sessionId = Guid.Parse("");
var authenticateThreeDSSessionRequest = new AuthenticateThreeDSSessionRequest()
{
AuthenticationCategory = "payment",
AuthenticationType = "payment-transaction",
PurchaseInfo = new ThreeDSPurchaseInfo {
Amount = "80000",
Currency = "826",
Exponent = "2",
Date = "20240109141010"
},
RequestorInfo = new ThreeDSRequestorInfo {
Id = "example-3ds-merchant",
Name = "Example 3DS Merchant",
Url = "https://www.example.com/example-merchant"
},
MerchantInfo = new ThreeDSMerchantInfo {
Mid = "9876543210001",
AcquirerBin = "000000999",
Name = "Example 3DS Merchant",
CategoryCode = "7922",
CountryCode = "826"
},
CardholderInfo = new ThreeDSCardholderInfo {
Name = "John Doe",
Email = "john@me.com"
}
};

ThreeDSAuthentication result = apiInstance.ThreeDSAuthenticateSession(sessionId, authenticateThreeDSSessionRequest);
```

</TabItem>
Expand Down Expand Up @@ -779,11 +794,18 @@ const result = await bt.threeds.getChallengeResult("c06d0789-0a38-40be-b7cc-c28a
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.ThreeDS;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var client = new ThreeDSClient("<PRIVATE_API_KEY>");
var apiInstance = new ThreeDSApi(config);
var sessionId = Guid.Parse("");

var result = await client.GetChallengeResultAsync("c06d0789-0a38-40be-b7cc-c28a718f76f1");
ThreeDSAuthentication result = apiInstance.ThreeDSGetChallengeResult(sessionId);
```

</TabItem>
Expand Down
121 changes: 89 additions & 32 deletions docs/api/applications/applications.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,26 @@ const application = await bt.applications.create({
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Applications;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

var client = new ApplicationClient("<MANAGEMENT_API_KEY>");
Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var application = await client.CreateAsync(new Application {
Name = "My Example App",
Type = "private",
Permissions = new List<string> { "token:create", "token:read" }
});
var apiInstance = new ApplicationsApi(config);
var createApplicationRequest = new CreateApplicationRequest()
{
Name = ...
Type = ...
ExpiresAt = ...
Permissions = ...
Rules = ...
CreateKey = ...
};

Application result = apiInstance.Create(createApplicationRequest);
```

</TabItem>
Expand Down Expand Up @@ -220,11 +231,22 @@ const applications = await bt.applications.list();
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Applications;

var client = new ApplicationClient("<MANAGEMENT_API_KEY>");

var applications = await client.GetAsync();
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var apiInstance = new ApplicationsApi(config);
var id = new List<Guid>();
var type = new List<string>();
var page = 1;
var start = "";
var size = 1;

ApplicationPaginatedList result = apiInstance.Get(id, type, page, start, size);
```

</TabItem>
Expand Down Expand Up @@ -367,11 +389,18 @@ const application = await bt.applications.retrieve(
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Applications;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var client = new ApplicationClient("<MANAGEMENT_API_KEY>");
var apiInstance = new ApplicationsApi(config);
var id = Guid.Parse("");

var application = await client.GetByIdAsync("fe1f9ba4-474e-44b9-b949-110cdba9d662");
Application result = apiInstance.GetById(id);
```

</TabItem>
Expand Down Expand Up @@ -496,11 +525,17 @@ const application = await bt.applications.retrieveByKey();
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Applications;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var client = new ApplicationClient("<MANAGEMENT_API_KEY>");
var apiInstance = new ApplicationsApi(config);

var application = await client.GetByKeyAsync();
Application result = apiInstance.GetByKey();
```

</TabItem>
Expand Down Expand Up @@ -634,16 +669,24 @@ const application = await bt.applications.update(
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Applications;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

var client = new ApplicationClient("<MANAGEMENT_API_KEY>");
Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var application = await client.UpdateAsync("fb124bba-f90d-45f0-9a59-5edca27b3b4a",
new Application {
Name = "My Example App",
Permissions = new List<string> { "application:create", "application:read" }
}
);
var apiInstance = new ApplicationsApi(config);
var id = Guid.Parse("");
var updateApplicationRequest = new UpdateApplicationRequest()
{
Name = ...
Permissions = ...
Rules = ...
};

Application result = apiInstance.Update(id, updateApplicationRequest);
```

</TabItem>
Expand Down Expand Up @@ -799,11 +842,18 @@ const application = await bt.applications.regenerateKey(
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Applications;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var client = new ApplicationClient("<MANAGEMENT_API_KEY>");
var apiInstance = new ApplicationsApi(config);
var id = Guid.Parse("");

var application = await client.RegenerateKeyAsync("fb124bba-f90d-45f0-9a59-5edca27b3b4a");
Application result = apiInstance.RegenerateKey(id);
```

</TabItem>
Expand Down Expand Up @@ -930,11 +980,18 @@ await bt.applications.delete("fb124bba-f90d-45f0-9a59-5edca27b3b4a");
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Applications;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var client = new ApplicationClient("<MANAGEMENT_API_KEY>");
var apiInstance = new ApplicationsApi(config);
var id = Guid.Parse("");

await client.DeleteAsync("fb124bba-f90d-45f0-9a59-5edca27b3b4a");
apiInstance.Delete(id);
```

</TabItem>
Expand Down
13 changes: 10 additions & 3 deletions docs/api/applications/permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,18 @@ const permissions = await bt.permissions.list();
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Permissions;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

var client = new PermissionClient("<API_KEY>");
Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var permissions = await client.GetAsync();
var apiInstance = new PermissionsApi(config);
var applicationType = "";

List<Permission> result = apiInstance.Get(applicationType);
```

</TabItem>
Expand Down
34 changes: 25 additions & 9 deletions docs/api/applications/sessions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,17 @@ const session = await bt.sessions.create();
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Sessions;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

var client = new SessionClient("<PUBLIC_API_KEY>");
Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

var session = await client.CreateAsync();
var apiInstance = new SessionsApi(config);

CreateSessionResponse result = apiInstance.Create();
```

</TabItem>
Expand Down Expand Up @@ -151,14 +157,24 @@ const authorizedSession = await bt.sessions.authorize({
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Sessions;
using BasisTheory.net.Api;
using BasisTheory.net.Client;
using BasisTheory.net.Model;

var client = new SessionClient("<PRIVATE_API_KEY>");
Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

await client.AuthorizeAsync(new AuthorizeSessionRequest {
Nonce = "4J7SiRvfADwJ9ZqwviJJs8",
Permissions = new List<string> { "token:create", "token:read" }
});
var apiInstance = new SessionsApi(config);
var authorizeSessionRequest = new AuthorizeSessionRequest()
{
Nonce = ...
ExpiresAt = ...
Permissions = ...
Rules = ...
};

apiInstance.Authorize(authorizeSessionRequest);
```

</TabItem>
Expand Down
12 changes: 4 additions & 8 deletions docs/api/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,13 @@ const applications = await bt.applications.list(
<TabItem value="csharp" label="C#">

```csharp showLineNumbers
using BasisTheory.net.Tokens;

// At service
var client = new TokenClient("<PRIVATE_API_KEY>");
Configuration config = new Configuration();
config.BasePath = "https://api.basistheory.com";
config.AddApiKey("BT-API-KEY", "YOUR_API_KEY");

// Per call
var client = new TokenClient();

await client.GetAsync(requestOptions: new RequestOptions {
ApiKey = "<PRIVATE_API_KEY>"
});
var apiInstance = new TokensApi(config);
```

</TabItem>
Expand Down
Loading
Loading