orb-billing
Version:
The official TypeScript library for the Orb API
77 lines • 3.44 kB
JavaScript
;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.CouponsPage = exports.Coupons = void 0;
const resource_1 = require("../../resource.js");
const core_1 = require("../../core.js");
const SubscriptionsAPI = __importStar(require("./subscriptions.js"));
const subscriptions_1 = require("./subscriptions.js");
const pagination_1 = require("../../pagination.js");
/**
* A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription or invoice. The duration of a coupon determines how long it remains available for use by end users.
*/
class Coupons extends resource_1.APIResource {
constructor() {
super(...arguments);
this.subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
}
/**
* This endpoint allows the creation of coupons, which can then be redeemed at
* subscription creation or plan change.
*/
create(body, options) {
return this._client.post('/coupons', { body, ...options });
}
list(query = {}, options) {
if ((0, core_1.isRequestOptions)(query)) {
return this.list({}, query);
}
return this._client.getAPIList('/coupons', CouponsPage, { query, ...options });
}
/**
* This endpoint allows a coupon to be archived. Archived coupons can no longer be
* redeemed, and will be hidden from lists of active coupons. Additionally, once a
* coupon is archived, its redemption code can be reused for a different coupon.
*/
archive(couponId, options) {
return this._client.post(`/coupons/${couponId}/archive`, options);
}
/**
* This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption
* code, use the [List coupons](list-coupons) endpoint with the redemption_code
* parameter.
*/
fetch(couponId, options) {
return this._client.get(`/coupons/${couponId}`, options);
}
}
exports.Coupons = Coupons;
class CouponsPage extends pagination_1.Page {
}
exports.CouponsPage = CouponsPage;
Coupons.CouponsPage = CouponsPage;
Coupons.Subscriptions = subscriptions_1.Subscriptions;
//# sourceMappingURL=coupons.js.map