@codat/lending 3.1.0 → 3.2.0

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

@@ -0,0 +1,99 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { AccountingTransfer } from "./accountingtransfer";
+import { DataType } from "./datatype";
+import { PushOperationChange } from "./pushoperationchange";
+import { PushOperationStatus } from "./pushoperationstatus";
+import { Validation } from "./validation";
+export declare class AccountingCreateTransferResponse extends SpeakeasyBase {
+    /**
+     * Contains a single entry that communicates which record has changed and the manner in which it changed.
+     */
+    changes?: PushOperationChange[];
+    /**
+     * Unique identifier for your SMB in Codat.
+     */
+    companyId: 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:
+     *
+     * @remarks
+     *
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
+     *
+     *
+     *
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+     *
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+     *
+     * > Time zones
+     * >
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     */
+    completedOnUtc?: string;
+    /**
+     * > View the coverage for transfers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers" target="_blank">Data coverage explorer</a>.
+     *
+     * @remarks
+     *
+     * A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+     */
+    data?: AccountingTransfer;
+    /**
+     * Unique identifier for a company's data connection.
+     */
+    dataConnectionKey: string;
+    /**
+     * Available Data types
+     */
+    dataType?: DataType;
+    errorMessage?: string;
+    /**
+     * A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.
+     */
+    pushOperationKey: 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:
+     *
+     * @remarks
+     *
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
+     *
+     *
+     *
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+     *
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+     *
+     * > Time zones
+     * >
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     */
+    requestedOnUtc: string;
+    /**
+     * The current status of the push operation.
+     */
+    status: PushOperationStatus;
+    statusCode: number;
+    timeoutInMinutes?: number;
+    /**
+     * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    timeoutInSeconds?: number;
+    /**
+     * A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.
+     */
+    validation?: Validation;
+}

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

@@ -0,0 +1,118 @@
+"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.AccountingCreateTransferResponse = void 0;
+var utils_1 = require("../../../internal/utils");
+var accountingtransfer_1 = require("./accountingtransfer");
+var datatype_1 = require("./datatype");
+var pushoperationchange_1 = require("./pushoperationchange");
+var pushoperationstatus_1 = require("./pushoperationstatus");
+var validation_1 = require("./validation");
+var class_transformer_1 = require("class-transformer");
+var AccountingCreateTransferResponse = /** @class */ (function (_super) {
+    __extends(AccountingCreateTransferResponse, _super);
+    function AccountingCreateTransferResponse() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: pushoperationchange_1.PushOperationChange }),
+        (0, class_transformer_1.Expose)({ name: "changes" }),
+        (0, class_transformer_1.Type)(function () { return pushoperationchange_1.PushOperationChange; }),
+        __metadata("design:type", Array)
+    ], AccountingCreateTransferResponse.prototype, "changes", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "companyId" }),
+        __metadata("design:type", String)
+    ], AccountingCreateTransferResponse.prototype, "companyId", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "completedOnUtc" }),
+        __metadata("design:type", String)
+    ], AccountingCreateTransferResponse.prototype, "completedOnUtc", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "data" }),
+        (0, class_transformer_1.Type)(function () { return accountingtransfer_1.AccountingTransfer; }),
+        __metadata("design:type", accountingtransfer_1.AccountingTransfer)
+    ], AccountingCreateTransferResponse.prototype, "data", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "dataConnectionKey" }),
+        __metadata("design:type", String)
+    ], AccountingCreateTransferResponse.prototype, "dataConnectionKey", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "dataType" }),
+        __metadata("design:type", String)
+    ], AccountingCreateTransferResponse.prototype, "dataType", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "errorMessage" }),
+        __metadata("design:type", String)
+    ], AccountingCreateTransferResponse.prototype, "errorMessage", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "pushOperationKey" }),
+        __metadata("design:type", String)
+    ], AccountingCreateTransferResponse.prototype, "pushOperationKey", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "requestedOnUtc" }),
+        __metadata("design:type", String)
+    ], AccountingCreateTransferResponse.prototype, "requestedOnUtc", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "status" }),
+        __metadata("design:type", String)
+    ], AccountingCreateTransferResponse.prototype, "status", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "statusCode" }),
+        __metadata("design:type", Number)
+    ], AccountingCreateTransferResponse.prototype, "statusCode", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "timeoutInMinutes" }),
+        __metadata("design:type", Number)
+    ], AccountingCreateTransferResponse.prototype, "timeoutInMinutes", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "timeoutInSeconds" }),
+        __metadata("design:type", Number)
+    ], AccountingCreateTransferResponse.prototype, "timeoutInSeconds", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "validation" }),
+        (0, class_transformer_1.Type)(function () { return validation_1.Validation; }),
+        __metadata("design:type", validation_1.Validation)
+    ], AccountingCreateTransferResponse.prototype, "validation", void 0);
+    return AccountingCreateTransferResponse;
+}(utils_1.SpeakeasyBase));
+exports.AccountingCreateTransferResponse = AccountingCreateTransferResponse;

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

@@ -0,0 +1,31 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+export declare class CreateBankAccountTransaction extends SpeakeasyBase {
+    amount?: number;
+    balance?: number;
+    /**
+     * 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:
+     *
+     * @remarks
+     *
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
+     *
+     *
+     *
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+     *
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+     *
+     * > Time zones
+     * >
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     */
+    date?: string;
+    description?: string;
+    id?: string;
+}

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

@@ -0,0 +1,65 @@
+"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.CreateBankAccountTransaction = void 0;
+var utils_1 = require("../../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+var CreateBankAccountTransaction = /** @class */ (function (_super) {
+    __extends(CreateBankAccountTransaction, _super);
+    function CreateBankAccountTransaction() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "amount" }),
+        __metadata("design:type", Number)
+    ], CreateBankAccountTransaction.prototype, "amount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "balance" }),
+        __metadata("design:type", Number)
+    ], CreateBankAccountTransaction.prototype, "balance", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "date" }),
+        __metadata("design:type", String)
+    ], CreateBankAccountTransaction.prototype, "date", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "description" }),
+        __metadata("design:type", String)
+    ], CreateBankAccountTransaction.prototype, "description", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], CreateBankAccountTransaction.prototype, "id", void 0);
+    return CreateBankAccountTransaction;
+}(utils_1.SpeakeasyBase));
+exports.CreateBankAccountTransaction = CreateBankAccountTransaction;

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

@@ -28,6 +28,13 @@ export * from "./accountingbillpayments";
 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 "./accountingcreatesupplierresponse";
+export * from "./accountingcreatetransferresponse";
 export * from "./accountingcreditnote";
 export * from "./accountingcreditnotes";
 export * from "./accountingcustomer";
@@ -126,6 +133,7 @@ export * from "./connection";
 export * from "./connections";
 export * from "./contact";
 export * from "./contactref";
+export * from "./createbankaccounttransaction";
 export * from "./creditnotelineitem";
 export * from "./creditnotestatus";
 export * from "./customerstatus";
@@ -211,6 +219,18 @@ export * from "./profitandlossreport";
 export * from "./projectref";
 export * from "./pulloperation";
 export * from "./pulloperations";
+export * from "./pushchangetype";
+export * from "./pushfieldvalidation";
+export * from "./pushoperation";
+export * from "./pushoperationchange";
+export * from "./pushoperationref";
+export * from "./pushoperations";
+export * from "./pushoperationstatus";
+export * from "./pushoption";
+export * from "./pushoptionchoice";
+export * from "./pushoptionproperty";
+export * from "./pushoptiontype";
+export * from "./pushvalidationinfo";
 export * from "./recordref";
 export * from "./reportbasis";
 export * from "./reportcomponentmeasure";
@@ -238,4 +258,6 @@ export * from "./transactionsourceref";
 export * from "./transactionsourcetype";
 export * from "./transactiontype";
 export * from "./transferaccount";
+export * from "./validation";
+export * from "./validationitem";
 export * from "./weblink";

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

@@ -47,6 +47,13 @@ __exportStar(require("./accountingbillpayments"), exports);
 __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("./accountingcreatesupplierresponse"), exports);
+__exportStar(require("./accountingcreatetransferresponse"), exports);
 __exportStar(require("./accountingcreditnote"), exports);
 __exportStar(require("./accountingcreditnotes"), exports);
 __exportStar(require("./accountingcustomer"), exports);
@@ -145,6 +152,7 @@ __exportStar(require("./connection"), exports);
 __exportStar(require("./connections"), exports);
 __exportStar(require("./contact"), exports);
 __exportStar(require("./contactref"), exports);
+__exportStar(require("./createbankaccounttransaction"), exports);
 __exportStar(require("./creditnotelineitem"), exports);
 __exportStar(require("./creditnotestatus"), exports);
 __exportStar(require("./customerstatus"), exports);
@@ -230,6 +238,18 @@ __exportStar(require("./profitandlossreport"), exports);
 __exportStar(require("./projectref"), exports);
 __exportStar(require("./pulloperation"), exports);
 __exportStar(require("./pulloperations"), exports);
+__exportStar(require("./pushchangetype"), exports);
+__exportStar(require("./pushfieldvalidation"), exports);
+__exportStar(require("./pushoperation"), exports);
+__exportStar(require("./pushoperationchange"), exports);
+__exportStar(require("./pushoperationref"), exports);
+__exportStar(require("./pushoperations"), exports);
+__exportStar(require("./pushoperationstatus"), exports);
+__exportStar(require("./pushoption"), exports);
+__exportStar(require("./pushoptionchoice"), exports);
+__exportStar(require("./pushoptionproperty"), exports);
+__exportStar(require("./pushoptiontype"), exports);
+__exportStar(require("./pushvalidationinfo"), exports);
 __exportStar(require("./recordref"), exports);
 __exportStar(require("./reportbasis"), exports);
 __exportStar(require("./reportcomponentmeasure"), exports);
@@ -257,4 +277,6 @@ __exportStar(require("./transactionsourceref"), exports);
 __exportStar(require("./transactionsourcetype"), exports);
 __exportStar(require("./transactiontype"), exports);
 __exportStar(require("./transferaccount"), exports);
+__exportStar(require("./validation"), exports);
+__exportStar(require("./validationitem"), exports);
 __exportStar(require("./weblink"), exports);

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

@@ -0,0 +1,7 @@
+export declare enum PushChangeType {
+    Unknown = "Unknown",
+    Created = "Created",
+    Modified = "Modified",
+    Deleted = "Deleted",
+    AttachmentUploaded = "AttachmentUploaded"
+}

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

@@ -0,0 +1,14 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushChangeType = void 0;
+var PushChangeType;
+(function (PushChangeType) {
+    PushChangeType["Unknown"] = "Unknown";
+    PushChangeType["Created"] = "Created";
+    PushChangeType["Modified"] = "Modified";
+    PushChangeType["Deleted"] = "Deleted";
+    PushChangeType["AttachmentUploaded"] = "AttachmentUploaded";
+})(PushChangeType = exports.PushChangeType || (exports.PushChangeType = {}));

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

@@ -0,0 +1,6 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+export declare class PushFieldValidation extends SpeakeasyBase {
+    details: string;
+    field?: string;
+    ref?: string;
+}

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

@@ -0,0 +1,55 @@
+"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.PushFieldValidation = void 0;
+var utils_1 = require("../../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+var PushFieldValidation = /** @class */ (function (_super) {
+    __extends(PushFieldValidation, _super);
+    function PushFieldValidation() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "details" }),
+        __metadata("design:type", String)
+    ], PushFieldValidation.prototype, "details", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "field" }),
+        __metadata("design:type", String)
+    ], PushFieldValidation.prototype, "field", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "ref" }),
+        __metadata("design:type", String)
+    ], PushFieldValidation.prototype, "ref", void 0);
+    return PushFieldValidation;
+}(utils_1.SpeakeasyBase));
+exports.PushFieldValidation = PushFieldValidation;

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

@@ -0,0 +1,90 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { DataType } from "./datatype";
+import { PushOperationChange } from "./pushoperationchange";
+import { PushOperationStatus } from "./pushoperationstatus";
+import { Validation } from "./validation";
+export declare class PushOperation extends SpeakeasyBase {
+    /**
+     * Contains a single entry that communicates which record has changed and the manner in which it changed.
+     */
+    changes?: PushOperationChange[];
+    /**
+     * Unique identifier for your SMB in Codat.
+     */
+    companyId: 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:
+     *
+     * @remarks
+     *
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
+     *
+     *
+     *
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+     *
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+     *
+     * > Time zones
+     * >
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     */
+    completedOnUtc?: string;
+    /**
+     * Unique identifier for a company's data connection.
+     */
+    dataConnectionKey: string;
+    /**
+     * Available Data types
+     */
+    dataType?: DataType;
+    errorMessage?: string;
+    /**
+     * A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.
+     */
+    pushOperationKey: 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:
+     *
+     * @remarks
+     *
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
+     *
+     *
+     *
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+     *
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+     *
+     * > Time zones
+     * >
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     */
+    requestedOnUtc: string;
+    /**
+     * The current status of the push operation.
+     */
+    status: PushOperationStatus;
+    statusCode: number;
+    timeoutInMinutes?: number;
+    /**
+     * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    timeoutInSeconds?: number;
+    /**
+     * A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.
+     */
+    validation?: Validation;
+}