@codat/lending 3.2.0 → 3.3.0

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

@@ -4,6 +4,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreditNoteStatus = void 0;
+/**
+ * Current state of the credit note.
+ */
 var CreditNoteStatus;
 (function (CreditNoteStatus) {
     CreditNoteStatus["Unknown"] = "Unknown";

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

@@ -1,5 +1,8 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class DataConnectionError extends SpeakeasyBase {
+    /**
+     * A brief message about the error.
+     */
     errorMessage?: string;
     /**
      * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
@@ -25,6 +28,12 @@ export declare class DataConnectionError extends SpeakeasyBase {
      * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
      */
     erroredOnUtc?: string;
+    /**
+     * The HTTP status code returned by the error.
+     */
     statusCode?: string;
+    /**
+     * A non-numeric status code/text.
+     */
     statusText?: string;
 }

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

@@ -3,8 +3,17 @@ import { DataIntegrityDetail } from "./dataintegritydetail";
 import { Links } from "./links";
 export declare class DataIntegrityDetails extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: DataIntegrityDetail[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

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

@@ -1,10 +1,63 @@
 import { SpeakeasyBase } from "../../../internal/utils";
+/**
+ * Available Data types
+ */
+export declare enum DataStatusDataTypes {
+    AccountTransactions = "accountTransactions",
+    BalanceSheet = "balanceSheet",
+    BankAccounts = "bankAccounts",
+    BankTransactions = "bankTransactions",
+    BillCreditNotes = "billCreditNotes",
+    BillPayments = "billPayments",
+    Bills = "bills",
+    CashFlowStatement = "cashFlowStatement",
+    ChartOfAccounts = "chartOfAccounts",
+    Company = "company",
+    CreditNotes = "creditNotes",
+    Customers = "customers",
+    DirectCosts = "directCosts",
+    DirectIncomes = "directIncomes",
+    Invoices = "invoices",
+    Items = "items",
+    JournalEntries = "journalEntries",
+    Journals = "journals",
+    PaymentMethods = "paymentMethods",
+    Payments = "payments",
+    ProfitAndLoss = "profitAndLoss",
+    PurchaseOrders = "purchaseOrders",
+    SalesOrders = "salesOrders",
+    Suppliers = "suppliers",
+    TaxRates = "taxRates",
+    TrackingCategories = "trackingCategories",
+    Transfers = "transfers",
+    BankingAccountBalances = "banking-accountBalances",
+    BankingAccounts = "banking-accounts",
+    BankingTransactionCategories = "banking-transactionCategories",
+    BankingTransactions = "banking-transactions",
+    CommerceCompanyInfo = "commerce-companyInfo",
+    CommerceCustomers = "commerce-customers",
+    CommerceDisputes = "commerce-disputes",
+    CommerceLocations = "commerce-locations",
+    CommerceOrders = "commerce-orders",
+    CommercePaymentMethods = "commerce-paymentMethods",
+    CommercePayments = "commerce-payments",
+    CommerceProductCategories = "commerce-productCategories",
+    CommerceProducts = "commerce-products",
+    CommerceTaxComponents = "commerce-taxComponents",
+    CommerceTransactions = "commerce-transactions"
+}
 /**
  * Describes the state of data in the Codat cache for a company and data type
  */
 export declare class DataStatus extends SpeakeasyBase {
+    /**
+     * The current status of the dataset in Codat's cache.
+     */
     currentStatus: string;
-    dataType: string;
+    /**
+     * Available Data types
+     */
+    dataType: DataStatusDataTypes;
     /**
      * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
      *
@@ -29,6 +82,12 @@ export declare class DataStatus extends SpeakeasyBase {
      * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
      */
     lastSuccessfulSync: string;
+    /**
+     * Unique identifier for the most recent successful sync of data type.
+     */
     latestSuccessfulSyncId?: string;
+    /**
+     * Unique identifier for most recent sync of data type.
+     */
     latestSyncId?: string;
 }

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

@@ -27,9 +27,57 @@ 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.DataStatus = void 0;
+exports.DataStatus = exports.DataStatusDataTypes = void 0;
 var utils_1 = require("../../../internal/utils");
 var class_transformer_1 = require("class-transformer");
+/**
+ * Available Data types
+ */
+var DataStatusDataTypes;
+(function (DataStatusDataTypes) {
+    DataStatusDataTypes["AccountTransactions"] = "accountTransactions";
+    DataStatusDataTypes["BalanceSheet"] = "balanceSheet";
+    DataStatusDataTypes["BankAccounts"] = "bankAccounts";
+    DataStatusDataTypes["BankTransactions"] = "bankTransactions";
+    DataStatusDataTypes["BillCreditNotes"] = "billCreditNotes";
+    DataStatusDataTypes["BillPayments"] = "billPayments";
+    DataStatusDataTypes["Bills"] = "bills";
+    DataStatusDataTypes["CashFlowStatement"] = "cashFlowStatement";
+    DataStatusDataTypes["ChartOfAccounts"] = "chartOfAccounts";
+    DataStatusDataTypes["Company"] = "company";
+    DataStatusDataTypes["CreditNotes"] = "creditNotes";
+    DataStatusDataTypes["Customers"] = "customers";
+    DataStatusDataTypes["DirectCosts"] = "directCosts";
+    DataStatusDataTypes["DirectIncomes"] = "directIncomes";
+    DataStatusDataTypes["Invoices"] = "invoices";
+    DataStatusDataTypes["Items"] = "items";
+    DataStatusDataTypes["JournalEntries"] = "journalEntries";
+    DataStatusDataTypes["Journals"] = "journals";
+    DataStatusDataTypes["PaymentMethods"] = "paymentMethods";
+    DataStatusDataTypes["Payments"] = "payments";
+    DataStatusDataTypes["ProfitAndLoss"] = "profitAndLoss";
+    DataStatusDataTypes["PurchaseOrders"] = "purchaseOrders";
+    DataStatusDataTypes["SalesOrders"] = "salesOrders";
+    DataStatusDataTypes["Suppliers"] = "suppliers";
+    DataStatusDataTypes["TaxRates"] = "taxRates";
+    DataStatusDataTypes["TrackingCategories"] = "trackingCategories";
+    DataStatusDataTypes["Transfers"] = "transfers";
+    DataStatusDataTypes["BankingAccountBalances"] = "banking-accountBalances";
+    DataStatusDataTypes["BankingAccounts"] = "banking-accounts";
+    DataStatusDataTypes["BankingTransactionCategories"] = "banking-transactionCategories";
+    DataStatusDataTypes["BankingTransactions"] = "banking-transactions";
+    DataStatusDataTypes["CommerceCompanyInfo"] = "commerce-companyInfo";
+    DataStatusDataTypes["CommerceCustomers"] = "commerce-customers";
+    DataStatusDataTypes["CommerceDisputes"] = "commerce-disputes";
+    DataStatusDataTypes["CommerceLocations"] = "commerce-locations";
+    DataStatusDataTypes["CommerceOrders"] = "commerce-orders";
+    DataStatusDataTypes["CommercePaymentMethods"] = "commerce-paymentMethods";
+    DataStatusDataTypes["CommercePayments"] = "commerce-payments";
+    DataStatusDataTypes["CommerceProductCategories"] = "commerce-productCategories";
+    DataStatusDataTypes["CommerceProducts"] = "commerce-products";
+    DataStatusDataTypes["CommerceTaxComponents"] = "commerce-taxComponents";
+    DataStatusDataTypes["CommerceTransactions"] = "commerce-transactions";
+})(DataStatusDataTypes = exports.DataStatusDataTypes || (exports.DataStatusDataTypes = {}));
 /**
  * Describes the state of data in the Codat cache for a company and data type
  */

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

@@ -11,6 +11,17 @@ export declare class EnhancedCashFlowTransaction extends SpeakeasyBase {
      * The bank transaction amount.
      */
     amount?: number;
+    /**
+     * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
+     *
+     * @remarks
+     *
+     * ## Unknown currencies
+     *
+     * In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.
+     *
+     * There are only a very small number of edge cases where this currency code is returned by the Codat system.
+     */
     currency?: string;
     /**
      * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

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

@@ -14,7 +14,7 @@ import { ReportInfo } from "./reportinfo";
 export declare class EnhancedCashFlowTransactions extends SpeakeasyBase {
     dataSources?: DataSource[];
     /**
-     * Report additional information, which is specific to Assess reports
+     * Report additional information, which is specific to Lending API reports.
      */
     reportInfo?: ReportInfo;
     reportItems?: EnhancedCashFlowItem[];

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

@@ -3,6 +3,9 @@ import { InvoiceStatus } from "./invoicestatus";
 import { LendingCustomerRef } from "./lendingcustomerref";
 import { Payment } from "./payment";
 export declare class EnhancedInvoiceReportItem extends SpeakeasyBase {
+    /**
+     * Invoice's total amount due.
+     */
     amountDue?: number;
     /**
      * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
@@ -42,9 +45,12 @@ export declare class EnhancedInvoiceReportItem extends SpeakeasyBase {
      */
     dueDate?: string;
     /**
-     * ID of the invoice, which may be a GUID but it may be something else depending on the accounting platdform
+     * ID of the invoice, which may be a GUID but it may be something else depending on the accounting platform.
      */
     id?: string;
+    /**
+     * Invoice number.
+     */
     invoiceNumber?: string;
     /**
      * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
@@ -109,5 +115,8 @@ export declare class EnhancedInvoiceReportItem extends SpeakeasyBase {
      * - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account.
      */
     status?: InvoiceStatus;
+    /**
+     * Invoice's total amount.
+     */
     totalAmount?: number;
 }

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

@@ -6,7 +6,7 @@ import { ReportInfo } from "./reportinfo";
  */
 export declare class EnhancedInvoicesReport extends SpeakeasyBase {
     /**
-     * Report additional information, which is specific to Assess reports
+     * Report additional information, which is specific to Lending API reports.
      */
     reportInfo?: ReportInfo;
     reportItems?: EnhancedInvoiceReportItem[];

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

@@ -1,9 +1,27 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class ErrorMessage extends SpeakeasyBase {
+    /**
+     * `True` if the error occurred transiently and can be retried.
+     */
     canBeRetried?: string;
+    /**
+     * Unique identifier used to propagate to all downstream services and determine the source of the error.
+     */
     correlationId?: string;
+    /**
+     * Machine readable error code used to automate processes based on the code returned.
+     */
     detailedErrorCode?: number;
+    /**
+     * A brief description of the error.
+     */
     error?: string;
+    /**
+     * Codat's service the returned the error.
+     */
     service?: string;
+    /**
+     * The HTTP status code returned by the error.
+     */
     statusCode?: number;
 }

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

@@ -1,7 +1,16 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class File extends SpeakeasyBase {
+    /**
+     * An optional display name for the file.
+     */
     displayName?: string;
+    /**
+     * The file's name.
+     */
     fileName?: string;
+    /**
+     * The source of the file uploaded.
+     */
     sourceType?: string;
     /**
      * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

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

@@ -1,4 +1,7 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class HalRef extends SpeakeasyBase {
+    /**
+     * Uri hypertext reference.
+     */
     href?: string;
 }

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

@@ -29,10 +29,10 @@ export * from "./accountingbills";
 export * from "./accountingcashflowstatement";
 export * from "./accountingcompanyinfo";
 export * from "./accountingcreateaccountresponse";
-export * from "./accountingcreatebankaccountresponse";
 export * from "./accountingcreatebanktransactions";
 export * from "./accountingcreatebanktransactionsresponse";
 export * from "./accountingcreatedirectcostresponse";
+export * from "./accountingcreatepaymentresponse";
 export * from "./accountingcreatesupplierresponse";
 export * from "./accountingcreatetransferresponse";
 export * from "./accountingcreditnote";
@@ -201,7 +201,7 @@ export * from "./paymentallocationpayment";
 export * from "./paymentline";
 export * from "./paymentlinelink";
 export * from "./paymentlinktype";
-export * from "./paymentmethodstatus";
+export * from "./paymentmethodref";
 export * from "./paymentref";
 export * from "./paymentstatus";
 export * from "./paymenttype";

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

@@ -48,10 +48,10 @@ __exportStar(require("./accountingbills"), exports);
 __exportStar(require("./accountingcashflowstatement"), exports);
 __exportStar(require("./accountingcompanyinfo"), exports);
 __exportStar(require("./accountingcreateaccountresponse"), exports);
-__exportStar(require("./accountingcreatebankaccountresponse"), exports);
 __exportStar(require("./accountingcreatebanktransactions"), exports);
 __exportStar(require("./accountingcreatebanktransactionsresponse"), exports);
 __exportStar(require("./accountingcreatedirectcostresponse"), exports);
+__exportStar(require("./accountingcreatepaymentresponse"), exports);
 __exportStar(require("./accountingcreatesupplierresponse"), exports);
 __exportStar(require("./accountingcreatetransferresponse"), exports);
 __exportStar(require("./accountingcreditnote"), exports);
@@ -220,7 +220,7 @@ __exportStar(require("./paymentallocationpayment"), exports);
 __exportStar(require("./paymentline"), exports);
 __exportStar(require("./paymentlinelink"), exports);
 __exportStar(require("./paymentlinktype"), exports);
-__exportStar(require("./paymentmethodstatus"), exports);
+__exportStar(require("./paymentmethodref"), exports);
 __exportStar(require("./paymentref"), exports);
 __exportStar(require("./paymentstatus"), exports);
 __exportStar(require("./paymenttype"), exports);

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

@@ -21,6 +21,9 @@ export declare class InvoiceLineItem extends SpeakeasyBase {
      * Percentage rate (from 0 to 100) of any discounts applied to the unit amount.
      */
     discountPercentage?: number;
+    /**
+     * The invoice is a direct income if `True`.
+     */
     isDirectIncome?: boolean;
     /**
      * Reference to the item the line is linked to.

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

@@ -1,5 +1,11 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class Items extends SpeakeasyBase {
+    /**
+     * Amount of tax withheld.
+     */
     amount: number;
+    /**
+     * Name assigned to withheld tax.
+     */
     name: string;
 }

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

@@ -1,11 +1,11 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class LendingCustomerRef extends SpeakeasyBase {
     /**
-     * `customerName` from the Customer data type
+     * `customerName` from the Customer data type.
      */
     customerName?: string;
     /**
-     * `id` from the Customers data type
+     * `id` from the Customers data type.
      */
     id?: string;
 }

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

@@ -9,6 +9,10 @@ export declare class LoanSummaryReportItem extends SpeakeasyBase {
      * The description of the object being referred to. E.g. the account.
      */
     description?: string;
+    /**
+     * The name of lender providing the loan.
+     */
+    lenderName?: string;
     recordRef?: LoanSummaryRecordRef;
     /**
      * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

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

@@ -46,6 +46,11 @@ var LoanSummaryReportItem = /** @class */ (function (_super) {
         (0, class_transformer_1.Expose)({ name: "description" }),
         __metadata("design:type", String)
     ], LoanSummaryReportItem.prototype, "description", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "lenderName" }),
+        __metadata("design:type", String)
+    ], LoanSummaryReportItem.prototype, "lenderName", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "recordRef" }),

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

@@ -5,7 +5,7 @@ export declare class OrderDiscountAllocation extends SpeakeasyBase {
      */
     name?: string;
     /**
-     * Total amount of discount applied.
+     * Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line).
      */
     totalAmount?: number;
 }

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

@@ -21,12 +21,12 @@ export declare class OrderLineItem extends SpeakeasyBase {
      * Number of units of the product sold.
      *
      * @remarks
-     * For refunds, quantity is a negative value.
+     * For refunds, quantity is negative.
      *
      */
     quantity?: number;
     /**
-     * Percentage rate (from 0 to 100) of any sale tax applied to the unit amount.
+     * Percentage rate (from 0 to 100) of any sales tax applied to the unit price.
      */
     taxPercentage?: number;
     /**
@@ -34,15 +34,15 @@ export declare class OrderLineItem extends SpeakeasyBase {
      */
     taxes?: TaxComponentAllocation[];
     /**
-     * Total price of the line item, including discounts, tax and minus any refunds.
+     * Total amount of the line item, including discounts and tax.
      */
     totalAmount?: number;
     /**
-     * Total amount of tax applied to the line item.
+     * Total amount of tax applied to the line item, factoring in any discounts.
      */
     totalTaxAmount?: number;
     /**
-     * Price per unit of goods or service.
+     * Price per unit of goods or services, excluding discounts and tax.
      */
     unitPrice?: number;
 }

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

@@ -1,6 +1,9 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 import { BankingTransactionRef } from "./bankingtransactionref";
 export declare class Payment extends SpeakeasyBase {
+    /**
+     * Payment amount.
+     */
     amount?: number;
     bankingTransactionRefs?: BankingTransactionRef[];
     /**
@@ -70,8 +73,11 @@ export declare class Payment extends SpeakeasyBase {
      */
     date?: string;
     /**
-     * ID of the invoice, which may be a GUID but it may be something else depending on the accounting platform
+     * ID of the invoice, which may be a GUID but it may be something else depending on the accounting platform.
      */
     id?: string;
+    /**
+     * The type of payment.
+     */
     paymentType?: string;
 }

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

@@ -0,0 +1,14 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+/**
+ * The payment method the record is linked to in the accounting or commerce platform.
+ */
+export declare class PaymentMethodRef extends SpeakeasyBase {
+    /**
+     * The unique identifier of the location being referenced.
+     */
+    id: string;
+    /**
+     * Name of the location being referenced.
+     */
+    name?: string;
+}

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

@@ -0,0 +1,53 @@
+"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.PaymentMethodRef = void 0;
+var utils_1 = require("../../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+/**
+ * The payment method the record is linked to in the accounting or commerce platform.
+ */
+var PaymentMethodRef = /** @class */ (function (_super) {
+    __extends(PaymentMethodRef, _super);
+    function PaymentMethodRef() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], PaymentMethodRef.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "name" }),
+        __metadata("design:type", String)
+    ], PaymentMethodRef.prototype, "name", void 0);
+    return PaymentMethodRef;
+}(utils_1.SpeakeasyBase));
+exports.PaymentMethodRef = PaymentMethodRef;

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

@@ -5,5 +5,8 @@ import { ProductInventoryLocation } from "./productinventorylocation";
  */
 export declare class ProductInventory extends SpeakeasyBase {
     locations?: ProductInventoryLocation[];
+    /**
+     * The total quantity of stock remaining across locations.
+     */
     totalQuantity?: number;
 }

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

@@ -5,5 +5,8 @@ export declare class ProductInventoryLocation extends SpeakeasyBase {
      * Reference to the geographic location where the order was placed.
      */
     locationRef?: LocationRef;
+    /**
+     * The quantity of stock remaining at location.
+     */
     quantity?: number;
 }

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

@@ -12,5 +12,8 @@ export declare class ProductPrice extends SpeakeasyBase {
      * There are only a very small number of edge cases where this currency code is returned by the Codat system.
      */
     currency?: string;
+    /**
+     * The product variant's unit price.
+     */
     unitPrice?: number;
 }

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

@@ -4,7 +4,7 @@ import { SpeakeasyBase } from "../../../internal/utils";
  */
 export declare class ProductRef extends SpeakeasyBase {
     /**
-     * The unique identitifer of the product being referenced.
+     * The unique identifier of the product being referenced.
      */
     id: string;
     /**

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

@@ -67,6 +67,9 @@ export declare class ProductVariant extends SpeakeasyBase {
      */
     sku?: string;
     sourceModifiedDate?: string;
+    /**
+     * The status of the product variant.
+     */
     status?: ProductVariantStatus;
     /**
      * Unit of measure for the variant, such as `kg` or `meters`.

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

@@ -4,7 +4,7 @@ import { SpeakeasyBase } from "../../../internal/utils";
  */
 export declare class ProductVariantRef extends SpeakeasyBase {
     /**
-     * The unique identitifer of the product variant being referenced.
+     * The unique identifier of the product variant being referenced.
      */
     id: string;
     /**

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

@@ -1,3 +1,6 @@
+/**
+ * The status of the product variant.
+ */
 export declare enum ProductVariantStatus {
     Unknown = "Unknown",
     Published = "Published",

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

@@ -4,6 +4,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProductVariantStatus = void 0;
+/**
+ * The status of the product variant.
+ */
 var ProductVariantStatus;
 (function (ProductVariantStatus) {
     ProductVariantStatus["Unknown"] = "Unknown";