Class PricingTemplatesApi

PricingTemplatesApi - object-oriented interface

Export

Hierarchy

BaseAPI
- PricingTemplatesApi

Index

Constructors

Properties

axios basePath configuration

Methods

getPricingTemplate listPricingTemplates

Constructors

constructor

new PricingTemplatesApi(configuration?, basePath?, axios?): PricingTemplatesApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PricingTemplatesApi
Inherited from BaseAPI.constructor
- Defined in base.ts:56

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

getPricingTemplate

getPricingTemplate(requestParameters, options?): Promise<AxiosResponse<PricingTemplate, any>>
Retrieves the details of an existing Pricing Template.

Summary
Get a Pricing Template

Throws

Memberof
PricingTemplatesApi
Parameters
- requestParameters: PricingTemplatesApiGetPricingTemplateRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PricingTemplate, any>>
- Defined in api/pricing-templates-api.ts:285

listPricingTemplates

listPricingTemplates(requestParameters, options?): Promise<AxiosResponse<ListPricingTemplates200Response, any>>
Returns a list of Pricing Templates. The Pricing Templates are sorted with the most recently created appearing first.

Summary
List all Pricing Templates

Throws

Memberof
PricingTemplatesApi
Parameters
- requestParameters: PricingTemplatesApiListPricingTemplatesRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ListPricingTemplates200Response, any>>
- Defined in api/pricing-templates-api.ts:297

Generated using TypeDoc