@maxio-com/advanced-billing-sdk
Version:
Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.
79 lines • 4.09 kB
TypeScript
/**
* AdvancedBilling
*
* This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core';
import { CreateOfferRequest } from '../models/createOfferRequest';
import { ListOffersResponse } from '../models/listOffersResponse';
import { OfferResponse } from '../models/offerResponse';
import { BaseController } from './baseController';
export declare class OffersController extends BaseController {
/**
* Create an offer within your Advanced Billing site by sending a POST request.
*
* ## Documentation
*
* Offers allow you to package complicated combinations of products, components and coupons into a
* convenient package which can then be subscribed to just like products.
*
* Once an offer is defined it can be used as an alternative to the product when creating subscriptions.
*
* Full documentation on how to use offers in the Advanced Billing UI can be located [here](https:
* //maxio.zendesk.com/hc/en-us/articles/24261295098637-Offers-Overview).
*
* ## Using a Product Price Point
*
* You can optionally pass in a `product_price_point_id` that corresponds with the `product_id` and the
* offer will use that price point. If a `product_price_point_id` is not passed in, the product's
* default price point will be used.
*
* @param body
* @return Response from the API call
*/
createOffer(body?: CreateOfferRequest, requestOptions?: RequestOptions): Promise<ApiResponse<OfferResponse>>;
/**
* This endpoint will list offers for a site.
*
* @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 includeArchived Include archived products. Use in query: `include_archived=true`.
* @return Response from the API call
*/
listOffers({ page, perPage, includeArchived, }: {
page?: number;
perPage?: number;
includeArchived?: boolean;
}, requestOptions?: RequestOptions): Promise<ApiResponse<ListOffersResponse>>;
/**
* This method allows you to list a specific offer's attributes. This is different than list all offers
* for a site, as it requires an `offer_id`.
*
* @param offerId The Chargify id of the offer
* @return Response from the API call
*/
readOffer(offerId: number, requestOptions?: RequestOptions): Promise<ApiResponse<OfferResponse>>;
/**
* Archive an existing offer. Please provide an `offer_id` in order to archive the correct item.
*
* @param offerId The Chargify id of the offer
* @return Response from the API call
*/
archiveOffer(offerId: number, requestOptions?: RequestOptions): Promise<ApiResponse<void>>;
/**
* Unarchive a previously archived offer. Please provide an `offer_id` in order to un-archive the
* correct item.
*
* @param offerId The Chargify id of the offer
* @return Response from the API call
*/
unarchiveOffer(offerId: number, requestOptions?: RequestOptions): Promise<ApiResponse<void>>;
}
//# sourceMappingURL=offersController.d.ts.map