Function MembershipsApiFactory

Returns {
    membershipsDestroy(requestParameters, options?) => AxiosPromise<void>;
    membershipsList(requestParameters?, options?) => AxiosPromise<PaginatedMembershipReadList>;
    membershipsPartialUpdate(requestParameters, options?) => AxiosPromise<MembershipRead>;
    membershipsRetrieve(requestParameters, options?) => AxiosPromise<MembershipRead>;
}

• membershipsDestroy:function

  • membershipsDestroy(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: MembershipsApiMembershipsDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes a membership

    Throws

• membershipsList:function

  • membershipsList(requestParameters?, options?): AxiosPromise<PaginatedMembershipReadList>

  • Parameters

    • requestParameters: MembershipsApiMembershipsListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedMembershipReadList>

    Summary

    Method returns a paginated list of memberships

    Throws

• membershipsPartialUpdate:function

  • membershipsPartialUpdate(requestParameters, options?): AxiosPromise<MembershipRead>

  • Parameters

    • requestParameters: MembershipsApiMembershipsPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MembershipRead>

    Summary

    Methods does a partial update of chosen fields in a membership

    Throws

• membershipsRetrieve:function

  • membershipsRetrieve(requestParameters, options?): AxiosPromise<MembershipRead>

  • Parameters

    • requestParameters: MembershipsApiMembershipsRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MembershipRead>

    Summary

    Method returns details of a membership

    Throws