@codat/lending 0.1.0 → 1.2.0

package/dist/sdk/accountsreceivablecreditnotes.d.ts

@@ -0,0 +1,34 @@
+import * as utils from "../internal/utils";
+import * as operations from "./models/operations";
+import { SDKConfiguration } from "./sdk";
+import { AxiosRequestConfig } from "axios";
+export declare class AccountsReceivableCreditNotes {
+    private sdkConfiguration;
+    constructor(sdkConfig: SDKConfiguration);
+    /**
+     * Get credit note
+     *
+     * @remarks
+     * The *Get credit note* endpoint returns a single credit note for a given creditNoteId.
+     *
+     * [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support getting a specific credit note.
+     *
+     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+     *
+     */
+    get(req: operations.GetAccountingCreditNoteRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingCreditNoteResponse>;
+    /**
+     * List credit notes
+     *
+     * @remarks
+     * The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection.
+     *
+     * [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
+     *
+     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+     *
+     */
+    list(req: operations.ListAccountingCreditNotesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingCreditNotesResponse>;
+}

package/dist/sdk/accountsreceivablecreditnotes.js

@@ -0,0 +1,262 @@
+"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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountsReceivableCreditNotes = 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"));
+var AccountsReceivableCreditNotes = /** @class */ (function () {
+    function AccountsReceivableCreditNotes(sdkConfig) {
+        this.sdkConfiguration = sdkConfig;
+    }
+    /**
+     * Get credit note
+     *
+     * @remarks
+     * The *Get credit note* endpoint returns a single credit note for a given creditNoteId.
+     *
+     * [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support getting a specific credit note.
+     *
+     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+     *
+     */
+    AccountsReceivableCreditNotes.prototype.get = function (req, retries, config) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var baseURL, url, client, globalSecurity, properties, headers, globalRetryConfig, retryConfig, httpRes, contentType, res, decodedRes;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!(req instanceof utils.SpeakeasyBase)) {
+                            req = new operations.GetAccountingCreditNoteRequest(req);
+                        }
+                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
+                        url = utils.generateURL(baseURL, "/companies/{companyId}/data/creditNotes/{creditNoteId}", 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);
+                        headers["Accept"] = "application/json";
+                        headers["user-agent"] = "speakeasy-sdk/".concat(this.sdkConfiguration.language, " ").concat(this.sdkConfiguration.sdkVersion, " ").concat(this.sdkConfiguration.genVersion, " ").concat(this.sdkConfiguration.openapiDocVersion);
+                        globalRetryConfig = this.sdkConfiguration.retryConfig;
+                        retryConfig = retries;
+                        if (!retryConfig) {
+                            if (globalRetryConfig) {
+                                retryConfig = globalRetryConfig;
+                            }
+                            else {
+                                retryConfig = new utils.RetryConfig("backoff", new utils.BackoffStrategy(500, 60000, 1.5, 3600000), true);
+                            }
+                        }
+                        return [4 /*yield*/, utils.Retry(function () {
+                                return client.request(__assign({ validateStatus: function () { return true; }, url: url, method: "get", headers: headers, responseType: "arraybuffer" }, config));
+                            }, new utils.Retries(retryConfig, ["408", "429", "5XX"]))];
+                    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.GetAccountingCreditNoteResponse({
+                            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.accountingCreditNote = utils.objectToClass(JSON.parse(decodedRes), shared.AccountingCreditNote);
+                                }
+                                else {
+                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
+                                }
+                                break;
+                            case [401, 404, 409, 429].includes(httpRes === null || httpRes === void 0 ? void 0 : httpRes.status):
+                                if (utils.matchContentType(contentType, "application/json")) {
+                                    res.errorMessage = utils.objectToClass(JSON.parse(decodedRes), shared.ErrorMessage);
+                                }
+                                else {
+                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
+                                }
+                                break;
+                        }
+                        return [2 /*return*/, res];
+                }
+            });
+        });
+    };
+    /**
+     * List credit notes
+     *
+     * @remarks
+     * The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection.
+     *
+     * [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
+     *
+     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+     *
+     */
+    AccountsReceivableCreditNotes.prototype.list = function (req, retries, config) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var baseURL, url, client, globalSecurity, properties, headers, queryParams, globalRetryConfig, retryConfig, httpRes, contentType, res, decodedRes;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!(req instanceof utils.SpeakeasyBase)) {
+                            req = new operations.ListAccountingCreditNotesRequest(req);
+                        }
+                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
+                        url = utils.generateURL(baseURL, "/companies/{companyId}/data/creditNotes", 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"] = "speakeasy-sdk/".concat(this.sdkConfiguration.language, " ").concat(this.sdkConfiguration.sdkVersion, " ").concat(this.sdkConfiguration.genVersion, " ").concat(this.sdkConfiguration.openapiDocVersion);
+                        globalRetryConfig = this.sdkConfiguration.retryConfig;
+                        retryConfig = retries;
+                        if (!retryConfig) {
+                            if (globalRetryConfig) {
+                                retryConfig = globalRetryConfig;
+                            }
+                            else {
+                                retryConfig = new utils.RetryConfig("backoff", new utils.BackoffStrategy(500, 60000, 1.5, 3600000), true);
+                            }
+                        }
+                        return [4 /*yield*/, utils.Retry(function () {
+                                return client.request(__assign({ validateStatus: function () { return true; }, url: url + queryParams, method: "get", headers: headers, responseType: "arraybuffer" }, config));
+                            }, new utils.Retries(retryConfig, ["408", "429", "5XX"]))];
+                    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.ListAccountingCreditNotesResponse({
+                            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.accountingCreditNotes = utils.objectToClass(JSON.parse(decodedRes), shared.AccountingCreditNotes);
+                                }
+                                else {
+                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
+                                }
+                                break;
+                            case [400, 401, 404, 409].includes(httpRes === null || httpRes === void 0 ? void 0 : httpRes.status):
+                                if (utils.matchContentType(contentType, "application/json")) {
+                                    res.errorMessage = utils.objectToClass(JSON.parse(decodedRes), shared.ErrorMessage);
+                                }
+                                else {
+                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
+                                }
+                                break;
+                        }
+                        return [2 /*return*/, res];
+                }
+            });
+        });
+    };
+    return AccountsReceivableCreditNotes;
+}());
+exports.AccountsReceivableCreditNotes = AccountsReceivableCreditNotes;

package/dist/sdk/accountsreceivablecustomers.d.ts

@@ -0,0 +1,74 @@
+import * as utils from "../internal/utils";
+import * as operations from "./models/operations";
+import { SDKConfiguration } from "./sdk";
+import { AxiosRequestConfig } from "axios";
+export declare enum DownloadAttachmentAcceptEnum {
+    applicationJson = "application/json",
+    applicationOctetStream = "application/octet-stream"
+}
+export declare class AccountsReceivableCustomers {
+    private sdkConfiguration;
+    constructor(sdkConfig: SDKConfiguration);
+    /**
+     * Download customer attachment
+     *
+     * @remarks
+     * The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`.
+     *
+     * [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support downloading a customer attachment.
+     *
+     */
+    downloadAttachment(req: operations.DownloadAccountingCustomerAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig, acceptHeaderOverride?: DownloadAttachmentAcceptEnum): Promise<operations.DownloadAccountingCustomerAttachmentResponse>;
+    /**
+     * Get customer
+     *
+     * @remarks
+     * The *Get customer* endpoint returns a single customer for a given customerId.
+     *
+     * [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer.
+     *
+     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+     *
+     */
+    get(req: operations.GetAccountingCustomerRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingCustomerResponse>;
+    /**
+     * Get customer attachment
+     *
+     * @remarks
+     * The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`.
+     *
+     * [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a customer attachment.
+     *
+     */
+    getAttachment(req: operations.GetAccountingCustomerAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingCustomerAttachmentResponse>;
+    /**
+     * List customers
+     *
+     * @remarks
+     * The *List customers* endpoint returns a list of [customers](https://docs.codat.io/accounting-api#/schemas/Customer) for a given company's connection.
+     *
+     * [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
+     *
+     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+     *
+     */
+    list(req: operations.ListAccountingCustomersRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingCustomersResponse>;
+    /**
+     * List customer attachments
+     *
+     * @remarks
+     * The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`.
+     *
+     * [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support listing customer attachments.
+     *
+     */
+    listAttachments(req: operations.ListAccountingCustomerAttachmentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingCustomerAttachmentsResponse>;
+}