@gtmi/ramp-api-client 0.0.1 → 0.0.2

package/src/generated/zod.gen.ts

@@ -2,6 +2,60 @@
 
 import { z } from 'zod';
 
+export const zErrorResponse = z.object({
+  error: z.string().optional(),
+  details: z.string().optional(),
+});
+
+export const zConversation = z.object({
+  accountId: z.string().optional(),
+  configuration: z.string().optional(),
+  configurationId: z.string().optional(),
+  createdAt: z.string().optional(),
+  id: z.string().optional(),
+  name: z.string().optional(),
+  status: z.string().optional(),
+  updatedAt: z.string().optional(),
+});
+
+export const zParticipant = z.object({
+  id: z.string().optional(),
+  conversationId: z.string().optional(),
+  accountId: z.string().optional(),
+  name: z.string().optional(),
+  type: z.string().optional(),
+  addresses: z.string().optional(),
+  createdAt: z.string().optional(),
+  updatedAt: z.string().optional(),
+  profileId: z.string().optional(),
+});
+
+export const zOperator = z.object({
+  id: z.string().optional(),
+  displayName: z.string().optional(),
+  description: z.string().optional(),
+  version: z.string().optional(),
+  availability: z.string().optional(),
+  author: z.string().optional(),
+  prompt: z.string().optional(),
+  outputFormat: z.string().optional(),
+  outputSchema: z.string().optional(),
+  trainingExamples: z.string().optional(),
+  context: z.string().optional(),
+  parameters: z.string().optional(),
+});
+
+export const zIntelligenceConfiguration = z.object({
+  accountId: z.string().optional(),
+  dateCreated: z.string().optional(),
+  dateUpdated: z.string().optional(),
+  description: z.string().optional(),
+  displayName: z.string().optional(),
+  id: z.string().optional(),
+  rules: z.string().optional(),
+  version: z.string().optional(),
+});
+
 export const zAutogenRequest = z.object({
   email: z.string().optional(),
   company: z.string().optional(),
@@ -16,6 +70,41 @@ export const zAutogenRequest = z.object({
   websiteUrl: z.string().optional(),
 });
 
+export const zTemplateData = z.object({
+  objectID: z.string().optional(),
+  title: z.string().optional(),
+  img: z.string().optional(),
+  associatedNumbers: z.string().optional(),
+  author: z.string().optional(),
+  createdAt: z.string().optional(),
+  createdAtUnix: z.string().optional(),
+  lastUpdatedAtUnix: z.string().optional(),
+  lastUpdated: z.string().optional(),
+  lastUpdatedBy: z.string().optional(),
+  prompt: z.string().optional(),
+  data: z.string().optional(),
+  content: z.string().optional(),
+});
+
+export const zCalledByData = z.object({
+  phoneNumber: z.string().optional(),
+  timestamp: z.number().optional(),
+  direction: z.string().optional(),
+  objectId: z.string().optional(),
+});
+
+export const zCampaign = z.object({
+  email: z.string().optional(),
+  companyName: z.string().optional(),
+  objectID: z.string().optional(),
+  encryptedObjectId: z.string().optional(),
+  agentNumber: z.string().optional(),
+  tag: z.string().optional(),
+  createdAt: z.string().optional(),
+  numCalls: z.string().optional(),
+  shortLink: z.string().optional(),
+});
+
 export const zSupportedRegion = z.object({
   isoCountry: z.string().optional(),
   numberType: z.string().optional(),
@@ -27,24 +116,73 @@ export const zSupportedRegion = z.object({
 
 export const zShortenUrlInput = z.record(z.unknown());
 
+/**
+ * Success
+ */
+export const zGetHealthResponse = z.object({
+  status: z.string(),
+});
+
 export const zPostConversationsTokenBody = z.record(z.unknown());
 
+/**
+ * Success
+ */
+export const zPostConversationsTokenResponse = z.object({
+  identity: z.string(),
+  token: z.string(),
+});
+
 export const zGetSyncTokenQuery = z.object({
   identity: z.string().optional(),
 });
 
+/**
+ * Success
+ */
+export const zGetSyncTokenResponse = z.object({
+  identity: z.string(),
+  token: z.string(),
+});
+
 export const zGetVoiceTokenQuery = z.object({
   identity: z.string().optional(),
 });
 
+/**
+ * Success
+ */
+export const zGetVoiceTokenResponse = z.object({
+  identity: z.string(),
+  token: z.string(),
+});
+
 export const zPostUiConfigBody = z.record(z.unknown());
 
+/**
+ * Success
+ */
+export const zPostUiConfigResponse = z.object({
+  ui: z.record(z.unknown()),
+  linkMap: z.record(z.unknown()),
+  hideChatLink: z.boolean(),
+  templateTitle: z.string(),
+  dialogConfig: z.record(z.unknown()),
+  templateObjectId: z.string(),
+  resolvedCustomerNumber: z.string(),
+});
+
 export const zPostCreateExternalFlexConnectionBody = z.object({
   seAccountSid: z.string(),
   seApiKeySid: z.string(),
   seApiKeySecret: z.string(),
 });
 
+/**
+ * Studio Flow, TwiML App, and RAMP integration configuration
+ */
+export const zPostCreateExternalFlexConnectionResponse = z.record(z.unknown());
+
 export const zPostInstallFlexPluginBody = z.object({
   seAccountSid: z.string(),
   seApiKeySid: z.string(),
@@ -52,26 +190,91 @@ export const zPostInstallFlexPluginBody = z.object({
   pluginName: z.string(),
 });
 
+/**
+ * Success
+ */
+export const zPostInstallFlexPluginResponse = z.object({
+  success: z.boolean(),
+  plugin: z.record(z.unknown()),
+  deployedVersion: z.string(),
+  release: z.record(z.unknown()),
+});
+
 export const zPostLiveAgentWebchatConnectBody = z.record(z.unknown());
 
+export const zPostLiveAgentWebchatConnectResponse = z.union([
+  z.unknown(),
+  z.object({
+    conversationSid: z.string(),
+    interactionSid: z.string(),
+    interactionChannelSid: z.string(),
+    identity: z.string(),
+    serviceSid: z.string(),
+  }),
+]);
+
 export const zPostLiveAgentWebchatSendBody = z.object({
   conversationSid: z.string(),
   identity: z.string(),
   message: z.string(),
 });
 
+export const zPostLiveAgentWebchatSendResponse = z.union([
+  z.unknown(),
+  z.object({
+    message: z.record(z.unknown()),
+  }),
+]);
+
 export const zPostLiveAgentWebchatEndBody = z.record(z.unknown());
 
+/**
+ * Success
+ */
+export const zPostLiveAgentWebchatEndResponse = z.object({
+  success: z.boolean(),
+});
+
+/**
+ * Success
+ */
+export const zDeleteLeadGenResponse = z.object({
+  message: z.string(),
+});
+
 export const zPatchLeadGenBody = z.record(z.unknown());
 
+/**
+ * Success
+ */
+export const zPatchLeadGenResponse = z.object({
+  message: z.string(),
+  data: z.record(z.unknown()),
+});
+
 export const zPostLeadGenBody = z.object({
   objectID: z.string(),
   userEmail: z.string(),
 });
 
+/**
+ * Success
+ */
+export const zPostLeadGenResponse = z.object({
+  agentNumber: z.string(),
+});
+
+/**
+ * Success
+ */
+export const zPostLeadGenMonitorResponse = z.object({
+  message: z.string(),
+  data: z.record(z.unknown()),
+});
+
 export const zPostConversationsCommunicationsByConversationIdBody = z.object({
-  author: z.string(),
-  content: z.string(),
+  author: z.record(z.unknown()),
+  content: z.record(z.unknown()),
   recipients: z.string(),
 });
 
@@ -79,45 +282,94 @@ export const zPostConversationsCommunicationsByConversationIdPath = z.object({
   conversationId: z.string(),
 });
 
+export const zPostConversationsCommunicationsByConversationIdResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zGetConversationsFetchQuery = z.object({
   conversationId: z.string().optional(),
   status: z.string().optional(),
 });
 
+/**
+ * A single Conversation (when conversationId is provided) or a paginated conversations list
+ */
+export const zGetConversationsFetchResponse = z.record(z.unknown());
+
 export const zPostConversationsBody = z.object({
   configurationId: z.string(),
 });
 
+/**
+ * The created conversation
+ */
+export const zPostConversationsResponse = zConversation;
+
 export const zPutConversationsBody = z.object({
   conversationsId: z.string(),
   status: z.string(),
 });
 
+/**
+ * The updated conversation object
+ */
+export const zPutConversationsResponse = zConversation;
+
 export const zGetParticipantsQuery = z.object({
   conversationId: z.string().optional(),
   participantId: z.string().optional(),
 });
 
+/**
+ * Success
+ */
+export const zGetParticipantsResponse = z.object({
+  participants: z.array(zParticipant),
+});
+
 export const zPostParticipantsBody = z.object({
   conversationId: z.string(),
   participantType: z.string(),
   addresses: z.string(),
 });
 
+/**
+ * The created participant object from Twilio
+ */
+export const zPostParticipantsResponse = z.record(z.unknown());
+
 export const zPutParticipantsBody = z.object({
   conversationId: z.string(),
   participantId: z.string(),
 });
 
+/**
+ * The updated participant object from Twilio
+ */
+export const zPutParticipantsResponse = z.record(z.unknown());
+
 export const zDeleteConversationalIntelligenceOperatorBody = z.object({
   intelligenceOperatorId: z.string(),
 });
 
+/**
+ * Success
+ */
+export const zDeleteConversationalIntelligenceOperatorResponse = z.object({
+  success: z.boolean(),
+});
+
 export const zGetConversationalIntelligenceOperatorQuery = z.object({
   intelligenceOperatorId: z.string().optional(),
   pageToken: z.string().optional(),
 });
 
+/**
+ * A single Operator (when intelligenceOperatorId is provided) or an OperatorList (paginated)
+ */
+export const zGetConversationalIntelligenceOperatorResponse = z.record(z.unknown());
+
 export const zPostConversationalIntelligenceOperatorBody = z.object({
   author: z.string(),
   displayName: z.string(),
@@ -127,6 +379,11 @@ export const zPostConversationalIntelligenceOperatorBody = z.object({
   uiType: z.string(),
 });
 
+/**
+ * The created operator object
+ */
+export const zPostConversationalIntelligenceOperatorResponse = zOperator;
+
 export const zPutConversationalIntelligenceOperatorBody = z.object({
   displayName: z.string(),
   description: z.string(),
@@ -136,22 +393,47 @@ export const zPutConversationalIntelligenceOperatorBody = z.object({
   intelligenceOperatorId: z.string(),
 });
 
+/**
+ * The updated operator object
+ */
+export const zPutConversationalIntelligenceOperatorResponse = zOperator;
+
 export const zGetIntelligenceConfigurationQuery = z.object({
   intelligenceConfigurationId: z.string().optional(),
   pageToken: z.string().optional(),
 });
 
+/**
+ * A single IntelligenceConfiguration (when intelligenceConfigurationId is provided) or an IntelligenceConfigurationList (paginated)
+ */
+export const zGetIntelligenceConfigurationResponse = z.record(z.unknown());
+
 export const zPostIntelligenceConfigurationBody = z.record(z.unknown());
 
+/**
+ * The created configuration
+ */
+export const zPostIntelligenceConfigurationResponse = zIntelligenceConfiguration;
+
 export const zPutIntelligenceConfigurationBody = z.object({
   intelligenceConfigurationId: z.string(),
 });
 
+/**
+ * The updated configuration
+ */
+export const zPutIntelligenceConfigurationResponse = zIntelligenceConfiguration;
+
 export const zDeleteConversationMemoryProfilesQuery = z.object({
   storeId: z.string().optional(),
   profileId: z.string().optional(),
 });
 
+export const zDeleteConversationMemoryProfilesResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zGetConversationMemoryProfilesQuery = z.object({
   storeId: z.string().optional(),
   profileId: z.string().optional(),
@@ -161,28 +443,53 @@ export const zGetConversationMemoryProfilesQuery = z.object({
   orderBy: z.string().optional(),
 });
 
+/**
+ * Upstream profile data (single profile or paginated list) from the Conversation Memory API
+ */
+export const zGetConversationMemoryProfilesResponse = z.record(z.unknown());
+
 export const zPatchConversationMemoryProfilesBody = z.object({
   storeId: z.string(),
   profileId: z.string(),
-  traits: z.string(),
+  traits: z.record(z.unknown()),
 });
 
+export const zPatchConversationMemoryProfilesResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zPostConversationMemoryProfilesBody = z.object({
   storeId: z.string(),
-  traits: z.string(),
+  traits: z.record(z.unknown()),
 });
 
+export const zPostConversationMemoryProfilesResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zPostConversationMemoryProfilesLookupBody = z.object({
   storeId: z.string(),
   idType: z.string(),
   value: z.string(),
 });
 
+/**
+ * Upstream matching profiles payload from the Conversation Memory API
+ */
+export const zPostConversationMemoryProfilesLookupResponse = z.record(z.unknown());
+
 export const zPostConversationMemoryRecallBody = z.object({
   storeId: z.string(),
   profileId: z.string(),
 });
 
+/**
+ * Upstream memory retrieval results from the Conversation Memory API
+ */
+export const zPostConversationMemoryRecallResponse = z.record(z.unknown());
+
 export const zDeleteConversationMemoryIdentifiersQuery = z.object({
   storeId: z.string().optional(),
   profileId: z.string().optional(),
@@ -190,12 +497,22 @@ export const zDeleteConversationMemoryIdentifiersQuery = z.object({
   removeAll: z.string().optional(),
 });
 
+export const zDeleteConversationMemoryIdentifiersResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zGetConversationMemoryIdentifiersQuery = z.object({
   storeId: z.string().optional(),
   profileId: z.string().optional(),
   idType: z.string().optional(),
 });
 
+/**
+ * Upstream identifier data from the Conversation Memory API
+ */
+export const zGetConversationMemoryIdentifiersResponse = z.record(z.unknown());
+
 export const zPatchConversationMemoryIdentifiersBody = z.object({
   storeId: z.string(),
   profileId: z.string(),
@@ -204,6 +521,11 @@ export const zPatchConversationMemoryIdentifiersBody = z.object({
   newValue: z.string(),
 });
 
+export const zPatchConversationMemoryIdentifiersResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zPostConversationMemoryIdentifiersBody = z.object({
   storeId: z.string(),
   profileId: z.string(),
@@ -211,11 +533,21 @@ export const zPostConversationMemoryIdentifiersBody = z.object({
   value: z.string(),
 });
 
+export const zPostConversationMemoryIdentifiersResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zDeleteConversationMemoryTraitGroupsQuery = z.object({
   storeId: z.string().optional(),
   traitGroupName: z.string().optional(),
 });
 
+export const zDeleteConversationMemoryTraitGroupsResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zGetConversationMemoryTraitGroupsQuery = z.object({
   storeId: z.string().optional(),
   traitGroupName: z.string().optional(),
@@ -225,16 +557,31 @@ export const zGetConversationMemoryTraitGroupsQuery = z.object({
   orderBy: z.string().optional(),
 });
 
+/**
+ * Upstream Trait Group data (single group or paginated list) from the Conversation Memory API
+ */
+export const zGetConversationMemoryTraitGroupsResponse = z.record(z.unknown());
+
 export const zPatchConversationMemoryTraitGroupsBody = z.object({
   storeId: z.string(),
   traitGroupName: z.string(),
 });
 
+export const zPatchConversationMemoryTraitGroupsResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zPostConversationMemoryTraitGroupsBody = z.object({
   storeId: z.string(),
   displayName: z.string(),
 });
 
+export const zPostConversationMemoryTraitGroupsResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zGetConversationMemoryTraitsQuery = z.object({
   storeId: z.string().optional(),
   profileId: z.string().optional(),
@@ -244,12 +591,22 @@ export const zGetConversationMemoryTraitsQuery = z.object({
   traitGroups: z.string().optional(),
 });
 
+/**
+ * Upstream paginated traits list from the Conversation Memory API
+ */
+export const zGetConversationMemoryTraitsResponse = z.record(z.unknown());
+
 export const zDeleteConversationMemoryObservationsQuery = z.object({
   storeId: z.string().optional(),
   profileId: z.string().optional(),
   observationId: z.string().optional(),
 });
 
+export const zDeleteConversationMemoryObservationsResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zGetConversationMemoryObservationsQuery = z.object({
   storeId: z.string().optional(),
   profileId: z.string().optional(),
@@ -262,6 +619,11 @@ export const zGetConversationMemoryObservationsQuery = z.object({
   createdBefore: z.string().optional(),
 });
 
+/**
+ * Upstream observation data (single observation or paginated list) from the Conversation Memory API
+ */
+export const zGetConversationMemoryObservationsResponse = z.record(z.unknown());
+
 export const zPatchConversationMemoryObservationsBody = z.object({
   storeId: z.string(),
   profileId: z.string(),
@@ -271,18 +633,33 @@ export const zPatchConversationMemoryObservationsBody = z.object({
   occurredAt: z.string(),
 });
 
+export const zPatchConversationMemoryObservationsResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zPostConversationMemoryObservationsBody = z.object({
   storeId: z.string(),
   profileId: z.string(),
   observations: z.string(),
 });
 
+export const zPostConversationMemoryObservationsResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zDeleteConversationMemoryConversationSummariesQuery = z.object({
   storeId: z.string().optional(),
   profileId: z.string().optional(),
   summaryId: z.string().optional(),
 });
 
+export const zDeleteConversationMemoryConversationSummariesResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zGetConversationMemoryConversationSummariesQuery = z.object({
   storeId: z.string().optional(),
   profileId: z.string().optional(),
@@ -291,27 +668,69 @@ export const zGetConversationMemoryConversationSummariesQuery = z.object({
   pageToken: z.string().optional(),
 });
 
+/**
+ * Upstream summary data (single summary or paginated list) from the Conversation Memory API
+ */
+export const zGetConversationMemoryConversationSummariesResponse = z.record(z.unknown());
+
 export const zPatchConversationMemoryConversationSummariesBody = z.object({
   storeId: z.string(),
   profileId: z.string(),
   summaryId: z.string(),
 });
 
+export const zPatchConversationMemoryConversationSummariesResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
 export const zPostConversationMemoryConversationSummariesBody = z.object({
   storeId: z.string(),
   profileId: z.string(),
   summaries: z.string(),
 });
 
+export const zPostConversationMemoryConversationSummariesResponse = z.union([
+  z.unknown(),
+  z.record(z.unknown()),
+]);
+
+/**
+ * Success
+ */
+export const zDeleteConversationMemoryResetResponse = z.object({
+  deletedObservations: z.number(),
+  deletedSummaries: z.number(),
+});
+
 export const zPostAssignDemoBody = z.object({
   phoneNumber: z.string(),
   targetObjectID: z.string(),
 });
 
+/**
+ * Success
+ */
+export const zPostAssignDemoResponse = z.object({
+  addedToTarget: z.boolean(),
+  message: z.string(),
+  phoneNumber: z.string(),
+  removedFrom: z.array(z.string()),
+  targetObjectID: z.string(),
+});
+
 export const zGetLookupDemoQuery = z.object({
   phoneNumber: z.string().optional(),
 });
 
+/**
+ * Success
+ */
+export const zGetLookupDemoResponse = z.object({
+  phoneNumber: z.string(),
+  templates: z.array(z.record(z.unknown())),
+});
+
 export const zPostTemplateAutogenBody = z.object({
   requests: z.array(zAutogenRequest),
   tags: z.array(z.string()),
@@ -321,12 +740,33 @@ export const zPostTemplateAutogenBody = z.object({
   tools: z.array(z.string()),
 });
 
+/**
+ * Success
+ */
+export const zPostTemplateAutogenResponse = z.object({
+  templates: z.array(zTemplateData),
+});
+
 export const zDeleteTemplateQuery = z.object({
   campaign: z.string().optional(),
 });
 
+/**
+ * Success
+ */
+export const zDeleteTemplateResponse = z.object({
+  deleted: z.array(z.string()),
+});
+
 export const zPostTemplateBody = z.record(z.unknown());
 
+/**
+ * Success
+ */
+export const zPostTemplateResponse = z.object({
+  message: z.string(),
+});
+
 export const zGetCampaignQuery = z.object({
   limit: z.string().optional(),
   offset: z.string().optional(),
@@ -337,6 +777,15 @@ export const zGetCampaignQuery = z.object({
   includeCalledBy: z.string().optional(),
 });
 
+/**
+ * Success
+ */
+export const zGetCampaignResponse = z.object({
+  calledByData: z.array(zCalledByData),
+  campaigns: z.array(zCampaign),
+  total: z.number(),
+});
+
 /**
  * Success
  */
@@ -344,15 +793,49 @@ export const zGetSupportedRegionsResponse = z.object({
   regions: z.array(zSupportedRegion),
 });
 
+/**
+ * Success
+ */
+export const zGetLinkShortenerResponse = z.object({
+  links: z.array(z.record(z.unknown())),
+});
+
 export const zPatchLinkShortenerBody = z.object({
   objectID: z.string(),
   shortLink: z.string(),
 });
 
+/**
+ * Success
+ */
+export const zPatchLinkShortenerResponse = z.object({
+  ok: z.boolean(),
+});
+
 export const zPostLinkShortenerBody = z.object({
   urls: z.array(zShortenUrlInput),
 });
 
+export const zPostLinkShortenerResponse = z.union([
+  z.unknown(),
+  z.object({
+    results: z.array(z.record(z.unknown())),
+  }),
+]);
+
 export const zDeleteLinkShortenerByCodePath = z.object({
   code: z.string(),
 });
+
+/**
+ * Success
+ */
+export const zDeleteLinkShortenerByCodeResponse = z.object({
+  code: z.string(),
+  ok: z.boolean(),
+});
+
+/**
+ * The raw OpenAPI 3.1 spec JSON document
+ */
+export const zGetDocsOpenapiJsonResponse = z.record(z.unknown());