@apideck/unify 0.25.1 → 0.26.0

package/src/funcs/accountingCategoriesList.ts

@@ -0,0 +1,288 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ApideckCore } from "../core.js";
+import { dlv } from "../lib/dlv.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 { ApideckError } from "../models/errors/apideckerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * List Categories
+ *
+ * @remarks
+ * List Categories
+ */
+export function accountingCategoriesList(
+  client: ApideckCore,
+  request: operations.AccountingCategoriesAllRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.AccountingCategoriesAllResponse,
+      | errors.BadRequestResponse
+      | errors.UnauthorizedResponse
+      | errors.PaymentRequiredResponse
+      | errors.NotFoundResponse
+      | errors.UnprocessableResponse
+      | ApideckError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { cursor: string }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ApideckCore,
+  request: operations.AccountingCategoriesAllRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.AccountingCategoriesAllResponse,
+        | errors.BadRequestResponse
+        | errors.UnauthorizedResponse
+        | errors.PaymentRequiredResponse
+        | errors.NotFoundResponse
+        | errors.UnprocessableResponse
+        | ApideckError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { cursor: string }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.AccountingCategoriesAllRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/accounting/categories")();
+
+  const query = encodeFormQuery({
+    "cursor": payload.cursor,
+    "fields": payload.fields,
+    "limit": payload.limit,
+    "raw": payload.raw,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "x-apideck-app-id": encodeSimple(
+      "x-apideck-app-id",
+      payload.appId ?? client._options.appId,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-consumer-id": encodeSimple(
+      "x-apideck-consumer-id",
+      payload.consumerId ?? client._options.consumerId,
+      { explode: false, charEncoding: "none" },
+    ),
+    "x-apideck-service-id": encodeSimple(
+      "x-apideck-service-id",
+      payload.serviceId,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "accounting.categoriesAll",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "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 [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "402", "404", "422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.AccountingCategoriesAllResponse,
+    | errors.BadRequestResponse
+    | errors.UnauthorizedResponse
+    | errors.PaymentRequiredResponse
+    | errors.NotFoundResponse
+    | errors.UnprocessableResponse
+    | ApideckError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.AccountingCategoriesAllResponse$inboundSchema, {
+      key: "GetCategoriesResponse",
+    }),
+    M.jsonErr(400, errors.BadRequestResponse$inboundSchema),
+    M.jsonErr(401, errors.UnauthorizedResponse$inboundSchema),
+    M.jsonErr(402, errors.PaymentRequiredResponse$inboundSchema),
+    M.jsonErr(404, errors.NotFoundResponse$inboundSchema),
+    M.jsonErr(422, errors.UnprocessableResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+    M.json(
+      "default",
+      operations.AccountingCategoriesAllResponse$inboundSchema,
+      { key: "UnexpectedErrorResponse" },
+    ),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.AccountingCategoriesAllResponse,
+        | errors.BadRequestResponse
+        | errors.UnauthorizedResponse
+        | errors.PaymentRequiredResponse
+        | errors.NotFoundResponse
+        | errors.UnprocessableResponse
+        | ApideckError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { cursor: string };
+  } => {
+    const nextCursor = dlv(responseData, "meta.cursors.next");
+    if (typeof nextCursor !== "string") {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      accountingCategoriesList(
+        client,
+        {
+          ...request,
+          cursor: nextCursor,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { cursor: nextCursor } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/lib/config.ts

@@ -67,8 +67,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "10.17.2",
-  sdkVersion: "0.25.1",
-  genVersion: "2.629.1",
-  userAgent: "speakeasy-sdk/typescript 0.25.1 2.629.1 10.17.2 @apideck/unify",
+  openapiDocVersion: "10.18.0",
+  sdkVersion: "0.26.0",
+  genVersion: "2.632.2",
+  userAgent: "speakeasy-sdk/typescript 0.26.0 2.632.2 10.18.0 @apideck/unify",
 } as const;

package/src/models/components/bill.ts

@@ -141,7 +141,7 @@ export type Bill = {
    */
   poNumber?: string | null | undefined;
   /**
-   * Optional bill reference.
+   * Optional reference identifier for the transaction.
    */
   reference?: string | null | undefined;
   lineItems?: Array<BillLineItem> | undefined;
@@ -285,7 +285,7 @@ export type BillInput = {
    */
   poNumber?: string | null | undefined;
   /**
-   * Optional bill reference.
+   * Optional reference identifier for the transaction.
    */
   reference?: string | null | undefined;
   lineItems?: Array<BillLineItemInput> | undefined;

package/src/models/components/category.ts

@@ -0,0 +1,193 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PassThroughBody,
+  PassThroughBody$inboundSchema,
+  PassThroughBody$Outbound,
+  PassThroughBody$outboundSchema,
+} from "./passthroughbody.js";
+
+/**
+ * Based on the status some functionality is enabled or disabled.
+ */
+export const CategoryStatus = {
+  Active: "active",
+  Inactive: "inactive",
+} as const;
+/**
+ * Based on the status some functionality is enabled or disabled.
+ */
+export type CategoryStatus = ClosedEnum<typeof CategoryStatus>;
+
+export type Category = {
+  /**
+   * A unique identifier for an object.
+   */
+  id?: string | undefined;
+  /**
+   * The name of the category.
+   */
+  name?: string | undefined;
+  /**
+   * Based on the status some functionality is enabled or disabled.
+   */
+  status?: CategoryStatus | undefined;
+  /**
+   * When custom mappings are configured on the resource, the result is included here.
+   */
+  customMappings?: { [k: string]: any } | null | undefined;
+  /**
+   * A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
+   */
+  rowVersion?: string | null | undefined;
+  /**
+   * The user who last updated the object.
+   */
+  updatedBy?: string | null | undefined;
+  /**
+   * The user who created the object.
+   */
+  createdBy?: string | null | undefined;
+  /**
+   * The date and time when the object was last updated.
+   */
+  updatedAt?: Date | null | undefined;
+  /**
+   * The date and time when the object was created.
+   */
+  createdAt?: Date | null | undefined;
+  /**
+   * The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
+   */
+  passThrough?: Array<PassThroughBody> | undefined;
+};
+
+/** @internal */
+export const CategoryStatus$inboundSchema: z.ZodNativeEnum<
+  typeof CategoryStatus
+> = z.nativeEnum(CategoryStatus);
+
+/** @internal */
+export const CategoryStatus$outboundSchema: z.ZodNativeEnum<
+  typeof CategoryStatus
+> = CategoryStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CategoryStatus$ {
+  /** @deprecated use `CategoryStatus$inboundSchema` instead. */
+  export const inboundSchema = CategoryStatus$inboundSchema;
+  /** @deprecated use `CategoryStatus$outboundSchema` instead. */
+  export const outboundSchema = CategoryStatus$outboundSchema;
+}
+
+/** @internal */
+export const Category$inboundSchema: z.ZodType<
+  Category,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+  status: CategoryStatus$inboundSchema.optional(),
+  custom_mappings: z.nullable(z.record(z.any())).optional(),
+  row_version: z.nullable(z.string()).optional(),
+  updated_by: z.nullable(z.string()).optional(),
+  created_by: z.nullable(z.string()).optional(),
+  updated_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  created_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  pass_through: z.array(PassThroughBody$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "custom_mappings": "customMappings",
+    "row_version": "rowVersion",
+    "updated_by": "updatedBy",
+    "created_by": "createdBy",
+    "updated_at": "updatedAt",
+    "created_at": "createdAt",
+    "pass_through": "passThrough",
+  });
+});
+
+/** @internal */
+export type Category$Outbound = {
+  id?: string | undefined;
+  name?: string | undefined;
+  status?: string | undefined;
+  custom_mappings?: { [k: string]: any } | null | undefined;
+  row_version?: string | null | undefined;
+  updated_by?: string | null | undefined;
+  created_by?: string | null | undefined;
+  updated_at?: string | null | undefined;
+  created_at?: string | null | undefined;
+  pass_through?: Array<PassThroughBody$Outbound> | undefined;
+};
+
+/** @internal */
+export const Category$outboundSchema: z.ZodType<
+  Category$Outbound,
+  z.ZodTypeDef,
+  Category
+> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+  status: CategoryStatus$outboundSchema.optional(),
+  customMappings: z.nullable(z.record(z.any())).optional(),
+  rowVersion: z.nullable(z.string()).optional(),
+  updatedBy: z.nullable(z.string()).optional(),
+  createdBy: z.nullable(z.string()).optional(),
+  updatedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  createdAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  passThrough: z.array(PassThroughBody$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    customMappings: "custom_mappings",
+    rowVersion: "row_version",
+    updatedBy: "updated_by",
+    createdBy: "created_by",
+    updatedAt: "updated_at",
+    createdAt: "created_at",
+    passThrough: "pass_through",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Category$ {
+  /** @deprecated use `Category$inboundSchema` instead. */
+  export const inboundSchema = Category$inboundSchema;
+  /** @deprecated use `Category$outboundSchema` instead. */
+  export const outboundSchema = Category$outboundSchema;
+  /** @deprecated use `Category$Outbound` instead. */
+  export type Outbound = Category$Outbound;
+}
+
+export function categoryToJSON(category: Category): string {
+  return JSON.stringify(Category$outboundSchema.parse(category));
+}
+
+export function categoryFromJSON(
+  jsonString: string,
+): SafeParseResult<Category, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Category$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Category' from JSON`,
+  );
+}

package/src/models/components/expense.ts

@@ -137,6 +137,10 @@ export type Expense = {
    * Expense line items linked to this expense.
    */
   lineItems: Array<ExpenseLineItem>;
+  /**
+   * Optional reference identifier for the transaction.
+   */
+  reference?: string | null | undefined;
   customFields?: Array<CustomField> | undefined;
   /**
    * When custom mappings are configured on the resource, the result is included here.
@@ -226,6 +230,10 @@ export type ExpenseInput = {
    * Expense line items linked to this expense.
    */
   lineItems: Array<ExpenseLineItemInput>;
+  /**
+   * Optional reference identifier for the transaction.
+   */
+  reference?: string | null | undefined;
   customFields?: Array<CustomField> | undefined;
   /**
    * A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
@@ -298,6 +306,7 @@ export const Expense$inboundSchema: z.ZodType<Expense, z.ZodTypeDef, unknown> =
     tax_rate: LinkedTaxRate$inboundSchema.optional(),
     total_amount: z.nullable(z.number()).optional(),
     line_items: z.array(ExpenseLineItem$inboundSchema),
+    reference: z.nullable(z.string()).optional(),
     custom_fields: z.array(CustomField$inboundSchema).optional(),
     custom_mappings: z.nullable(z.record(z.any())).optional(),
     updated_at: z.nullable(
@@ -352,6 +361,7 @@ export type Expense$Outbound = {
   tax_rate?: LinkedTaxRate$Outbound | undefined;
   total_amount?: number | null | undefined;
   line_items: Array<ExpenseLineItem$Outbound>;
+  reference?: string | null | undefined;
   custom_fields?: Array<CustomField$Outbound> | undefined;
   custom_mappings?: { [k: string]: any } | null | undefined;
   updated_at?: string | null | undefined;
@@ -384,6 +394,7 @@ export const Expense$outboundSchema: z.ZodType<
   taxRate: LinkedTaxRate$outboundSchema.optional(),
   totalAmount: z.nullable(z.number()).optional(),
   lineItems: z.array(ExpenseLineItem$outboundSchema),
+  reference: z.nullable(z.string()).optional(),
   customFields: z.array(CustomField$outboundSchema).optional(),
   customMappings: z.nullable(z.record(z.any())).optional(),
   updatedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
@@ -466,6 +477,7 @@ export const ExpenseInput$inboundSchema: z.ZodType<
   tax_rate: LinkedTaxRateInput$inboundSchema.optional(),
   total_amount: z.nullable(z.number()).optional(),
   line_items: z.array(ExpenseLineItemInput$inboundSchema),
+  reference: z.nullable(z.string()).optional(),
   custom_fields: z.array(CustomField$inboundSchema).optional(),
   row_version: z.nullable(z.string()).optional(),
   pass_through: z.array(PassThroughBody$inboundSchema).optional(),
@@ -505,6 +517,7 @@ export type ExpenseInput$Outbound = {
   tax_rate?: LinkedTaxRateInput$Outbound | undefined;
   total_amount?: number | null | undefined;
   line_items: Array<ExpenseLineItemInput$Outbound>;
+  reference?: string | null | undefined;
   custom_fields?: Array<CustomField$Outbound> | undefined;
   row_version?: string | null | undefined;
   pass_through?: Array<PassThroughBody$Outbound> | undefined;
@@ -531,6 +544,7 @@ export const ExpenseInput$outboundSchema: z.ZodType<
   taxRate: LinkedTaxRateInput$outboundSchema.optional(),
   totalAmount: z.nullable(z.number()).optional(),
   lineItems: z.array(ExpenseLineItemInput$outboundSchema),
+  reference: z.nullable(z.string()).optional(),
   customFields: z.array(CustomField$outboundSchema).optional(),
   rowVersion: z.nullable(z.string()).optional(),
   passThrough: z.array(PassThroughBody$outboundSchema).optional(),

package/src/models/components/formfieldoption.ts

@@ -20,8 +20,8 @@ import {
 } from "./simpleformfieldoption.js";
 
 export type FormFieldOption =
-  | (SimpleFormFieldOption & { optionType: "simple" })
-  | (FormFieldOptionGroup & { optionType: "group" });
+  | (FormFieldOptionGroup & { optionType: "group" })
+  | (SimpleFormFieldOption & { optionType: "simple" });
 
 /** @internal */
 export const FormFieldOption$inboundSchema: z.ZodType<
@@ -29,13 +29,13 @@ export const FormFieldOption$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
-  SimpleFormFieldOption$inboundSchema.and(
-    z.object({ option_type: z.literal("simple") }).transform((v) => ({
+  FormFieldOptionGroup$inboundSchema.and(
+    z.object({ option_type: z.literal("group") }).transform((v) => ({
       optionType: v.option_type,
     })),
   ),
-  FormFieldOptionGroup$inboundSchema.and(
-    z.object({ option_type: z.literal("group") }).transform((v) => ({
+  SimpleFormFieldOption$inboundSchema.and(
+    z.object({ option_type: z.literal("simple") }).transform((v) => ({
       optionType: v.option_type,
     })),
   ),
@@ -43,8 +43,8 @@ export const FormFieldOption$inboundSchema: z.ZodType<
 
 /** @internal */
 export type FormFieldOption$Outbound =
-  | (SimpleFormFieldOption$Outbound & { option_type: "simple" })
-  | (FormFieldOptionGroup$Outbound & { option_type: "group" });
+  | (FormFieldOptionGroup$Outbound & { option_type: "group" })
+  | (SimpleFormFieldOption$Outbound & { option_type: "simple" });
 
 /** @internal */
 export const FormFieldOption$outboundSchema: z.ZodType<
@@ -52,13 +52,13 @@ export const FormFieldOption$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   FormFieldOption
 > = z.union([
-  SimpleFormFieldOption$outboundSchema.and(
-    z.object({ optionType: z.literal("simple") }).transform((v) => ({
+  FormFieldOptionGroup$outboundSchema.and(
+    z.object({ optionType: z.literal("group") }).transform((v) => ({
       option_type: v.optionType,
     })),
   ),
-  FormFieldOptionGroup$outboundSchema.and(
-    z.object({ optionType: z.literal("group") }).transform((v) => ({
+  SimpleFormFieldOption$outboundSchema.and(
+    z.object({ optionType: z.literal("simple") }).transform((v) => ({
       option_type: v.optionType,
     })),
   ),