@unified-api/typescript-sdk 2.34.0 → 2.36.0

package/src/funcs/reportGetAccountingReport.ts

@@ -0,0 +1,169 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { SDKError } from "../sdk/models/errors/sdkerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.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";
+
+/**
+ * Retrieve a report
+ */
+export function reportGetAccountingReport(
+  client: UnifiedToCore,
+  request: operations.GetAccountingReportRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.AccountingReport,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: UnifiedToCore,
+  request: operations.GetAccountingReportRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.AccountingReport,
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetAccountingReportRequest$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",
+    }),
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/accounting/{connection_id}/report/{id}")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "fields": payload.fields,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getAccountingReport",
+    oAuth2Scopes: [],
+
+    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,
+    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<
+    shared.AccountingReport,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, shared.AccountingReport$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/reportListAccountingReports.ts

@@ -0,0 +1,171 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 { SDKError } from "../sdk/models/errors/sdkerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.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 reports
+ */
+export function reportListAccountingReports(
+  client: UnifiedToCore,
+  request: operations.ListAccountingReportsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Array<shared.AccountingReport>,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: UnifiedToCore,
+  request: operations.ListAccountingReportsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Array<shared.AccountingReport>,
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListAccountingReportsRequest$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}/report")(pathParams);
+
+  const query = encodeFormQuery({
+    "fields": payload.fields,
+    "limit": payload.limit,
+    "offset": payload.offset,
+    "order": payload.order,
+    "query": payload.query,
+    "sort": payload.sort,
+    "type": payload.type,
+    "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 = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listAccountingReports",
+    oAuth2Scopes: [],
+
+    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,
+    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.AccountingReport>,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, z.array(shared.AccountingReport$inboundSchema)),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

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

package/src/sdk/accounting.ts

@@ -15,6 +15,7 @@ import { accountingGetAccountingInvoice } from "../funcs/accountingGetAccounting
 import { accountingGetAccountingJournal } from "../funcs/accountingGetAccountingJournal.js";
 import { accountingGetAccountingOrder } from "../funcs/accountingGetAccountingOrder.js";
 import { accountingGetAccountingOrganization } from "../funcs/accountingGetAccountingOrganization.js";
+import { accountingGetAccountingReport } from "../funcs/accountingGetAccountingReport.js";
 import { accountingGetAccountingTaxrate } from "../funcs/accountingGetAccountingTaxrate.js";
 import { accountingGetAccountingTransaction } from "../funcs/accountingGetAccountingTransaction.js";
 import { accountingListAccountingAccounts } from "../funcs/accountingListAccountingAccounts.js";
@@ -23,6 +24,7 @@ import { accountingListAccountingInvoices } from "../funcs/accountingListAccount
 import { accountingListAccountingJournals } from "../funcs/accountingListAccountingJournals.js";
 import { accountingListAccountingOrders } from "../funcs/accountingListAccountingOrders.js";
 import { accountingListAccountingOrganizations } from "../funcs/accountingListAccountingOrganizations.js";
+import { accountingListAccountingReports } from "../funcs/accountingListAccountingReports.js";
 import { accountingListAccountingTaxrates } from "../funcs/accountingListAccountingTaxrates.js";
 import { accountingListAccountingTransactions } from "../funcs/accountingListAccountingTransactions.js";
 import { accountingPatchAccountingAccount } from "../funcs/accountingPatchAccountingAccount.js";
@@ -234,6 +236,20 @@ export class Accounting extends ClientSDK {
     ));
   }
 
+  /**
+   * Retrieve a report
+   */
+  async getAccountingReport(
+    request: operations.GetAccountingReportRequest,
+    options?: RequestOptions,
+  ): Promise<shared.AccountingReport> {
+    return unwrapAsync(accountingGetAccountingReport(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve a taxrate
    */
@@ -346,6 +362,20 @@ export class Accounting extends ClientSDK {
     ));
   }
 
+  /**
+   * List all reports
+   */
+  async listAccountingReports(
+    request: operations.ListAccountingReportsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.AccountingReport>> {
+    return unwrapAsync(accountingListAccountingReports(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List all taxrates
    */

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

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 GetAccountingReportRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Report
+   */
+  id: string;
+};
+
+/** @internal */
+export const GetAccountingReportRequest$inboundSchema: z.ZodType<
+  GetAccountingReportRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type GetAccountingReportRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+};
+
+/** @internal */
+export const GetAccountingReportRequest$outboundSchema: z.ZodType<
+  GetAccountingReportRequest$Outbound,
+  z.ZodTypeDef,
+  GetAccountingReportRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+}).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 GetAccountingReportRequest$ {
+  /** @deprecated use `GetAccountingReportRequest$inboundSchema` instead. */
+  export const inboundSchema = GetAccountingReportRequest$inboundSchema;
+  /** @deprecated use `GetAccountingReportRequest$outboundSchema` instead. */
+  export const outboundSchema = GetAccountingReportRequest$outboundSchema;
+  /** @deprecated use `GetAccountingReportRequest$Outbound` instead. */
+  export type Outbound = GetAccountingReportRequest$Outbound;
+}
+
+export function getAccountingReportRequestToJSON(
+  getAccountingReportRequest: GetAccountingReportRequest,
+): string {
+  return JSON.stringify(
+    GetAccountingReportRequest$outboundSchema.parse(getAccountingReportRequest),
+  );
+}
+
+export function getAccountingReportRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAccountingReportRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAccountingReportRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAccountingReportRequest' from JSON`,
+  );
+}

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

@@ -72,6 +72,7 @@ export * from "./getaccountinginvoice.js";
 export * from "./getaccountingjournal.js";
 export * from "./getaccountingorder.js";
 export * from "./getaccountingorganization.js";
+export * from "./getaccountingreport.js";
 export * from "./getaccountingtaxrate.js";
 export * from "./getaccountingtransaction.js";
 export * from "./getatsactivity.js";
@@ -145,6 +146,7 @@ export * from "./listaccountinginvoices.js";
 export * from "./listaccountingjournals.js";
 export * from "./listaccountingorders.js";
 export * from "./listaccountingorganizations.js";
+export * from "./listaccountingreports.js";
 export * from "./listaccountingtaxrates.js";
 export * from "./listaccountingtransactions.js";
 export * from "./listatsactivities.js";

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

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 ListAccountingReportsRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * 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;
+  sort?: string | undefined;
+  type?: string | undefined;
+  /**
+   * Return only results whose updated date is equal or greater to this value
+   */
+  updatedGte?: Date | undefined;
+};
+
+/** @internal */
+export const ListAccountingReportsRequest$inboundSchema: z.ZodType<
+  ListAccountingReportsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  query: z.string().optional(),
+  sort: z.string().optional(),
+  type: z.string().optional(),
+  updated_gte: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+    "updated_gte": "updatedGte",
+  });
+});
+
+/** @internal */
+export type ListAccountingReportsRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  query?: string | undefined;
+  sort?: string | undefined;
+  type?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListAccountingReportsRequest$outboundSchema: z.ZodType<
+  ListAccountingReportsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAccountingReportsRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  query: z.string().optional(),
+  sort: z.string().optional(),
+  type: z.string().optional(),
+  updatedGte: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    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 ListAccountingReportsRequest$ {
+  /** @deprecated use `ListAccountingReportsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListAccountingReportsRequest$inboundSchema;
+  /** @deprecated use `ListAccountingReportsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListAccountingReportsRequest$outboundSchema;
+  /** @deprecated use `ListAccountingReportsRequest$Outbound` instead. */
+  export type Outbound = ListAccountingReportsRequest$Outbound;
+}
+
+export function listAccountingReportsRequestToJSON(
+  listAccountingReportsRequest: ListAccountingReportsRequest,
+): string {
+  return JSON.stringify(
+    ListAccountingReportsRequest$outboundSchema.parse(
+      listAccountingReportsRequest,
+    ),
+  );
+}
+
+export function listAccountingReportsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAccountingReportsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAccountingReportsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAccountingReportsRequest' from JSON`,
+  );
+}