Function TenantsApiAxiosParamCreator

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

• apiTenantsAccessGet: ((resourcePath?: string, vector?: string, readCache?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  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

  Throws

  • • (resourcePath?, vector?, readCache?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalresourcePath: string
      • Optionalvector: string
      • OptionalreadCache: boolean
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsAccountAccessGet: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsGet: ((isLightVersion?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve information about the current user/tenant

  Throws

  • • (isLightVersion?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalisLightVersion: boolean
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsPost: ((tenantCreateDeets?: TenantCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Create and on-board a tenant account

  Throws

  • • (tenantCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltenantCreateDeets: TenantCreateDeets

        Details about the tenant account
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsPut: ((tenantCreateDeets?: TenantCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  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.

  Throws

  • • (tenantCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltenantCreateDeets: TenantCreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsRemoveOnboardingDelete: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary It uses to remove details from stripe

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsResourcesGet: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Returns a list of securable resources

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsTaskListGet: ((taskListType?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve information about the onbaording tasks

  Throws

  • • (taskListType?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltaskListType: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsTaskPut: ((taskUpdateStatusDeets?: TaskUpdateStatusDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary It will update the task status

  Throws

  • • (taskUpdateStatusDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltaskUpdateStatusDeets: TaskUpdateStatusDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsTaskTaskIdGet: ((taskId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve information about the onbaording task

  Throws

  • • (taskId, options?): Promise<RequestArgs>

    • Parameters

      • taskId: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsVerificationFileUploadPut: ((frontFile?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (frontFile?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalfrontFile: File
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• apiTenantsVerificationPut: ((tenantUpdateVerificationDeets?: TenantUpdateVerificationDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Throws

  • • (tenantUpdateVerificationDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltenantUpdateVerificationDeets: TenantUpdateVerificationDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getOnboardingSessionApiKey: ((country?: string, enableExternalAccountCollection?: boolean, businessType?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Gets an onboarding session key from stripe

  Throws

  • • (country?, enableExternalAccountCollection?, businessType?, options?): Promise<RequestArgs>

    • 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<RequestArgs>