orb-billing 1.0.1

package/dist/sdk/models/shared/invoice.js

@@ -0,0 +1,460 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Invoice = exports.InvoiceMinimumAmount = exports.InvoiceMaximumAmount = exports.InvoiceDiscount = exports.InvoiceCustomerTaxID = void 0;
+var utils_1 = require("../../../internal/utils");
+var autocollection_1 = require("./autocollection");
+var creditnotesummary_1 = require("./creditnotesummary");
+var customerminified_1 = require("./customerminified");
+var discounttype_1 = require("./discounttype");
+var invoicelineitem_1 = require("./invoicelineitem");
+var invoicestatus_1 = require("./invoicestatus");
+var subscriptionminified_1 = require("./subscriptionminified");
+var transactions_1 = require("./transactions");
+var class_transformer_1 = require("class-transformer");
+/**
+ * Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.
+ *
+ * @remarks
+ *
+ *
+ * ### Supported Tax ID Countries and Types
+ *
+ *
+ * | Country        | Type         | Description                                 |
+ * |----------------|--------------|---------------------------------------------|
+ * | Australia      | `au_abn`     | Australian Business Number (AU ABN)	        |
+ * | Australia      | `au_arn`     | Australian Taxation Office Reference Number |
+ * | Austria        | `eu_vat`     | European VAT number                         |
+ * | Belgium        | `eu_vat`     | European VAT number                         |
+ * | Brazil         | `br_cnpj`    | Brazilian CNPJ number                       |
+ * | Brazil         | `br_cpf`     | Brazilian CPF number	                       |
+ * | Bulgaria       | `bg_uic`     | Bulgaria Unified Identification Code        |
+ * | Bulgaria       | `eu_vat`     | European VAT number                         |
+ * | Canada         | `ca_bn`      | Canadian BN                                 |
+ * | Canada         | `ca_gst_hst` | Canadian GST/HST number                     |
+ * | Canada         | `ca_pst_bc`  | Canadian PST number (British Columbia)      |
+ * | Canada         | `ca_pst_mb`  | Canadian PST number (Manitoba)              |
+ * | Canada         | `ca_pst_sk`  | Canadian PST number (Saskatchewan)          |
+ * | Canada         | `ca_qst`     | Canadian QST number (Québec)                |
+ * | Chile          | `cl_tin`     | Chilean TIN                                 |
+ * | Croatia        | `eu_vat`     | European VAT number                         |
+ * | Cyprus         | `eu_vat`     | European VAT number                         |
+ * | Czech Republic | `eu_vat`     | European VAT number                         |
+ * | Denmark        | `eu_vat`     | European VAT number                         |
+ * | Egypt          | `eg_tin`     | Egyptian Tax Identification Number	         |
+ * | Estonia   | `eu_vat`     | European VAT number   |
+ * | EU        | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme                                                   |
+ * | Finland   | `eu_vat`     | European VAT number                                                                                      |
+ * | France    | `eu_vat`     | European VAT number                                                                                      |
+ * | Georgia   | `ge_vat`     | Georgian VAT                                                                                             |
+ * | Germany   | `eu_vat`     | European VAT number                                                                                      |
+ * | Greece    | `eu_vat`     | European VAT number                                                                                      |
+ * | Hong Kong | `hk_br`      | Hong Kong BR number                                                                                      |
+ * | Hungary   | `eu_vat`     | European VAT number                                                                                      |
+ * | Hungary   | `hu_tin`     | Hungary tax number (adószám)	                                                                            |
+ * | Iceland   | `is_vat`     | Icelandic VAT                                                                                            |
+ * | India     | `in_gst`     | Indian GST number                                                                                        |
+ * | Indonesia | `id_npwp`    | Indonesian NPWP number                                                                                   |
+ * | Ireland   | `eu_vat`     | European VAT number                                                                                      |
+ * | Israel    | `il_vat`     | Israel VAT                                                                                               |
+ * | Italy     | `eu_vat`     | European VAT number                                                                                      |
+ * | Japan     | `jp_cn`      | Japanese Corporate Number (*Hōjin Bangō*)                                                                |
+ * | Japan     | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*)	 |
+ * | Japan     | `jp_trn`     | Japanese Tax Registration Number (*Tōroku Bangō*)	                                                       |
+ * | Kenya     | `ke_pin`     | Kenya Revenue Authority Personal Identification Number                                                   |
+ * | Latvia    | `eu_vat`     | European VAT number                                                                                  |
+ * | Liechtenstein | `li_uid`  | Liechtensteinian UID number           |
+ * | Lithuania     | `eu_vat`  | European VAT number	                  |
+ * | Luxembourg    | `eu_vat`  | European VAT number	                  |
+ * | Malaysia      | `my_frp`  | Malaysian FRP number                  |
+ * | Malaysia      | `my_itn`  | Malaysian ITN                         |
+ * | Malaysia      | `my_sst`  | Malaysian SST number                  |
+ * | Malta         | `eu_vat ` | European VAT number                   |
+ * | Mexico        | `mx_rfc`  | Mexican RFC number                    |
+ * | Netherlands   | `eu_vat`  | European VAT number	                  |
+ * | New Zealand   | `nz_gst`  | New Zealand GST number	               |
+ * | Norway        | `no_vat`  | Norwegian VAT number                  |
+ * | Philippines   | `ph_tin	` | Philippines Tax Identification Number |
+ * | Poland        | `eu_vat`  | European VAT number                   |
+ * | Portugal      | `eu_vat`  | European VAT number                   |
+ * | Romania       | `eu_vat`  | European VAT number                   |
+ * | Russia        | `ru_inn`  | Russian INN                           |
+ * | Russia        | `ru_kpp`  | Russian KPP                           |
+ * | Saudi Arabia  | `sg_gst`  | Singaporean GST                       |
+ * | Singapore     | `sg_uen`  | Singaporean UEN	                      |
+ * | Slovakia      | `eu_vat`  | European VAT number                   |
+ * | Slovenia      | `eu_vat`  | European VAT number                   |
+ * | Slovenia             | `si_tin` | Slovenia tax number (davčna številka)	             |
+ * | South Africa	        | `za_vat` | South African VAT number                           |
+ * | South Korea          | `kr_brn` | Korean BRN                                         |
+ * | Spain                | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
+ * | Spain                | `eu_vat` | European VAT number	                               |
+ * | Sweden               | `eu_vat` | European VAT number                                |
+ * | Switzerland          | `ch_vat` | Switzerland VAT number	                            |
+ * | Taiwan               | `tw_vat` | Taiwanese VAT	                                     |
+ * | Thailand             | `th_vat` | Thai VAT                                           |
+ * | Turkey               | `tr_tin` | Turkish Tax Identification Number                  |
+ * | Ukraine              | `ua_vat` | Ukrainian VAT                                      |
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN	                          |
+ * | United Kingdom       | `eu_vat` | Northern Ireland VAT number                        |
+ * | United Kingdom       | `gb_vat` | United Kingdom VAT number                          |
+ * | United States        | `us_ein` | United States EIN                                  |
+ */
+var InvoiceCustomerTaxID = /** @class */ (function (_super) {
+    __extends(InvoiceCustomerTaxID, _super);
+    function InvoiceCustomerTaxID() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "country" }),
+        __metadata("design:type", String)
+    ], InvoiceCustomerTaxID.prototype, "country", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "type" }),
+        __metadata("design:type", String)
+    ], InvoiceCustomerTaxID.prototype, "type", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "value" }),
+        __metadata("design:type", String)
+    ], InvoiceCustomerTaxID.prototype, "value", void 0);
+    return InvoiceCustomerTaxID;
+}(utils_1.SpeakeasyBase));
+exports.InvoiceCustomerTaxID = InvoiceCustomerTaxID;
+var InvoiceDiscount = /** @class */ (function (_super) {
+    __extends(InvoiceDiscount, _super);
+    function InvoiceDiscount() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "amount_discount" }),
+        __metadata("design:type", String)
+    ], InvoiceDiscount.prototype, "amountDiscount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "applies_to_price_ids" }),
+        __metadata("design:type", Array)
+    ], InvoiceDiscount.prototype, "appliesToPriceIds", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "discount_type" }),
+        __metadata("design:type", String)
+    ], InvoiceDiscount.prototype, "discountType", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "percentage_discount" }),
+        __metadata("design:type", Number)
+    ], InvoiceDiscount.prototype, "percentageDiscount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "trial_amount_discount" }),
+        __metadata("design:type", String)
+    ], InvoiceDiscount.prototype, "trialAmountDiscount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "usage_discount" }),
+        __metadata("design:type", Number)
+    ], InvoiceDiscount.prototype, "usageDiscount", void 0);
+    return InvoiceDiscount;
+}(utils_1.SpeakeasyBase));
+exports.InvoiceDiscount = InvoiceDiscount;
+var InvoiceMaximumAmount = /** @class */ (function (_super) {
+    __extends(InvoiceMaximumAmount, _super);
+    function InvoiceMaximumAmount() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "applies_to_price_ids" }),
+        __metadata("design:type", Array)
+    ], InvoiceMaximumAmount.prototype, "appliesToPriceIds", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "maximum_amount" }),
+        __metadata("design:type", String)
+    ], InvoiceMaximumAmount.prototype, "maximumAmount", void 0);
+    return InvoiceMaximumAmount;
+}(utils_1.SpeakeasyBase));
+exports.InvoiceMaximumAmount = InvoiceMaximumAmount;
+var InvoiceMinimumAmount = /** @class */ (function (_super) {
+    __extends(InvoiceMinimumAmount, _super);
+    function InvoiceMinimumAmount() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "applies_to_price_ids" }),
+        __metadata("design:type", Array)
+    ], InvoiceMinimumAmount.prototype, "appliesToPriceIds", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "minimum_amount" }),
+        __metadata("design:type", String)
+    ], InvoiceMinimumAmount.prototype, "minimumAmount", void 0);
+    return InvoiceMinimumAmount;
+}(utils_1.SpeakeasyBase));
+exports.InvoiceMinimumAmount = InvoiceMinimumAmount;
+/**
+ * An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity, representing the request for payment for a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as the result of an action, such as a cancellation.
+ */
+var Invoice = /** @class */ (function (_super) {
+    __extends(Invoice, _super);
+    function Invoice() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "amount_due" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "amountDue", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "auto_collection" }),
+        (0, class_transformer_1.Type)(function () { return autocollection_1.AutoCollection; }),
+        __metadata("design:type", autocollection_1.AutoCollection)
+    ], Invoice.prototype, "autoCollection", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "created_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "createdAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: creditnotesummary_1.CreditNoteSummary }),
+        (0, class_transformer_1.Expose)({ name: "credit_notes" }),
+        (0, class_transformer_1.Type)(function () { return creditnotesummary_1.CreditNoteSummary; }),
+        __metadata("design:type", Array)
+    ], Invoice.prototype, "creditNotes", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "currency" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "currency", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "customer" }),
+        (0, class_transformer_1.Type)(function () { return customerminified_1.CustomerMinified; }),
+        __metadata("design:type", customerminified_1.CustomerMinified)
+    ], Invoice.prototype, "customer", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "customer_balance_transactions" }),
+        (0, class_transformer_1.Type)(function () { return transactions_1.Transactions; }),
+        __metadata("design:type", transactions_1.Transactions)
+    ], Invoice.prototype, "customerBalanceTransactions", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "customer_tax_id" }),
+        (0, class_transformer_1.Type)(function () { return InvoiceCustomerTaxID; }),
+        __metadata("design:type", InvoiceCustomerTaxID)
+    ], Invoice.prototype, "customerTaxId", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "discount" }),
+        (0, class_transformer_1.Type)(function () { return InvoiceDiscount; }),
+        __metadata("design:type", InvoiceDiscount)
+    ], Invoice.prototype, "discount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "due_date" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "dueDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "eligible_for_issue_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "eligibleForIssueAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "hosted_invoice_url" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "hostedInvoiceUrl", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "invoice_date" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "invoiceDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "invoice_number" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "invoiceNumber", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "invoice_pdf" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "invoicePdf", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "issue_failed_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "issueFailedAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "issued_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "issuedAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: invoicelineitem_1.InvoiceLineItem }),
+        (0, class_transformer_1.Expose)({ name: "line_items" }),
+        (0, class_transformer_1.Type)(function () { return invoicelineitem_1.InvoiceLineItem; }),
+        __metadata("design:type", Array)
+    ], Invoice.prototype, "lineItems", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "maximum" }),
+        (0, class_transformer_1.Type)(function () { return InvoiceMaximumAmount; }),
+        __metadata("design:type", InvoiceMaximumAmount)
+    ], Invoice.prototype, "maximum", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "memo" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "memo", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "minimum" }),
+        (0, class_transformer_1.Type)(function () { return InvoiceMinimumAmount; }),
+        __metadata("design:type", InvoiceMinimumAmount)
+    ], Invoice.prototype, "minimum", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "paid_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "paidAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "payment_failed_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "paymentFailedAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "payment_started_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "paymentStartedAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "scheduled_issue_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "scheduledIssueAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "status" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "status", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "subscription" }),
+        (0, class_transformer_1.Type)(function () { return subscriptionminified_1.SubscriptionMinified; }),
+        __metadata("design:type", subscriptionminified_1.SubscriptionMinified)
+    ], Invoice.prototype, "subscription", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "subtotal" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "subtotal", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "sync_failed_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "syncFailedAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "total" }),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "total", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "voided_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Invoice.prototype, "voidedAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "will_auto_issue" }),
+        __metadata("design:type", Boolean)
+    ], Invoice.prototype, "willAutoIssue", void 0);
+    return Invoice;
+}(utils_1.SpeakeasyBase));
+exports.Invoice = Invoice;

package/dist/sdk/models/shared/invoicelineitem.d.ts

@@ -0,0 +1,207 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { BillableMetric } from "./billablemetric";
+import { BpsConfig } from "./bpsconfig";
+import { BulkBpsConfig } from "./bulkbpsconfig";
+import { BulkConfig } from "./bulkconfig";
+import { Cadence } from "./cadence";
+import { DiscountType } from "./discounttype";
+import { MatrixConfig } from "./matrixconfig";
+import { ModelType } from "./modeltype";
+import { PackageConfig } from "./packageconfig";
+import { SubLineItem } from "./sublineitem";
+import { TaxAmount } from "./taxamount";
+import { TieredBpsConfig } from "./tieredbpsconfig";
+import { TieredConfig } from "./tieredconfig";
+import { UnitConfig } from "./unitconfig";
+export declare class InvoiceLineItemDiscount extends SpeakeasyBase {
+    /**
+     * Only available if discount_type is `amount`.
+     */
+    amountDiscount?: string;
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
+     */
+    appliesToPriceIds?: string[];
+    discountType: DiscountType;
+    /**
+     * Only available if discount_type is `percentage`.This is a number between 0 and 1.
+     */
+    percentageDiscount?: number;
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trialAmountDiscount?: string;
+    /**
+     * Only available if discount_type is `usage`. Number of usage units that this discount is for
+     */
+    usageDiscount?: number;
+}
+export declare class InvoiceLineItemMaximumAmount extends SpeakeasyBase {
+    /**
+     * List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
+     */
+    appliesToPriceIds: string[];
+    /**
+     * Maximum amount applied
+     */
+    maximumAmount: string;
+}
+export declare class InvoiceLineItemMinimumAmount extends SpeakeasyBase {
+    /**
+     * List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
+     */
+    appliesToPriceIds: string[];
+    /**
+     * Minimum amount applied
+     */
+    minimumAmount: string;
+}
+export declare class InvoiceLineItemPriceDiscount extends SpeakeasyBase {
+    /**
+     * Only available if discount_type is `amount`.
+     */
+    amountDiscount?: string;
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
+     */
+    appliesToPriceIds?: string[];
+    discountType: DiscountType;
+    /**
+     * Only available if discount_type is `percentage`.This is a number between 0 and 1.
+     */
+    percentageDiscount?: number;
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trialAmountDiscount?: string;
+    /**
+     * Only available if discount_type is `usage`. Number of usage units that this discount is for
+     */
+    usageDiscount?: number;
+}
+export declare class InvoiceLineItemPriceMaximumAmount extends SpeakeasyBase {
+    /**
+     * List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
+     */
+    appliesToPriceIds: string[];
+    /**
+     * Maximum amount applied
+     */
+    maximumAmount: string;
+}
+export declare class InvoiceLineItemPriceMinimumAmount extends SpeakeasyBase {
+    /**
+     * List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
+     */
+    appliesToPriceIds: string[];
+    /**
+     * Minimum amount applied
+     */
+    minimumAmount: string;
+}
+/**
+ * See the [plan reference](plan.tag.mdx) for a detailed discussion of different pricing models
+ */
+export declare class InvoiceLineItemPrice extends SpeakeasyBase {
+    billableMetric?: BillableMetric;
+    /**
+     * Provided when model_type is `bps`
+     */
+    bpsConfig?: BpsConfig;
+    /**
+     * Provided when model_type is `bulk_bps`
+     */
+    bulkBpsConfig?: BulkBpsConfig;
+    /**
+     * Provided when model_type is `bulk`
+     */
+    bulkConfig?: BulkConfig;
+    cadence?: Cadence;
+    createdAt?: Date;
+    /**
+     * An ISO 4217 currency string for this plan's prices.
+     */
+    currency: string;
+    discount: InvoiceLineItemPriceDiscount;
+    /**
+     * If the Price represents a fixed cost, this represents the quantity of units applied. Mutually exclusive with billable_metric.
+     */
+    fixedPriceQuantity?: number;
+    id?: string;
+    /**
+     * Provided when model_type is `matrix`
+     */
+    matrixConfig?: MatrixConfig;
+    maximum?: InvoiceLineItemPriceMaximumAmount;
+    minimum: InvoiceLineItemPriceMinimumAmount;
+    modelType?: ModelType;
+    name?: string;
+    /**
+     * Provided when model_type is `package`
+     */
+    packageConfig?: PackageConfig;
+    /**
+     * The phase order which includes this price, only applicable to a plan with phases.
+     */
+    planPhaseOrder: number;
+    /**
+     * Provided when model_type is `tiered_bps`
+     */
+    tieredBpsConfig?: TieredBpsConfig;
+    /**
+     * Provided when model_type is`tiered`
+     */
+    tieredConfig?: TieredConfig;
+    /**
+     * Provided when model_type is `unit`
+     */
+    unitConfig?: UnitConfig;
+}
+/**
+ * The component line of an [Invoice](../guides/concepts#invoice)
+ */
+export declare class InvoiceLineItem extends SpeakeasyBase {
+    /**
+     * The final amount after any discounts or minimums.
+     */
+    amount: string;
+    discount: InvoiceLineItemDiscount;
+    /**
+     * The end date of the range of time applied for this line item's price.
+     */
+    endDate: Date;
+    /**
+     * [DEPRECATED] For configured prices that are split by a grouping key, this will be populated with the key and a value. The `amount` and `subtotal` will be the values for this particular grouping.
+     *
+     * @deprecated this field will be removed in a future release, please migrate away from it as soon as possible
+     */
+    grouping: string;
+    /**
+     * A unique ID for this line item.
+     */
+    id: string;
+    maximum?: InvoiceLineItemMaximumAmount;
+    minimum: InvoiceLineItemMinimumAmount;
+    /**
+     * The name of the price associated with this line item.
+     */
+    name: string;
+    price: InvoiceLineItemPrice;
+    quantity: number;
+    /**
+     * The start date of the range of time applied for this line item's price.
+     */
+    startDate: Date;
+    /**
+     * For complex pricing structures, the line item can be broken down further in `sub_line_items`.
+     */
+    subLineItems: SubLineItem[];
+    /**
+     * The line amount before any line item-specific discounts or minimums.
+     */
+    subtotal: string;
+    /**
+     * An array of tax rates and their incurred tax amounts. Empty if no tax integration is configured.
+     */
+    taxAmounts: TaxAmount[];
+}