Pricing_api.PricingMenusApi.md

saasus-sdk / Pricing/api / PricingMenusApi

Class: PricingMenusApi

Pricing/api.PricingMenusApi

PricingMenusApi - object-oriented interface

Export

PricingMenusApi

Hierarchy

• BaseAPI

  ↳ PricingMenusApi

Table of contents

Constructors

• constructor

Properties

• axios
• basePath
• configuration

Methods

• createPricingMenu
• deletePricingMenu
• getPricingMenu
• getPricingMenus
• updatePricingMenu

Constructors

constructor

• new PricingMenusApi(configuration?, basePath?, axios?): PricingMenusApi

Parameters

Name	Type	Default value
configuration?	Configuration	undefined
basePath	string	BASE_PATH
axios	AxiosInstance	globalAxios

Returns

PricingMenusApi

Inherited from

BaseAPI.constructor

Defined in

src/generated/Pricing/base.ts:52

Properties

axios

• Protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios

Defined in

src/generated/Pricing/base.ts:52

---

basePath

• Protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath

Defined in

src/generated/Pricing/base.ts:52

---

configuration

• Protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Defined in

src/generated/Pricing/base.ts:50

Methods

createPricingMenu

▸ createPricingMenu(body?, options?): Promise<AxiosResponse<PricingMenu, any>>

Create a pricing feature menu.

Parameters

Name	Type	Description
body?	SavePricingMenuParam
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<PricingMenu, any>>

Summary

Create a Pricing Feature Menu

Throws

Memberof

PricingMenusApi

Defined in

src/generated/Pricing/api.ts:3271

---

deletePricingMenu

▸ deletePricingMenu(menuId, options?): Promise<AxiosResponse<void, any>>

Delete pricing feature menu.

Parameters

Name	Type	Description
menuId	string	Menu ID
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Summary

Delete Pricing Feature Menu

Throws

Memberof

PricingMenusApi

Defined in

src/generated/Pricing/api.ts:3283

---

getPricingMenu

▸ getPricingMenu(menuId, options?): Promise<AxiosResponse<PricingMenu, any>>

Get a pricing feature menu.

Parameters

Name	Type	Description
menuId	string	Menu ID
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<PricingMenu, any>>

Summary

Get Pricing Feature Menu

Throws

Memberof

PricingMenusApi

Defined in

src/generated/Pricing/api.ts:3295

---

getPricingMenus

▸ getPricingMenus(options?): Promise<AxiosResponse<PricingMenus, any>>

Get the feature menu list. Multiple measurement units are grouped together and defined as one feature menu. Multiple feature menus defined here are combined into one billing plan.

Parameters

Name	Type	Description
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<PricingMenus, any>>

Summary

Get Pricing Feature Menus

Throws

Memberof

PricingMenusApi

Defined in

src/generated/Pricing/api.ts:3306

---

updatePricingMenu

▸ updatePricingMenu(menuId, body?, options?): Promise<AxiosResponse<void, any>>

Update pricing feature menu.

Parameters

Name	Type	Description
menuId	string	Menu ID
body?	SavePricingMenuParam
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Summary

Update Pricing Feature Menu

Throws

Memberof

PricingMenusApi

Defined in

src/generated/Pricing/api.ts:3319