# Reference
## Applications
client.applications.list({ ...params }) -> core.Page<BasisTheory.Application>
-
#### 🔌 Usage
-
-
```typescript
const response = await client.applications.list();
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.applications.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.ApplicationsListRequest`
-
**requestOptions:** `Applications.RequestOptions`
client.applications.create({ ...params }) -> BasisTheory.Application
-
#### 🔌 Usage
-
-
```typescript
await client.applications.create({
name: "name",
type: "type"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.CreateApplicationRequest`
-
**requestOptions:** `Applications.IdempotentRequestOptions`
client.applications.get(id) -> BasisTheory.Application
-
#### 🔌 Usage
-
-
```typescript
await client.applications.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Applications.RequestOptions`
client.applications.update(id, { ...params }) -> BasisTheory.Application
-
#### 🔌 Usage
-
-
```typescript
await client.applications.update("id", {
name: "name"
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `BasisTheory.UpdateApplicationRequest`
-
**requestOptions:** `Applications.IdempotentRequestOptions`
client.applications.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.applications.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Applications.RequestOptions`
client.applications.getByKey() -> BasisTheory.Application
-
#### 🔌 Usage
-
-
```typescript
await client.applications.getByKey();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Applications.RequestOptions`
client.applicationKeys.list(id, { ...params }) -> BasisTheory.ApplicationKey[]
-
#### 🔌 Usage
-
-
```typescript
await client.applicationKeys.list("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `BasisTheory.ApplicationKeysListRequest`
-
**requestOptions:** `ApplicationKeys.RequestOptions`
client.applicationKeys.create(id) -> BasisTheory.ApplicationKey
-
#### 🔌 Usage
-
-
```typescript
await client.applicationKeys.create("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `ApplicationKeys.IdempotentRequestOptions`
client.applicationKeys.get(id, keyId) -> BasisTheory.ApplicationKey
-
#### 🔌 Usage
-
-
```typescript
await client.applicationKeys.get("id", "keyId");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**keyId:** `string`
-
**requestOptions:** `ApplicationKeys.RequestOptions`
client.applicationKeys.delete(id, keyId) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.applicationKeys.delete("id", "keyId");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**keyId:** `string`
-
**requestOptions:** `ApplicationKeys.RequestOptions`
client.applicationTemplates.list() -> BasisTheory.ApplicationTemplate[]
-
#### 🔌 Usage
-
-
```typescript
await client.applicationTemplates.list();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `ApplicationTemplates.RequestOptions`
client.applicationTemplates.get(id) -> BasisTheory.ApplicationTemplate
-
#### 🔌 Usage
-
-
```typescript
await client.applicationTemplates.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `ApplicationTemplates.RequestOptions`
client.applePay.create({ ...params }) -> BasisTheory.ApplePayCreateResponse
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.create();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.ApplePayCreateRequest`
-
**requestOptions:** `ApplePay.RequestOptions`
client.applePay.get(id) -> BasisTheory.ApplePayToken
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `ApplePay.RequestOptions`
client.applePay.delete(id) -> string
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `ApplePay.RequestOptions`
client.googlePay.create({ ...params }) -> BasisTheory.GooglePayCreateResponse
-
#### 🔌 Usage
-
-
```typescript
await client.googlePay.create();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.GooglePayCreateRequest`
-
**requestOptions:** `GooglePay.RequestOptions`
client.googlePay.get(id) -> BasisTheory.GooglePayToken
-
#### 🔌 Usage
-
-
```typescript
await client.googlePay.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `GooglePay.RequestOptions`
client.googlePay.delete(id) -> string
-
#### 🔌 Usage
-
-
```typescript
await client.googlePay.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `GooglePay.RequestOptions`
client.documents.upload({ ...params }) -> BasisTheory.Document
-
#### 🔌 Usage
-
-
```typescript
await client.documents.upload({});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.DocumentsUploadRequest`
-
**requestOptions:** `Documents.RequestOptions`
client.documents.get(id) -> BasisTheory.Document
-
#### 🔌 Usage
-
-
```typescript
await client.documents.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Documents.RequestOptions`
client.documents.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.documents.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Documents.RequestOptions`
client.tokens.detokenize({ ...params }) -> unknown
-
#### 🔌 Usage
-
-
```typescript
await client.tokens.detokenize({
"key": "value"
});
```
#### ⚙️ Parameters
-
-
**request:** `unknown`
-
**requestOptions:** `Tokens.RequestOptions`
client.tokens.tokenize({ ...params }) -> unknown
-
#### 🔌 Usage
-
-
```typescript
await client.tokens.tokenize({
"key": "value"
});
```
#### ⚙️ Parameters
-
-
**request:** `unknown`
-
**requestOptions:** `Tokens.IdempotentRequestOptions`
client.tokens.get(id) -> BasisTheory.Token
-
#### 🔌 Usage
-
-
```typescript
await client.tokens.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Tokens.RequestOptions`
client.tokens.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.tokens.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Tokens.RequestOptions`
client.tokens.update(id, { ...params }) -> BasisTheory.Token
-
#### 🔌 Usage
-
-
```typescript
await client.tokens.update("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `BasisTheory.UpdateTokenRequest`
-
**requestOptions:** `Tokens.IdempotentRequestOptions`
client.tokens.create({ ...params }) -> BasisTheory.Token
-
#### 🔌 Usage
-
-
```typescript
await client.tokens.create({});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.CreateTokenRequest`
-
**requestOptions:** `Tokens.IdempotentRequestOptions`
client.tokens.listV2({ ...params }) -> core.Page<BasisTheory.Token>
-
#### 🔌 Usage
-
-
```typescript
const response = await client.tokens.listV2();
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.tokens.listV2();
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.TokensListV2Request`
-
**requestOptions:** `Tokens.RequestOptions`
client.tokens.searchV2({ ...params }) -> core.Page<BasisTheory.Token>
-
#### 🔌 Usage
-
-
```typescript
const response = await client.tokens.searchV2();
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.tokens.searchV2();
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.SearchTokensRequestV2`
-
**requestOptions:** `Tokens.IdempotentRequestOptions`
client.enrichments.bankAccountVerify({ ...params }) -> BasisTheory.BankVerificationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.enrichments.bankAccountVerify({
tokenId: "token_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.BankVerificationRequest`
-
**requestOptions:** `Enrichments.RequestOptions`
client.enrichments.getcarddetails({ ...params }) -> BasisTheory.CardDetailsResponse
-
#### 🔌 Usage
-
-
```typescript
await client.enrichments.getcarddetails({
bin: "bin"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.EnrichmentsGetCardDetailsRequest`
-
**requestOptions:** `Enrichments.RequestOptions`
client.keys.list() -> BasisTheory.ClientEncryptionKeyMetadataResponse[]
-
#### 🔌 Usage
-
-
```typescript
await client.keys.list();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Keys.RequestOptions`
client.keys.create({ ...params }) -> BasisTheory.ClientEncryptionKeyResponse
-
#### 🔌 Usage
-
-
```typescript
await client.keys.create();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.ClientEncryptionKeyRequest`
-
**requestOptions:** `Keys.RequestOptions`
client.keys.get(id) -> BasisTheory.ClientEncryptionKeyMetadataResponse
-
#### 🔌 Usage
-
-
```typescript
await client.keys.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Keys.RequestOptions`
client.keys.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.keys.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Keys.RequestOptions`
client.logs.list({ ...params }) -> core.Page<BasisTheory.Log>
-
#### 🔌 Usage
-
-
```typescript
const response = await client.logs.list();
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.logs.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.LogsListRequest`
-
**requestOptions:** `Logs.RequestOptions`
client.logs.getEntityTypes() -> BasisTheory.LogEntityType[]
-
#### 🔌 Usage
-
-
```typescript
await client.logs.getEntityTypes();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Logs.RequestOptions`
client.networkTokens.create({ ...params }) -> BasisTheory.NetworkToken
-
#### 🔌 Usage
-
-
```typescript
await client.networkTokens.create();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.CreateNetworkTokenRequest`
-
**requestOptions:** `NetworkTokens.RequestOptions`
client.networkTokens.cryptogram(id) -> BasisTheory.NetworkTokenCryptogram
-
#### 🔌 Usage
-
-
```typescript
await client.networkTokens.cryptogram("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `NetworkTokens.RequestOptions`
client.networkTokens.get(id) -> BasisTheory.NetworkToken
-
#### 🔌 Usage
-
-
```typescript
await client.networkTokens.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `NetworkTokens.RequestOptions`
client.networkTokens.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.networkTokens.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `NetworkTokens.RequestOptions`
client.networkTokens.suspend(id) -> BasisTheory.NetworkToken
-
#### 🔌 Usage
-
-
```typescript
await client.networkTokens.suspend("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `NetworkTokens.RequestOptions`
client.networkTokens.resume(id) -> BasisTheory.NetworkToken
-
#### 🔌 Usage
-
-
```typescript
await client.networkTokens.resume("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `NetworkTokens.RequestOptions`
client.permissions.list({ ...params }) -> BasisTheory.Permission[]
-
#### 🔌 Usage
-
-
```typescript
await client.permissions.list();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.PermissionsListRequest`
-
**requestOptions:** `Permissions.RequestOptions`
client.proxies.list({ ...params }) -> core.Page<BasisTheory.Proxy>
-
#### 🔌 Usage
-
-
```typescript
const response = await client.proxies.list();
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.proxies.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.ProxiesListRequest`
-
**requestOptions:** `Proxies.RequestOptions`
client.proxies.create({ ...params }) -> BasisTheory.Proxy
-
#### 🔌 Usage
-
-
```typescript
await client.proxies.create({
name: "name",
destinationUrl: "destination_url"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.CreateProxyRequest`
-
**requestOptions:** `Proxies.IdempotentRequestOptions`
client.proxies.get(id) -> BasisTheory.Proxy
-
#### 🔌 Usage
-
-
```typescript
await client.proxies.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Proxies.RequestOptions`
client.proxies.update(id, { ...params }) -> BasisTheory.Proxy
-
#### 🔌 Usage
-
-
```typescript
await client.proxies.update("id", {
name: "name",
destinationUrl: "destination_url"
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `BasisTheory.UpdateProxyRequest`
-
**requestOptions:** `Proxies.IdempotentRequestOptions`
client.proxies.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.proxies.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Proxies.RequestOptions`
client.proxies.patch(id, { ...params }) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.proxies.patch("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `BasisTheory.PatchProxyRequest`
-
**requestOptions:** `Proxies.IdempotentRequestOptions`
client.reactors.list({ ...params }) -> core.Page<BasisTheory.Reactor>
-
#### 🔌 Usage
-
-
```typescript
const response = await client.reactors.list();
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.reactors.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.ReactorsListRequest`
-
**requestOptions:** `Reactors.RequestOptions`
client.reactors.create({ ...params }) -> BasisTheory.Reactor
-
#### 🔌 Usage
-
-
```typescript
await client.reactors.create({
name: "name",
code: "code"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.CreateReactorRequest`
-
**requestOptions:** `Reactors.IdempotentRequestOptions`
client.reactors.get(id) -> BasisTheory.Reactor
-
#### 🔌 Usage
-
-
```typescript
await client.reactors.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Reactors.RequestOptions`
client.reactors.update(id, { ...params }) -> BasisTheory.Reactor
-
#### 🔌 Usage
-
-
```typescript
await client.reactors.update("id", {
name: "name",
code: "code"
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `BasisTheory.UpdateReactorRequest`
-
**requestOptions:** `Reactors.IdempotentRequestOptions`
client.reactors.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.reactors.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Reactors.RequestOptions`
client.reactors.patch(id, { ...params }) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.reactors.patch("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `BasisTheory.PatchReactorRequest`
-
**requestOptions:** `Reactors.IdempotentRequestOptions`
client.reactors.react(id, { ...params }) -> BasisTheory.ReactResponse
-
#### 🔌 Usage
-
-
```typescript
await client.reactors.react("id", {
"key": "value"
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `unknown`
-
**requestOptions:** `Reactors.RequestOptions`
client.reactors.reactAsync(id, { ...params }) -> BasisTheory.AsyncReactResponse
-
#### 🔌 Usage
-
-
```typescript
await client.reactors.reactAsync("id", {
"key": "value"
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `unknown`
-
**requestOptions:** `Reactors.RequestOptions`
client.roles.list() -> BasisTheory.Role[]
-
#### 🔌 Usage
-
-
```typescript
await client.roles.list();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Roles.RequestOptions`
client.sessions.create() -> BasisTheory.CreateSessionResponse
-
#### 🔌 Usage
-
-
```typescript
await client.sessions.create();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Sessions.IdempotentRequestOptions`
client.sessions.authorize({ ...params }) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.sessions.authorize({
nonce: "nonce"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.AuthorizeSessionRequest`
-
**requestOptions:** `Sessions.IdempotentRequestOptions`
client.tokenIntents.get(id) -> BasisTheory.TokenIntent
-
#### 🔌 Usage
-
-
```typescript
await client.tokenIntents.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `TokenIntents.RequestOptions`
client.tokenIntents.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.tokenIntents.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `TokenIntents.RequestOptions`
client.tokenIntents.create({ ...params }) -> BasisTheory.CreateTokenIntentResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tokenIntents.create({
type: "x",
data: {
"key": "value"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.CreateTokenIntentRequest`
-
**requestOptions:** `TokenIntents.RequestOptions`
client.webhooks.ping() -> void
-
#### 📝 Description
-
-
Simple endpoint that can be utilized to verify the application is running
#### 🔌 Usage
-
-
```typescript
await client.webhooks.ping();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Webhooks.RequestOptions`
client.webhooks.get(id) -> BasisTheory.Webhook
-
#### 📝 Description
-
-
Returns the webhook
#### 🔌 Usage
-
-
```typescript
await client.webhooks.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Webhooks.RequestOptions`
client.webhooks.update(id, { ...params }) -> BasisTheory.Webhook
-
#### 📝 Description
-
-
Update a new webhook
#### 🔌 Usage
-
-
```typescript
await client.webhooks.update("id", {
name: "webhook-update",
url: "http://www.example.com",
events: ["token:created"]
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**request:** `BasisTheory.UpdateWebhookRequest`
-
**requestOptions:** `Webhooks.RequestOptions`
client.webhooks.delete(id) -> void
-
#### 📝 Description
-
-
Delete a new webhook
#### 🔌 Usage
-
-
```typescript
await client.webhooks.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Webhooks.RequestOptions`
client.webhooks.list() -> BasisTheory.WebhookList
-
#### 📝 Description
-
-
Returns the configured webhooks
#### 🔌 Usage
-
-
```typescript
await client.webhooks.list();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Webhooks.RequestOptions`
client.webhooks.create({ ...params }) -> BasisTheory.Webhook
-
#### 📝 Description
-
-
Create a new webhook
#### 🔌 Usage
-
-
```typescript
await client.webhooks.create({
name: "webhook-create",
url: "http://www.example.com",
events: ["token:created"]
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.CreateWebhookRequest`
-
**requestOptions:** `Webhooks.RequestOptions`
client.accountUpdater.jobs.get(id) -> BasisTheory.AccountUpdaterJob
-
#### 📝 Description
-
-
Returns the account updater batch job
#### 🔌 Usage
-
-
```typescript
await client.accountUpdater.jobs.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Jobs.RequestOptions`
client.accountUpdater.jobs.list({ ...params }) -> BasisTheory.AccountUpdaterJobList
-
#### 📝 Description
-
-
Returns a list of account updater batch jobs
#### 🔌 Usage
-
-
```typescript
await client.accountUpdater.jobs.list();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.accountUpdater.JobsListRequest`
-
**requestOptions:** `Jobs.RequestOptions`
client.accountUpdater.jobs.create() -> BasisTheory.AccountUpdaterJob
-
#### 📝 Description
-
-
Returns the created account updater batch job
#### 🔌 Usage
-
-
```typescript
await client.accountUpdater.jobs.create();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Jobs.RequestOptions`
client.accountUpdater.realTime.invoke({ ...params }) -> BasisTheory.AccountUpdaterRealTimeResponse
-
#### 📝 Description
-
-
Returns the update result
#### 🔌 Usage
-
-
```typescript
await client.accountUpdater.realTime.invoke({
tokenId: "9a420b15-ddfe-4793-9466-48f53520e47c"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.accountUpdater.AccountUpdaterRealTimeRequest`
-
**requestOptions:** `RealTime.RequestOptions`
client.agentic.agents.create({ ...params }) -> BasisTheory.Agent
-
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.create({
name: "name"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.agentic.CreateAgentRequest`
-
**requestOptions:** `Agents.RequestOptions`
client.agentic.agents.get(agentId) -> BasisTheory.Agent
-
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.get("agent_id");
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**requestOptions:** `Agents.RequestOptions`
client.agentic.agents.delete(agentId) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.delete("agent_id");
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**requestOptions:** `Agents.RequestOptions`
client.agentic.agents.update(agentId, { ...params }) -> BasisTheory.Agent
-
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.update("agent_id");
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**request:** `BasisTheory.agentic.UpdateAgentRequest`
-
**requestOptions:** `Agents.RequestOptions`
client.agentic.enrollments.list({ ...params }) -> core.Page<BasisTheory.Enrollment>
-
#### 📝 Description
-
-
List all enrollments for the current tenant with cursor-based pagination.
#### 🔌 Usage
-
-
```typescript
const response = await client.agentic.enrollments.list();
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.agentic.enrollments.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.agentic.EnrollmentsListRequest`
-
**requestOptions:** `Enrollments.RequestOptions`
client.agentic.enrollments.create({ ...params }) -> BasisTheory.Enrollment
-
#### 📝 Description
-
-
Enroll a card token with a card network (Visa or Mastercard).
#### 🔌 Usage
-
-
```typescript
await client.agentic.enrollments.create({
tokenId: "token_id",
consumer: {
email: "email"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.agentic.CreateEnrollmentRequest`
-
**requestOptions:** `Enrollments.RequestOptions`
client.agentic.enrollments.get(enrollmentId) -> BasisTheory.Enrollment
-
#### 🔌 Usage
-
-
```typescript
await client.agentic.enrollments.get("enrollment_id");
```
#### ⚙️ Parameters
-
-
**enrollmentId:** `string`
-
**requestOptions:** `Enrollments.RequestOptions`
client.agentic.enrollments.delete(enrollmentId) -> void
-
#### 📝 Description
-
-
Soft-deletes the enrollment by marking its status as deleted.
#### 🔌 Usage
-
-
```typescript
await client.agentic.enrollments.delete("enrollment_id");
```
#### ⚙️ Parameters
-
-
**enrollmentId:** `string`
-
**requestOptions:** `Enrollments.RequestOptions`
client.agentic.enrollments.retry(enrollmentId) -> BasisTheory.Enrollment
-
#### 📝 Description
-
-
Retry enrolling a card that previously failed. Only failed enrollments can be retried.
#### 🔌 Usage
-
-
```typescript
await client.agentic.enrollments.retry("enrollment_id");
```
#### ⚙️ Parameters
-
-
**enrollmentId:** `string`
-
**requestOptions:** `Enrollments.RequestOptions`
client.agentic.agents.instructions.list(agentId, { ...params }) -> core.Page<BasisTheory.Instruction>
-
#### 📝 Description
-
-
List all purchase instructions for an agent with cursor-based pagination and optional enrollment filter.
#### 🔌 Usage
-
-
```typescript
const response = await client.agentic.agents.instructions.list("agent_id");
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.agentic.agents.instructions.list("agent_id");
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**request:** `BasisTheory.agentic.agents.InstructionsListRequest`
-
**requestOptions:** `Instructions.RequestOptions`
client.agentic.agents.instructions.create(agentId, { ...params }) -> BasisTheory.Instruction
-
#### 📝 Description
-
-
Create a new payment instruction for an agent, linked to an enrollment.
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.instructions.create("agent_id", {
enrollmentId: "enrollment_id",
amount: {
value: "100.00"
},
description: "description",
expiresAt: new Date("2024-01-15T09:30:00.000Z")
});
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**request:** `BasisTheory.agentic.agents.CreateInstructionRequest`
-
**requestOptions:** `Instructions.RequestOptions`
client.agentic.agents.instructions.get(agentId, instructionId) -> BasisTheory.Instruction
-
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.instructions.get("agent_id", "instruction_id");
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**instructionId:** `string`
-
**requestOptions:** `Instructions.RequestOptions`
client.agentic.agents.instructions.delete(agentId, instructionId) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.instructions.delete("agent_id", "instruction_id");
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**instructionId:** `string`
-
**requestOptions:** `Instructions.RequestOptions`
client.agentic.agents.instructions.update(agentId, instructionId, { ...params }) -> BasisTheory.Instruction
-
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.instructions.update("agent_id", "instruction_id");
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**instructionId:** `string`
-
**request:** `BasisTheory.agentic.agents.UpdateInstructionRequest`
-
**requestOptions:** `Instructions.RequestOptions`
client.agentic.agents.instructions.credentials.create(agentId, instructionId, { ...params }) -> BasisTheory.Credentials
-
#### 📝 Description
-
-
Retrieve payment credentials (card number, expiration, CVC) for a purchase instruction.
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.instructions.credentials.create("agent_id", "instruction_id", {
merchant: {
name: "name",
url: "url",
countryCode: "country_code"
}
});
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**instructionId:** `string`
-
**request:** `BasisTheory.agentic.agents.instructions.GetCredentialsRequest`
-
**requestOptions:** `Credentials.RequestOptions`
client.agentic.agents.instructions.verify.start(agentId, instructionId, { ...params }) -> BasisTheory.VerificationResponse
-
#### 📝 Description
-
-
Initiate cardholder verification for a purchase instruction that requires it.
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.instructions.verify.start("agent_id", "instruction_id", {
deviceContext: {
screenHeight: 1,
screenWidth: 1,
userAgentString: "user_agent_string",
languageCode: "language_code",
timeZone: "time_zone",
javaScriptEnabled: true,
clientDeviceId: "client_device_id",
clientReferenceId: "client_reference_id",
platformType: "WEB"
}
});
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**instructionId:** `string`
-
**request:** `BasisTheory.StartVerificationRequest`
-
**requestOptions:** `Verify.RequestOptions`
client.agentic.agents.instructions.verify.passkey(agentId, instructionId, { ...params }) -> BasisTheory.Instruction
-
#### 📝 Description
-
-
Submit passkey/FIDO assertion data to complete instruction verification.
#### 🔌 Usage
-
-
```typescript
await client.agentic.agents.instructions.verify.passkey("agent_id", "instruction_id", {
assuranceData: {
"key": "value"
}
});
```
#### ⚙️ Parameters
-
-
**agentId:** `string`
-
**instructionId:** `string`
-
**request:** `BasisTheory.agentic.agents.instructions.SubmitPasskeyRequest`
-
**requestOptions:** `Verify.RequestOptions`
client.agentic.enrollments.verify.start(enrollmentId, { ...params }) -> BasisTheory.VerificationResponse
-
#### 📝 Description
-
-
Initiates the cardholder verification flow for a pending enrollment.
#### 🔌 Usage
-
-
```typescript
await client.agentic.enrollments.verify.start("enrollment_id", {
deviceContext: {
screenHeight: 1,
screenWidth: 1,
userAgentString: "user_agent_string",
languageCode: "language_code",
timeZone: "time_zone",
javaScriptEnabled: true,
clientDeviceId: "client_device_id",
clientReferenceId: "client_reference_id",
platformType: "WEB"
}
});
```
#### ⚙️ Parameters
-
-
**enrollmentId:** `string`
-
**request:** `BasisTheory.StartVerificationRequest`
-
**requestOptions:** `Verify.RequestOptions`
client.agentic.enrollments.verify.method(enrollmentId, { ...params }) -> BasisTheory.VerificationResponse
-
#### 📝 Description
-
-
Choose the OTP delivery method (SMS, email, etc.) for enrollment verification.
#### 🔌 Usage
-
-
```typescript
await client.agentic.enrollments.verify.method("enrollment_id", {
methodId: "method_id"
});
```
#### ⚙️ Parameters
-
-
**enrollmentId:** `string`
-
**request:** `BasisTheory.agentic.enrollments.SelectMethodRequest`
-
**requestOptions:** `Verify.RequestOptions`
client.agentic.enrollments.verify.otp(enrollmentId, { ...params }) -> BasisTheory.VerificationResponse
-
#### 📝 Description
-
-
Submit the one-time password received by the cardholder.
#### 🔌 Usage
-
-
```typescript
await client.agentic.enrollments.verify.otp("enrollment_id", {
otpCode: "otp_code"
});
```
#### ⚙️ Parameters
-
-
**enrollmentId:** `string`
-
**request:** `BasisTheory.agentic.enrollments.SubmitOtpRequest`
-
**requestOptions:** `Verify.RequestOptions`
client.agentic.enrollments.verify.complete(enrollmentId, { ...params }) -> BasisTheory.VerificationResponse
-
#### 📝 Description
-
-
Complete the verification flow (e.g. after passkey creation). Body is optional — Visa sends empty body, Mastercard sends assurance_data.
#### 🔌 Usage
-
-
```typescript
await client.agentic.enrollments.verify.complete("enrollment_id");
```
#### ⚙️ Parameters
-
-
**enrollmentId:** `string`
-
**request:** `BasisTheory.agentic.enrollments.CompleteVerificationRequest`
-
**requestOptions:** `Verify.RequestOptions`
client.applePay.merchant.get(id) -> BasisTheory.ApplePayMerchant
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.merchant.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Merchant.RequestOptions`
client.applePay.merchant.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.merchant.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Merchant.RequestOptions`
client.applePay.merchant.create({ ...params }) -> BasisTheory.ApplePayMerchant
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.merchant.create();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.applePay.ApplePayMerchantRegisterRequest`
-
**requestOptions:** `Merchant.RequestOptions`
client.applePay.domain.deregister({ ...params }) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.domain.deregister({
domain: "domain"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.applePay.ApplePayDomainDeregistrationRequest`
-
**requestOptions:** `Domain.RequestOptions`
client.applePay.domain.get() -> BasisTheory.ApplePayDomainRegistrationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.domain.get();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Domain.RequestOptions`
client.applePay.domain.register({ ...params }) -> BasisTheory.ApplePayDomainRegistrationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.domain.register({
domain: "domain"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.applePay.ApplePayDomainRegistrationRequest`
-
**requestOptions:** `Domain.RequestOptions`
client.applePay.domain.registerAll({ ...params }) -> BasisTheory.ApplePayDomainRegistrationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.domain.registerAll();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.applePay.ApplePayDomainRegistrationListRequest`
-
**requestOptions:** `Domain.RequestOptions`
client.applePay.session.create({ ...params }) -> string
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.session.create();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.applePay.ApplePaySessionRequest`
-
**requestOptions:** `Session.RequestOptions`
client.applePay.merchant.certificates.get(merchantId, id) -> BasisTheory.ApplePayMerchantCertificates
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.merchant.certificates.get("merchantId", "id");
```
#### ⚙️ Parameters
-
-
**merchantId:** `string`
-
**id:** `string`
-
**requestOptions:** `Certificates.RequestOptions`
client.applePay.merchant.certificates.delete(merchantId, id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.merchant.certificates.delete("merchantId", "id");
```
#### ⚙️ Parameters
-
-
**merchantId:** `string`
-
**id:** `string`
-
**requestOptions:** `Certificates.RequestOptions`
client.applePay.merchant.certificates.create(merchantId, { ...params }) -> BasisTheory.ApplePayMerchantCertificates
-
#### 🔌 Usage
-
-
```typescript
await client.applePay.merchant.certificates.create("merchantId");
```
#### ⚙️ Parameters
-
-
**merchantId:** `string`
-
**request:** `BasisTheory.applePay.merchant.ApplePayMerchantCertificatesRegisterRequest`
-
**requestOptions:** `Certificates.RequestOptions`
client.documents.data.get(documentId) -> core.BinaryResponse
-
#### 🔌 Usage
-
-
```typescript
await client.documents.data.get("documentId");
```
#### ⚙️ Parameters
-
-
**documentId:** `string`
-
**requestOptions:** `Data.RequestOptions`
client.googlePay.merchant.get(id) -> BasisTheory.GooglePayMerchant
-
#### 🔌 Usage
-
-
```typescript
await client.googlePay.merchant.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Merchant.RequestOptions`
client.googlePay.merchant.delete(id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.googlePay.merchant.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Merchant.RequestOptions`
client.googlePay.merchant.create({ ...params }) -> BasisTheory.GooglePayMerchant
-
#### 🔌 Usage
-
-
```typescript
await client.googlePay.merchant.create();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.googlePay.GooglePayMerchantRegisterRequest`
-
**requestOptions:** `Merchant.RequestOptions`
client.googlePay.merchant.certificates.get(merchantId, id) -> BasisTheory.GooglePayMerchantCertificates
-
#### 🔌 Usage
-
-
```typescript
await client.googlePay.merchant.certificates.get("merchantId", "id");
```
#### ⚙️ Parameters
-
-
**merchantId:** `string`
-
**id:** `string`
-
**requestOptions:** `Certificates.RequestOptions`
client.googlePay.merchant.certificates.delete(merchantId, id) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.googlePay.merchant.certificates.delete("merchantId", "id");
```
#### ⚙️ Parameters
-
-
**merchantId:** `string`
-
**id:** `string`
-
**requestOptions:** `Certificates.RequestOptions`
client.googlePay.merchant.certificates.create(merchantId, { ...params }) -> BasisTheory.GooglePayMerchantCertificates
-
#### 🔌 Usage
-
-
```typescript
await client.googlePay.merchant.certificates.create("merchantId");
```
#### ⚙️ Parameters
-
-
**merchantId:** `string`
-
**request:** `BasisTheory.googlePay.merchant.GooglePayMerchantCertificatesRegisterRequest`
-
**requestOptions:** `Certificates.RequestOptions`
client.reactors.results.get(id, requestId) -> unknown
-
#### 🔌 Usage
-
-
```typescript
await client.reactors.results.get("id", "requestId");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestId:** `string`
-
**requestOptions:** `Results.RequestOptions`
client.tenants.securityContact.get() -> BasisTheory.SecurityContactEmailResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.securityContact.get();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `SecurityContact.RequestOptions`
client.tenants.securityContact.update({ ...params }) -> BasisTheory.SecurityContactEmailResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.securityContact.update({
email: "email"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.tenants.SecurityContactEmailRequest`
-
**requestOptions:** `SecurityContact.RequestOptions`
client.tenants.connections.create({ ...params }) -> BasisTheory.CreateTenantConnectionResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.connections.create({
strategy: "strategy",
options: {}
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.tenants.CreateTenantConnectionRequest`
-
**requestOptions:** `Connections.IdempotentRequestOptions`
client.tenants.connections.delete() -> BasisTheory.CreateTenantConnectionResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.connections.delete();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Connections.RequestOptions`
client.tenants.invitations.list({ ...params }) -> core.Page<BasisTheory.TenantInvitationResponse>
-
#### 🔌 Usage
-
-
```typescript
const response = await client.tenants.invitations.list();
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.tenants.invitations.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.tenants.InvitationsListRequest`
-
**requestOptions:** `Invitations.RequestOptions`
client.tenants.invitations.create({ ...params }) -> BasisTheory.TenantInvitationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.invitations.create({
email: "email"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.tenants.CreateTenantInvitationRequest`
-
**requestOptions:** `Invitations.IdempotentRequestOptions`
client.tenants.invitations.resend(invitationId) -> BasisTheory.TenantInvitationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.invitations.resend("invitationId");
```
#### ⚙️ Parameters
-
-
**invitationId:** `string`
-
**requestOptions:** `Invitations.IdempotentRequestOptions`
client.tenants.invitations.get(invitationId) -> BasisTheory.TenantInvitationResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.invitations.get("invitationId");
```
#### ⚙️ Parameters
-
-
**invitationId:** `string`
-
**requestOptions:** `Invitations.RequestOptions`
client.tenants.invitations.delete(invitationId) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.invitations.delete("invitationId");
```
#### ⚙️ Parameters
-
-
**invitationId:** `string`
-
**requestOptions:** `Invitations.RequestOptions`
client.tenants.members.list({ ...params }) -> BasisTheory.TenantMemberResponsePaginatedList
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.members.list();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.tenants.MembersListRequest`
-
**requestOptions:** `Members.RequestOptions`
client.tenants.members.update(memberId, { ...params }) -> BasisTheory.TenantMemberResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.members.update("memberId", {
role: "role"
});
```
#### ⚙️ Parameters
-
-
**memberId:** `string`
-
**request:** `BasisTheory.tenants.UpdateTenantMemberRequest`
-
**requestOptions:** `Members.IdempotentRequestOptions`
client.tenants.members.delete(memberId) -> void
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.members.delete("memberId");
```
#### ⚙️ Parameters
-
-
**memberId:** `string`
-
**requestOptions:** `Members.RequestOptions`
client.tenants.owner.get() -> BasisTheory.TenantMemberResponse
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.owner.get();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Owner.RequestOptions`
client.tenants.self.getUsageReports() -> BasisTheory.TenantUsageReport
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.self.getUsageReports();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Self.RequestOptions`
client.tenants.self.get() -> BasisTheory.Tenant
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.self.get();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Self.RequestOptions`
client.tenants.self.update({ ...params }) -> BasisTheory.Tenant
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.self.update({
name: "name"
});
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.tenants.UpdateTenantRequest`
-
**requestOptions:** `Self.IdempotentRequestOptions`
client.tenants.self.delete() -> void
-
#### 🔌 Usage
-
-
```typescript
await client.tenants.self.delete();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Self.RequestOptions`
client.threeds.sessions.create({ ...params }) -> BasisTheory.CreateThreeDsSessionResponse
-
#### 🔌 Usage
-
-
```typescript
await client.threeds.sessions.create();
```
#### ⚙️ Parameters
-
-
**request:** `BasisTheory.threeds.CreateThreeDsSessionRequest`
-
**requestOptions:** `Sessions.RequestOptions`
client.threeds.sessions.authenticate(sessionId, { ...params }) -> BasisTheory.ThreeDsAuthentication
-
#### 🔌 Usage
-
-
```typescript
await client.threeds.sessions.authenticate("sessionId", {
authenticationCategory: "authentication_category",
authenticationType: "authentication_type"
});
```
#### ⚙️ Parameters
-
-
**sessionId:** `string`
-
**request:** `BasisTheory.AuthenticateThreeDsSessionRequest`
-
**requestOptions:** `Sessions.IdempotentRequestOptions`
client.threeds.sessions.getChallengeResult(sessionId) -> BasisTheory.ThreeDsAuthentication
-
#### 🔌 Usage
-
-
```typescript
await client.threeds.sessions.getChallengeResult("sessionId");
```
#### ⚙️ Parameters
-
-
**sessionId:** `string`
-
**requestOptions:** `Sessions.RequestOptions`
client.threeds.sessions.get(id) -> BasisTheory.ThreeDsSession
-
#### 🔌 Usage
-
-
```typescript
await client.threeds.sessions.get("id");
```
#### ⚙️ Parameters
-
-
**id:** `string`
-
**requestOptions:** `Sessions.RequestOptions`
client.webhooks.events.list() -> BasisTheory.EventTypes
-
#### 📝 Description
-
-
Return a list of available event types
#### 🔌 Usage
-
-
```typescript
await client.webhooks.events.list();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `Events.RequestOptions`