@codat/lending 0.1.0 → 1.2.0

package/dist/sdk/accountsreceivable.d.ts

@@ -1,289 +1,17 @@
-import * as utils from "../internal/utils";
-import * as operations from "./models/operations";
+import { AccountsReceivableCreditNotes } from "./accountsreceivablecreditnotes";
+import { AccountsReceivableCustomers } from "./accountsreceivablecustomers";
+import { AccountsReceivableDirectIncomes } from "./accountsreceivabledirectincomes";
+import { AccountsReceivableInvoices } from "./accountsreceivableinvoices";
+import { AccountsReceivablePayments } from "./accountsreceivablepayments";
+import { AccountsReceivableReports } from "./accountsreceivablereports";
 import { SDKConfiguration } from "./sdk";
-import { AxiosRequestConfig } from "axios";
-/**
- * Data from a linked accounting platform representing money owed to the business for sold goods or services.
- */
-export declare enum DownloadCustomerAttachmentAcceptEnum {
-    applicationJson = "application/json",
-    applicationOctetStream = "application/octet-stream"
-}
-export declare enum DownloadDirectIncomeAttachmentAcceptEnum {
-    applicationJson = "application/json",
-    applicationOctetStream = "application/octet-stream"
-}
-export declare enum DownloadInvoiceAttachmentAcceptEnum {
-    applicationJson = "application/json",
-    applicationOctetStream = "application/octet-stream"
-}
 export declare class AccountsReceivable {
+    creditNotes: AccountsReceivableCreditNotes;
+    customers: AccountsReceivableCustomers;
+    directIncomes: AccountsReceivableDirectIncomes;
+    invoices: AccountsReceivableInvoices;
+    payments: AccountsReceivablePayments;
+    reports: AccountsReceivableReports;
     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.
-     *
-     */
-    downloadCustomerAttachment(req: operations.DownloadAccountingCustomerAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig, acceptHeaderOverride?: DownloadCustomerAttachmentAcceptEnum): Promise<operations.DownloadAccountingCustomerAttachmentResponse>;
-    /**
-     * Download direct income attachment
-     *
-     * @remarks
-     * The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`.
-     *
-     * [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support downloading a direct income attachment.
-     *
-     */
-    downloadDirectIncomeAttachment(req: operations.DownloadAccountingDirectIncomeAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig, acceptHeaderOverride?: DownloadDirectIncomeAttachmentAcceptEnum): Promise<operations.DownloadAccountingDirectIncomeAttachmentResponse>;
-    /**
-     * Download invoice attachment
-     *
-     * @remarks
-     * The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.
-     *
-     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support downloading an invoice attachment.
-     *
-     */
-    downloadInvoiceAttachment(req: operations.DownloadAccountingInvoiceAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig, acceptHeaderOverride?: DownloadInvoiceAttachmentAcceptEnum): Promise<operations.DownloadAccountingInvoiceAttachmentResponse>;
-    /**
-     * Get invoice as PDF
-     *
-     * @remarks
-     * Download invoice as a pdf.
-     */
-    downloadInvoicePdf(req: operations.DownloadAccountingInvoicePdfRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.DownloadAccountingInvoicePdfResponse>;
-    /**
-     * Aged debtors report
-     *
-     * @remarks
-     * Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time.
-     */
-    getAgedDebtorsReport(req: operations.GetAccountingAgedDebtorsReportRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingAgedDebtorsReportResponse>;
-    /**
-     * 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).
-     *
-     */
-    getCreditNote(req: operations.GetAccountingCreditNoteRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingCreditNoteResponse>;
-    /**
-     * 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).
-     *
-     */
-    getCustomer(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.
-     *
-     */
-    getCustomerAttachment(req: operations.GetAccountingCustomerAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingCustomerAttachmentResponse>;
-    /**
-     * Get direct income
-     *
-     * @remarks
-     * The *Get direct income* endpoint returns a single direct income for a given directIncomeId.
-     *
-     * [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a specific direct income.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getDirectIncome(req: operations.GetAccountingDirectIncomeRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingDirectIncomeResponse>;
-    /**
-     * Get direct income attachment
-     *
-     * @remarks
-     * The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`.
-     *
-     * [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a direct income attachment.
-     *
-     */
-    getDirectIncomeAttachment(req: operations.GetAccountingDirectIncomeAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingDirectIncomeAttachmentResponse>;
-    /**
-     * Get enhanced invoices report
-     *
-     * @remarks
-     * Gets a list of invoices linked to the corresponding banking transaction
-     */
-    getEnhancedInvoicesReport(req: operations.GetEnhancedInvoicesReportRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetEnhancedInvoicesReportResponse>;
-    /**
-     * Get invoice
-     *
-     * @remarks
-     * The *Get invoice* endpoint returns a single invoice for a given invoiceId.
-     *
-     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting a specific invoice.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getInvoice(req: operations.GetAccountingInvoiceRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingInvoiceResponse>;
-    /**
-     * Get invoice attachment
-     *
-     * @remarks
-     * The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`.
-     *
-     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting an invoice attachment.
-     *
-     */
-    getInvoiceAttachment(req: operations.GetAccountingInvoiceAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingInvoiceAttachmentResponse>;
-    /**
-     * Get payment
-     *
-     * @remarks
-     * The *Get payment* endpoint returns a single payment for a given paymentId.
-     *
-     * [Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support getting a specific payment.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getPayment(req: operations.GetAccountingPaymentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingPaymentResponse>;
-    /**
-     * Aged debtors report available
-     *
-     * @remarks
-     * Indicates whether the aged debtor report is available for the company.
-     */
-    isAgedDebtorReportAvailable(req: operations.IsAgedDebtorReportAvailableRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.IsAgedDebtorReportAvailableResponse>;
-    /**
-     * 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).
-     *
-     */
-    listCreditNotes(req: operations.ListAccountingCreditNotesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingCreditNotesResponse>;
-    /**
-     * 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.
-     *
-     */
-    listCustomerAttachments(req: operations.ListAccountingCustomerAttachmentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingCustomerAttachmentsResponse>;
-    /**
-     * 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).
-     *
-     */
-    listCustomers(req: operations.ListAccountingCustomersRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingCustomersResponse>;
-    /**
-     * List direct income attachments
-     *
-     * @remarks
-     * The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`.
-     *
-     * [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support listing direct income attachments.
-     *
-     */
-    listDirectIncomeAttachments(req: operations.ListAccountingDirectIncomeAttachmentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingDirectIncomeAttachmentsResponse>;
-    /**
-     * List direct incomes
-     *
-     * @remarks
-     * The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) for a given company's connection.
-     *
-     * [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listDirectIncomes(req: operations.ListAccountingDirectIncomesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingDirectIncomesResponse>;
-    /**
-     * List invoice attachments
-     *
-     * @remarks
-     * The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`.
-     *
-     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support listing invoice attachments.
-     *
-     */
-    listInvoiceAttachments(req: operations.ListAccountingInvoiceAttachmentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingInvoiceAttachmentsResponse>;
-    /**
-     * List invoices
-     *
-     * @remarks
-     * The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection.
-     *
-     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listInvoices(req: operations.ListAccountingInvoicesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingInvoicesResponse>;
-    /**
-     * List payments
-     *
-     * @remarks
-     * The *List payments* endpoint returns a list of [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection.
-     *
-     * [Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listPayments(req: operations.ListAccountingPaymentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingPaymentsResponse>;
 }