AppsAppMembershipsApi | IBM Aspera on Cloud SDK JS

AppsAppMembershipsApi - object-oriented interface

export

Hierarchy

BaseAPI
- AppsAppMembershipsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AppsAppMembershipsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): AppsAppMembershipsApi

Inherited from BaseAPI.constructor
- Defined in api/base.ts:50
Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns AppsAppMembershipsApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

addAppMembership

addAppMembership(requestParameters: AppsAppMembershipsApiAddAppMembershipRequest, options?: any): Promise<AxiosResponse<AppMembershipsResponse>>

- Defined in api/api.ts:4738
Create an app membership. Requires organization admin permission.

summary

add_app_membership

throws

{RequiredError}

memberof

AppsAppMembershipsApi

Parameters
- requestParameters: AppsAppMembershipsApiAddAppMembershipRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<AppMembershipsResponse>>

deleteAppMembership

deleteAppMembership(requestParameters: AppsAppMembershipsApiDeleteAppMembershipRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:4750
Delete an app membership, specified by membership ID. Requires organization admin permission.

summary

delete_app_membership

throws

{RequiredError}

memberof

AppsAppMembershipsApi

Parameters
- requestParameters: AppsAppMembershipsApiDeleteAppMembershipRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>

getAppMembershipById

getAppMembershipById(requestParameters: AppsAppMembershipsApiGetAppMembershipByIdRequest, options?: any): Promise<AxiosResponse<AppMembershipsResponse>>

- Defined in api/api.ts:4762
Get information about a specific app membership, specified by membership ID.

summary

get_app_membership_by_id

throws

{RequiredError}

memberof

AppsAppMembershipsApi

Parameters
- requestParameters: AppsAppMembershipsApiGetAppMembershipByIdRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<AppMembershipsResponse>>

getAppMemberships

getAppMemberships(requestParameters?: AppsAppMembershipsApiGetAppMembershipsRequest, options?: any): Promise<AxiosResponse<AppMembershipsResponse[]>>

- Defined in api/api.ts:4774
Get a listing of app memberships. For organization admins, all app memberships for the entire organization are available to view. For all other users, your own app memberships are available.

summary

get_app_memberships

throws

{RequiredError}

memberof

AppsAppMembershipsApi

Parameters
- requestParameters: AppsAppMembershipsApiGetAppMembershipsRequest = {}
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<AppMembershipsResponse[]>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = ...

axios: AxiosInstance = ...

Returns AppsAppMembershipsApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

addAppMembership

Parameters

requestParameters: AppsAppMembershipsApiAddAppMembershipRequest

Optional options: any

Returns Promise<AxiosResponse<AppMembershipsResponse>>

deleteAppMembership

Parameters

requestParameters: AppsAppMembershipsApiDeleteAppMembershipRequest

Optional options: any

Returns Promise<AxiosResponse<void>>

getAppMembershipById

Parameters

requestParameters: AppsAppMembershipsApiGetAppMembershipByIdRequest

Optional options: any

Returns Promise<AxiosResponse<AppMembershipsResponse>>

getAppMemberships

Parameters

requestParameters: AppsAppMembershipsApiGetAppMembershipsRequest = {}

Optional options: any

Returns Promise<AxiosResponse<AppMembershipsResponse[]>>