Class MembershipsApi

MembershipsApi - object-oriented interface

Export

MembershipsApi

Hierarchy

BaseAPI
- MembershipsApi

Index

Constructors

Properties

axios basePath configuration

Methods

membershipsDestroy membershipsList membershipsPartialUpdate membershipsRetrieve

Constructors

constructor

new MembershipsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): MembershipsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns MembershipsApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

membershipsDestroy

membershipsDestroy(
requestParameters: MembershipsApiMembershipsDestroyRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: MembershipsApiMembershipsDestroyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
MembershipsApi
- Defined in api-client/memberships-api.ts:546

membershipsList

membershipsList(
requestParameters?: MembershipsApiMembershipsListRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PaginatedMembershipReadList, any>>
Parameters
- requestParameters: MembershipsApiMembershipsListRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaginatedMembershipReadList, any>>
Throws
Memberof
MembershipsApi
- Defined in api-client/memberships-api.ts:558

membershipsPartialUpdate

membershipsPartialUpdate(
requestParameters: MembershipsApiMembershipsPartialUpdateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MembershipRead, any>>
Parameters
- requestParameters: MembershipsApiMembershipsPartialUpdateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MembershipRead, any>>
Throws
Memberof
MembershipsApi
- Defined in api-client/memberships-api.ts:570

membershipsRetrieve

membershipsRetrieve(
requestParameters: MembershipsApiMembershipsRetrieveRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MembershipRead, any>>
Parameters
- requestParameters: MembershipsApiMembershipsRetrieveRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MembershipRead, any>>
Throws
Memberof
MembershipsApi
- Defined in api-client/memberships-api.ts:582