/** * AdvancedBilling * * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { ApiResponse, RequestOptions } from '../core.js'; import { CloneComponentPricePointRequest } from '../models/cloneComponentPricePointRequest.js'; import { ComponentCurrencyPricesResponse } from '../models/componentCurrencyPricesResponse.js'; import { ComponentPricePointCurrencyOverageResponse } from '../models/componentPricePointCurrencyOverageResponse.js'; import { ComponentPricePointResponse } from '../models/componentPricePointResponse.js'; import { ComponentPricePointsResponse } from '../models/componentPricePointsResponse.js'; import { ComponentResponse } from '../models/componentResponse.js'; import { ArchiveComponentPricePointComponentId } from '../models/containers/archiveComponentPricePointComponentId.js'; import { ArchiveComponentPricePointPricePointId } from '../models/containers/archiveComponentPricePointPricePointId.js'; import { CloneComponentPricePointComponentId } from '../models/containers/cloneComponentPricePointComponentId.js'; import { CloneComponentPricePointPricePointId } from '../models/containers/cloneComponentPricePointPricePointId.js'; import { ReadComponentPricePointComponentId } from '../models/containers/readComponentPricePointComponentId.js'; import { ReadComponentPricePointPricePointId } from '../models/containers/readComponentPricePointPricePointId.js'; import { UpdateComponentPricePointComponentId } from '../models/containers/updateComponentPricePointComponentId.js'; import { UpdateComponentPricePointPricePointId } from '../models/containers/updateComponentPricePointPricePointId.js'; import { CreateComponentPricePointRequest } from '../models/createComponentPricePointRequest.js'; import { CreateComponentPricePointsRequest } from '../models/createComponentPricePointsRequest.js'; import { CreateCurrencyPricesRequest } from '../models/createCurrencyPricesRequest.js'; import { ListComponentsPricePointsInclude } from '../models/listComponentsPricePointsInclude.js'; import { ListComponentsPricePointsResponse } from '../models/listComponentsPricePointsResponse.js'; import { ListPricePointsFilter } from '../models/listPricePointsFilter.js'; import { PricePointType } from '../models/pricePointType.js'; import { SortingDirection } from '../models/sortingDirection.js'; import { UpdateComponentPricePointRequest } from '../models/updateComponentPricePointRequest.js'; import { UpdateCurrencyPricesRequest } from '../models/updateCurrencyPricesRequest.js'; import { BaseController } from './baseController.js'; export declare class ComponentPricePointsController extends BaseController { /** * Sets a new default price point for the component. This new default will apply to all new * subscriptions going forward - existing subscriptions will remain on their current price point. * * See [Price Points Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261191737101-Price- * Points-Components) for more information on price points and moving subscriptions between price * points. * * Note: Custom price points are not able to be set as the default for a component. * * @param componentId The Advanced Billing id of the component to which the price point belongs * @param pricePointId The Advanced Billing id of the price point * @return Response from the API call */ promoteComponentPricePointToDefault(componentId: number, pricePointId: number, requestOptions?: RequestOptions): Promise>; /** * Creates a price point for an existing component. * * @param componentId The Advanced Billing id of the component * @param body * @return Response from the API call */ createComponentPricePoint(componentId: number, body?: CreateComponentPricePointRequest, requestOptions?: RequestOptions): Promise>; /** * Lists the price points associated with a component. * * You may specify the component by using either the numeric id or the `handle:gold` syntax. * * When fetching a component's price points, if you have defined multiple currencies at the site level, * you can optionally pass the `?currency_prices=true` query param to include an array of currency * price data in the response. * * If the price point is set to `use_site_exchange_rate: true`, it will return pricing based on the * current exchange rate. If the flag is set to false, it will return all of the defined prices for * each currency. * * @param componentId The Advanced Billing id of the component * @param currencyPrices Include an array of currency price data * @param page Result records are organized in pages. By default, the first page of * results is displayed. The page parameter specifies a page number of * results to fetch. You can start navigating through the pages to consume * the results. You do this by passing in a page parameter. Retrieve the * next page by adding ?page=2 to the query string. If there are no * results to return, then an empty result set will be returned. Use in * query `page=1`. * @param perPage This parameter indicates how many records to fetch in each request. * Default value is 20. The maximum allowed values is 200; any per_page * value over 200 will be changed to 200. Use in query `per_page=200`. * @param filterType Use in query: `filter[type]=catalog,default`. * @return Response from the API call */ listComponentPricePoints({ componentId, currencyPrices, page, perPage, filterType, }: { componentId: number; currencyPrices?: boolean; page?: number; perPage?: number; filterType?: PricePointType[]; }, requestOptions?: RequestOptions): Promise>; /** * Creates multiple component price points in one request. * * @param componentId The Advanced Billing id of the component for * which you want to fetch price points. * @param body * @return Response from the API call */ bulkCreateComponentPricePoints(componentId: string, body?: CreateComponentPricePointsRequest, requestOptions?: RequestOptions): Promise>; /** * Clones a component price point. Custom price points (tied to a specific subscription) cannot be * cloned. The following attributes are copied from the source price point: * - Pricing scheme * - All price tiers (with starting/ending quantities and unit prices) * - Tax included setting * - Currency prices (if definitive pricing is set) * - Overage pricing (for prepaid usage components) * - Interval settings (if multi-frequency is enabled) * - Event-based billing segments (if applicable) * * @param componentId The id or handle of the component. When using the * handle, it must be prefixed with `handle:`. * Example: `123` for an integer ID, or `handle: * example-product-handle` for a string handle. * @param pricePointId The id or handle of the price point. When using * the handle, it must be prefixed with `handle:`. * Example: `123` for an integer ID, or `handle: * example-price_point-handle` for a string handle. * @param body * @return Response from the API call */ cloneComponentPricePoint(componentId: CloneComponentPricePointComponentId, pricePointId: CloneComponentPricePointPricePointId, body?: CloneComponentPricePointRequest, requestOptions?: RequestOptions): Promise>; /** * Updates a component price point and its associated prices. * * Passing in a price bracket without an `id` will attempt to create a new price. * * Including an `id` will update the corresponding price, and including the `_destroy` flag set to true * along with the `id` will remove that price. * * Note: Custom price points cannot be updated directly. They must be edited through the Subscription. * * @param componentId The id or handle of the component. When using * the handle, it must be prefixed with `handle:`. * Example: `123` for an integer ID, or `handle: * example-product-handle` for a string handle. * @param pricePointId The id or handle of the price point. When using * the handle, it must be prefixed with `handle:`. * Example: `123` for an integer ID, or `handle: * example-price_point-handle` for a string handle. * @param body * @return Response from the API call */ updateComponentPricePoint(componentId: UpdateComponentPricePointComponentId, pricePointId: UpdateComponentPricePointPricePointId, body?: UpdateComponentPricePointRequest, requestOptions?: RequestOptions): Promise>; /** * Returns details for a specific component price point. You can achieve this by using either the * component price point ID or handle. * * @param componentId The id or handle of the component. When using the * handle, it must be prefixed with `handle:`. Example: * `123` for an integer ID, or `handle:example-product- * handle` for a string handle. * @param pricePointId The id or handle of the price point. When using the * handle, it must be prefixed with `handle:`. Example: * `123` for an integer ID, or `handle:example- * price_point-handle` for a string handle. * @param currencyPrices Include an array of currency price data * @return Response from the API call */ readComponentPricePoint(componentId: ReadComponentPricePointComponentId, pricePointId: ReadComponentPricePointPricePointId, currencyPrices?: boolean, requestOptions?: RequestOptions): Promise>; /** * Archives a component price point. Subscriptions using a price point that has been archived will * continue using it until they're moved to another price point. * * @param componentId The id or handle of the component. When using the * handle, it must be prefixed with `handle:`. * Example: `123` for an integer ID, or `handle: * example-product-handle` for a string handle. * @param pricePointId The id or handle of the price point. When using * the handle, it must be prefixed with `handle:`. * Example: `123` for an integer ID, or `handle: * example-price_point-handle` for a string handle. * @return Response from the API call */ archiveComponentPricePoint(componentId: ArchiveComponentPricePointComponentId, pricePointId: ArchiveComponentPricePointPricePointId, requestOptions?: RequestOptions): Promise>; /** * Unarchives a component price point. * * @param componentId The Advanced Billing id of the component to which the price point belongs * @param pricePointId The Advanced Billing id of the price point * @return Response from the API call */ unarchiveComponentPricePoint(componentId: number, pricePointId: number, requestOptions?: RequestOptions): Promise>; /** * Creates currency prices for a given currency defined at the site level. * * When creating currency prices, they need to mirror the structure of your primary pricing. For each * price level defined on the component price point, there should be a matching price level created in * the given currency. * * Note: Currency Prices are not able to be created for custom price points. * * @param pricePointId The Advanced Billing id of the price point * @param body * @return Response from the API call */ createCurrencyPrices(pricePointId: number, body?: CreateCurrencyPricesRequest, requestOptions?: RequestOptions): Promise>; /** * Updates currency prices for a given currency defined at the site level. * * Note: Currency Prices are not able to be updated for custom price points. * * @param pricePointId The Advanced Billing id of the price point * @param body * @return Response from the API call */ updateCurrencyPrices(pricePointId: number, body?: UpdateCurrencyPricesRequest, requestOptions?: RequestOptions): Promise>; /** * Lists all component price points belonging to a site. * * @param include Allows including additional data in the response. Use in * query: `include=currency_prices`. * @param page Result records are organized in pages. By default, the first * page of results is displayed. The page parameter specifies a * page number of results to fetch. You can start navigating * through the pages to consume the results. You do this by * passing in a page parameter. Retrieve the next page by adding * ?page=2 to the query string. If there are no results to * return, then an empty result set will be returned. Use in * query `page=1`. * @param perPage This parameter indicates how many records to fetch in each * request. Default value is 20. The maximum allowed values is * 200; any per_page value over 200 will be changed to 200. Use * in query `per_page=200`. * @param direction Controls the order in which results are returned. Use in * query `direction=asc`. * @param filter Filter to use for List PricePoints operations * @return Response from the API call */ listAllComponentPricePoints({ include, page, perPage, direction, filter, }: { include?: ListComponentsPricePointsInclude; page?: number; perPage?: number; direction?: SortingDirection; filter?: ListPricePointsFilter; }, requestOptions?: RequestOptions): Promise>; } //# sourceMappingURL=componentPricePointsController.d.ts.map