Function InvitationsApiAxiosParamCreator

Returns {
    invitationsAccept: ((key, acceptInvitationWriteRequest, options?) => Promise<RequestArgs>);
    invitationsCreate: ((invitationWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>);
    invitationsDestroy: ((key, options?) => Promise<RequestArgs>);
    invitationsList: ((xOrganization?, filter?, org?, orgId?, owner?, page?, pageSize?, search?, sort?, options?) => Promise<RequestArgs>);
    invitationsPartialUpdate: ((key, patchedInvitationWriteRequest?, options?) => Promise<RequestArgs>);
    invitationsResend: ((key, options?) => Promise<RequestArgs>);
    invitationsRetrieve: ((key, options?) => Promise<RequestArgs>);
}

• invitationsAccept: ((key, acceptInvitationWriteRequest, options?) => Promise<RequestArgs>)

  • • (key, acceptInvitationWriteRequest, options?): Promise<RequestArgs>

    • Parameters

      • key: string

        A unique value identifying this invitation.

      • acceptInvitationWriteRequest: AcceptInvitationWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method registers user and accepts invitation to organization

      Throws

• invitationsCreate: ((invitationWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>)

  • • (invitationWriteRequest, xOrganization?, org?, orgId?, options?): Promise<RequestArgs>

    • Parameters

      • invitationWriteRequest: InvitationWriteRequest

      • Optional xOrganization: string

        Organization unique slug

      • Optional org: string

        Organization unique slug

      • Optional orgId: number

        Organization identifier

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method creates an invitation

      Throws

• invitationsDestroy: ((key, options?) => Promise<RequestArgs>)

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

    • Parameters

      • key: string

        A unique value identifying this invitation.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method deletes an invitation

      Throws

• invitationsList: ((xOrganization?, filter?, org?, orgId?, owner?, page?, pageSize?, search?, sort?, options?) => Promise<RequestArgs>)

  • • (xOrganization?, filter?, org?, orgId?, owner?, page?, pageSize?, search?, sort?, options?): Promise<RequestArgs>

    • Parameters

      • Optional xOrganization: string

        Organization unique slug

      • Optional filter: string

        JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;owner&#39;].

      • Optional org: string

        Organization unique slug

      • Optional orgId: number

        Organization identifier

      • Optional owner: string

        A simple equality filter for the owner field

      • Optional page: number

        A page number within the paginated result set.

      • Optional pageSize: number

        Number of results to return per page.

      • Optional search: string

        A search term. Available search_fields: (&#39;owner&#39;,)

      • Optional sort: string

        Which field to use when ordering the results. Available ordering_fields: [&#39;owner&#39;, &#39;created_date&#39;]

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns a paginated list of invitations

      Throws

• invitationsPartialUpdate: ((key, patchedInvitationWriteRequest?, options?) => Promise<RequestArgs>)

  • • (key, patchedInvitationWriteRequest?, options?): Promise<RequestArgs>

    • Parameters

      • key: string

        A unique value identifying this invitation.

      • Optional patchedInvitationWriteRequest: PatchedInvitationWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Methods does a partial update of chosen fields in an invitation

      Throws

• invitationsResend: ((key, options?) => Promise<RequestArgs>)

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

    • Parameters

      • key: string

        A unique value identifying this invitation.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method resends the invitation

      Throws

• invitationsRetrieve: ((key, options?) => Promise<RequestArgs>)

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

    • Parameters

      • key: string

        A unique value identifying this invitation.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns details of an invitation

      Throws