@codat/lending 7.2.0 → 7.3.0

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { bankingTransactionCategoriesGet } from "../../funcs/bankingTransactionCategoriesGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetBankingTransactionCategoryRequest$inboundSchema,
+};
+
+export const tool$bankingTransactionCategoriesGet: ToolDefinition<typeof args> =
+  {
+    name: "banking-transaction-categories-get",
+    description: `Get transaction category
+
+The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId.
+
+[Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.
+
+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 bankingTransactionCategoriesGet(
+        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/bankingTransactionCategoriesList.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { bankingTransactionCategoriesList } from "../../funcs/bankingTransactionCategoriesList.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListBankingTransactionCategoriesRequest$inboundSchema,
+};
+
+export const tool$bankingTransactionCategoriesList: ToolDefinition<
+  typeof args
+> = {
+  name: "banking-transaction-categories-list",
+  description: `List transaction categories
+
+The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) for a given company's connection.
+
+[Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.
+
+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 bankingTransactionCategoriesList(
+      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/bankingTransactionsGet.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { bankingTransactionsGet } from "../../funcs/bankingTransactionsGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetBankingTransactionRequest$inboundSchema,
+};
+
+export const tool$bankingTransactionsGet: ToolDefinition<typeof args> = {
+  name: "banking-transactions-get",
+  description: `Get bank transaction
+
+The *Get transaction* endpoint returns a single transaction for a given transactionId.
+
+[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.
+
+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 bankingTransactionsGet(
+      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/bankingTransactionsList.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { bankingTransactionsList } from "../../funcs/bankingTransactionsList.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListBankingTransactionsRequest$inboundSchema,
+};
+
+export const tool$bankingTransactionsList: ToolDefinition<typeof args> = {
+  name: "banking-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) provide an immutable source of up-to-date information on income and expenditure.
+
+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 bankingTransactionsList(
+      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/companiesCreate.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { companiesCreate } from "../../funcs/companiesCreate.js";
+import * as shared from "../../sdk/models/shared/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: shared.CompanyRequestBody$inboundSchema.optional(),
+};
+
+export const tool$companiesCreate: ToolDefinition<typeof args> = {
+  name: "companies-create",
+  description: `Create company
+
+Use the *Create company* endpoint to create a new [company](https://docs.codat.io/lending-api#/schemas/Company) that represents your customer in Codat. 
+
+A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+
+If forbidden characters (see \`name\` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, \`Company (Codat[1])\` with be created as \`Company Codat1\`.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await companiesCreate(
+      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/companiesDelete.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { companiesDelete } from "../../funcs/companiesDelete.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DeleteCompanyRequest$inboundSchema,
+};
+
+export const tool$companiesDelete: ToolDefinition<typeof args> = {
+  name: "companies-delete",
+  description: `Delete a company
+
+The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/lending-api#/schemas/Company), its [connections](https://docs.codat.io/lending-api#/schemas/Connection) and any cached data. This operation is irreversible.
+
+A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await companiesDelete(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

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

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { companiesGet } from "../../funcs/companiesGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetCompanyRequest$inboundSchema,
+};
+
+export const tool$companiesGet: ToolDefinition<typeof args> = {
+  name: "companies-get",
+  description: `Get company
+
+The *Get company* endpoint returns a single company for a given \`companyId\`.
+
+A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await companiesGet(
+      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/companiesList.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { companiesList } from "../../funcs/companiesList.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListCompaniesRequest$inboundSchema.optional(),
+};
+
+export const tool$companiesList: ToolDefinition<typeof args> = {
+  name: "companies-list",
+  description: `List companies
+
+The *List companies* endpoint returns a list of [companies](https://docs.codat.io/lending-api#/schemas/Company) associated to your instances.
+
+A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+
+## Filter by tags
+
+The *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):
+
+- equals (\`=\`)
+- not equals (\`!=\`)
+- contains (\`~\`)
+
+For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team: 
+- Foreign key: \`uid = {yourCustomerId}\`
+- Region: \`region != uk\`
+- Owning team and region: \`region = uk && owningTeam = invoice-finance\``,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await companiesList(
+      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/companiesReplace.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { companiesReplace } from "../../funcs/companiesReplace.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ReplaceCompanyRequest$inboundSchema,
+};
+
+export const tool$companiesReplace: ToolDefinition<typeof args> = {
+  name: "companies-replace",
+  description: `Replace company
+
+Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.
+
+A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await companiesReplace(
+      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/companiesUpdate.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { companiesUpdate } from "../../funcs/companiesUpdate.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.UpdateCompanyRequest$inboundSchema,
+};
+
+export const tool$companiesUpdate: ToolDefinition<typeof args> = {
+  name: "companies-update",
+  description: `Update company
+
+Use the *Update company* endpoint to update the name, description, or tags of the company.
+
+The *Update company* endpoint doesn't have any required fields. If any of the fields provided are \`null\` or not provided, they won't be included in the update.  
+
+A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await companiesUpdate(
+      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/companyInfoGetAccountingProfile.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { companyInfoGetAccountingProfile } from "../../funcs/companyInfoGetAccountingProfile.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetAccountingProfileRequest$inboundSchema,
+};
+
+export const tool$companyInfoGetAccountingProfile: ToolDefinition<typeof args> =
+  {
+    name: "company-info-get-accounting-profile",
+    description: `Get company accounting profile
+
+Gets the latest basic info for a company.`,
+    args,
+    tool: async (client, args, ctx) => {
+      const [result, apiCall] = await companyInfoGetAccountingProfile(
+        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/companyInfoGetCommerceProfile.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { companyInfoGetCommerceProfile } from "../../funcs/companyInfoGetCommerceProfile.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetCommerceProfileRequest$inboundSchema,
+};
+
+export const tool$companyInfoGetCommerceProfile: ToolDefinition<typeof args> = {
+  name: "company-info-get-commerce-profile",
+  description: `Get company commerce profile
+
+Retrieve information about the company, as seen in the commerce
+platform.
+
+This may include information like addresses, tax registration details and
+social media or website information."`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await companyInfoGetCommerceProfile(
+      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/connectionsCreate.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { connectionsCreate } from "../../funcs/connectionsCreate.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.CreateConnectionRequest$inboundSchema,
+};
+
+export const tool$connectionsCreate: ToolDefinition<typeof args> = {
+  name: "connections-create",
+  description: `Create connection
+
+Creates a connection for the company by providing a valid \`platformKey\`. 
+
+Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await connectionsCreate(
+      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/connectionsDelete.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { connectionsDelete } from "../../funcs/connectionsDelete.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DeleteConnectionRequest$inboundSchema,
+};
+
+export const tool$connectionsDelete: ToolDefinition<typeof args> = {
+  name: "connections-delete",
+  description: `Delete connection
+
+Revoke and remove a connection from a company.
+This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await connectionsDelete(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { connectionsGet } from "../../funcs/connectionsGet.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetConnectionRequest$inboundSchema,
+};
+
+export const tool$connectionsGet: ToolDefinition<typeof args> = {
+  name: "connections-get",
+  description: `Get connection
+
+Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await connectionsGet(
+      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/connectionsList.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { connectionsList } from "../../funcs/connectionsList.js";
+import * as operations from "../../sdk/models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListConnectionsRequest$inboundSchema,
+};
+
+export const tool$connectionsList: ToolDefinition<typeof args> = {
+  name: "connections-list",
+  description: `List connections
+
+List the connections for a company.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await connectionsList(
+      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);
+  },
+};