Function InvitationsApiFp

Returns {
    invitationsAccept(key, acceptInvitationWriteRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<AcceptInvitationRead>)>;
    invitationsCreate(invitationWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<((axios?, basePath?) => AxiosPromise<InvitationRead>)>;
    invitationsDestroy(key, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    invitationsList(xOrganization?, filter?, org?, orgId?, owner?, page?, pageSize?, search?, sort?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedInvitationReadList>)>;
    invitationsPartialUpdate(key, patchedInvitationWriteRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<InvitationRead>)>;
    invitationsResend(key, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    invitationsRetrieve(key, options?) => Promise<((axios?, basePath?) => AxiosPromise<InvitationRead>)>;
}

• invitationsAccept:function

  • invitationsAccept(key, acceptInvitationWriteRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<AcceptInvitationRead>)>

  • Parameters

    • key: string

      A unique value identifying this invitation.

    • acceptInvitationWriteRequest: AcceptInvitationWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<AcceptInvitationRead>)>

    Summary

    Method registers user and accepts invitation to organization

    Throws

• invitationsCreate:function

  • invitationsCreate(invitationWriteRequest, xOrganization?, org?, orgId?, options?): Promise<((axios?, basePath?) => AxiosPromise<InvitationRead>)>

  • 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<((axios?, basePath?) => AxiosPromise<InvitationRead>)>

    Summary

    Method creates an invitation

    Throws

• invitationsDestroy:function

  • invitationsDestroy(key, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • key: string

      A unique value identifying this invitation.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Method deletes an invitation

    Throws

• invitationsList:function

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

  • 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<((axios?, basePath?) => AxiosPromise<PaginatedInvitationReadList>)>

    Summary

    Method returns a paginated list of invitations

    Throws

• invitationsPartialUpdate:function

  • invitationsPartialUpdate(key, patchedInvitationWriteRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<InvitationRead>)>

  • Parameters

    • key: string

      A unique value identifying this invitation.

    • Optional patchedInvitationWriteRequest: PatchedInvitationWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<InvitationRead>)>

    Summary

    Methods does a partial update of chosen fields in an invitation

    Throws

• invitationsResend:function

  • invitationsResend(key, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • key: string

      A unique value identifying this invitation.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Method resends the invitation

    Throws

• invitationsRetrieve:function

  • invitationsRetrieve(key, options?): Promise<((axios?, basePath?) => AxiosPromise<InvitationRead>)>

  • Parameters

    • key: string

      A unique value identifying this invitation.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<InvitationRead>)>

    Summary

    Method returns details of an invitation

    Throws