Class SubscriptionIntegrations

Hierarchy

SubscriptionIntegrations

Index

Properties

Methods

As Delete Get Patch Save

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): SubscriptionIntegrations
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
SubscriptionIntegrations.As().List() // lists SubscriptionIntegrations using the impersonated users' token
```
Returns SubscriptionIntegrations
- Defined in api/SubscriptionIntegrations.ts:111

Delete

Delete(requestOptions?: RequestOptions): Promise<void>
Delete a subscription integration Check out the docs for more info
Parameters
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/SubscriptionIntegrations.ts:71

Get

Get<TSubscriptionIntegration>(requestOptions?: RequestOptions): Promise<RequiredDeep<TSubscriptionIntegration>>
Retrieve a subscription integration Check out the docs for more info
Type Parameters
- TSubscriptionIntegration extends SubscriptionIntegration<any, TSubscriptionIntegration>
Parameters
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSubscriptionIntegration>>
- Defined in api/SubscriptionIntegrations.ts:30

Patch

Patch<TSubscriptionIntegration>(subscriptionIntegration: PartialObjectDeep<SubscriptionIntegration<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSubscriptionIntegration>>
Partially update a subscription integration Check out the docs for more info
Type Parameters
- TSubscriptionIntegration extends SubscriptionIntegration<any, TSubscriptionIntegration>
Parameters
- subscriptionIntegration: PartialObjectDeep<SubscriptionIntegration<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSubscriptionIntegration>>
- Defined in api/SubscriptionIntegrations.ts:92

Save

Save<TSubscriptionIntegration>(subscriptionIntegration: SubscriptionIntegration<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSubscriptionIntegration>>
Create or update a subscription integration If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TSubscriptionIntegration extends SubscriptionIntegration<any, TSubscriptionIntegration>
Parameters
- subscriptionIntegration: SubscriptionIntegration<any>
  
  Required fields: ApiClientID, HashKey
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSubscriptionIntegration>>
- Defined in api/SubscriptionIntegrations.ts:51

Generated using TypeDoc