Function MembershipsApiFp

Returns {
    membershipsDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    membershipsList(
        xOrganization?: string,
        filter?: string,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        role?: MembershipsListRoleEnum,
        search?: string,
        sort?: string,
        user?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedMembershipReadList>,
    >;
    membershipsPartialUpdate(
        id: number,
        patchedMembershipWriteRequest?: PatchedMembershipWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MembershipRead>,
    >;
    membershipsRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MembershipRead>,
    >;
}

• membershipsDestroy:function

  • membershipsDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • id: number

      A unique integer value identifying this membership.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• membershipsList:function

  • membershipsList(
        xOrganization?: string,
        filter?: string,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        role?: MembershipsListRoleEnum,
        search?: string,
        sort?: string,
        user?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedMembershipReadList>,
    >

    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;user&#39;, &#39;role&#39;, &#39;id&#39;].
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionalpage: number

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

      Number of results to return per page.
    • Optionalrole: MembershipsListRoleEnum

      A simple equality filter for the role field
    • Optionalsearch: string

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

      Which field to use when ordering the results. Available ordering_fields: [&#39;user&#39;, &#39;role&#39;, &#39;id&#39;]
    • Optionaluser: string

      A simple equality filter for the user field
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• membershipsPartialUpdate:function

  • membershipsPartialUpdate(
        id: number,
        patchedMembershipWriteRequest?: PatchedMembershipWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MembershipRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this membership.
    • OptionalpatchedMembershipWriteRequest: PatchedMembershipWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• membershipsRetrieve:function

  • membershipsRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MembershipRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this membership.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws