@codat/lending 7.2.0 → 7.3.0

package/src/mcp-server/tools/salesPaymentsGet.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesPaymentsGet } from "../../funcs/salesPaymentsGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetCommercePaymentRequest$inboundSchema,
+};
+
+export const tool$salesPaymentsGet: ToolDefinition<typeof args> = {
+  name: "sales-payments-get",
+  description: `Get payment
+
+The *Get payment* endpoint returns a single payment for a given paymentId.
+
+[Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesPaymentsGet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/salesPaymentsList.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesPaymentsList } from "../../funcs/salesPaymentsList.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListCommercePaymentsRequest$inboundSchema,
+};
+
+export const tool$salesPaymentsList: ToolDefinition<typeof args> = {
+  name: "sales-payments-list",
+  description: `List payments
+
+The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection.
+
+[Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+    `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesPaymentsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/salesProductCategoriesGet.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesProductCategoriesGet } from "../../funcs/salesProductCategoriesGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetCommerceProductCategoryRequest$inboundSchema,
+};
+
+export const tool$salesProductCategoriesGet: ToolDefinition<typeof args> = {
+  name: "sales-product-categories-get",
+  description: `Get product category
+
+The *Get product* endpoint returns a single product for a given productId.
+
+[Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesProductCategoriesGet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/salesProductCategoriesList.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesProductCategoriesList } from "../../funcs/salesProductCategoriesList.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListCommerceProductCategoriesRequest$inboundSchema,
+};
+
+export const tool$salesProductCategoriesList: ToolDefinition<typeof args> = {
+  name: "sales-product-categories-list",
+  description: `List product categories
+
+The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) for a given company's connection.
+
+[Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+    `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesProductCategoriesList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/salesProductsGet.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesProductsGet } from "../../funcs/salesProductsGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetCommerceProductRequest$inboundSchema,
+};
+
+export const tool$salesProductsGet: ToolDefinition<typeof args> = {
+  name: "sales-products-get",
+  description: `Get product
+
+The *Get product* endpoint returns a single product for a given productId.
+
+[Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesProductsGet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/salesProductsList.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesProductsList } from "../../funcs/salesProductsList.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListCommerceProductsRequest$inboundSchema,
+};
+
+export const tool$salesProductsList: ToolDefinition<typeof args> = {
+  name: "sales-products-list",
+  description: `List products
+
+The *List products* endpoint returns a list of [products](https://docs.codat.io/lending-api#/schemas/Product) for a given company's connection.
+
+[Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+    `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesProductsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/salesReportsGetOrders.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesReportsGetOrders } from "../../funcs/salesReportsGetOrders.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetCommerceOrdersReportRequest$inboundSchema,
+};
+
+export const tool$salesReportsGetOrders: ToolDefinition<typeof args> = {
+  name: "sales-reports-get-orders",
+  description: `Get orders report
+
+The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time.
+
+This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. 
+
+[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the order metrics.
+
+#### Response structure
+
+The Orders report's dimensions and measures are:
+
+| Index         | Dimensions     |
+|---------------|----------------|
+|   \`index\` = 0 | Period         |
+|   \`index\` = 1 | Order metrics  |
+
+| Index         | Measures   |
+|---------------|------------|
+| \`index\` = 0   | Count      |
+| \`index\` = 1   | Value      |
+
+The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesReportsGetOrders(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/salesReportsGetRefunds.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesReportsGetRefunds } from "../../funcs/salesReportsGetRefunds.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetCommerceRefundsReportRequest$inboundSchema,
+};
+
+export const tool$salesReportsGetRefunds: ToolDefinition<typeof args> = {
+  name: "sales-reports-get-refunds",
+  description: `Get refunds report
+
+The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time.
+
+This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. 
+
+[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the refunds metrics.
+
+#### Response structure
+
+The Refunds report's dimensions and measures are:
+
+| Index          | Dimensions     |
+|----------------|----------------|
+| \`index\` = 0    | Period         |
+| \`index\` = 1    | Refund metrics |
+
+| Index          | Measures    |
+|----------------|------------|
+| \`index\` = 0    | Count      |
+| \`index\` = 1    | Value      |
+| \`index\` = 2    | Percentage |
+
+The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesReportsGetRefunds(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/salesTransactionsGet.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesTransactionsGet } from "../../funcs/salesTransactionsGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetCommerceTransactionRequest$inboundSchema,
+};
+
+export const tool$salesTransactionsGet: ToolDefinition<typeof args> = {
+  name: "sales-transactions-get",
+  description: `Get transaction
+
+The *Get transaction* endpoint returns a single transaction for a given transactionId.
+
+[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesTransactionsGet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/salesTransactionsList.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesTransactionsList } from "../../funcs/salesTransactionsList.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListCommerceTransactionsRequest$inboundSchema,
+};
+
+export const tool$salesTransactionsList: ToolDefinition<typeof args> = {
+  name: "sales-transactions-list",
+  description: `List transactions
+
+The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection.
+
+[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+    `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await salesTransactionsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/transactionsAccountTransactionsGet.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionsAccountTransactionsGet } from "../../funcs/transactionsAccountTransactionsGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetAccountingAccountTransactionRequest$inboundSchema,
+};
+
+export const tool$transactionsAccountTransactionsGet: ToolDefinition<
+  typeof args
+> = {
+  name: "transactions-account-transactions-get",
+  description: `Get account transaction
+
+The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId.
+
+[Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. 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).
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await transactionsAccountTransactionsGet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/transactionsAccountTransactionsList.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionsAccountTransactionsList } from "../../funcs/transactionsAccountTransactionsList.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListAccountingAccountTransactionsRequest$inboundSchema,
+};
+
+export const tool$transactionsAccountTransactionsList: ToolDefinition<
+  typeof args
+> = {
+  name: "transactions-account-transactions-list",
+  description: `List account transactions
+
+The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) for a given company's connection.
+
+[Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. 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).
+    `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await transactionsAccountTransactionsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/transactionsDirectCostsDownloadAttachment.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionsDirectCostsDownloadAttachment } from "../../funcs/transactionsDirectCostsDownloadAttachment.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request:
+    operations.DownloadAccountingDirectCostAttachmentRequest$inboundSchema,
+};
+
+export const tool$transactionsDirectCostsDownloadAttachment: ToolDefinition<
+  typeof args
+> = {
+  name: "transactions-direct-costs-download-attachment",
+  description: `Download direct cost attachment
+
+The *Download direct cost attachment* endpoint downloads a specific attachment for a given \`directCostId\` and \`attachmentId\`.
+
+[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await transactionsDirectCostsDownloadAttachment(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/transactionsDirectCostsGet.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionsDirectCostsGet } from "../../funcs/transactionsDirectCostsGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetAccountingDirectCostRequest$inboundSchema,
+};
+
+export const tool$transactionsDirectCostsGet: ToolDefinition<typeof args> = {
+  name: "transactions-direct-costs-get",
+  description: `Get direct cost
+
+The *Get direct cost* endpoint returns a single direct cost for a given directCostId.
+
+[Direct costs](https://docs.codat.io/lending-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).
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await transactionsDirectCostsGet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/transactionsDirectCostsGetAttachment.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionsDirectCostsGetAttachment } from "../../funcs/transactionsDirectCostsGetAttachment.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetAccountingDirectCostAttachmentRequest$inboundSchema,
+};
+
+export const tool$transactionsDirectCostsGetAttachment: ToolDefinition<
+  typeof args
+> = {
+  name: "transactions-direct-costs-get-attachment",
+  description: `Get direct cost attachment
+
+The *Get direct cost attachment* endpoint returns a specific attachment for a given \`directCostId\` and \`attachmentId\`.
+
+[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await transactionsDirectCostsGetAttachment(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};