orb-billing 1.21.0 → 1.23.0

package/dist/sdk/credit.js

@@ -1,1020 +0,0 @@
-"use strict";
-/*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
- */
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-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;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Credit = void 0;
-var utils = __importStar(require("../internal/utils"));
-var errors = __importStar(require("./models/errors"));
-var operations = __importStar(require("./models/operations"));
-var shared = __importStar(require("./models/shared"));
-/**
- * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
- */
-var Credit = /** @class */ (function () {
-    function Credit(sdkConfig) {
-        this.sdkConfiguration = sdkConfig;
-    }
-    /**
-     * Create ledger entry by external ID
-     *
-     * @remarks
-     * This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
-     * increment balance, deduct credits, and change the expiry date of existing credits.
-     *
-     * ## Effects of adding a ledger entry
-     * 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
-     *   represents the changes (i.e. balance changes or transfers).
-     * 2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
-     *   [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
-     *   the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
-     *   credit blocks.
-     * 3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
-     *   `amount` and `per_unit_cost_basis`).
-     *
-     * ## Adding credits
-     *   Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
-     *   credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
-     *   to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
-     *   how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
-     *
-     * The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
-     *
-     * ```json
-     * {
-     *   "entry_type": "increment",
-     *   "amount": 100,
-     *   "expiry_date": "2022-12-28",
-     *   "per_unit_cost_basis": "0.20",
-     *   "description": "Purchased 100 credits"
-     * }
-     * ```
-     *
-     * Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
-     * remaining amount to the desired credit block.
-     *
-     * ### Invoicing for credits
-     * By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
-     * `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
-     * credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
-     * invoice are calculated by multiplying the cost basis with the number of credit units added.
-     *
-     * ## Deducting Credits
-     * Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
-     * algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
-     * deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
-     * optionally allows specifying a description to assist with auditing.
-     *
-     * The following snippet illustrates a sample request body to decrement credits.
-     *
-     * ```json
-     * {
-     *   "entry_type": "decrement",
-     *   "amount": 20,
-     *   "description": "Removing excess credits"
-     * }
-     * ```
-     *
-     * ## Changing credits expiry
-     * If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
-     * For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
-     * `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
-     * with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
-     *
-     * Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
-     * amount determined by the `amount` parameter.
-     *
-     * The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
-     *
-     * ```json
-     * {
-     *   "entry_type": "expiration_change",
-     *   "amount": 10,
-     *   "expiry_date": "2022-12-28",
-     *   "block_id": "UiUhFWeLHPrBY4Ad",
-     *   "target_expiry_date": "2023-12-28",
-     *   "description": "Extending credit validity"
-     * }
-     * ```
-     *
-     * ## Voiding credits
-     *
-     * If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
-     * to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
-     * in a `void_reason` of `refund` if the void is due to a refund.
-     *
-     * ## Amendment
-     *
-     * If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
-     * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
-     * to the customer, up to the block's initial balance.
-     */
-    Credit.prototype.addByExternalId = function (externalCustomerId, requestBody, config) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function () {
-            var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes, err, err, err;
-            var _d;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
-                    case 0:
-                        req = new operations.CreateLedgerEntryExternalIdRequest({
-                            externalCustomerId: externalCustomerId,
-                            requestBody: requestBody,
-                        });
-                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
-                        url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}/credits/ledger_entry", req);
-                        _c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
-                        try {
-                            _d = __read(utils.serializeRequestBody(req, "requestBody", "json"), 2), reqBodyHeaders = _d[0], reqBody = _d[1];
-                        }
-                        catch (e) {
-                            if (e instanceof Error) {
-                                throw new Error("Error serializing request body, cause: ".concat(e.message));
-                            }
-                        }
-                        client = this.sdkConfiguration.defaultClient;
-                        globalSecurity = this.sdkConfiguration.security;
-                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
-                        return [4 /*yield*/, globalSecurity()];
-                    case 1:
-                        globalSecurity = _e.sent();
-                        _e.label = 2;
-                    case 2:
-                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
-                            globalSecurity = new shared.Security(globalSecurity);
-                        }
-                        properties = utils.parseSecurityProperties(globalSecurity);
-                        headers = __assign(__assign(__assign({}, reqBodyHeaders), config === null || config === void 0 ? void 0 : config.headers), properties.headers);
-                        headers["Accept"] = "application/json";
-                        headers["user-agent"] = this.sdkConfiguration.userAgent;
-                        return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: url, method: "post", headers: headers, responseType: "arraybuffer", data: reqBody }, config))];
-                    case 3:
-                        httpRes = _e.sent();
-                        contentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
-                        if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
-                            throw new Error("status code not found in response: ".concat(httpRes));
-                        }
-                        res = new operations.CreateLedgerEntryExternalIdResponse({
-                            statusCode: httpRes.status,
-                            contentType: contentType,
-                            rawResponse: httpRes,
-                        });
-                        decodedRes = new TextDecoder().decode(httpRes === null || httpRes === void 0 ? void 0 : httpRes.data);
-                        switch (true) {
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 201:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.creditLedgerEntry = JSON.parse(decodedRes);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 400 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 404 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 409 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 413 ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 400 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 500) ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 500 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 600):
-                                throw new errors.SDKError("API error occurred", httpRes.status, decodedRes, httpRes);
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 401:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndOneError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndOneError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 429:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndTwentyNineError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndTwentyNineError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 500:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FiveHundredError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FiveHundredError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                        }
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * Create ledger entry
-     *
-     * @remarks
-     * This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
-     * increment balance, deduct credits, and change the expiry date of existing credits.
-     *
-     * ## Effects of adding a ledger entry
-     * 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
-     *   represents the changes (i.e. balance changes or transfers).
-     * 2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
-     *   [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
-     *   the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
-     *   credit blocks.
-     * 3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
-     *   `amount` and `per_unit_cost_basis`).
-     *
-     * ## Adding credits
-     *   Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
-     *   credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
-     *   to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
-     *   how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
-     *
-     * The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
-     *
-     * ```json
-     * {
-     *   "entry_type": "increment",
-     *   "amount": 100,
-     *   "expiry_date": "2022-12-28",
-     *   "per_unit_cost_basis": "0.20",
-     *   "description": "Purchased 100 credits"
-     * }
-     * ```
-     *
-     * Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
-     * remaining amount to the desired credit block.
-     *
-     * ### Invoicing for credits
-     * By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
-     * `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
-     * credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
-     * invoice are calculated by multiplying the cost basis with the number of credit units added.
-     *
-     * ## Deducting Credits
-     * Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
-     * algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
-     * deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
-     * optionally allows specifying a description to assist with auditing.
-     *
-     * The following snippet illustrates a sample request body to decrement credits.
-     *
-     * ```json
-     * {
-     *   "entry_type": "decrement",
-     *   "amount": 20,
-     *   "description": "Removing excess credits"
-     * }
-     * ```
-     *
-     * ## Changing credits expiry
-     * If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
-     * For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
-     * `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
-     * with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
-     *
-     * Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
-     * amount determined by the `amount` parameter.
-     *
-     * The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
-     *
-     * ```json
-     * {
-     *   "entry_type": "expiration_change",
-     *   "amount": 10,
-     *   "expiry_date": "2022-12-28",
-     *   "block_id": "UiUhFWeLHPrBY4Ad",
-     *   "target_expiry_date": "2023-12-28",
-     *   "description": "Extending credit validity"
-     * }
-     * ```
-     *
-     * ## Voiding credits
-     *
-     * If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
-     * to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
-     * in a `void_reason` of `refund` if the void is due to a refund.
-     *
-     * ## Amendment
-     *
-     * If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
-     * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
-     * to the customer, up to the block's initial balance.
-     */
-    Credit.prototype.create = function (customerId, requestBody, config) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function () {
-            var req, baseURL, url, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes, err, err, err;
-            var _d;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
-                    case 0:
-                        req = new operations.CreateLedgerEntryRequest({
-                            customerId: customerId,
-                            requestBody: requestBody,
-                        });
-                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
-                        url = utils.generateURL(baseURL, "/customers/{customer_id}/credits/ledger_entry", req);
-                        _c = __read([{}, null], 2), reqBodyHeaders = _c[0], reqBody = _c[1];
-                        try {
-                            _d = __read(utils.serializeRequestBody(req, "requestBody", "json"), 2), reqBodyHeaders = _d[0], reqBody = _d[1];
-                        }
-                        catch (e) {
-                            if (e instanceof Error) {
-                                throw new Error("Error serializing request body, cause: ".concat(e.message));
-                            }
-                        }
-                        client = this.sdkConfiguration.defaultClient;
-                        globalSecurity = this.sdkConfiguration.security;
-                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
-                        return [4 /*yield*/, globalSecurity()];
-                    case 1:
-                        globalSecurity = _e.sent();
-                        _e.label = 2;
-                    case 2:
-                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
-                            globalSecurity = new shared.Security(globalSecurity);
-                        }
-                        properties = utils.parseSecurityProperties(globalSecurity);
-                        headers = __assign(__assign(__assign({}, reqBodyHeaders), config === null || config === void 0 ? void 0 : config.headers), properties.headers);
-                        headers["Accept"] = "application/json";
-                        headers["user-agent"] = this.sdkConfiguration.userAgent;
-                        return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: url, method: "post", headers: headers, responseType: "arraybuffer", data: reqBody }, config))];
-                    case 3:
-                        httpRes = _e.sent();
-                        contentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
-                        if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
-                            throw new Error("status code not found in response: ".concat(httpRes));
-                        }
-                        res = new operations.CreateLedgerEntryResponse({
-                            statusCode: httpRes.status,
-                            contentType: contentType,
-                            rawResponse: httpRes,
-                        });
-                        decodedRes = new TextDecoder().decode(httpRes === null || httpRes === void 0 ? void 0 : httpRes.data);
-                        switch (true) {
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 201:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.creditLedgerEntry = JSON.parse(decodedRes);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 400 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 404 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 409 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 413 ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 400 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 500) ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 500 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 600):
-                                throw new errors.SDKError("API error occurred", httpRes.status, decodedRes, httpRes);
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 401:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndOneError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndOneError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 429:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndTwentyNineError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndTwentyNineError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 500:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FiveHundredError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FiveHundredError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                        }
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * Fetch customer credit balance
-     *
-     * @remarks
-     * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
-     */
-    Credit.prototype.fetchBalance = function (customerId, cursor, limit, config) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function () {
-            var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes, err, err, err;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        req = new operations.FetchCustomerCreditsRequest({
-                            customerId: customerId,
-                            cursor: cursor,
-                            limit: limit,
-                        });
-                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
-                        url = utils.generateURL(baseURL, "/customers/{customer_id}/credits", req);
-                        client = this.sdkConfiguration.defaultClient;
-                        globalSecurity = this.sdkConfiguration.security;
-                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
-                        return [4 /*yield*/, globalSecurity()];
-                    case 1:
-                        globalSecurity = _c.sent();
-                        _c.label = 2;
-                    case 2:
-                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
-                            globalSecurity = new shared.Security(globalSecurity);
-                        }
-                        properties = utils.parseSecurityProperties(globalSecurity);
-                        headers = __assign(__assign({}, config === null || config === void 0 ? void 0 : config.headers), properties.headers);
-                        queryParams = utils.serializeQueryParams(req);
-                        headers["Accept"] = "application/json";
-                        headers["user-agent"] = this.sdkConfiguration.userAgent;
-                        return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: url + queryParams, method: "get", headers: headers, responseType: "arraybuffer" }, config))];
-                    case 3:
-                        httpRes = _c.sent();
-                        contentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
-                        if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
-                            throw new Error("status code not found in response: ".concat(httpRes));
-                        }
-                        res = new operations.FetchCustomerCreditsResponse({
-                            statusCode: httpRes.status,
-                            contentType: contentType,
-                            rawResponse: httpRes,
-                        });
-                        decodedRes = new TextDecoder().decode(httpRes === null || httpRes === void 0 ? void 0 : httpRes.data);
-                        switch (true) {
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 200:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.customerCreditBalances = utils.objectToClass(JSON.parse(decodedRes), shared.CustomerCreditBalances);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 400 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 404 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 409 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 413 ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 400 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 500) ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 500 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 600):
-                                throw new errors.SDKError("API error occurred", httpRes.status, decodedRes, httpRes);
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 401:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndOneError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndOneError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 429:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndTwentyNineError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndTwentyNineError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 500:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FiveHundredError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FiveHundredError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                        }
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * Fetch customer credit balance by external customer id
-     *
-     * @remarks
-     * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
-     */
-    Credit.prototype.fetchBalanceByExternalId = function (externalCustomerId, cursor, limit, config) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function () {
-            var req, baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes, err, err, err;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        req = new operations.FetchCustomerCreditsExternalIdRequest({
-                            externalCustomerId: externalCustomerId,
-                            cursor: cursor,
-                            limit: limit,
-                        });
-                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
-                        url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}/credits", req);
-                        client = this.sdkConfiguration.defaultClient;
-                        globalSecurity = this.sdkConfiguration.security;
-                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
-                        return [4 /*yield*/, globalSecurity()];
-                    case 1:
-                        globalSecurity = _c.sent();
-                        _c.label = 2;
-                    case 2:
-                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
-                            globalSecurity = new shared.Security(globalSecurity);
-                        }
-                        properties = utils.parseSecurityProperties(globalSecurity);
-                        headers = __assign(__assign({}, config === null || config === void 0 ? void 0 : config.headers), properties.headers);
-                        queryParams = utils.serializeQueryParams(req);
-                        headers["Accept"] = "application/json";
-                        headers["user-agent"] = this.sdkConfiguration.userAgent;
-                        return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: url + queryParams, method: "get", headers: headers, responseType: "arraybuffer" }, config))];
-                    case 3:
-                        httpRes = _c.sent();
-                        contentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
-                        if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
-                            throw new Error("status code not found in response: ".concat(httpRes));
-                        }
-                        res = new operations.FetchCustomerCreditsExternalIdResponse({
-                            statusCode: httpRes.status,
-                            contentType: contentType,
-                            rawResponse: httpRes,
-                        });
-                        decodedRes = new TextDecoder().decode(httpRes === null || httpRes === void 0 ? void 0 : httpRes.data);
-                        switch (true) {
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 200:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.customerCreditBalances = utils.objectToClass(JSON.parse(decodedRes), shared.CustomerCreditBalances);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 400 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 404 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 409 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 413 ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 400 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 500) ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 500 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 600):
-                                throw new errors.SDKError("API error occurred", httpRes.status, decodedRes, httpRes);
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 401:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndOneError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndOneError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 429:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndTwentyNineError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndTwentyNineError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 500:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FiveHundredError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FiveHundredError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                        }
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * Fetch customer credits ledger
-     *
-     * @remarks
-     * The credits ledger provides _auditing_ functionality over Orb's credits system with a list of actions that have
-     * taken place to modify a customer's credit balance. This [paginated endpoint](../reference/pagination) lists these
-     * entries, starting from the most recent ledger entry.
-     *
-     * More details on using Orb's real-time credit feature are [here](../guides/product-catalog/prepurchase.md).
-     *
-     * There are four major types of modifications to credit balance, detailed below.
-     *
-     * ## Increment
-     * Credits (which optionally expire on a future date) can be added via the API
-     * ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action will always contain the total
-     * eligible starting and ending balance for the customer at the time the entry was added to the ledger.
-     *
-     * ## Decrement
-     * Deductions can occur as a result of an API call to create a ledger entry (see
-     * [Add Ledger Entry](create-ledger-entry)), or automatically as a result of incurring usage. Both ledger entries
-     * present the `decrement` entry type.
-     *
-     * As usage for a customer is reported into Orb, credits may be deducted according to the customer's plan
-     * configuration. An automated deduction of this type will result in a ledger entry, also with a starting and ending
-     * balance. In order to provide better tracing capabilities for automatic deductions, Orb always associates each
-     * automatic deduction with the `event_id` at the time of ingestion, used to pinpoint _why_ credit deduction took
-     * place and to ensure that credits are never deducted without an associated usage event.
-     *
-     * By default, Orb uses an algorithm that automatically deducts from the *soonest expiring credit block* first in
-     * order to ensure that all credits are utilized appropriately. As an example, if trial credits with an expiration date
-     * of 2 weeks from now are present for a customer, they will be used before any deductions take place from a
-     * non-expiring credit block.
-     *
-     * If there are multiple blocks with the same expiration date, Orb will deduct from the block with the
-     * *lower cost basis* first (ex. trial credits with a $0 cost basis before paid credits with a $5.00 cost basis).
-     *
-     * It's also possible for a single usage event's deduction to _span_ credit blocks. In this case, Orb will deduct from
-     * the next block, ending at the credit block which consists of unexpiring credits. Each of these deductions will lead
-     * to a _separate_ ledger entry, one per credit block that is deducted from. By default, the customer's total credit
-     * balance in Orb can be negative as a result of a decrement.
-     *
-     * ## Expiration change
-     * The expiry of credits can be changed as a result of the API (See [Add Ledger Entry](create-ledger-entry)). This will
-     * create a ledger entry that specifies the balance as well as the initial and target expiry dates.
-     *
-     * Note that for this entry type, `starting_balance` will equal `ending_balance`, and the `amount` represents the
-     * balance transferred. The credit block linked to the ledger entry is the source credit block from which there was an
-     * expiration change
-     *
-     * ## Credits expiry
-     * When a set of credits expire on pre-set expiration date, the customer's balance automatically reflects this change
-     * and adds an entry to the ledger indicating this event. Note that credit expiry should always happen close to a date
-     * boundary in the customer's timezone.
-     *
-     * ## Void initiated
-     * Credit blocks can be voided via the API. The `amount` on this entry corresponds to the number of credits that were
-     * remaining in the block at time of void. `void_reason` will be populated if the void is created with a reason.
-     *
-     * ## Void
-     * When a set of credits is voided, the customer's balance automatically reflects this change and adds an entry to the
-     * ledger indicating this event.
-     *
-     * ## Amendment
-     * When credits are added to a customer's balance as a result of a correction, this entry will be added to the ledger
-     * to indicate the adjustment of credits.
-     */
-    Credit.prototype.fetchLedger = function (req, config) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function () {
-            var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes, err, err, err;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        if (!(req instanceof utils.SpeakeasyBase)) {
-                            req = new operations.FetchCustomerCreditsLedgerRequest(req);
-                        }
-                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
-                        url = utils.generateURL(baseURL, "/customers/{customer_id}/credits/ledger", req);
-                        client = this.sdkConfiguration.defaultClient;
-                        globalSecurity = this.sdkConfiguration.security;
-                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
-                        return [4 /*yield*/, globalSecurity()];
-                    case 1:
-                        globalSecurity = _c.sent();
-                        _c.label = 2;
-                    case 2:
-                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
-                            globalSecurity = new shared.Security(globalSecurity);
-                        }
-                        properties = utils.parseSecurityProperties(globalSecurity);
-                        headers = __assign(__assign({}, config === null || config === void 0 ? void 0 : config.headers), properties.headers);
-                        queryParams = utils.serializeQueryParams(req);
-                        headers["Accept"] = "application/json";
-                        headers["user-agent"] = this.sdkConfiguration.userAgent;
-                        return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: url + queryParams, method: "get", headers: headers, responseType: "arraybuffer" }, config))];
-                    case 3:
-                        httpRes = _c.sent();
-                        contentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
-                        if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
-                            throw new Error("status code not found in response: ".concat(httpRes));
-                        }
-                        res = new operations.FetchCustomerCreditsLedgerResponse({
-                            statusCode: httpRes.status,
-                            contentType: contentType,
-                            rawResponse: httpRes,
-                        });
-                        decodedRes = new TextDecoder().decode(httpRes === null || httpRes === void 0 ? void 0 : httpRes.data);
-                        switch (true) {
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 200:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.creditLedgerEntries = utils.objectToClass(JSON.parse(decodedRes), shared.CreditLedgerEntries);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 400 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 404 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 409 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 413 ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 400 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 500) ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 500 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 600):
-                                throw new errors.SDKError("API error occurred", httpRes.status, decodedRes, httpRes);
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 401:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndOneError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndOneError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 429:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndTwentyNineError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndTwentyNineError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 500:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FiveHundredError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FiveHundredError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                        }
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * Fetch customer credits ledger by external ID
-     *
-     * @remarks
-     * The credits ledger provides _auditing_ functionality over Orb's credits system with a list of actions that have
-     * taken place to modify a customer's credit balance. This [paginated endpoint](../reference/pagination) lists these
-     * entries, starting from the most recent ledger entry.
-     *
-     * More details on using Orb's real-time credit feature are [here](../guides/product-catalog/prepurchase.md).
-     *
-     * There are four major types of modifications to credit balance, detailed below.
-     *
-     * ## Increment
-     * Credits (which optionally expire on a future date) can be added via the API
-     * ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action will always contain the total
-     * eligible starting and ending balance for the customer at the time the entry was added to the ledger.
-     *
-     * ## Decrement
-     * Deductions can occur as a result of an API call to create a ledger entry (see
-     * [Add Ledger Entry](create-ledger-entry)), or automatically as a result of incurring usage. Both ledger entries
-     * present the `decrement` entry type.
-     *
-     * As usage for a customer is reported into Orb, credits may be deducted according to the customer's plan
-     * configuration. An automated deduction of this type will result in a ledger entry, also with a starting and ending
-     * balance. In order to provide better tracing capabilities for automatic deductions, Orb always associates each
-     * automatic deduction with the `event_id` at the time of ingestion, used to pinpoint _why_ credit deduction took
-     * place and to ensure that credits are never deducted without an associated usage event.
-     *
-     * By default, Orb uses an algorithm that automatically deducts from the *soonest expiring credit block* first in
-     * order to ensure that all credits are utilized appropriately. As an example, if trial credits with an expiration date
-     * of 2 weeks from now are present for a customer, they will be used before any deductions take place from a
-     * non-expiring credit block.
-     *
-     * If there are multiple blocks with the same expiration date, Orb will deduct from the block with the
-     * *lower cost basis* first (ex. trial credits with a $0 cost basis before paid credits with a $5.00 cost basis).
-     *
-     * It's also possible for a single usage event's deduction to _span_ credit blocks. In this case, Orb will deduct from
-     * the next block, ending at the credit block which consists of unexpiring credits. Each of these deductions will lead
-     * to a _separate_ ledger entry, one per credit block that is deducted from. By default, the customer's total credit
-     * balance in Orb can be negative as a result of a decrement.
-     *
-     * ## Expiration change
-     * The expiry of credits can be changed as a result of the API (See [Add Ledger Entry](create-ledger-entry)). This will
-     * create a ledger entry that specifies the balance as well as the initial and target expiry dates.
-     *
-     * Note that for this entry type, `starting_balance` will equal `ending_balance`, and the `amount` represents the
-     * balance transferred. The credit block linked to the ledger entry is the source credit block from which there was an
-     * expiration change
-     *
-     * ## Credits expiry
-     * When a set of credits expire on pre-set expiration date, the customer's balance automatically reflects this change
-     * and adds an entry to the ledger indicating this event. Note that credit expiry should always happen close to a date
-     * boundary in the customer's timezone.
-     *
-     * ## Void initiated
-     * Credit blocks can be voided via the API. The `amount` on this entry corresponds to the number of credits that were
-     * remaining in the block at time of void. `void_reason` will be populated if the void is created with a reason.
-     *
-     * ## Void
-     * When a set of credits is voided, the customer's balance automatically reflects this change and adds an entry to the
-     * ledger indicating this event.
-     *
-     * ## Amendment
-     * When credits are added to a customer's balance as a result of a correction, this entry will be added to the ledger
-     * to indicate the adjustment of credits.
-     */
-    Credit.prototype.fetchLedgerByExternalId = function (req, config) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function () {
-            var baseURL, url, client, globalSecurity, properties, headers, queryParams, httpRes, contentType, res, decodedRes, err, err, err;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        if (!(req instanceof utils.SpeakeasyBase)) {
-                            req = new operations.FetchCustomerCreditsLedgerExternalIdRequest(req);
-                        }
-                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
-                        url = utils.generateURL(baseURL, "/customers/external_customer_id/{external_customer_id}/credits/ledger", req);
-                        client = this.sdkConfiguration.defaultClient;
-                        globalSecurity = this.sdkConfiguration.security;
-                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
-                        return [4 /*yield*/, globalSecurity()];
-                    case 1:
-                        globalSecurity = _c.sent();
-                        _c.label = 2;
-                    case 2:
-                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
-                            globalSecurity = new shared.Security(globalSecurity);
-                        }
-                        properties = utils.parseSecurityProperties(globalSecurity);
-                        headers = __assign(__assign({}, config === null || config === void 0 ? void 0 : config.headers), properties.headers);
-                        queryParams = utils.serializeQueryParams(req);
-                        headers["Accept"] = "application/json";
-                        headers["user-agent"] = this.sdkConfiguration.userAgent;
-                        return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: url + queryParams, method: "get", headers: headers, responseType: "arraybuffer" }, config))];
-                    case 3:
-                        httpRes = _c.sent();
-                        contentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
-                        if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
-                            throw new Error("status code not found in response: ".concat(httpRes));
-                        }
-                        res = new operations.FetchCustomerCreditsLedgerExternalIdResponse({
-                            statusCode: httpRes.status,
-                            contentType: contentType,
-                            rawResponse: httpRes,
-                        });
-                        decodedRes = new TextDecoder().decode(httpRes === null || httpRes === void 0 ? void 0 : httpRes.data);
-                        switch (true) {
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 200:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.creditLedgerEntries = utils.objectToClass(JSON.parse(decodedRes), shared.CreditLedgerEntries);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 400 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 404 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 409 ||
-                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 413 ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 400 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 500) ||
-                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 500 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 600):
-                                throw new errors.SDKError("API error occurred", httpRes.status, decodedRes, httpRes);
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 401:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndOneError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndOneError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 429:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndTwentyNineError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FourHundredAndTwentyNineError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 500:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FiveHundredError);
-                                    err.rawResponse = httpRes;
-                                    throw new errors.FiveHundredError(err);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                        }
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    return Credit;
-}());
-exports.Credit = Credit;