@codat/lending 0.1.0 → 1.2.0

package/dist/sdk/transactions.d.ts

@@ -1,181 +1,15 @@
-import * as utils from "../internal/utils";
-import * as operations from "./models/operations";
 import { SDKConfiguration } from "./sdk";
-import { AxiosRequestConfig } from "axios";
-/**
- * Data from a linked accounting platform representing transactions.
- */
-export declare enum DownloadDirectCostAttachmentAcceptEnum {
-    applicationJson = "application/json",
-    applicationOctetStream = "application/octet-stream"
-}
+import { TransactionsAccountTransactions } from "./transactionsaccounttransactions";
+import { TransactionsDirectCosts } from "./transactionsdirectcosts";
+import { TransactionsJournalEntries } from "./transactionsjournalentries";
+import { TransactionsJournals } from "./transactionsjournals";
+import { TransactionsTransfers } from "./transactionstransfers";
 export declare class Transactions {
+    accountTransactions: TransactionsAccountTransactions;
+    directCosts: TransactionsDirectCosts;
+    journalEntries: TransactionsJournalEntries;
+    journals: TransactionsJournals;
+    transfers: TransactionsTransfers;
     private sdkConfiguration;
     constructor(sdkConfig: SDKConfiguration);
-    /**
-     * Download direct cost attachment
-     *
-     * @remarks
-     * The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`.
-     *
-     * [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support downloading a direct cost attachment.
-     *
-     */
-    downloadDirectCostAttachment(req: operations.DownloadAccountingDirectCostAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig, acceptHeaderOverride?: DownloadDirectCostAttachmentAcceptEnum): Promise<operations.DownloadAccountingDirectCostAttachmentResponse>;
-    /**
-     * Get account transaction
-     *
-     * @remarks
-     * The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId.
-     *
-     * [Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=accountTransactions) for integrations that support getting a specific account transaction.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getAccountTransaction(req: operations.GetAccountingAccountTransactionRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingAccountTransactionResponse>;
-    /**
-     * Get direct cost
-     *
-     * @remarks
-     * The *Get direct cost* endpoint returns a single direct cost for a given directCostId.
-     *
-     * [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a specific direct cost.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getDirectCost(req: operations.GetAccountingDirectCostRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingDirectCostResponse>;
-    /**
-     * Get direct cost attachment
-     *
-     * @remarks
-     * The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`.
-     *
-     * [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a direct cost attachment.
-     *
-     */
-    getDirectCostAttachment(req: operations.GetAccountingDirectCostAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingDirectCostAttachmentResponse>;
-    /**
-     * Get journal
-     *
-     * @remarks
-     * The *Get journal* endpoint returns a single journal for a given journalId.
-     *
-     * [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support getting a specific journal.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getJournal(req: operations.GetAccountingJournalRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingJournalResponse>;
-    /**
-     * Get journal entry
-     *
-     * @remarks
-     * The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId.
-     *
-     * [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are  made in a company's general ledger, or accounts, when transactions are approved.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support getting a specific journal entry.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getJournalEntry(req: operations.GetAccountingJournalEntryRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingJournalEntryResponse>;
-    /**
-     * Get transfer
-     *
-     * @remarks
-     * The *Get transfer* endpoint returns a single transfer for a given transferId.
-     *
-     * [Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support getting a specific transfer.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getTransfer(req: operations.GetAccountingTransferRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingTransferResponse>;
-    /**
-     * List account transactions
-     *
-     * @remarks
-     * The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) for a given company's connection.
-     *
-     * [Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listAccountTransactions(req: operations.ListAccountingAccountTransactionsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingAccountTransactionsResponse>;
-    /**
-     * List direct cost attachments
-     *
-     * @remarks
-     * The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`.
-     *
-     * [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support listing direct cost attachments.
-     *
-     */
-    listDirectCostAttachments(req: operations.ListAccountingDirectCostAttachmentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingDirectCostAttachmentsResponse>;
-    /**
-     * List direct costs
-     *
-     * @remarks
-     * The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection.
-     *
-     * [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listDirectCosts(req: operations.ListAccountingDirectCostsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingDirectCostsResponse>;
-    /**
-     * List journal entries
-     *
-     * @remarks
-     * The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) for a given company's connection.
-     *
-     * [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are  made in a company's general ledger, or accounts, when transactions are approved.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listJournalEntries(req: operations.ListAccountingJournalEntriesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingJournalEntriesResponse>;
-    /**
-     * List journals
-     *
-     * @remarks
-     * The *List journals* endpoint returns a list of [journals](https://docs.codat.io/accounting-api#/schemas/Journal) for a given company's connection.
-     *
-     * [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listJournals(req: operations.ListAccountingJournalsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingJournalsResponse>;
-    /**
-     * List transfers
-     *
-     * @remarks
-     * The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection.
-     *
-     * [Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listTransfers(req: operations.ListAccountingTransfersRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingTransfersResponse>;
 }