Function InvitationsApiFp

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

• invitationsAccept:function

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

    Parameters

    • key: string

      A unique value identifying this invitation.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• invitationsCreate:function

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

    Parameters

    • invitationWriteRequest: InvitationWriteRequest
    • OptionalxOrganization: string

      Organization unique slug
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• invitationsDecline:function

  • invitationsDecline(
        key: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • key: string

      A unique value identifying this invitation.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• invitationsDestroy:function

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

    Parameters

    • key: string

      A unique value identifying this invitation.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• invitationsList:function

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

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • Optionalfilter: 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;, &#39;user_id&#39;, &#39;accepted&#39;].
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionalowner: string

      A simple equality filter for the owner field
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • Optionalsearch: string

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

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

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedInvitationReadList>,
    >

    Throws

• invitationsPartialUpdate:function

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

    Parameters

    • key: string

      A unique value identifying this invitation.
    • OptionalpatchedInvitationWriteRequest: PatchedInvitationWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• invitationsResend:function

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

    Parameters

    • key: string

      A unique value identifying this invitation.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• invitationsRetrieve:function

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

    Parameters

    • key: string

      A unique value identifying this invitation.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws