Function MembershipsApiAxiosParamCreator

Returns {
    membershipsDestroy: ((id, options?) => Promise<RequestArgs>);
    membershipsList: ((xOrganization?, filter?, org?, orgId?, page?, pageSize?, role?, search?, sort?, user?, options?) => Promise<RequestArgs>);
    membershipsPartialUpdate: ((id, patchedMembershipWriteRequest?, options?) => Promise<RequestArgs>);
    membershipsRetrieve: ((id, options?) => Promise<RequestArgs>);
}

• membershipsDestroy: ((id, options?) => Promise<RequestArgs>)

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

    • Parameters

      • id: number

        A unique integer value identifying this membership.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method deletes a membership

      Throws

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

  • • (xOrganization?, filter?, org?, orgId?, page?, pageSize?, role?, search?, sort?, user?, 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;user&#39;, &#39;role&#39;, &#39;id&#39;].

      • Optional org: string

        Organization unique slug

      • Optional orgId: number

        Organization identifier

      • Optional page: number

        A page number within the paginated result set.

      • Optional pageSize: number

        Number of results to return per page.

      • Optional role: MembershipsListRoleEnum

        A simple equality filter for the role field

      • Optional search: string

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

      • Optional sort: string

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

      • Optional user: string

        A simple equality filter for the user field

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns a paginated list of memberships

      Throws

• membershipsPartialUpdate: ((id, patchedMembershipWriteRequest?, options?) => Promise<RequestArgs>)

  • • (id, patchedMembershipWriteRequest?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this membership.

      • Optional patchedMembershipWriteRequest: PatchedMembershipWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Methods does a partial update of chosen fields in a membership

      Throws

• membershipsRetrieve: ((id, options?) => Promise<RequestArgs>)

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

    • Parameters

      • id: number

        A unique integer value identifying this membership.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns details of a membership

      Throws