@unified-api/typescript-sdk 2.80.8 → 2.80.10

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

@@ -0,0 +1,64 @@
+/*
+ * 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 * as shared from "../shared/index.js";
+
+export type UpdateCommerceSaleschannelRequest = {
+  commerceSaleschannel: shared.CommerceSaleschannel;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Saleschannel
+   */
+  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 type UpdateCommerceSaleschannelRequest$Outbound = {
+  CommerceSaleschannel: shared.CommerceSaleschannel$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const UpdateCommerceSaleschannelRequest$outboundSchema: z.ZodType<
+  UpdateCommerceSaleschannelRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateCommerceSaleschannelRequest
+> = z.object({
+  commerceSaleschannel: shared.CommerceSaleschannel$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    commerceSaleschannel: "CommerceSaleschannel",
+    connectionId: "connection_id",
+  });
+});
+
+export function updateCommerceSaleschannelRequestToJSON(
+  updateCommerceSaleschannelRequest: UpdateCommerceSaleschannelRequest,
+): string {
+  return JSON.stringify(
+    UpdateCommerceSaleschannelRequest$outboundSchema.parse(
+      updateCommerceSaleschannelRequest,
+    ),
+  );
+}

package/src/sdk/models/shared/commercecollection.ts

@@ -39,9 +39,6 @@ export type CommerceCollection = {
   isActive?: boolean | undefined;
   isFeatured?: boolean | undefined;
   isVisible?: boolean | undefined;
-  /**
-   * includes the list of metadata_metadata required to create a commerce_item under the respective commerce_collection
-   */
   itemMetadata?: Array<CommerceMetadata> | undefined;
   media?: Array<CommerceItemMedia> | undefined;
   metadata?: Array<CommerceMetadata> | undefined;

package/src/sdk/models/shared/commercemetadata.ts

@@ -64,9 +64,9 @@ export type CommerceMetadata = {
     | undefined;
   format?: CommerceMetadataFormat | undefined;
   id?: string | undefined;
+  isRequired?: boolean | undefined;
   key?: string | undefined;
   namespace?: string | undefined;
-  required?: boolean | undefined;
   slug?: string | undefined;
   type?: string | undefined;
   value?:
@@ -402,9 +402,9 @@ export const CommerceMetadata$inboundSchema: z.ZodType<
   ]).optional(),
   format: CommerceMetadataFormat$inboundSchema.optional(),
   id: z.string().optional(),
+  is_required: z.boolean().optional(),
   key: z.string().optional(),
   namespace: z.string().optional(),
-  required: z.boolean().optional(),
   slug: z.string().optional(),
   type: z.string().optional(),
   value: z.union([
@@ -424,6 +424,7 @@ export const CommerceMetadata$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "extra_data": "extraData",
+    "is_required": "isRequired",
   });
 });
 /** @internal */
@@ -438,9 +439,9 @@ export type CommerceMetadata$Outbound = {
     | undefined;
   format?: string | undefined;
   id?: string | undefined;
+  is_required?: boolean | undefined;
   key?: string | undefined;
   namespace?: string | undefined;
-  required?: boolean | undefined;
   slug?: string | undefined;
   type?: string | undefined;
   value?:
@@ -475,9 +476,9 @@ export const CommerceMetadata$outboundSchema: z.ZodType<
   ]).optional(),
   format: CommerceMetadataFormat$outboundSchema.optional(),
   id: z.string().optional(),
+  isRequired: z.boolean().optional(),
   key: z.string().optional(),
   namespace: z.string().optional(),
-  required: z.boolean().optional(),
   slug: z.string().optional(),
   type: z.string().optional(),
   value: z.union([
@@ -497,6 +498,7 @@ export const CommerceMetadata$outboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     extraData: "extra_data",
+    isRequired: "is_required",
   });
 });
 

package/src/sdk/models/shared/commercereference.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CommerceReference = {
+  id?: string | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const CommerceReference$inboundSchema: z.ZodType<
+  CommerceReference,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+});
+/** @internal */
+export type CommerceReference$Outbound = {
+  id?: string | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const CommerceReference$outboundSchema: z.ZodType<
+  CommerceReference$Outbound,
+  z.ZodTypeDef,
+  CommerceReference
+> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+});
+
+export function commerceReferenceToJSON(
+  commerceReference: CommerceReference,
+): string {
+  return JSON.stringify(
+    CommerceReference$outboundSchema.parse(commerceReference),
+  );
+}
+export function commerceReferenceFromJSON(
+  jsonString: string,
+): SafeParseResult<CommerceReference, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommerceReference$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommerceReference' from JSON`,
+  );
+}

package/src/sdk/models/shared/commercesaleschannel.ts

@@ -0,0 +1,103 @@
+/*
+ * 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";
+import {
+  CommerceReference,
+  CommerceReference$inboundSchema,
+  CommerceReference$Outbound,
+  CommerceReference$outboundSchema,
+} from "./commercereference.js";
+
+export type CommerceSaleschannel = {
+  /**
+   * points to a CommerceCollection
+   */
+  collections?: Array<CommerceReference> | undefined;
+  createdAt?: Date | undefined;
+  description?: string | undefined;
+  id?: string | undefined;
+  isActive?: boolean | undefined;
+  raw?: { [k: string]: any } | undefined;
+  slug?: string | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const CommerceSaleschannel$inboundSchema: z.ZodType<
+  CommerceSaleschannel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  collections: z.array(CommerceReference$inboundSchema).optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  description: z.string().optional(),
+  id: z.string().optional(),
+  is_active: z.boolean().optional(),
+  raw: z.record(z.any()).optional(),
+  slug: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "is_active": "isActive",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type CommerceSaleschannel$Outbound = {
+  collections?: Array<CommerceReference$Outbound> | undefined;
+  created_at?: string | undefined;
+  description?: string | undefined;
+  id?: string | undefined;
+  is_active?: boolean | undefined;
+  raw?: { [k: string]: any } | undefined;
+  slug?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const CommerceSaleschannel$outboundSchema: z.ZodType<
+  CommerceSaleschannel$Outbound,
+  z.ZodTypeDef,
+  CommerceSaleschannel
+> = z.object({
+  collections: z.array(CommerceReference$outboundSchema).optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  description: z.string().optional(),
+  id: z.string().optional(),
+  isActive: z.boolean().optional(),
+  raw: z.record(z.any()).optional(),
+  slug: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    isActive: "is_active",
+    updatedAt: "updated_at",
+  });
+});
+
+export function commerceSaleschannelToJSON(
+  commerceSaleschannel: CommerceSaleschannel,
+): string {
+  return JSON.stringify(
+    CommerceSaleschannel$outboundSchema.parse(commerceSaleschannel),
+  );
+}
+export function commerceSaleschannelFromJSON(
+  jsonString: string,
+): SafeParseResult<CommerceSaleschannel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommerceSaleschannel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommerceSaleschannel' from JSON`,
+  );
+}

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

@@ -83,8 +83,10 @@ export * from "./commerceitemprice.js";
 export * from "./commerceitemvariant.js";
 export * from "./commercelocation.js";
 export * from "./commercemetadata.js";
+export * from "./commercereference.js";
 export * from "./commercereview.js";
 export * from "./commercereviewcomment.js";
+export * from "./commercesaleschannel.js";
 export * from "./connection.js";
 export * from "./crmcompany.js";
 export * from "./crmcontact.js";

package/src/sdk/models/shared/integrationsupport.ts

@@ -35,6 +35,13 @@ export const ListApplicationId = {
 } as const;
 export type ListApplicationId = OpenEnum<typeof ListApplicationId>;
 
+export const ListBenefitId = {
+  SupportedRequired: "supported-required",
+  Supported: "supported",
+  NotSupported: "not-supported",
+} as const;
+export type ListBenefitId = OpenEnum<typeof ListBenefitId>;
+
 export const ListBranchId = {
   SupportedRequired: "supported-required",
   Supported: "supported",
@@ -345,6 +352,13 @@ export const ListRootId = {
 } as const;
 export type ListRootId = OpenEnum<typeof ListRootId>;
 
+export const ListSaleschannelId = {
+  SupportedRequired: "supported-required",
+  Supported: "supported",
+  NotSupported: "not-supported",
+} as const;
+export type ListSaleschannelId = OpenEnum<typeof ListSaleschannelId>;
+
 export const ListSortByCreatedAt = {
   SupportedRequired: "supported-required",
   Supported: "supported",
@@ -746,6 +760,15 @@ export const VirtualWebhookRepoId = {
 } as const;
 export type VirtualWebhookRepoId = OpenEnum<typeof VirtualWebhookRepoId>;
 
+export const VirtualWebhookSaleschannelId = {
+  SupportedRequired: "supported-required",
+  Supported: "supported",
+  NotSupported: "not-supported",
+} as const;
+export type VirtualWebhookSaleschannelId = OpenEnum<
+  typeof VirtualWebhookSaleschannelId
+>;
+
 export const VirtualWebhookSpaceId = {
   SupportedRequired: "supported-required",
   Supported: "supported",
@@ -818,6 +841,7 @@ export type IntegrationSupport = {
   inboundFields?: { [k: string]: string } | undefined;
   listAccountId?: ListAccountId | undefined;
   listApplicationId?: ListApplicationId | undefined;
+  listBenefitId?: ListBenefitId | undefined;
   listBranchId?: ListBranchId | undefined;
   listCalendarId?: ListCalendarId | undefined;
   listCallId?: ListCallId | undefined;
@@ -862,6 +886,7 @@ export type IntegrationSupport = {
   listRawFields?: ListRawFields | undefined;
   listRepoId?: ListRepoId | undefined;
   listRootId?: ListRootId | undefined;
+  listSaleschannelId?: ListSaleschannelId | undefined;
   listSortByCreatedAt?: ListSortByCreatedAt | undefined;
   listSortByName?: ListSortByName | undefined;
   listSortByUpdatedAt?: ListSortByUpdatedAt | undefined;
@@ -924,6 +949,7 @@ export type IntegrationSupport = {
   virtualWebhookPipelineId?: VirtualWebhookPipelineId | undefined;
   virtualWebhookProjectId?: VirtualWebhookProjectId | undefined;
   virtualWebhookRepoId?: VirtualWebhookRepoId | undefined;
+  virtualWebhookSaleschannelId?: VirtualWebhookSaleschannelId | undefined;
   virtualWebhookSpaceId?: VirtualWebhookSpaceId | undefined;
   virtualWebhookStartGte?: VirtualWebhookStartGte | undefined;
   virtualWebhookStatus?: VirtualWebhookStatus | undefined;
@@ -957,6 +983,13 @@ export const ListApplicationId$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(ListApplicationId);
 
+/** @internal */
+export const ListBenefitId$inboundSchema: z.ZodType<
+  ListBenefitId,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListBenefitId);
+
 /** @internal */
 export const ListBranchId$inboundSchema: z.ZodType<
   ListBranchId,
@@ -1265,6 +1298,13 @@ export const ListRootId$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(ListRootId);
 
+/** @internal */
+export const ListSaleschannelId$inboundSchema: z.ZodType<
+  ListSaleschannelId,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListSaleschannelId);
+
 /** @internal */
 export const ListSortByCreatedAt$inboundSchema: z.ZodType<
   ListSortByCreatedAt,
@@ -1650,6 +1690,13 @@ export const VirtualWebhookRepoId$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(VirtualWebhookRepoId);
 
+/** @internal */
+export const VirtualWebhookSaleschannelId$inboundSchema: z.ZodType<
+  VirtualWebhookSaleschannelId,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(VirtualWebhookSaleschannelId);
+
 /** @internal */
 export const VirtualWebhookSpaceId$inboundSchema: z.ZodType<
   VirtualWebhookSpaceId,
@@ -1723,6 +1770,7 @@ export const IntegrationSupport$inboundSchema: z.ZodType<
   inbound_fields: z.record(z.string()).optional(),
   list_account_id: ListAccountId$inboundSchema.optional(),
   list_application_id: ListApplicationId$inboundSchema.optional(),
+  list_benefit_id: ListBenefitId$inboundSchema.optional(),
   list_branch_id: ListBranchId$inboundSchema.optional(),
   list_calendar_id: ListCalendarId$inboundSchema.optional(),
   list_call_id: ListCallId$inboundSchema.optional(),
@@ -1768,6 +1816,7 @@ export const IntegrationSupport$inboundSchema: z.ZodType<
   list_raw_fields: ListRawFields$inboundSchema.optional(),
   list_repo_id: ListRepoId$inboundSchema.optional(),
   list_root_id: ListRootId$inboundSchema.optional(),
+  list_saleschannel_id: ListSaleschannelId$inboundSchema.optional(),
   list_sort_by_created_at: ListSortByCreatedAt$inboundSchema.optional(),
   list_sort_by_name: ListSortByName$inboundSchema.optional(),
   list_sort_by_updated_at: ListSortByUpdatedAt$inboundSchema.optional(),
@@ -1835,6 +1884,8 @@ export const IntegrationSupport$inboundSchema: z.ZodType<
     .optional(),
   virtual_webhook_project_id: VirtualWebhookProjectId$inboundSchema.optional(),
   virtual_webhook_repo_id: VirtualWebhookRepoId$inboundSchema.optional(),
+  virtual_webhook_saleschannel_id: VirtualWebhookSaleschannelId$inboundSchema
+    .optional(),
   virtual_webhook_space_id: VirtualWebhookSpaceId$inboundSchema.optional(),
   virtual_webhook_start_gte: VirtualWebhookStartGte$inboundSchema.optional(),
   virtual_webhook_status: VirtualWebhookStatus$inboundSchema.optional(),
@@ -1854,6 +1905,7 @@ export const IntegrationSupport$inboundSchema: z.ZodType<
     "inbound_fields": "inboundFields",
     "list_account_id": "listAccountId",
     "list_application_id": "listApplicationId",
+    "list_benefit_id": "listBenefitId",
     "list_branch_id": "listBranchId",
     "list_calendar_id": "listCalendarId",
     "list_call_id": "listCallId",
@@ -1898,6 +1950,7 @@ export const IntegrationSupport$inboundSchema: z.ZodType<
     "list_raw_fields": "listRawFields",
     "list_repo_id": "listRepoId",
     "list_root_id": "listRootId",
+    "list_saleschannel_id": "listSaleschannelId",
     "list_sort_by_created_at": "listSortByCreatedAt",
     "list_sort_by_name": "listSortByName",
     "list_sort_by_updated_at": "listSortByUpdatedAt",
@@ -1956,6 +2009,7 @@ export const IntegrationSupport$inboundSchema: z.ZodType<
     "virtual_webhook_pipeline_id": "virtualWebhookPipelineId",
     "virtual_webhook_project_id": "virtualWebhookProjectId",
     "virtual_webhook_repo_id": "virtualWebhookRepoId",
+    "virtual_webhook_saleschannel_id": "virtualWebhookSaleschannelId",
     "virtual_webhook_space_id": "virtualWebhookSpaceId",
     "virtual_webhook_start_gte": "virtualWebhookStartGte",
     "virtual_webhook_status": "virtualWebhookStatus",

package/src/sdk/models/shared/propertyconnectionpermissions.ts

@@ -62,6 +62,8 @@ export const PropertyConnectionPermissions = {
   CommerceLocationWrite: "commerce_location_write",
   CommerceReviewRead: "commerce_review_read",
   CommerceReviewWrite: "commerce_review_write",
+  CommerceSaleschannelRead: "commerce_saleschannel_read",
+  CommerceSaleschannelWrite: "commerce_saleschannel_write",
   VerificationPackageRead: "verification_package_read",
   VerificationRequestRead: "verification_request_read",
   VerificationRequestWrite: "verification_request_write",

package/src/sdk/models/shared/webhook.ts

@@ -56,6 +56,7 @@ export const ObjectType = {
   CommerceInventory: "commerce_inventory",
   CommerceLocation: "commerce_location",
   CommerceReview: "commerce_review",
+  CommerceSaleschannel: "commerce_saleschannel",
   VerificationPackage: "verification_package",
   VerificationRequest: "verification_request",
   AtsActivity: "ats_activity",

package/src/sdk/saleschannel.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { commerceCreateCommerceSaleschannel } from "../funcs/commerceCreateCommerceSaleschannel.js";
+import { commerceGetCommerceSaleschannel } from "../funcs/commerceGetCommerceSaleschannel.js";
+import { commerceListCommerceSaleschannels } from "../funcs/commerceListCommerceSaleschannels.js";
+import { commercePatchCommerceSaleschannel } from "../funcs/commercePatchCommerceSaleschannel.js";
+import { commerceRemoveCommerceSaleschannel } from "../funcs/commerceRemoveCommerceSaleschannel.js";
+import { commerceUpdateCommerceSaleschannel } from "../funcs/commerceUpdateCommerceSaleschannel.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 Saleschannel extends ClientSDK {
+  /**
+   * Create a saleschannel
+   */
+  async createCommerceSaleschannel(
+    request: operations.CreateCommerceSaleschannelRequest,
+    options?: RequestOptions,
+  ): Promise<shared.CommerceSaleschannel> {
+    return unwrapAsync(commerceCreateCommerceSaleschannel(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a saleschannel
+   */
+  async getCommerceSaleschannel(
+    request: operations.GetCommerceSaleschannelRequest,
+    options?: RequestOptions,
+  ): Promise<shared.CommerceSaleschannel> {
+    return unwrapAsync(commerceGetCommerceSaleschannel(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all saleschannels
+   */
+  async listCommerceSaleschannels(
+    request: operations.ListCommerceSaleschannelsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.CommerceSaleschannel>> {
+    return unwrapAsync(commerceListCommerceSaleschannels(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a saleschannel
+   */
+  async patchCommerceSaleschannel(
+    request: operations.PatchCommerceSaleschannelRequest,
+    options?: RequestOptions,
+  ): Promise<shared.CommerceSaleschannel> {
+    return unwrapAsync(commercePatchCommerceSaleschannel(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Remove a saleschannel
+   */
+  async removeCommerceSaleschannel(
+    request: operations.RemoveCommerceSaleschannelRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RemoveCommerceSaleschannelResponse | undefined> {
+    return unwrapAsync(commerceRemoveCommerceSaleschannel(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a saleschannel
+   */
+  async updateCommerceSaleschannel(
+    request: operations.UpdateCommerceSaleschannelRequest,
+    options?: RequestOptions,
+  ): Promise<shared.CommerceSaleschannel> {
+    return unwrapAsync(commerceUpdateCommerceSaleschannel(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -93,6 +93,7 @@ import { Report } from "./report.js";
 import { Repository } from "./repository.js";
 import { RequestT } from "./request.js";
 import { Review } from "./review.js";
+import { Saleschannel } from "./saleschannel.js";
 import { Salesorder } from "./salesorder.js";
 import { Scim } from "./scim.js";
 import { Scorecard } from "./scorecard.js";
@@ -320,6 +321,11 @@ export class UnifiedTo extends ClientSDK {
     return (this._review ??= new Review(this._options));
   }
 
+  private _saleschannel?: Saleschannel;
+  get saleschannel(): Saleschannel {
+    return (this._saleschannel ??= new Saleschannel(this._options));
+  }
+
   private _crm?: Crm;
   get crm(): Crm {
     return (this._crm ??= new Crm(this._options));