Class TenantsApi

TenantsApi - object-oriented interface export TenantsApi

Hierarchy (view full)

BaseAPI
- TenantsApi

Index

Constructors

constructor

new TenantsApi(configuration?, basePath?, axios?): TenantsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns TenantsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiTenantsAccessGet

apiTenantsAccessGet(resourcePath?, vector?, readCache?, options?): Promise<AxiosResponse<AccessControlRule, any>>
summary Returns permission details such as CanCreate, CanView, etc for the specified resource to assist the UI. For a list of resources available on this account call GetListResources
Parameters
- OptionalresourcePath: string
- Optionalvector: string
- OptionalreadCache: boolean
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AccessControlRule, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27347

apiTenantsAccountAccessGet

apiTenantsAccountAccessGet(options?): Promise<AxiosResponse<void, any>>
summary Returns the list of all access rules for the current user on the current account
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27358

apiTenantsGet

apiTenantsGet(isLightVersion?, options?): Promise<AxiosResponse<Tenant, any>>
summary Retrieve information about the current user/tenant
Parameters
- OptionalisLightVersion: boolean
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Tenant, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27370

apiTenantsPost

apiTenantsPost(tenantCreateDeets?, options?): Promise<AxiosResponse<Tenant, any>>
summary Create and on-board a tenant account
Parameters
- OptionaltenantCreateDeets: TenantCreateDeets
  Details about the tenant account
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Tenant, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27382

apiTenantsPut

apiTenantsPut(tenantCreateDeets?, options?): Promise<AxiosResponse<Tenant, any>>
summary This is a special use case for onboarding a tenant where the external wallets already exist. Calling this will pull data instead of creating new external accounts where possible.
Parameters
- OptionaltenantCreateDeets: TenantCreateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Tenant, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27394

apiTenantsRemoveOnboardingDelete

apiTenantsRemoveOnboardingDelete(options?): Promise<AxiosResponse<Tenant, any>>
summary It uses to remove details from stripe
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Tenant, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27405

apiTenantsResourcesGet

apiTenantsResourcesGet(options?): Promise<AxiosResponse<void, any>>
summary Returns a list of securable resources
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27416

apiTenantsTaskListGet

apiTenantsTaskListGet(taskListType?, options?): Promise<AxiosResponse<TaskList, any>>
summary Retrieve information about the onbaording tasks
Parameters
- OptionaltaskListType: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TaskList, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27428

apiTenantsTaskPut

apiTenantsTaskPut(taskUpdateStatusDeets?, options?): Promise<AxiosResponse<OnBoardingTask, any>>
summary It will update the task status
Parameters
- OptionaltaskUpdateStatusDeets: TaskUpdateStatusDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<OnBoardingTask, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27440

apiTenantsTaskTaskIdGet

apiTenantsTaskTaskIdGet(taskId, options?): Promise<AxiosResponse<OnBoardingTask, any>>
summary Retrieve information about the onbaording task
Parameters
- taskId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<OnBoardingTask, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27452

apiTenantsVerificationFileUploadPut

apiTenantsVerificationFileUploadPut(frontFile?, options?): Promise<AxiosResponse<any, any>>
summary It uses to update documents needed for stripe, Proof of concept.
Parameters
- OptionalfrontFile: File
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<any, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27464

apiTenantsVerificationPut

apiTenantsVerificationPut(tenantUpdateVerificationDeets?, options?): Promise<AxiosResponse<Tenant, any>>
Parameters
- OptionaltenantUpdateVerificationDeets: TenantUpdateVerificationDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Tenant, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27475

getOnboardingSessionApiKey

getOnboardingSessionApiKey(country?, enableExternalAccountCollection?, businessType?, options?): Promise<AxiosResponse<AccountSession, any>>
summary Gets an onboarding session key from stripe
Parameters
- Optionalcountry: string
  A two letter country code that will be passed to Stripe for account onboarding. Ex: US
- OptionalenableExternalAccountCollection: boolean
  Whether to allow platforms to control bank account collection for their connected<br />accounts. This feature can only be false for custom accounts (or accounts where the<br />platform is compliance owner). Otherwise, bank account collection is determined by<br />compliance requirements.
- OptionalbusinessType: string
  One of: `company`, `government_entity`, `individual`, or `non_profit`.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AccountSession, any>>
Throws
memberof TenantsApi
- Defined in src/api/api.ts:27489

Class TenantsApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TenantsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

apiTenantsAccessGet

Parameters

Returns Promise<AxiosResponse<AccessControlRule, any>>

Throws

apiTenantsAccountAccessGet

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

apiTenantsGet

Parameters

Returns Promise<AxiosResponse<Tenant, any>>

Throws

apiTenantsPost

Parameters

Returns Promise<AxiosResponse<Tenant, any>>

Throws

apiTenantsPut

Parameters

Returns Promise<AxiosResponse<Tenant, any>>

Throws

apiTenantsRemoveOnboardingDelete

Parameters

Returns Promise<AxiosResponse<Tenant, any>>

Throws

apiTenantsResourcesGet

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

apiTenantsTaskListGet

Parameters

Returns Promise<AxiosResponse<TaskList, any>>

Throws

apiTenantsTaskPut

Parameters

Returns Promise<AxiosResponse<OnBoardingTask, any>>

Throws

apiTenantsTaskTaskIdGet

Parameters

Returns Promise<AxiosResponse<OnBoardingTask, any>>

Throws

apiTenantsVerificationFileUploadPut

Parameters

Returns Promise<AxiosResponse<any, any>>

Throws

apiTenantsVerificationPut

Parameters

Returns Promise<AxiosResponse<Tenant, any>>

Throws

getOnboardingSessionApiKey

Parameters

Returns Promise<AxiosResponse<AccountSession, any>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration