Skip to content

Latest commit

Β 

History

History
6019 lines (4221 loc) Β· 54.3 KB

File metadata and controls

6019 lines (4221 loc) Β· 54.3 KB

Reference

Applications

client.applications.list() -> ApplicationPaginatedList

πŸ”Œ Usage

client.applications().list(
    ApplicationsListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

id: Optional<String>

type: Optional<String>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.applications.create(request) -> Application

πŸ”Œ Usage

client.applications().create(
    CreateApplicationRequest
        .builder()
        .name("name")
        .type("type")
        .build()
);

βš™οΈ Parameters

name: String

type: String

permissions: Optional<List<String>>

rules: Optional<List<AccessRule>>

createKey: Optional<Boolean>

client.applications.get(id) -> Application

πŸ”Œ Usage

client.applications().get("id");

βš™οΈ Parameters

id: String

client.applications.update(id, request) -> Application

πŸ”Œ Usage

client.applications().update(
    "id",
    UpdateApplicationRequest
        .builder()
        .name("name")
        .build()
);

βš™οΈ Parameters

id: String

name: String

permissions: Optional<List<String>>

rules: Optional<List<AccessRule>>

client.applications.delete(id)

πŸ”Œ Usage

client.applications().delete("id");

βš™οΈ Parameters

id: String

client.applications.getByKey() -> Application

πŸ”Œ Usage

client.applications().getByKey();

ApplicationKeys

client.applicationKeys.list(id) -> List&lt;ApplicationKey&gt;

πŸ”Œ Usage

client.applicationKeys().list(
    "id",
    ApplicationKeysListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

id: String

id: Optional<String>

type: Optional<String>

client.applicationKeys.create(id) -> ApplicationKey

πŸ”Œ Usage

client.applicationKeys().create("id");

βš™οΈ Parameters

id: String

client.applicationKeys.get(id, keyId) -> ApplicationKey

πŸ”Œ Usage

client.applicationKeys().get("id", "keyId");

βš™οΈ Parameters

id: String

keyId: String

client.applicationKeys.delete(id, keyId)

πŸ”Œ Usage

client.applicationKeys().delete("id", "keyId");

βš™οΈ Parameters

id: String

keyId: String

ApplicationTemplates

client.applicationTemplates.list() -> List&lt;ApplicationTemplate&gt;

πŸ”Œ Usage

client.applicationTemplates().list();
client.applicationTemplates.get(id) -> ApplicationTemplate

πŸ”Œ Usage

client.applicationTemplates().get("id");

βš™οΈ Parameters

id: String

ApplePay

client.applePay.create(request) -> ApplePayCreateResponse

πŸ”Œ Usage

client.applePay().create(
    ApplePayCreateRequest
        .builder()
        .build()
);

βš™οΈ Parameters

expiresAt: Optional<String>

applePaymentData: Optional<ApplePayMethodToken>

merchantRegistrationId: Optional<String>

client.applePay.get(id) -> ApplePayToken

πŸ”Œ Usage

client.applePay().get("id");

βš™οΈ Parameters

id: String

client.applePay.delete(id) -> String

πŸ”Œ Usage

client.applePay().delete("id");

βš™οΈ Parameters

id: String

GooglePay

client.googlePay.create(request) -> GooglePayCreateResponse

πŸ”Œ Usage

client.googlePay().create(
    GooglePayCreateRequest
        .builder()
        .build()
);

βš™οΈ Parameters

expiresAt: Optional<String>

googlePaymentData: Optional<GooglePayMethodToken>

merchantRegistrationId: Optional<String>

client.googlePay.get(id) -> GooglePayToken

πŸ”Œ Usage

client.googlePay().get("id");

βš™οΈ Parameters

id: String

client.googlePay.delete(id) -> String

πŸ”Œ Usage

client.googlePay().delete("id");

βš™οΈ Parameters

id: String

Documents

client.documents.upload(request) -> Document

πŸ”Œ Usage

client.documents().upload(
    DocumentsUploadRequest
        .builder()
        .build()
);
client.documents.get(id) -> Document

πŸ”Œ Usage

client.documents().get("id");

βš™οΈ Parameters

id: String

client.documents.delete(id)

πŸ”Œ Usage

client.documents().delete("id");

βš™οΈ Parameters

id: String

Tokens

client.tokens.detokenize(request) -> Object

πŸ”Œ Usage

client.tokens().detokenize(new 
HashMap<String, Object>() {{put("key", "value");
}});

βš™οΈ Parameters

request: Object

client.tokens.tokenize(request) -> Object

πŸ”Œ Usage

client.tokens().tokenize(new 
HashMap<String, Object>() {{put("key", "value");
}});

βš™οΈ Parameters

request: Object

client.tokens.get(id) -> Token

πŸ”Œ Usage

client.tokens().get("id");

βš™οΈ Parameters

id: String

client.tokens.delete(id)

πŸ”Œ Usage

client.tokens().delete("id");

βš™οΈ Parameters

id: String

client.tokens.update(id, request) -> Token

πŸ”Œ Usage

client.tokens().update(
    "id",
    UpdateTokenRequest
        .builder()
        .build()
);

βš™οΈ Parameters

id: String

data: Optional<Object>

privacy: Optional<UpdatePrivacy>

metadata: Optional<Map<String, Optional<String>>>

searchIndexes: Optional<List<String>>

fingerprintExpression: Optional<String>

mask: Optional<Object>

expiresAt: Optional<String>

deduplicateToken: Optional<Boolean>

containers: Optional<List<String>>

client.tokens.create(request) -> Token

πŸ”Œ Usage

client.tokens().create(
    CreateTokenRequest
        .builder()
        .build()
);

βš™οΈ Parameters

request: CreateTokenRequest

client.tokens.listV2() -> TokenCursorPaginatedList

πŸ”Œ Usage

client.tokens().listV2(
    TokensListV2Request
        .builder()
        .build()
);

βš™οΈ Parameters

type: Optional<String>

container: Optional<String>

fingerprint: Optional<String>

metadata: Optional<Map<String, Optional<String>>>

start: Optional<String>

size: Optional<Integer>

client.tokens.searchV2(request) -> TokenCursorPaginatedList

πŸ”Œ Usage

client.tokens().searchV2(
    SearchTokensRequestV2
        .builder()
        .build()
);

βš™οΈ Parameters

query: Optional<String>

start: Optional<String>

size: Optional<Integer>

Enrichments

client.enrichments.bankAccountVerify(request) -> BankVerificationResponse

πŸ”Œ Usage

client.enrichments().bankAccountVerify(
    BankVerificationRequest
        .builder()
        .tokenId("token_id")
        .build()
);

βš™οΈ Parameters

tokenId: String

countryCode: Optional<String>

routingNumber: Optional<String>

client.enrichments.getcarddetails() -> CardDetailsResponse

πŸ”Œ Usage

client.enrichments().getcarddetails(
    EnrichmentsGetCardDetailsRequest
        .builder()
        .bin("bin")
        .build()
);

βš™οΈ Parameters

bin: String

Keys

client.keys.list() -> List&lt;ClientEncryptionKeyMetadataResponse&gt;

πŸ”Œ Usage

client.keys().list();
client.keys.create(request) -> ClientEncryptionKeyResponse

πŸ”Œ Usage

client.keys().create(
    ClientEncryptionKeyRequest
        .builder()
        .build()
);

βš™οΈ Parameters

expiresAt: Optional<OffsetDateTime>

client.keys.get(id) -> ClientEncryptionKeyMetadataResponse

πŸ”Œ Usage

client.keys().get("id");

βš™οΈ Parameters

id: String

client.keys.delete(id)

πŸ”Œ Usage

client.keys().delete("id");

βš™οΈ Parameters

id: String

Logs

client.logs.list() -> LogPaginatedList

πŸ”Œ Usage

client.logs().list(
    LogsListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

entityType: Optional<String>

entityId: Optional<String>

startDate: Optional<OffsetDateTime>

endDate: Optional<OffsetDateTime>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.logs.getEntityTypes() -> List&lt;LogEntityType&gt;

πŸ”Œ Usage

client.logs().getEntityTypes();

NetworkTokens

client.networkTokens.create(request) -> NetworkToken

πŸ”Œ Usage

client.networkTokens().create(
    CreateNetworkTokenRequest
        .builder()
        .build()
);

βš™οΈ Parameters

data: Optional<Card>

tokenId: Optional<String>

tokenIntentId: Optional<String>

cardholderInfo: Optional<CardholderInfo>

merchantId: Optional<String>

client.networkTokens.cryptogram(id) -> NetworkTokenCryptogram

πŸ”Œ Usage

client.networkTokens().cryptogram("id");

βš™οΈ Parameters

id: String

client.networkTokens.get(id) -> NetworkToken

πŸ”Œ Usage

client.networkTokens().get("id");

βš™οΈ Parameters

id: String

client.networkTokens.delete(id)

πŸ”Œ Usage

client.networkTokens().delete("id");

βš™οΈ Parameters

id: String

client.networkTokens.suspend(id) -> NetworkToken

πŸ”Œ Usage

client.networkTokens().suspend("id");

βš™οΈ Parameters

id: String

client.networkTokens.resume(id) -> NetworkToken

πŸ”Œ Usage

client.networkTokens().resume("id");

βš™οΈ Parameters

id: String

Permissions

client.permissions.list() -> List&lt;Permission&gt;

πŸ”Œ Usage

client.permissions().list(
    PermissionsListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

applicationType: Optional<String>

Proxies

client.proxies.list() -> ProxyPaginatedList

πŸ”Œ Usage

client.proxies().list(
    ProxiesListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

id: Optional<String>

name: Optional<String>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.proxies.create(request) -> Proxy

πŸ”Œ Usage

client.proxies().create(
    CreateProxyRequest
        .builder()
        .name("name")
        .destinationUrl("destination_url")
        .build()
);

βš™οΈ Parameters

name: String

destinationUrl: String

requestReactorId: Optional<String>

responseReactorId: Optional<String>

requestTransform: Optional<ProxyTransform>

responseTransform: Optional<ProxyTransform>

requestTransforms: Optional<List<ProxyTransform>>

responseTransforms: Optional<List<ProxyTransform>>

application: Optional<Application>

configuration: Optional<Map<String, Optional<String>>>

requireAuth: Optional<Boolean>

disableDetokenization: Optional<Boolean>

client.proxies.get(id) -> Proxy

πŸ”Œ Usage

client.proxies().get("id");

βš™οΈ Parameters

id: String

client.proxies.update(id, request) -> Proxy

πŸ”Œ Usage

client.proxies().update(
    "id",
    UpdateProxyRequest
        .builder()
        .name("name")
        .destinationUrl("destination_url")
        .build()
);

βš™οΈ Parameters

id: String

name: String

destinationUrl: String

requestReactorId: Optional<String>

responseReactorId: Optional<String>

requestTransform: Optional<ProxyTransform>

responseTransform: Optional<ProxyTransform>

requestTransforms: Optional<List<ProxyTransform>>

responseTransforms: Optional<List<ProxyTransform>>

application: Optional<Application>

configuration: Optional<Map<String, Optional<String>>>

requireAuth: Optional<Boolean>

disableDetokenization: Optional<Boolean>

client.proxies.delete(id)

πŸ”Œ Usage

client.proxies().delete("id");

βš™οΈ Parameters

id: String

client.proxies.patch(id, request)

πŸ”Œ Usage

client.proxies().patch(
    "id",
    PatchProxyRequest
        .builder()
        .build()
);

βš™οΈ Parameters

id: String

name: Optional<String>

destinationUrl: Optional<String>

requestTransform: Optional<ProxyTransform>

responseTransform: Optional<ProxyTransform>

requestTransforms: Optional<List<ProxyTransform>>

responseTransforms: Optional<List<ProxyTransform>>

application: Optional<Application>

configuration: Optional<Map<String, Optional<String>>>

requireAuth: Optional<Boolean>

disableDetokenization: Optional<Boolean>

Reactors

client.reactors.list() -> ReactorPaginatedList

πŸ”Œ Usage

client.reactors().list(
    ReactorsListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

id: Optional<String>

name: Optional<String>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.reactors.create(request) -> Reactor

πŸ”Œ Usage

client.reactors().create(
    CreateReactorRequest
        .builder()
        .name("name")
        .code("code")
        .build()
);

βš™οΈ Parameters

name: String

code: String

application: Optional<Application>

configuration: Optional<Map<String, Optional<String>>>

runtime: Optional<Runtime>

client.reactors.get(id) -> Reactor

πŸ”Œ Usage

client.reactors().get("id");

βš™οΈ Parameters

id: String

client.reactors.update(id, request) -> Reactor

πŸ”Œ Usage

client.reactors().update(
    "id",
    UpdateReactorRequest
        .builder()
        .name("name")
        .code("code")
        .build()
);

βš™οΈ Parameters

id: String

name: String

application: Optional<Application>

code: String

configuration: Optional<Map<String, Optional<String>>>

runtime: Optional<Runtime>

client.reactors.delete(id)

πŸ”Œ Usage

client.reactors().delete("id");

βš™οΈ Parameters

id: String

client.reactors.patch(id, request)

πŸ”Œ Usage

client.reactors().patch(
    "id",
    PatchReactorRequest
        .builder()
        .build()
);

βš™οΈ Parameters

id: String

name: Optional<String>

application: Optional<Application>

code: Optional<String>

configuration: Optional<Map<String, Optional<String>>>

runtime: Optional<Runtime>

client.reactors.react(id, request) -> ReactResponse

πŸ”Œ Usage

client.reactors().react("id", new 
HashMap<String, Object>() {{put("key", "value");
}});

βš™οΈ Parameters

id: String

request: Object

client.reactors.reactAsync(id, request) -> AsyncReactResponse

πŸ”Œ Usage

client.reactors().reactAsync("id", new 
HashMap<String, Object>() {{put("key", "value");
}});

βš™οΈ Parameters

id: String

request: Object

Roles

client.roles.list() -> List&lt;Role&gt;

πŸ”Œ Usage

client.roles().list();

Sessions

client.sessions.create() -> CreateSessionResponse

πŸ”Œ Usage

client.sessions().create();
client.sessions.authorize(request)

πŸ”Œ Usage

client.sessions().authorize(
    AuthorizeSessionRequest
        .builder()
        .nonce("nonce")
        .build()
);

βš™οΈ Parameters

nonce: String

expiresAt: Optional<String>

permissions: Optional<List<String>>

rules: Optional<List<AccessRule>>

TokenIntents

client.tokenIntents.get(id) -> TokenIntent

πŸ”Œ Usage

client.tokenIntents().get("id");

βš™οΈ Parameters

id: String

client.tokenIntents.delete(id)

πŸ”Œ Usage

client.tokenIntents().delete("id");

βš™οΈ Parameters

id: String

client.tokenIntents.create(request) -> CreateTokenIntentResponse

πŸ”Œ Usage

client.tokenIntents().create(
    CreateTokenIntentRequest
        .builder()
        .type("x")
        .data(new 
            HashMap<String, Object>() {{put("key", "value");
            }})
        .build()
);

βš™οΈ Parameters

type: String

data: Object

Webhooks

client.webhooks.ping()

πŸ“ Description

Simple endpoint that can be utilized to verify the application is running

πŸ”Œ Usage

client.webhooks().ping();
client.webhooks.get(id) -> Webhook

πŸ“ Description

Returns the webhook

πŸ”Œ Usage

client.webhooks().get("id");

βš™οΈ Parameters

id: String

client.webhooks.update(id, request) -> Webhook

πŸ“ Description

Update a new webhook

πŸ”Œ Usage

client.webhooks().update(
    "id",
    UpdateWebhookRequest
        .builder()
        .name("webhook-update")
        .url("http://www.example.com")
        .events(
            new ArrayList<String>(
                Arrays.asList("token:created")
            )
        )
        .build()
);

βš™οΈ Parameters

id: String

name: String β€” The name of the webhook

url: String β€” The URL to which the webhook will send events

notifyEmail: Optional<String> β€” The email address to use for management notification events. Ie: webhook disabled

events: List<String> β€” An array of event types that the webhook will listen for

client.webhooks.delete(id)

πŸ“ Description

Delete a new webhook

πŸ”Œ Usage

client.webhooks().delete("id");

βš™οΈ Parameters

id: String

client.webhooks.list() -> WebhookList

πŸ“ Description

Returns the configured webhooks

πŸ”Œ Usage

client.webhooks().list();
client.webhooks.create(request) -> Webhook

πŸ“ Description

Create a new webhook

πŸ”Œ Usage

client.webhooks().create(
    CreateWebhookRequest
        .builder()
        .name("webhook-create")
        .url("http://www.example.com")
        .events(
            new ArrayList<String>(
                Arrays.asList("token:created")
            )
        )
        .build()
);

βš™οΈ Parameters

name: String β€” The name of the webhook

url: String β€” The URL to which the webhook will send events

notifyEmail: Optional<String> β€” The email address to use for management notification events. Ie: webhook disabled

events: List<String> β€” An array of event types that the webhook will listen for

AccountUpdater Jobs

client.accountUpdater.jobs.get(id) -> AccountUpdaterJob

πŸ“ Description

Returns the account updater batch job

πŸ”Œ Usage

client.accountUpdater().jobs().get("id");

βš™οΈ Parameters

id: String

client.accountUpdater.jobs.list() -> AccountUpdaterJobList

πŸ“ Description

Returns a list of account updater batch jobs

πŸ”Œ Usage

client.accountUpdater().jobs().list(
    JobsListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

size: Optional<Integer> β€” The maximum number of jobs to return

start: Optional<String> β€” Cursor for pagination

client.accountUpdater.jobs.create() -> AccountUpdaterJob

πŸ“ Description

Returns the created account updater batch job

πŸ”Œ Usage

client.accountUpdater().jobs().create();

AccountUpdater RealTime

client.accountUpdater.realTime.invoke(request) -> AccountUpdaterRealTimeResponse

πŸ“ Description

Returns the update result

πŸ”Œ Usage

client.accountUpdater().realTime().invoke(
    AccountUpdaterRealTimeRequest
        .builder()
        .tokenId("9a420b15-ddfe-4793-9466-48f53520e47c")
        .build()
);

βš™οΈ Parameters

tokenId: String β€” Card Token identifier

expirationYear: Optional<Integer> β€” The 4-digit expiration year of the account number. Not required if the card token already stores this value.

expirationMonth: Optional<Integer> β€” The 2-digit expiration month of the account number. Not required if the card token already stores this value.

deduplicateToken: Optional<Boolean> β€” Whether deduplication should be enabled when creating the new token. Uses the value of the Deduplicate Tokens setting on the tenant if not set.

merchantId: Optional<String> β€” Tenant merchant identifier

ApplePay Merchant

client.applePay.merchant.get(id) -> ApplePayMerchant

πŸ”Œ Usage

client.applePay().merchant().get("id");

βš™οΈ Parameters

id: String

client.applePay.merchant.delete(id)

πŸ”Œ Usage

client.applePay().merchant().delete("id");

βš™οΈ Parameters

id: String

client.applePay.merchant.create(request) -> ApplePayMerchant

πŸ”Œ Usage

client.applePay().merchant().create(
    ApplePayMerchantRegisterRequest
        .builder()
        .build()
);

βš™οΈ Parameters

merchantIdentifier: Optional<String>

ApplePay Domain

client.applePay.domain.deregister(request)

πŸ”Œ Usage

client.applePay().domain().deregister(
    ApplePayDomainDeregistrationRequest
        .builder()
        .domain("domain")
        .build()
);

βš™οΈ Parameters

domain: String

client.applePay.domain.get() -> ApplePayDomainRegistrationResponse

πŸ”Œ Usage

client.applePay().domain().get();
client.applePay.domain.register(request) -> ApplePayDomainRegistrationResponse

πŸ”Œ Usage

client.applePay().domain().register(
    ApplePayDomainRegistrationRequest
        .builder()
        .domain("domain")
        .build()
);

βš™οΈ Parameters

domain: String

client.applePay.domain.registerAll(request) -> ApplePayDomainRegistrationResponse

πŸ”Œ Usage

client.applePay().domain().registerAll(
    ApplePayDomainRegistrationListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

domains: Optional<List<String>>

ApplePay Session

client.applePay.session.create(request) -> String

πŸ”Œ Usage

client.applePay().session().create(
    ApplePaySessionRequest
        .builder()
        .build()
);

βš™οΈ Parameters

validationUrl: Optional<String>

displayName: Optional<String>

domain: Optional<String>

merchantRegistrationId: Optional<String>

ApplePay Merchant Certificates

client.applePay.merchant.certificates.get(merchantId, id) -> ApplePayMerchantCertificates

πŸ”Œ Usage

client.applePay().merchant().certificates().get("merchantId", "id");

βš™οΈ Parameters

merchantId: String

id: String

client.applePay.merchant.certificates.delete(merchantId, id)

πŸ”Œ Usage

client.applePay().merchant().certificates().delete("merchantId", "id");

βš™οΈ Parameters

merchantId: String

id: String

client.applePay.merchant.certificates.create(merchantId, request) -> ApplePayMerchantCertificates

πŸ”Œ Usage

client.applePay().merchant().certificates().create(
    "merchantId",
    ApplePayMerchantCertificatesRegisterRequest
        .builder()
        .build()
);

βš™οΈ Parameters

merchantId: String

merchantCertificateData: Optional<String>

merchantCertificatePassword: Optional<String>

paymentProcessorCertificateData: Optional<String>

paymentProcessorCertificatePassword: Optional<String>

domain: Optional<String>

Documents Data

client.documents.data.get(documentId) -> InputStream

πŸ”Œ Usage

client.documents().data().get("documentId");

βš™οΈ Parameters

documentId: String

GooglePay Merchant

client.googlePay.merchant.get(id) -> GooglePayMerchant

πŸ”Œ Usage

client.googlePay().merchant().get("id");

βš™οΈ Parameters

id: String

client.googlePay.merchant.delete(id)

πŸ”Œ Usage

client.googlePay().merchant().delete("id");

βš™οΈ Parameters

id: String

client.googlePay.merchant.create(request) -> GooglePayMerchant

πŸ”Œ Usage

client.googlePay().merchant().create(
    GooglePayMerchantRegisterRequest
        .builder()
        .build()
);

βš™οΈ Parameters

merchantIdentifier: Optional<String>

GooglePay Merchant Certificates

client.googlePay.merchant.certificates.get(merchantId, id) -> GooglePayMerchantCertificates

πŸ”Œ Usage

client.googlePay().merchant().certificates().get("merchantId", "id");

βš™οΈ Parameters

merchantId: String

id: String

client.googlePay.merchant.certificates.delete(merchantId, id)

πŸ”Œ Usage

client.googlePay().merchant().certificates().delete("merchantId", "id");

βš™οΈ Parameters

merchantId: String

id: String

client.googlePay.merchant.certificates.create(merchantId, request) -> GooglePayMerchantCertificates

πŸ”Œ Usage

client.googlePay().merchant().certificates().create(
    "merchantId",
    GooglePayMerchantCertificatesRegisterRequest
        .builder()
        .build()
);

βš™οΈ Parameters

merchantId: String

merchantCertificateData: Optional<String>

merchantCertificatePassword: Optional<String>

Reactors Results

client.reactors.results.get(id, requestId) -> Object

πŸ”Œ Usage

client.reactors().results().get("id", "requestId");

βš™οΈ Parameters

id: String

requestId: String

Tenants SecurityContact

client.tenants.securityContact.get() -> SecurityContactEmailResponse

πŸ”Œ Usage

client.tenants().securityContact().get();
client.tenants.securityContact.update(request) -> SecurityContactEmailResponse

πŸ”Œ Usage

client.tenants().securityContact().update(
    SecurityContactEmailRequest
        .builder()
        .email("email")
        .build()
);

βš™οΈ Parameters

email: String

Tenants Connections

client.tenants.connections.create(request) -> CreateTenantConnectionResponse

πŸ”Œ Usage

client.tenants().connections().create(
    CreateTenantConnectionRequest
        .builder()
        .strategy("strategy")
        .options(
            TenantConnectionOptions
                .builder()
                .build()
        )
        .build()
);

βš™οΈ Parameters

strategy: String

options: TenantConnectionOptions

client.tenants.connections.delete() -> CreateTenantConnectionResponse

πŸ”Œ Usage

client.tenants().connections().delete();

Tenants Invitations

client.tenants.invitations.list() -> TenantInvitationResponsePaginatedList

πŸ”Œ Usage

client.tenants().invitations().list(
    InvitationsListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

status: Optional<TenantInvitationStatus>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.tenants.invitations.create(request) -> TenantInvitationResponse

πŸ”Œ Usage

client.tenants().invitations().create(
    CreateTenantInvitationRequest
        .builder()
        .email("email")
        .build()
);

βš™οΈ Parameters

email: String

role: Optional<String>

client.tenants.invitations.resend(invitationId) -> TenantInvitationResponse

πŸ”Œ Usage

client.tenants().invitations().resend("invitationId");

βš™οΈ Parameters

invitationId: String

client.tenants.invitations.get(invitationId) -> TenantInvitationResponse

πŸ”Œ Usage

client.tenants().invitations().get("invitationId");

βš™οΈ Parameters

invitationId: String

client.tenants.invitations.delete(invitationId)

πŸ”Œ Usage

client.tenants().invitations().delete("invitationId");

βš™οΈ Parameters

invitationId: String

Tenants Members

client.tenants.members.list() -> TenantMemberResponsePaginatedList

πŸ”Œ Usage

client.tenants().members().list(
    MembersListRequest
        .builder()
        .build()
);

βš™οΈ Parameters

userId: Optional<String>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.tenants.members.update(memberId, request) -> TenantMemberResponse

πŸ”Œ Usage

client.tenants().members().update(
    "memberId",
    UpdateTenantMemberRequest
        .builder()
        .role("role")
        .build()
);

βš™οΈ Parameters

memberId: String

role: String

client.tenants.members.delete(memberId)

πŸ”Œ Usage

client.tenants().members().delete("memberId");

βš™οΈ Parameters

memberId: String

Tenants Owner

client.tenants.owner.get() -> TenantMemberResponse

πŸ”Œ Usage

client.tenants().owner().get();

Tenants Self

client.tenants.self.getUsageReports() -> TenantUsageReport

πŸ”Œ Usage

client.tenants().self().getUsageReports();
client.tenants.self.get() -> Tenant

πŸ”Œ Usage

client.tenants().self().get();
client.tenants.self.update(request) -> Tenant

πŸ”Œ Usage

client.tenants().self().update(
    UpdateTenantRequest
        .builder()
        .name("name")
        .build()
);

βš™οΈ Parameters

name: String

settings: Optional<Map<String, Optional<String>>>

client.tenants.self.delete()

πŸ”Œ Usage

client.tenants().self().delete();

Threeds Sessions

client.threeds.sessions.create(request) -> CreateThreeDsSessionResponse

πŸ”Œ Usage

client.threeds().sessions().create(
    CreateThreeDsSessionRequest
        .builder()
        .build()
);

βš™οΈ Parameters

pan: Optional<String>

tokenId: Optional<String>

tokenIntentId: Optional<String>

type: Optional<String>

device: Optional<String>

webChallengeMode: Optional<String>

deviceInfo: Optional<ThreeDsDeviceInfo>

authenticationRequest: Optional<AuthenticateThreeDsSessionRequest>

callbackUrls: Optional<ThreeDsCallbackUrls>

metadata: Optional<Map<String, Optional<String>>>

client.threeds.sessions.authenticate(sessionId, request) -> ThreeDsAuthentication

πŸ”Œ Usage

client.threeds().sessions().authenticate(
    "sessionId",
    AuthenticateThreeDsSessionRequest
        .builder()
        .authenticationCategory("authentication_category")
        .authenticationType("authentication_type")
        .build()
);

βš™οΈ Parameters

sessionId: String

request: AuthenticateThreeDsSessionRequest

client.threeds.sessions.getChallengeResult(sessionId) -> ThreeDsAuthentication

πŸ”Œ Usage

client.threeds().sessions().getChallengeResult("sessionId");

βš™οΈ Parameters

sessionId: String

client.threeds.sessions.get(id) -> ThreeDsSession

πŸ”Œ Usage

client.threeds().sessions().get("id");

βš™οΈ Parameters

id: String

Webhooks Events

client.webhooks.events.list() -> List&lt;String&gt;

πŸ“ Description

Return a list of available event types

πŸ”Œ Usage

client.webhooks().events().list();