Class Channels

Channels - object-oriented interface

export

Hierarchy

BaseAPI
- Channels

Index

Constructors

constructor

Methods

Constructors

constructor

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

Inherited from BaseAPI.constructor
- Defined in src/openapi/base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns Channels

Methods

create

create(channelParams: ChannelParams, options?: any): Promise<AxiosResponse<ChannelResult>>

- Defined in src/openapi/api.ts:3118
summary
Create a channel

throws
{RequiredError}

memberof
Channels

Parameters
- channelParams: ChannelParams
- Optional options: any
Returns Promise<AxiosResponse<ChannelResult>>

list

list(customerId?: string, startingAfter?: string, options?: any): Promise<AxiosResponse<ChannelListResult>>

- Defined in src/openapi/api.ts:3131
summary
List channels

throws
{RequiredError}

memberof
Channels

Parameters
- Optional customerId: string
- Optional startingAfter: string
- Optional options: any
Returns Promise<AxiosResponse<ChannelListResult>>

listPayments

listPayments(channelId: string, startingAfter?: string, options?: any): Promise<AxiosResponse<ChannelPaymentListResult>>

- Defined in src/openapi/api.ts:3144
summary
List channel payments

throws
{RequiredError}

memberof
Channels

Parameters
- channelId: string
  
  Channel ID
- Optional startingAfter: string
- Optional options: any
Returns Promise<AxiosResponse<ChannelPaymentListResult>>

retrieve

retrieve(channelId: string, options?: any): Promise<AxiosResponse<ChannelResult>>

- Defined in src/openapi/api.ts:3156
summary
Retrieve a channel

throws
{RequiredError}

memberof
Channels

Parameters
- channelId: string
  
  Channel ID
- Optional options: any
Returns Promise<AxiosResponse<ChannelResult>>

retrieveByCustomId

retrieveByCustomId(customId: string, options?: any): Promise<AxiosResponse<ChannelResult>>

- Defined in src/openapi/api.ts:3168
summary
Retrieve a channel by custom id

throws
{RequiredError}

memberof
Channels

Parameters
- customId: string
- Optional options: any
Returns Promise<AxiosResponse<ChannelResult>>

retrievePayment

retrievePayment(channelId: string, channelPaymentId: string, options?: any): Promise<AxiosResponse<ChannelPaymentResult>>

- Defined in src/openapi/api.ts:3181
summary
Retrieve a channel payment

throws
{RequiredError}

memberof
Channels

Parameters
- channelId: string
  
  Channel ID
- channelPaymentId: string
  
  Channel payment ID
- Optional options: any
Returns Promise<AxiosResponse<ChannelPaymentResult>>

update

update(channelId: string, channelUpdateParams: ChannelUpdateParams, options?: any): Promise<AxiosResponse<ChannelResult>>

- Defined in src/openapi/api.ts:3194
summary
Update a channel

throws
{RequiredError}

memberof
Channels

Parameters
- channelId: string
  
  Channel ID
- channelUpdateParams: ChannelUpdateParams
- Optional options: any
Returns Promise<AxiosResponse<ChannelResult>>

Generated using TypeDoc