Function TenantsApiFactory

Returns {
    apiTenantsAccessGet(resourcePath?: string, vector?: string, readCache?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AccessControlRule>;
    apiTenantsAccountAccessGet(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    apiTenantsGet(isLightVersion?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Tenant>;
    apiTenantsPost(tenantCreateDeets?: TenantCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<Tenant>;
    apiTenantsPut(tenantCreateDeets?: TenantCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<Tenant>;
    apiTenantsRemoveOnboardingDelete(options?: RawAxiosRequestConfig): AxiosPromise<Tenant>;
    apiTenantsResourcesGet(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    apiTenantsTaskListGet(taskListType?: string, options?: RawAxiosRequestConfig): AxiosPromise<TaskList>;
    apiTenantsTaskPut(taskUpdateStatusDeets?: TaskUpdateStatusDeets, options?: RawAxiosRequestConfig): AxiosPromise<OnBoardingTask>;
    apiTenantsTaskTaskIdGet(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<OnBoardingTask>;
    apiTenantsVerificationFileUploadPut(frontFile?: File, options?: RawAxiosRequestConfig): AxiosPromise<any>;
    apiTenantsVerificationPut(tenantUpdateVerificationDeets?: TenantUpdateVerificationDeets, options?: RawAxiosRequestConfig): AxiosPromise<Tenant>;
    getOnboardingSessionApiKey(country?: string, enableExternalAccountCollection?: boolean, businessType?: string, options?: RawAxiosRequestConfig): AxiosPromise<AccountSession>;
}

• apiTenantsAccessGet:function

  • apiTenantsAccessGet(resourcePath?, vector?, readCache?, options?): AxiosPromise<AccessControlRule>

  • 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 AxiosPromise<AccessControlRule>

    Throws

• apiTenantsAccountAccessGet:function

  • apiTenantsAccountAccessGet(options?): AxiosPromise<void>

  • summary Returns the list of all access rules for the current user on the current account

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• apiTenantsGet:function

  • apiTenantsGet(isLightVersion?, options?): AxiosPromise<Tenant>

  • summary Retrieve information about the current user/tenant

    Parameters

    • OptionalisLightVersion: boolean
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Tenant>

    Throws

• apiTenantsPost:function

  • apiTenantsPost(tenantCreateDeets?, options?): AxiosPromise<Tenant>

  • summary Create and on-board a tenant account

    Parameters

    • OptionaltenantCreateDeets: TenantCreateDeets

      Details about the tenant account
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Tenant>

    Throws

• apiTenantsPut:function

  • apiTenantsPut(tenantCreateDeets?, options?): AxiosPromise<Tenant>

  • 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 AxiosPromise<Tenant>

    Throws

• apiTenantsRemoveOnboardingDelete:function

  • apiTenantsRemoveOnboardingDelete(options?): AxiosPromise<Tenant>

  • summary It uses to remove details from stripe

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Tenant>

    Throws

• apiTenantsResourcesGet:function

  • apiTenantsResourcesGet(options?): AxiosPromise<void>

  • summary Returns a list of securable resources

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• apiTenantsTaskListGet:function

  • apiTenantsTaskListGet(taskListType?, options?): AxiosPromise<TaskList>

  • summary Retrieve information about the onbaording tasks

    Parameters

    • OptionaltaskListType: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskList>

    Throws

• apiTenantsTaskPut:function

  • apiTenantsTaskPut(taskUpdateStatusDeets?, options?): AxiosPromise<OnBoardingTask>

  • summary It will update the task status

    Parameters

    • OptionaltaskUpdateStatusDeets: TaskUpdateStatusDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<OnBoardingTask>

    Throws

• apiTenantsTaskTaskIdGet:function

  • apiTenantsTaskTaskIdGet(taskId, options?): AxiosPromise<OnBoardingTask>

  • summary Retrieve information about the onbaording task

    Parameters

    • taskId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<OnBoardingTask>

    Throws

• apiTenantsVerificationFileUploadPut:function

  • apiTenantsVerificationFileUploadPut(frontFile?, options?): AxiosPromise<any>

  • summary It uses to update documents needed for stripe, Proof of concept.

    Parameters

    • OptionalfrontFile: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<any>

    Throws

• apiTenantsVerificationPut:function

  • apiTenantsVerificationPut(tenantUpdateVerificationDeets?, options?): AxiosPromise<Tenant>

  • Parameters

    • OptionaltenantUpdateVerificationDeets: TenantUpdateVerificationDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Tenant>

    Throws

• getOnboardingSessionApiKey:function

  • getOnboardingSessionApiKey(country?, enableExternalAccountCollection?, businessType?, options?): AxiosPromise<AccountSession>

  • 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 AxiosPromise<AccountSession>

    Throws