@unified-api/typescript-sdk 2.78.0 → 2.79.0

package/src/funcs/accountingListAccountingCashflows.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { UnifiedToCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import { UnifiedToError } from "../sdk/models/errors/unifiedtoerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * List all cashflows
+ */
+export function accountingListAccountingCashflows(
+  client: UnifiedToCore,
+  request: operations.ListAccountingCashflowsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Array<shared.AccountingCashflow>,
+    | UnifiedToError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: UnifiedToCore,
+  request: operations.ListAccountingCashflowsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Array<shared.AccountingCashflow>,
+      | UnifiedToError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListAccountingCashflowsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    connection_id: encodeSimple("connection_id", payload.connection_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/accounting/{connection_id}/cashflow")(pathParams);
+
+  const query = encodeFormQuery({
+    "category_id": payload.category_id,
+    "contact_id": payload.contact_id,
+    "end_le": payload.end_le,
+    "end_lt": payload.end_lt,
+    "fields": payload.fields,
+    "limit": payload.limit,
+    "offset": payload.offset,
+    "order": payload.order,
+    "query": payload.query,
+    "raw": payload.raw,
+    "sort": payload.sort,
+    "start_gte": payload.start_gte,
+    "updated_gte": payload.updated_gte,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listAccountingCashflows",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    Array<shared.AccountingCashflow>,
+    | UnifiedToError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, z.array(shared.AccountingCashflow$inboundSchema)),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -73,8 +73,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.78.0",
-  genVersion: "2.730.5",
+  sdkVersion: "2.79.0",
+  genVersion: "2.735.1",
   userAgent:
-    "speakeasy-sdk/typescript 2.78.0 2.730.5 1.0 @unified-api/typescript-sdk",
+    "speakeasy-sdk/typescript 2.79.0 2.735.1 1.0 @unified-api/typescript-sdk",
 } as const;

package/src/sdk/accounting.ts

@@ -18,6 +18,7 @@ import { accountingCreateAccountingTransaction } from "../funcs/accountingCreate
 import { accountingGetAccountingAccount } from "../funcs/accountingGetAccountingAccount.js";
 import { accountingGetAccountingBalancesheet } from "../funcs/accountingGetAccountingBalancesheet.js";
 import { accountingGetAccountingBill } from "../funcs/accountingGetAccountingBill.js";
+import { accountingGetAccountingCashflow } from "../funcs/accountingGetAccountingCashflow.js";
 import { accountingGetAccountingCategory } from "../funcs/accountingGetAccountingCategory.js";
 import { accountingGetAccountingContact } from "../funcs/accountingGetAccountingContact.js";
 import { accountingGetAccountingCreditmemo } from "../funcs/accountingGetAccountingCreditmemo.js";
@@ -36,6 +37,7 @@ import { accountingGetAccountingTrialbalance } from "../funcs/accountingGetAccou
 import { accountingListAccountingAccounts } from "../funcs/accountingListAccountingAccounts.js";
 import { accountingListAccountingBalancesheets } from "../funcs/accountingListAccountingBalancesheets.js";
 import { accountingListAccountingBills } from "../funcs/accountingListAccountingBills.js";
+import { accountingListAccountingCashflows } from "../funcs/accountingListAccountingCashflows.js";
 import { accountingListAccountingCategories } from "../funcs/accountingListAccountingCategories.js";
 import { accountingListAccountingContacts } from "../funcs/accountingListAccountingContacts.js";
 import { accountingListAccountingCreditmemoes } from "../funcs/accountingListAccountingCreditmemoes.js";
@@ -320,6 +322,20 @@ export class Accounting extends ClientSDK {
     ));
   }
 
+  /**
+   * Retrieve a cashflow
+   */
+  async getAccountingCashflow(
+    request: operations.GetAccountingCashflowRequest,
+    options?: RequestOptions,
+  ): Promise<shared.AccountingCashflow> {
+    return unwrapAsync(accountingGetAccountingCashflow(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve a category
    */
@@ -572,6 +588,20 @@ export class Accounting extends ClientSDK {
     ));
   }
 
+  /**
+   * List all cashflows
+   */
+  async listAccountingCashflows(
+    request: operations.ListAccountingCashflowsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.AccountingCashflow>> {
+    return unwrapAsync(accountingListAccountingCashflows(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List all categories
    */

package/src/sdk/cashflow.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { accountingGetAccountingCashflow } from "../funcs/accountingGetAccountingCashflow.js";
+import { accountingListAccountingCashflows } from "../funcs/accountingListAccountingCashflows.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Cashflow extends ClientSDK {
+  /**
+   * Retrieve a cashflow
+   */
+  async getAccountingCashflow(
+    request: operations.GetAccountingCashflowRequest,
+    options?: RequestOptions,
+  ): Promise<shared.AccountingCashflow> {
+    return unwrapAsync(accountingGetAccountingCashflow(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all cashflows
+   */
+  async listAccountingCashflows(
+    request: operations.ListAccountingCashflowsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.AccountingCashflow>> {
+    return unwrapAsync(accountingListAccountingCashflows(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/models/operations/getaccountingcashflow.ts

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetAccountingCashflowRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Cashflow
+   */
+  id: string;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const GetAccountingCashflowRequest$inboundSchema: z.ZodType<
+  GetAccountingCashflowRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type GetAccountingCashflowRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const GetAccountingCashflowRequest$outboundSchema: z.ZodType<
+  GetAccountingCashflowRequest$Outbound,
+  z.ZodTypeDef,
+  GetAccountingCashflowRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAccountingCashflowRequest$ {
+  /** @deprecated use `GetAccountingCashflowRequest$inboundSchema` instead. */
+  export const inboundSchema = GetAccountingCashflowRequest$inboundSchema;
+  /** @deprecated use `GetAccountingCashflowRequest$outboundSchema` instead. */
+  export const outboundSchema = GetAccountingCashflowRequest$outboundSchema;
+  /** @deprecated use `GetAccountingCashflowRequest$Outbound` instead. */
+  export type Outbound = GetAccountingCashflowRequest$Outbound;
+}
+
+export function getAccountingCashflowRequestToJSON(
+  getAccountingCashflowRequest: GetAccountingCashflowRequest,
+): string {
+  return JSON.stringify(
+    GetAccountingCashflowRequest$outboundSchema.parse(
+      getAccountingCashflowRequest,
+    ),
+  );
+}
+
+export function getAccountingCashflowRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAccountingCashflowRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAccountingCashflowRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAccountingCashflowRequest' from JSON`,
+  );
+}

package/src/sdk/models/operations/index.ts

@@ -84,6 +84,7 @@ export * from "./createverificationrequest.js";
 export * from "./getaccountingaccount.js";
 export * from "./getaccountingbalancesheet.js";
 export * from "./getaccountingbill.js";
+export * from "./getaccountingcashflow.js";
 export * from "./getaccountingcategory.js";
 export * from "./getaccountingcontact.js";
 export * from "./getaccountingcreditmemo.js";
@@ -178,6 +179,7 @@ export * from "./getverificationrequest.js";
 export * from "./listaccountingaccounts.js";
 export * from "./listaccountingbalancesheets.js";
 export * from "./listaccountingbills.js";
+export * from "./listaccountingcashflows.js";
 export * from "./listaccountingcategories.js";
 export * from "./listaccountingcontacts.js";
 export * from "./listaccountingcreditmemoes.js";

package/src/sdk/models/operations/listaccountingcashflows.ts

@@ -0,0 +1,171 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListAccountingCashflowsRequest = {
+  /**
+   * The category ID to filter by
+   */
+  categoryId?: string | undefined;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * The contact ID to filter by
+   */
+  contactId?: string | undefined;
+  /**
+   * The end date to filter by (deprecated)
+   */
+  endLe?: string | undefined;
+  /**
+   * The end date to filter by
+   */
+  endLt?: string | undefined;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  /**
+   * Query string to search. eg. email address or name
+   */
+  query?: string | undefined;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+  sort?: string | undefined;
+  /**
+   * The start date to filter by
+   */
+  startGte?: string | undefined;
+  /**
+   * Return only results whose updated date is equal or greater to this value
+   */
+  updatedGte?: string | undefined;
+};
+
+/** @internal */
+export const ListAccountingCashflowsRequest$inboundSchema: z.ZodType<
+  ListAccountingCashflowsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category_id: z.string().optional(),
+  connection_id: z.string(),
+  contact_id: z.string().optional(),
+  end_le: z.string().optional(),
+  end_lt: z.string().optional(),
+  fields: z.array(z.string()).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  start_gte: z.string().optional(),
+  updated_gte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "category_id": "categoryId",
+    "connection_id": "connectionId",
+    "contact_id": "contactId",
+    "end_le": "endLe",
+    "end_lt": "endLt",
+    "start_gte": "startGte",
+    "updated_gte": "updatedGte",
+  });
+});
+
+/** @internal */
+export type ListAccountingCashflowsRequest$Outbound = {
+  category_id?: string | undefined;
+  connection_id: string;
+  contact_id?: string | undefined;
+  end_le?: string | undefined;
+  end_lt?: string | undefined;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  start_gte?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListAccountingCashflowsRequest$outboundSchema: z.ZodType<
+  ListAccountingCashflowsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAccountingCashflowsRequest
+> = z.object({
+  categoryId: z.string().optional(),
+  connectionId: z.string(),
+  contactId: z.string().optional(),
+  endLe: z.string().optional(),
+  endLt: z.string().optional(),
+  fields: z.array(z.string()).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  startGte: z.string().optional(),
+  updatedGte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    categoryId: "category_id",
+    connectionId: "connection_id",
+    contactId: "contact_id",
+    endLe: "end_le",
+    endLt: "end_lt",
+    startGte: "start_gte",
+    updatedGte: "updated_gte",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAccountingCashflowsRequest$ {
+  /** @deprecated use `ListAccountingCashflowsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListAccountingCashflowsRequest$inboundSchema;
+  /** @deprecated use `ListAccountingCashflowsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListAccountingCashflowsRequest$outboundSchema;
+  /** @deprecated use `ListAccountingCashflowsRequest$Outbound` instead. */
+  export type Outbound = ListAccountingCashflowsRequest$Outbound;
+}
+
+export function listAccountingCashflowsRequestToJSON(
+  listAccountingCashflowsRequest: ListAccountingCashflowsRequest,
+): string {
+  return JSON.stringify(
+    ListAccountingCashflowsRequest$outboundSchema.parse(
+      listAccountingCashflowsRequest,
+    ),
+  );
+}
+
+export function listAccountingCashflowsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAccountingCashflowsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAccountingCashflowsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAccountingCashflowsRequest' from JSON`,
+  );
+}