@apideck/unify 0.43.11 → 0.44.0

package/src/models/components/connection.ts

@@ -4,7 +4,10 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../lib/schemas.js";
 import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
@@ -72,6 +75,17 @@ export const ConnectionStatus = {
  */
 export type ConnectionStatus = OpenEnum<typeof ConnectionStatus>;
 
+/**
+ * Attach your own consumer specific metadata
+ */
+export type ConnectionMetadata = {
+  /**
+   * Normalized identifier of the authorized organization, copied from the connector-specific setting (e.g. Xero tenant_id, QuickBooks realm_id, NetSuite account_id).
+   */
+  companyId?: string | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
 export const Target = {
   CustomFields: "custom_fields",
   Resource: "resource",
@@ -192,7 +206,7 @@ export type Connection = {
   /**
    * Attach your own consumer specific metadata
    */
-  metadata?: { [k: string]: any } | null | undefined;
+  metadata?: ConnectionMetadata | null | undefined;
   /**
    * The settings that are wanted to create a connection.
    */
@@ -246,6 +260,13 @@ export type Connection = {
   updatedAt?: number | null | undefined;
 };
 
+/**
+ * Attach your own consumer specific metadata
+ */
+export type ConnectionMetadataInput = {
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
 export type ConnectionDefaults = {
   id?: string | undefined;
   options?: Array<FormFieldOption> | undefined;
@@ -275,7 +296,7 @@ export type ConnectionInput = {
   /**
    * Attach your own consumer specific metadata
    */
-  metadata?: { [k: string]: any } | null | undefined;
+  metadata?: ConnectionMetadataInput | null | undefined;
   configuration?: Array<ConnectionConfiguration> | undefined;
   /**
    * List of custom mappings configured for this connection
@@ -296,6 +317,33 @@ export const ConnectionStatus$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(ConnectionStatus);
 
+/** @internal */
+export const ConnectionMetadata$inboundSchema: z.ZodType<
+  ConnectionMetadata,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    company_id: types.optional(types.string()),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+).transform((v) => {
+  return remap$(v, {
+    "company_id": "companyId",
+  });
+});
+
+export function connectionMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<ConnectionMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConnectionMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConnectionMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const Target$inboundSchema: z.ZodType<Target, z.ZodTypeDef, unknown> =
   openEnums.inboundSchema(Target);
@@ -451,7 +499,8 @@ export const Connection$inboundSchema: z.ZodType<
   authorize_url: z.nullable(types.string()).optional(),
   revoke_url: z.nullable(types.string()).optional(),
   settings: z.nullable(z.record(z.any())).optional(),
-  metadata: z.nullable(z.record(z.any())).optional(),
+  metadata: z.nullable(z.lazy(() => ConnectionMetadata$inboundSchema))
+    .optional(),
   form_fields: types.optional(z.array(FormField$inboundSchema)),
   configuration: types.optional(
     z.array(z.lazy(() => Configuration$inboundSchema)),
@@ -515,6 +564,35 @@ export function connectionFromJSON(
   );
 }
 
+/** @internal */
+export type ConnectionMetadataInput$Outbound = {
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const ConnectionMetadataInput$outboundSchema: z.ZodType<
+  ConnectionMetadataInput$Outbound,
+  z.ZodTypeDef,
+  ConnectionMetadataInput
+> = z.object({
+  additionalProperties: z.record(z.any()).optional(),
+}).transform((v) => {
+  return {
+    ...v.additionalProperties,
+    ...remap$(v, {
+      additionalProperties: null,
+    }),
+  };
+});
+
+export function connectionMetadataInputToJSON(
+  connectionMetadataInput: ConnectionMetadataInput,
+): string {
+  return JSON.stringify(
+    ConnectionMetadataInput$outboundSchema.parse(connectionMetadataInput),
+  );
+}
+
 /** @internal */
 export type ConnectionDefaults$Outbound = {
   id?: string | undefined;
@@ -581,7 +659,7 @@ export function connectionConfigurationToJSON(
 export type ConnectionInput$Outbound = {
   enabled?: boolean | undefined;
   settings?: { [k: string]: any } | null | undefined;
-  metadata?: { [k: string]: any } | null | undefined;
+  metadata?: ConnectionMetadataInput$Outbound | null | undefined;
   configuration?: Array<ConnectionConfiguration$Outbound> | undefined;
   custom_mappings?: Array<CustomMappingInput$Outbound> | undefined;
   consent_state?: string | undefined;
@@ -597,7 +675,8 @@ export const ConnectionInput$outboundSchema: z.ZodType<
 > = z.object({
   enabled: z.boolean().optional(),
   settings: z.nullable(z.record(z.any())).optional(),
-  metadata: z.nullable(z.record(z.any())).optional(),
+  metadata: z.nullable(z.lazy(() => ConnectionMetadataInput$outboundSchema))
+    .optional(),
   configuration: z.array(z.lazy(() => ConnectionConfiguration$outboundSchema))
     .optional(),
   customMappings: z.array(CustomMappingInput$outboundSchema).optional(),

package/src/models/components/connector.ts

@@ -15,6 +15,10 @@ import {
   ConnectorEvent,
   ConnectorEvent$inboundSchema,
 } from "./connectorevent.js";
+import {
+  ConnectorOverview,
+  ConnectorOverview$inboundSchema,
+} from "./connectoroverview.js";
 import {
   ConnectorSetting,
   ConnectorSetting$inboundSchema,
@@ -242,6 +246,10 @@ export type Connector = {
    */
   schemaSupport?: SchemaSupport | undefined;
   docs?: Array<ConnectorDoc> | undefined;
+  /**
+   * Editorial overview metadata for the connector, used to render the connector's Overview documentation (implementation difficulty, partnership requirements, sandbox availability, and other at-a-glance facts).
+   */
+  overview?: ConnectorOverview | undefined;
   tlsSupport?: TlsSupport | undefined;
 };
 
@@ -409,6 +417,7 @@ export const Connector$inboundSchema: z.ZodType<
   webhook_support: types.optional(WebhookSupport$inboundSchema),
   schema_support: types.optional(SchemaSupport$inboundSchema),
   docs: types.optional(z.array(ConnectorDoc$inboundSchema)),
+  overview: types.optional(ConnectorOverview$inboundSchema),
   tls_support: types.optional(z.lazy(() => TlsSupport$inboundSchema)),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/connectoroverview.ts

@@ -0,0 +1,346 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * At-a-glance implementation difficulty rating.
+ */
+export const Difficulty = {
+  Straightforward: "straightforward",
+  Moderate: "moderate",
+  Involved: "involved",
+  HighlyComplex: "highly_complex",
+} as const;
+/**
+ * At-a-glance implementation difficulty rating.
+ */
+export type Difficulty = OpenEnum<typeof Difficulty>;
+
+export type SupportedResourceCategories = {
+  /**
+   * Category name.
+   */
+  name: string;
+  /**
+   * Resource ids belonging to this category.
+   */
+  resources: Array<string>;
+};
+
+export type ExternalGuides = {
+  /**
+   * Guide title.
+   */
+  title: string;
+  /**
+   * Guide URL.
+   */
+  url: string;
+  /**
+   * Publisher of the guide.
+   */
+  source: string;
+};
+
+export type ResponsibilityMatrix = {
+  /**
+   * The responsibility area.
+   */
+  area: string;
+  /**
+   * Apideck's responsibility for this area.
+   */
+  apideck?: string | undefined;
+  /**
+   * The consumer's responsibility for this area.
+   */
+  consumer?: string | undefined;
+  /**
+   * The end customer's responsibility for this area.
+   */
+  customer?: string | undefined;
+};
+
+export type EnvironmentNotes = {
+  /**
+   * Environment name.
+   */
+  environment: string;
+  /**
+   * Description of the environment.
+   */
+  description: string;
+};
+
+/**
+ * Editorial overview metadata for the connector, used to render the connector's Overview documentation (implementation difficulty, partnership requirements, sandbox availability, and other at-a-glance facts).
+ */
+export type ConnectorOverview = {
+  /**
+   * Whether this connector's overview content is still in beta.
+   */
+  beta?: boolean | undefined;
+  /**
+   * Whether this connector is demo-only.
+   */
+  demo?: boolean | undefined;
+  /**
+   * At-a-glance implementation difficulty rating.
+   */
+  difficulty: Difficulty;
+  /**
+   * Short explanation of why the connector has the given difficulty rating.
+   */
+  difficultyReason: string;
+  /**
+   * Notes on the connector's authentication flow.
+   */
+  authenticationNote?: string | undefined;
+  /**
+   * Description of webhook support for this connector.
+   */
+  webhooks?: string | undefined;
+  /**
+   * Whether a partnership with the downstream provider is required.
+   */
+  partnershipRequired: boolean;
+  /**
+   * URL to the downstream provider's partnership/developer portal.
+   */
+  partnershipUrl?: string | undefined;
+  /**
+   * Additional notes about the partnership requirement.
+   */
+  partnershipNote?: string | undefined;
+  /**
+   * Name of the downstream provider's developer portal.
+   */
+  partnershipPortalName?: string | undefined;
+  /**
+   * Whether Apideck-managed credentials are available for this connector.
+   */
+  apideckCredentialsAvailable: boolean;
+  /**
+   * Additional notes about Apideck-managed credentials.
+   */
+  apideckCredentialsNote?: string | undefined;
+  /**
+   * Notes on costs associated with using this connector.
+   */
+  costs?: string | undefined;
+  /**
+   * Notes on rate limits enforced by the downstream provider.
+   */
+  rateLimits?: string | undefined;
+  /**
+   * The type of downstream account required to use this connector.
+   */
+  accountTypeRequired: string;
+  /**
+   * Whether a sandbox environment is available for this connector.
+   */
+  sandboxAvailable: boolean;
+  /**
+   * URL to the downstream provider's sandbox environment.
+   */
+  sandboxUrl?: string | undefined;
+  /**
+   * Additional notes about the sandbox environment.
+   */
+  sandboxNote?: string | undefined;
+  /**
+   * The access level a consumer's end user needs to authorize the connection.
+   */
+  consumerAccessLevel: string;
+  /**
+   * Flat list of important facts about this connector.
+   */
+  importantToKnow?: Array<string> | undefined;
+  /**
+   * Grouping of the connector's supported resources by category.
+   */
+  supportedResourceCategories?: Array<SupportedResourceCategories> | undefined;
+  /**
+   * Links to external guides relevant to this connector.
+   */
+  externalGuides?: Array<ExternalGuides> | undefined;
+  /**
+   * Who is responsible for each area of the integration. Cell values are display strings (e.g. "✓", "Docs provided"), not booleans.
+   */
+  responsibilityMatrix?: Array<ResponsibilityMatrix> | undefined;
+  /**
+   * Notes about the different environments (sandbox, production, etc.) available for this connector.
+   */
+  environmentNotes?: Array<EnvironmentNotes> | undefined;
+};
+
+/** @internal */
+export const Difficulty$inboundSchema: z.ZodType<
+  Difficulty,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Difficulty);
+
+/** @internal */
+export const SupportedResourceCategories$inboundSchema: z.ZodType<
+  SupportedResourceCategories,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: types.string(),
+  resources: z.array(types.string()),
+});
+
+export function supportedResourceCategoriesFromJSON(
+  jsonString: string,
+): SafeParseResult<SupportedResourceCategories, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SupportedResourceCategories$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SupportedResourceCategories' from JSON`,
+  );
+}
+
+/** @internal */
+export const ExternalGuides$inboundSchema: z.ZodType<
+  ExternalGuides,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: types.string(),
+  url: types.string(),
+  source: types.string(),
+});
+
+export function externalGuidesFromJSON(
+  jsonString: string,
+): SafeParseResult<ExternalGuides, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExternalGuides$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExternalGuides' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponsibilityMatrix$inboundSchema: z.ZodType<
+  ResponsibilityMatrix,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  area: types.string(),
+  apideck: types.optional(types.string()),
+  consumer: types.optional(types.string()),
+  customer: types.optional(types.string()),
+});
+
+export function responsibilityMatrixFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponsibilityMatrix, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponsibilityMatrix$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponsibilityMatrix' from JSON`,
+  );
+}
+
+/** @internal */
+export const EnvironmentNotes$inboundSchema: z.ZodType<
+  EnvironmentNotes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  environment: types.string(),
+  description: types.string(),
+});
+
+export function environmentNotesFromJSON(
+  jsonString: string,
+): SafeParseResult<EnvironmentNotes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EnvironmentNotes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EnvironmentNotes' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConnectorOverview$inboundSchema: z.ZodType<
+  ConnectorOverview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  beta: types.optional(types.boolean()),
+  demo: types.optional(types.boolean()),
+  difficulty: Difficulty$inboundSchema,
+  difficulty_reason: types.string(),
+  authentication_note: types.optional(types.string()),
+  webhooks: types.optional(types.string()),
+  partnership_required: types.boolean(),
+  partnership_url: types.optional(types.string()),
+  partnership_note: types.optional(types.string()),
+  partnership_portal_name: types.optional(types.string()),
+  apideck_credentials_available: types.boolean(),
+  apideck_credentials_note: types.optional(types.string()),
+  costs: types.optional(types.string()),
+  rate_limits: types.optional(types.string()),
+  account_type_required: types.string(),
+  sandbox_available: types.boolean(),
+  sandbox_url: types.optional(types.string()),
+  sandbox_note: types.optional(types.string()),
+  consumer_access_level: types.string(),
+  important_to_know: types.optional(z.array(types.string())),
+  supported_resource_categories: types.optional(
+    z.array(z.lazy(() => SupportedResourceCategories$inboundSchema)),
+  ),
+  external_guides: types.optional(
+    z.array(z.lazy(() => ExternalGuides$inboundSchema)),
+  ),
+  responsibility_matrix: types.optional(
+    z.array(z.lazy(() => ResponsibilityMatrix$inboundSchema)),
+  ),
+  environment_notes: types.optional(
+    z.array(z.lazy(() => EnvironmentNotes$inboundSchema)),
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "difficulty_reason": "difficultyReason",
+    "authentication_note": "authenticationNote",
+    "partnership_required": "partnershipRequired",
+    "partnership_url": "partnershipUrl",
+    "partnership_note": "partnershipNote",
+    "partnership_portal_name": "partnershipPortalName",
+    "apideck_credentials_available": "apideckCredentialsAvailable",
+    "apideck_credentials_note": "apideckCredentialsNote",
+    "rate_limits": "rateLimits",
+    "account_type_required": "accountTypeRequired",
+    "sandbox_available": "sandboxAvailable",
+    "sandbox_url": "sandboxUrl",
+    "sandbox_note": "sandboxNote",
+    "consumer_access_level": "consumerAccessLevel",
+    "important_to_know": "importantToKnow",
+    "supported_resource_categories": "supportedResourceCategories",
+    "external_guides": "externalGuides",
+    "responsibility_matrix": "responsibilityMatrix",
+    "environment_notes": "environmentNotes",
+  });
+});
+
+export function connectorOverviewFromJSON(
+  jsonString: string,
+): SafeParseResult<ConnectorOverview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConnectorOverview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConnectorOverview' from JSON`,
+  );
+}

package/src/models/components/consumerconnection.ts

@@ -4,7 +4,10 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -18,6 +21,17 @@ import {
   ConnectionState$inboundSchema,
 } from "./connectionstate.js";
 
+/**
+ * Attach your own consumer specific metadata
+ */
+export type Metadata = {
+  /**
+   * Normalized identifier of the authorized organization, copied from the connector-specific setting (e.g. Xero tenant_id, QuickBooks realm_id, NetSuite account_id).
+   */
+  companyId?: string | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
 export type ConsumerConnection = {
   id?: string | undefined;
   name?: string | undefined;
@@ -40,7 +54,7 @@ export type ConsumerConnection = {
   /**
    * Attach your own consumer specific metadata
    */
-  metadata?: { [k: string]: any } | null | undefined;
+  metadata?: Metadata | null | undefined;
   createdAt?: string | undefined;
   updatedAt?: string | null | undefined;
   /**
@@ -61,6 +75,33 @@ export type ConsumerConnection = {
   lastRefreshFailedAt?: string | null | undefined;
 };
 
+/** @internal */
+export const Metadata$inboundSchema: z.ZodType<
+  Metadata,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    company_id: types.optional(types.string()),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+).transform((v) => {
+  return remap$(v, {
+    "company_id": "companyId",
+  });
+});
+
+export function metadataFromJSON(
+  jsonString: string,
+): SafeParseResult<Metadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Metadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const ConsumerConnection$inboundSchema: z.ZodType<
   ConsumerConnection,
@@ -79,7 +120,7 @@ export const ConsumerConnection$inboundSchema: z.ZodType<
   auth_type: types.optional(AuthType$inboundSchema),
   enabled: types.optional(types.boolean()),
   settings: z.nullable(z.record(z.any())).optional(),
-  metadata: z.nullable(z.record(z.any())).optional(),
+  metadata: z.nullable(z.lazy(() => Metadata$inboundSchema)).optional(),
   created_at: types.optional(types.string()),
   updated_at: z.nullable(types.string()).optional(),
   state: types.optional(ConnectionState$inboundSchema),

package/src/models/components/expensereport.ts

@@ -211,6 +211,10 @@ export type ExpenseReport = {
    * Expense line items linked to this expense report.
    */
   lineItems: Array<ExpenseReportLineItem>;
+  /**
+   * Optional reference identifier for the transaction.
+   */
+  reference?: string | null | undefined;
   subsidiary?: LinkedSubsidiary | null | undefined;
   /**
    * A list of linked tracking categories.
@@ -327,6 +331,10 @@ export type ExpenseReportInput = {
    * Expense line items linked to this expense report.
    */
   lineItems: Array<ExpenseReportLineItemInput>;
+  /**
+   * Optional reference identifier for the transaction.
+   */
+  reference?: string | null | undefined;
   subsidiary?: LinkedSubsidiaryInput | null | undefined;
   /**
    * A list of linked tracking categories.
@@ -530,6 +538,7 @@ export const ExpenseReport$inboundSchema: z.ZodType<
   accounting_period: z.nullable(z.lazy(() => AccountingPeriod$inboundSchema))
     .optional(),
   line_items: z.array(ExpenseReportLineItem$inboundSchema),
+  reference: z.nullable(types.string()).optional(),
   subsidiary: z.nullable(LinkedSubsidiary$inboundSchema).optional(),
   tracking_categories: z.nullable(
     z.array(types.nullable(LinkedTrackingCategory$inboundSchema)),
@@ -603,6 +612,7 @@ export type ExpenseReportInput$Outbound = {
   account?: LinkedLedgerAccount$Outbound | null | undefined;
   accounting_period?: AccountingPeriod$Outbound | null | undefined;
   line_items: Array<ExpenseReportLineItemInput$Outbound>;
+  reference?: string | null | undefined;
   subsidiary?: LinkedSubsidiaryInput$Outbound | null | undefined;
   tracking_categories?:
     | Array<LinkedTrackingCategory$Outbound | null>
@@ -646,6 +656,7 @@ export const ExpenseReportInput$outboundSchema: z.ZodType<
   accountingPeriod: z.nullable(z.lazy(() => AccountingPeriod$outboundSchema))
     .optional(),
   lineItems: z.array(ExpenseReportLineItemInput$outboundSchema),
+  reference: z.nullable(z.string()).optional(),
   subsidiary: z.nullable(LinkedSubsidiaryInput$outboundSchema).optional(),
   trackingCategories: z.nullable(
     z.array(z.nullable(LinkedTrackingCategory$outboundSchema)),