@codat/lending 0.1.0 → 1.2.0

package/dist/sdk/accountspayable.d.ts

@@ -1,4 +1,8 @@
 import * as utils from "../internal/utils";
+import { AccountsPayableBillCreditNotes } from "./accountspayablebillcreditnotes";
+import { AccountsPayableBillPayments } from "./accountspayablebillpayments";
+import { AccountsPayableBills } from "./accountspayablebills";
+import { AccountsPayableSuppliers } from "./accountspayablesuppliers";
 import * as operations from "./models/operations";
 import { SDKConfiguration } from "./sdk";
 import { AxiosRequestConfig } from "axios";
@@ -9,11 +13,11 @@ export declare enum DownloadBillAttachmentAcceptEnum {
     applicationJson = "application/json",
     applicationOctetStream = "application/octet-stream"
 }
-export declare enum DownloadSupplierAttachmentAcceptEnum {
-    applicationJson = "application/json",
-    applicationOctetStream = "application/octet-stream"
-}
 export declare class AccountsPayable {
+    billCreditNotes: AccountsPayableBillCreditNotes;
+    billPayments: AccountsPayableBillPayments;
+    bills: AccountsPayableBills;
+    suppliers: AccountsPayableSuppliers;
     private sdkConfiguration;
     constructor(sdkConfig: SDKConfiguration);
     /**
@@ -28,39 +32,6 @@ export declare class AccountsPayable {
      *
      */
     downloadBillAttachment(req: operations.DownloadAccountingBillAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig, acceptHeaderOverride?: DownloadBillAttachmentAcceptEnum): Promise<operations.DownloadAccountingBillAttachmentResponse>;
-    /**
-     * Download supplier attachment
-     *
-     * @remarks
-     * The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`.
-     *
-     * [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support downloading a supplier attachment.
-     *
-     */
-    downloadSupplierAttachment(req: operations.DownloadAccountingSupplierAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig, acceptHeaderOverride?: DownloadSupplierAttachmentAcceptEnum): Promise<operations.DownloadAccountingSupplierAttachmentResponse>;
-    /**
-     * Aged creditors report
-     *
-     * @remarks
-     * Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time.
-     */
-    getAgedCreditorsReport(req: operations.GetAccountingAgedCreditorsReportRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingAgedCreditorsReportResponse>;
-    /**
-     * Get bill
-     *
-     * @remarks
-     * The *Get bill* endpoint returns a single bill for a given billId.
-     *
-     * [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a specific bill.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getBill(req: operations.GetAccountingBillRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingBillResponse>;
     /**
      * Get bill attachment
      *
@@ -73,137 +44,4 @@ export declare class AccountsPayable {
      *
      */
     getBillAttachment(req: operations.GetAccountingBillAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingBillAttachmentResponse>;
-    /**
-     * Get bill credit note
-     *
-     * @remarks
-     * The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId.
-     *
-     * [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support getting a specific bill credit note.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getBillCreditNote(req: operations.GetAccountingBillCreditNoteRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingBillCreditNoteResponse>;
-    /**
-     * Get bill payment
-     *
-     * @remarks
-     * The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId.
-     *
-     * [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments) for integrations that support getting a specific bill payment.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getBillPayment(req: operations.GetAccountingBillPaymentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingBillPaymentResponse>;
-    /**
-     * Get supplier
-     *
-     * @remarks
-     * The *Get supplier* endpoint returns a single supplier for a given supplierId.
-     *
-     * [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getSupplier(req: operations.GetAccountingSupplierRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingSupplierResponse>;
-    /**
-     * Get supplier attachment
-     *
-     * @remarks
-     * The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`.
-     *
-     * [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a supplier attachment.
-     *
-     */
-    getSupplierAttachment(req: operations.GetAccountingSupplierAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingSupplierAttachmentResponse>;
-    /**
-     * Aged creditors report available
-     *
-     * @remarks
-     * Indicates whether the aged creditor report is available for the company.
-     */
-    isAgedCreditorsReportAvailable(req: operations.IsAgedCreditorsReportAvailableRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.IsAgedCreditorsReportAvailableResponse>;
-    /**
-     * List bill attachments
-     *
-     * @remarks
-     * The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`.
-     *
-     * [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support listing bill attachments.
-     *
-     */
-    listBillAttachments(req: operations.ListAccountingBillAttachmentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingBillAttachmentsResponse>;
-    /**
-     * List bill credit notes
-     *
-     * @remarks
-     * The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) for a given company's connection.
-     *
-     * [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listBillCreditNotes(req: operations.ListAccountingBillCreditNotesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingBillCreditNotesResponse>;
-    /**
-     * List bill payments
-     *
-     * @remarks
-     * The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) for a given company's connection.
-     *
-     * [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listBillPayments(req: operations.ListAccountingBillPaymentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingBillPaymentsResponse>;
-    /**
-     * List bills
-     *
-     * @remarks
-     * The *List bills* endpoint returns a list of [bills](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company's connection.
-     *
-     * [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listBills(req: operations.ListAccountingBillsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingBillsResponse>;
-    /**
-     * List supplier attachments
-     *
-     * @remarks
-     * The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`.
-     *
-     * [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support listing supplier attachments.
-     *
-     */
-    listSupplierAttachments(req: operations.ListAccountingSupplierAttachmentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingSupplierAttachmentsResponse>;
-    /**
-     * List suppliers
-     *
-     * @remarks
-     * The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection.
-     *
-     * [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listSuppliers(req: operations.ListAccountingSuppliersRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingSuppliersResponse>;
 }