Class MembershipsApi

MembershipsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- MembershipsApi

Index

Constructors

constructor

new MembershipsApi(configuration?, basePath?, axios?): MembershipsApi
Parameters
- Optional configuration: 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, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: MembershipsApiMembershipsDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes a membership

Throws

Memberof
MembershipsApi
- Defined in api-client/memberships-api.ts:539

membershipsList

membershipsList(requestParameters?, options?): Promise<AxiosResponse<PaginatedMembershipReadList, any>>
Parameters
- requestParameters: MembershipsApiMembershipsListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedMembershipReadList, any>>

Summary
Method returns a paginated list of memberships

Throws

Memberof
MembershipsApi
- Defined in api-client/memberships-api.ts:551

membershipsPartialUpdate

membershipsPartialUpdate(requestParameters, options?): Promise<AxiosResponse<MembershipRead, any>>
Parameters
- requestParameters: MembershipsApiMembershipsPartialUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<MembershipRead, any>>

Summary
Methods does a partial update of chosen fields in a membership

Throws

Memberof
MembershipsApi
- Defined in api-client/memberships-api.ts:563

membershipsRetrieve

membershipsRetrieve(requestParameters, options?): Promise<AxiosResponse<MembershipRead, any>>
Parameters
- requestParameters: MembershipsApiMembershipsRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<MembershipRead, any>>

Summary
Method returns details of a membership

Throws

Memberof
MembershipsApi
- Defined in api-client/memberships-api.ts:575

Class MembershipsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns MembershipsApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

membershipsDestroy

Parameters

requestParameters: MembershipsApiMembershipsDestroyRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

membershipsList

Parameters

requestParameters: MembershipsApiMembershipsListRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedMembershipReadList, any>>

Summary

Throws

Memberof

membershipsPartialUpdate

Parameters

requestParameters: MembershipsApiMembershipsPartialUpdateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<MembershipRead, any>>

Summary

Throws

Memberof

membershipsRetrieve

Parameters

requestParameters: MembershipsApiMembershipsRetrieveRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<MembershipRead, any>>

Summary

Throws

Memberof

Settings

Member Visibility

Theme

On This Page

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>