Class AccountApi

Hierarchy

BaseAPI
- AccountApi

Index

Constructors

Properties

Methods

cancelPurchaseNew cancelPurchaseNewRaw consumePurchase consumePurchaseRaw getPlanPurchases getPlanPurchasesRaw getPurchases getPurchasesRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new AccountApi(configuration?: Configuration): AccountApi
Parameters
- configuration: Configuration = DefaultConfig
Returns AccountApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

cancelPurchaseNew

cancelPurchaseNew(requestParameters: CancelPurchaseNewRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Cancel recurring subscription for the account by account ID and purchase ID.
Parameters
- requestParameters: CancelPurchaseNewRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/AccountApi.ts:100

cancelPurchaseNewRaw

cancelPurchaseNewRaw(requestParameters: CancelPurchaseNewRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Cancel recurring subscription for the account by account ID and purchase ID.
Parameters
- requestParameters: CancelPurchaseNewRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/AccountApi.ts:62

consumePurchase

consumePurchase(requestParameters: ConsumePurchaseRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTPurchaseInfo>
Mark purchase consumed by the user by purchase ID.
Parameters
- requestParameters: ConsumePurchaseRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTPurchaseInfo>
- Defined in apis/AccountApi.ts:141

consumePurchaseRaw

consumePurchaseRaw(requestParameters: ConsumePurchaseRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTPurchaseInfo>>
Mark purchase consumed by the user by purchase ID.
Parameters
- requestParameters: ConsumePurchaseRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTPurchaseInfo>>
- Defined in apis/AccountApi.ts:108

getPlanPurchases

getPlanPurchases(requestParameters: GetPlanPurchasesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTPurchaseInfo>
Parameters
- requestParameters: GetPlanPurchasesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTPurchaseInfo>
- Defined in apis/AccountApi.ts:180

getPlanPurchasesRaw

getPlanPurchasesRaw(requestParameters: GetPlanPurchasesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTPurchaseInfo>>
Parameters
- requestParameters: GetPlanPurchasesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTPurchaseInfo>>
- Defined in apis/AccountApi.ts:148

getPurchases

getPurchases(requestParameters?: GetPurchasesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTPurchaseInfo[]>
Retrieve an array of the user’s App Store purchases.
Parameters
- requestParameters: GetPurchasesRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTPurchaseInfo[]>
- Defined in apis/AccountApi.ts:221

getPurchasesRaw

getPurchasesRaw(requestParameters: GetPurchasesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTPurchaseInfo[]>>
Retrieve an array of the user’s App Store purchases.
Parameters
- requestParameters: GetPurchasesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTPurchaseInfo[]>>
- Defined in apis/AccountApi.ts:188

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Generated using TypeDoc