@gtmi/ramp-agent-client 0.0.1 → 0.0.2

package/dist/es/index.mjs

@@ -904,6 +904,8 @@ const client = createClient(createConfig());
     });
 /**
  * POST /export-logs
+ *
+ * Manually triggers export of pending phone logs to Snowflake
  */ const postExportLogs = (options)=>(options?.client ?? client).post({
         security: [
             {
@@ -1005,6 +1007,8 @@ const client = createClient(createConfig());
     });
 /**
  * POST /active-conversations/agent/claim
+ *
+ * Claims an unassigned campaign conversation so the requesting frontend owns it
  */ const postActiveConversationsAgentClaim = (options)=>(options.client ?? client).post({
         security: [
             {
@@ -1021,6 +1025,8 @@ const client = createClient(createConfig());
     });
 /**
  * GET /active-conversations/agent/:agentNumber
+ *
+ * Finds an unassigned campaign conversation for the given agent number (campaign polling)
  */ const getActiveConversationsAgentByAgentNumber = (options)=>(options.client ?? client).get({
         security: [
             {
@@ -1100,7 +1106,7 @@ const client = createClient(createConfig());
 /**
  * POST /stress-test-sms
  *
- * Twilio webhook endpoint for stress testing voice calls
+ * Twilio webhook endpoint for SMS messages during stress test calls
  */ const postStressTestSms = (options)=>(options.client ?? client).post({
         url: '/stress-test-sms',
         ...options,
@@ -1135,6 +1141,8 @@ const client = createClient(createConfig());
     });
 /**
  * POST /flex-transcription
+ *
+ * Twilio real-time transcription webhook for Flex calls
  */ const postFlexTranscription = (options)=>(options.client ?? client).post({
         url: '/flex-transcription',
         ...options,
@@ -1145,6 +1153,8 @@ const client = createClient(createConfig());
     });
 /**
  * POST /taskrouter-webhook
+ *
+ * Twilio TaskRouter event webhook
  */ const postTaskrouterWebhook = (options)=>(options.client ?? client).post({
         url: '/taskrouter-webhook',
         ...options,
@@ -1194,46 +1204,183 @@ const client = createClient(createConfig());
     });
 
 // This file is auto-generated by @hey-api/openapi-ts
+const zErrorResponse = z.object({
+    error: z.string().optional(),
+    details: z.string().optional()
+});
+/**
+ * Success
+ */ const zGetCountryConfigsResponse = z.object({
+    configs: z.array(z.record(z.unknown()))
+});
+/**
+ * Success
+ */ const zGetRecentlyActiveNumbersResponse = z.object({
+    numbers: z.array(z.record(z.unknown()))
+});
+/**
+ * Success
+ */ const zGetStatsResponse = z.object({
+    activeCalls: z.number(),
+    deployedAt: z.string()
+});
 const zGetPhoneLogsByPhoneNumberPath = z.object({
     phoneNumber: z.string()
 });
+/**
+ * Success
+ */ const zGetPhoneLogsByPhoneNumberResponse = z.object({
+    success: z.boolean(),
+    phoneNumber: z.string(),
+    calls: z.array(z.record(z.unknown())),
+    logs: z.array(z.record(z.unknown()))
+});
 const zPostOutboundCallBody = z.object({
     to: z.string(),
     from: z.string()
 });
+/**
+ * Success
+ */ const zPostOutboundCallResponse = z.object({
+    success: z.boolean(),
+    callSid: z.string(),
+    status: z.string(),
+    message: z.string()
+});
 const zGetOutboundCallByCallSidPath = z.object({
     callSid: z.string()
 });
+/**
+ * Success
+ */ const zGetOutboundCallByCallSidResponse = z.object({
+    callSid: z.string(),
+    status: z.string(),
+    duration: z.number(),
+    startTime: z.string(),
+    endTime: z.string(),
+    from: z.string(),
+    to: z.string()
+});
 const zPostOutboundCommunicationTextBody = z.record(z.unknown());
+/**
+ * Success
+ */ const zPostOutboundCommunicationTextResponse = z.object({
+    channel: z.string(),
+    from: z.string(),
+    outboundMessage: z.string(),
+    to: z.string()
+});
+/**
+ * Success
+ */ const zPostExportLogsResponse = z.object({
+    success: z.boolean(),
+    exported: z.number(),
+    failed: z.number(),
+    skipped: z.number(),
+    details: z.array(z.record(z.unknown()))
+});
+/**
+ * Success
+ */ const zDeleteLiveNumbersResponse = z.object({
+    clearedCount: z.number(),
+    clearedNumbers: z.array(z.string()),
+    message: z.string(),
+    terminatedCalls: z.array(z.string())
+});
+/**
+ * Success
+ */ const zGetLiveNumbersResponse = z.object({
+    liveNumbers: z.array(z.record(z.unknown())),
+    count: z.number()
+});
 const zDeleteLiveNumbersByPhoneNumberPath = z.object({
     phoneNumber: z.string()
 });
+/**
+ * Success
+ */ const zDeleteLiveNumbersByPhoneNumberResponse = z.object({
+    message: z.string(),
+    phoneNumber: z.string(),
+    terminatedCall: z.string()
+});
 const zDeleteKillConversationByPhoneNumberPath = z.object({
     phoneNumber: z.string()
 });
+/**
+ * Success
+ */ const zDeleteKillConversationByPhoneNumberResponse = z.object({
+    message: z.string(),
+    conversationsDeleted: z.array(z.string()),
+    conversationsFailed: z.array(z.record(z.unknown())),
+    callTerminated: z.string(),
+    activeConversationCleared: z.boolean()
+});
 const zPostSendEmailBody = z.object({
     to: z.string(),
     subject: z.string(),
     text: z.string()
 });
+/**
+ * Success
+ */ const zPostSendEmailResponse = z.object({
+    success: z.boolean()
+});
 const zPostAddMessageBody = z.object({
     to: z.string(),
     content: z.string()
 });
+/**
+ * Success
+ */ const zPostAddMessageResponse = z.object({
+    message: z.string(),
+    success: z.boolean()
+});
 const zPostActiveConversationsAgentClaimBody = z.record(z.unknown());
+/**
+ * Success
+ */ const zPostActiveConversationsAgentClaimResponse = z.object({
+    success: z.boolean()
+});
 const zGetActiveConversationsAgentByAgentNumberPath = z.object({
     agentNumber: z.string()
 });
+/**
+ * Success
+ */ const zGetActiveConversationsAgentByAgentNumberResponse = z.object({
+    activeConversation: z.record(z.unknown())
+});
 const zGetActiveConversationsByCustomerNumberPath = z.object({
     customerNumber: z.string()
 });
+/**
+ * Success
+ */ const zGetActiveConversationsByCustomerNumberResponse = z.object({
+    activeConversation: z.record(z.unknown())
+});
+/**
+ * Success
+ */ const zGetHealthResponse = z.object({
+    status: z.string()
+});
 const zPostCallBody = z.record(z.unknown());
+/**
+ * TwiML XML response connecting the call to ConversationRelay (or a Say if setup failed)
+ */ const zPostCallResponse = z.string();
 const zPostLiveAgentBody = z.object({
     From: z.string(),
     To: z.string(),
     Direction: z.string()
 });
+/**
+ * TwiML XML response (Dial, Enqueue, or external Flex handoff) — TwiML
+ */ const zPostLiveAgentResponse = z.string();
 const zPostRedirectToLiveAgentBody = z.record(z.unknown());
+/**
+ * Success
+ */ const zPostRedirectToLiveAgentResponse = z.object({
+    callSid: z.string(),
+    success: z.boolean()
+});
 const zGetStressTestQuery = z.object({
     From: z.string().optional(),
     To: z.string().optional(),
@@ -1242,47 +1389,104 @@ const zGetStressTestQuery = z.object({
     Confidence: z.string().optional(),
     CallStatus: z.string().optional()
 });
-const zPostStressTestSmsBody = z.record(z.unknown());
-const zPostStressTestSmsQuery = z.object({
-    From: z.string().optional(),
-    To: z.string().optional(),
-    CallSid: z.string().optional(),
-    SpeechResult: z.string().optional(),
-    Confidence: z.string().optional(),
-    CallStatus: z.string().optional()
+/**
+ * TwiML XML response with a Say/Gather/Redirect (or Hangup if the call closes) — TwiML
+ */ const zGetStressTestResponse = z.string();
+const zPostStressTestSmsBody = z.object({
+    From: z.string(),
+    To: z.string(),
+    Body: z.string()
 });
+/**
+ * TwiML XML response that reads the SMS body aloud, then gathers speech — TwiML
+ */ const zPostStressTestSmsResponse = z.string();
 const zPostWebchatSendBody = z.record(z.unknown());
+/**
+ * Success
+ */ const zPostWebchatSendResponse = z.object({
+    agentNumber: z.string(),
+    conversationId: z.string(),
+    identity: z.string(),
+    response: z.string(),
+    status: z.string()
+});
 const zPostCintelOperatorsBody = z.record(z.unknown());
+/**
+ * Success
+ */ const zPostCintelOperatorsResponse = z.object({
+    success: z.boolean()
+});
 const zPostFlexTranscriptionBody = z.record(z.unknown());
+/**
+ * "OK" (Express default sendStatus body, no JSON payload)
+ */ const zPostFlexTranscriptionResponse = z.string();
 const zPostTaskrouterWebhookBody = z.record(z.unknown());
+/**
+ * "OK" (Express default sendStatus body, no JSON payload)
+ */ const zPostTaskrouterWebhookResponse = z.string();
 const zPostResolvePhoneBody = z.record(z.unknown());
 const zPostCommunicationTextBody = z.record(z.unknown());
+/**
+ * TwiML XML response, optionally containing the LLM's reply message
+ */ const zPostCommunicationTextResponse = z.string();
+/**
+ * The OpenAPI 3.1 spec document
+ */ const zGetDocsOpenapiJsonResponse = z.record(z.unknown());
 
 var zod_gen = {
   __proto__: null,
   zDeleteKillConversationByPhoneNumberPath: zDeleteKillConversationByPhoneNumberPath,
+  zDeleteKillConversationByPhoneNumberResponse: zDeleteKillConversationByPhoneNumberResponse,
   zDeleteLiveNumbersByPhoneNumberPath: zDeleteLiveNumbersByPhoneNumberPath,
+  zDeleteLiveNumbersByPhoneNumberResponse: zDeleteLiveNumbersByPhoneNumberResponse,
+  zDeleteLiveNumbersResponse: zDeleteLiveNumbersResponse,
+  zErrorResponse: zErrorResponse,
   zGetActiveConversationsAgentByAgentNumberPath: zGetActiveConversationsAgentByAgentNumberPath,
+  zGetActiveConversationsAgentByAgentNumberResponse: zGetActiveConversationsAgentByAgentNumberResponse,
   zGetActiveConversationsByCustomerNumberPath: zGetActiveConversationsByCustomerNumberPath,
+  zGetActiveConversationsByCustomerNumberResponse: zGetActiveConversationsByCustomerNumberResponse,
+  zGetCountryConfigsResponse: zGetCountryConfigsResponse,
+  zGetDocsOpenapiJsonResponse: zGetDocsOpenapiJsonResponse,
+  zGetHealthResponse: zGetHealthResponse,
+  zGetLiveNumbersResponse: zGetLiveNumbersResponse,
   zGetOutboundCallByCallSidPath: zGetOutboundCallByCallSidPath,
+  zGetOutboundCallByCallSidResponse: zGetOutboundCallByCallSidResponse,
   zGetPhoneLogsByPhoneNumberPath: zGetPhoneLogsByPhoneNumberPath,
+  zGetPhoneLogsByPhoneNumberResponse: zGetPhoneLogsByPhoneNumberResponse,
+  zGetRecentlyActiveNumbersResponse: zGetRecentlyActiveNumbersResponse,
+  zGetStatsResponse: zGetStatsResponse,
   zGetStressTestQuery: zGetStressTestQuery,
+  zGetStressTestResponse: zGetStressTestResponse,
   zPostActiveConversationsAgentClaimBody: zPostActiveConversationsAgentClaimBody,
+  zPostActiveConversationsAgentClaimResponse: zPostActiveConversationsAgentClaimResponse,
   zPostAddMessageBody: zPostAddMessageBody,
+  zPostAddMessageResponse: zPostAddMessageResponse,
   zPostCallBody: zPostCallBody,
+  zPostCallResponse: zPostCallResponse,
   zPostCintelOperatorsBody: zPostCintelOperatorsBody,
+  zPostCintelOperatorsResponse: zPostCintelOperatorsResponse,
   zPostCommunicationTextBody: zPostCommunicationTextBody,
+  zPostCommunicationTextResponse: zPostCommunicationTextResponse,
+  zPostExportLogsResponse: zPostExportLogsResponse,
   zPostFlexTranscriptionBody: zPostFlexTranscriptionBody,
+  zPostFlexTranscriptionResponse: zPostFlexTranscriptionResponse,
   zPostLiveAgentBody: zPostLiveAgentBody,
+  zPostLiveAgentResponse: zPostLiveAgentResponse,
   zPostOutboundCallBody: zPostOutboundCallBody,
+  zPostOutboundCallResponse: zPostOutboundCallResponse,
   zPostOutboundCommunicationTextBody: zPostOutboundCommunicationTextBody,
+  zPostOutboundCommunicationTextResponse: zPostOutboundCommunicationTextResponse,
   zPostRedirectToLiveAgentBody: zPostRedirectToLiveAgentBody,
+  zPostRedirectToLiveAgentResponse: zPostRedirectToLiveAgentResponse,
   zPostResolvePhoneBody: zPostResolvePhoneBody,
   zPostSendEmailBody: zPostSendEmailBody,
+  zPostSendEmailResponse: zPostSendEmailResponse,
   zPostStressTestSmsBody: zPostStressTestSmsBody,
-  zPostStressTestSmsQuery: zPostStressTestSmsQuery,
+  zPostStressTestSmsResponse: zPostStressTestSmsResponse,
   zPostTaskrouterWebhookBody: zPostTaskrouterWebhookBody,
-  zPostWebchatSendBody: zPostWebchatSendBody
+  zPostTaskrouterWebhookResponse: zPostTaskrouterWebhookResponse,
+  zPostWebchatSendBody: zPostWebchatSendBody,
+  zPostWebchatSendResponse: zPostWebchatSendResponse
 };
 
 export { createRampAgentClient, deleteKillConversationByPhoneNumber, deleteLiveNumbers, deleteLiveNumbersByPhoneNumber, getActiveConversationsAgentByAgentNumber, getActiveConversationsByCustomerNumber, getCountryConfigs, getDocsOpenapiJson, getHealth, getLiveNumbers, getOutboundCallByCallSid, getPhoneLogsByPhoneNumber, getRecentlyActiveNumbers, getStats, getStressTest, postActiveConversationsAgentClaim, postAddMessage, postCall, postCintelOperators, postCommunicationText, postExportLogs, postFlexTranscription, postLiveAgent, postOutboundCall, postOutboundCommunicationText, postRedirectToLiveAgent, postResolvePhone, postSendEmail, postStressTestSms, postTaskrouterWebhook, postWebchatSend, zod_gen as schemas };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gtmi/ramp-agent-client",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "license": "MIT",
   "sideEffects": false,

package/src/generated/index.ts

@@ -36,93 +36,144 @@ export {
 export type {
   ClientOptions,
   DeleteKillConversationByPhoneNumberData,
+  DeleteKillConversationByPhoneNumberError,
   DeleteKillConversationByPhoneNumberErrors,
+  DeleteKillConversationByPhoneNumberResponse,
   DeleteKillConversationByPhoneNumberResponses,
   DeleteLiveNumbersByPhoneNumberData,
+  DeleteLiveNumbersByPhoneNumberError,
   DeleteLiveNumbersByPhoneNumberErrors,
+  DeleteLiveNumbersByPhoneNumberResponse,
   DeleteLiveNumbersByPhoneNumberResponses,
   DeleteLiveNumbersData,
+  DeleteLiveNumbersError,
   DeleteLiveNumbersErrors,
+  DeleteLiveNumbersResponse,
   DeleteLiveNumbersResponses,
+  ErrorResponse,
   GetActiveConversationsAgentByAgentNumberData,
+  GetActiveConversationsAgentByAgentNumberError,
   GetActiveConversationsAgentByAgentNumberErrors,
+  GetActiveConversationsAgentByAgentNumberResponse,
   GetActiveConversationsAgentByAgentNumberResponses,
   GetActiveConversationsByCustomerNumberData,
+  GetActiveConversationsByCustomerNumberError,
   GetActiveConversationsByCustomerNumberErrors,
+  GetActiveConversationsByCustomerNumberResponse,
   GetActiveConversationsByCustomerNumberResponses,
   GetCountryConfigsData,
+  GetCountryConfigsError,
   GetCountryConfigsErrors,
+  GetCountryConfigsResponse,
   GetCountryConfigsResponses,
   GetDocsOpenapiJsonData,
+  GetDocsOpenapiJsonError,
   GetDocsOpenapiJsonErrors,
+  GetDocsOpenapiJsonResponse,
   GetDocsOpenapiJsonResponses,
   GetHealthData,
   GetHealthErrors,
+  GetHealthResponse,
   GetHealthResponses,
   GetLiveNumbersData,
+  GetLiveNumbersError,
   GetLiveNumbersErrors,
+  GetLiveNumbersResponse,
   GetLiveNumbersResponses,
   GetOutboundCallByCallSidData,
+  GetOutboundCallByCallSidError,
   GetOutboundCallByCallSidErrors,
+  GetOutboundCallByCallSidResponse,
   GetOutboundCallByCallSidResponses,
   GetPhoneLogsByPhoneNumberData,
+  GetPhoneLogsByPhoneNumberError,
   GetPhoneLogsByPhoneNumberErrors,
+  GetPhoneLogsByPhoneNumberResponse,
   GetPhoneLogsByPhoneNumberResponses,
   GetRecentlyActiveNumbersData,
+  GetRecentlyActiveNumbersError,
   GetRecentlyActiveNumbersErrors,
+  GetRecentlyActiveNumbersResponse,
   GetRecentlyActiveNumbersResponses,
   GetStatsData,
+  GetStatsError,
   GetStatsErrors,
+  GetStatsResponse,
   GetStatsResponses,
   GetStressTestData,
   GetStressTestErrors,
+  GetStressTestResponse,
   GetStressTestResponses,
   PostActiveConversationsAgentClaimData,
+  PostActiveConversationsAgentClaimError,
   PostActiveConversationsAgentClaimErrors,
+  PostActiveConversationsAgentClaimResponse,
   PostActiveConversationsAgentClaimResponses,
   PostAddMessageData,
+  PostAddMessageError,
   PostAddMessageErrors,
+  PostAddMessageResponse,
   PostAddMessageResponses,
   PostCallData,
   PostCallErrors,
+  PostCallResponse,
   PostCallResponses,
   PostCintelOperatorsData,
+  PostCintelOperatorsError,
   PostCintelOperatorsErrors,
+  PostCintelOperatorsResponse,
   PostCintelOperatorsResponses,
   PostCommunicationTextData,
   PostCommunicationTextErrors,
+  PostCommunicationTextResponse,
   PostCommunicationTextResponses,
   PostExportLogsData,
+  PostExportLogsError,
   PostExportLogsErrors,
+  PostExportLogsResponse,
   PostExportLogsResponses,
   PostFlexTranscriptionData,
   PostFlexTranscriptionErrors,
+  PostFlexTranscriptionResponse,
   PostFlexTranscriptionResponses,
   PostLiveAgentData,
   PostLiveAgentErrors,
+  PostLiveAgentResponse,
   PostLiveAgentResponses,
   PostOutboundCallData,
+  PostOutboundCallError,
   PostOutboundCallErrors,
+  PostOutboundCallResponse,
   PostOutboundCallResponses,
   PostOutboundCommunicationTextData,
+  PostOutboundCommunicationTextError,
   PostOutboundCommunicationTextErrors,
+  PostOutboundCommunicationTextResponse,
   PostOutboundCommunicationTextResponses,
   PostRedirectToLiveAgentData,
+  PostRedirectToLiveAgentError,
   PostRedirectToLiveAgentErrors,
+  PostRedirectToLiveAgentResponse,
   PostRedirectToLiveAgentResponses,
   PostResolvePhoneData,
   PostResolvePhoneErrors,
   PostResolvePhoneResponses,
   PostSendEmailData,
+  PostSendEmailError,
   PostSendEmailErrors,
+  PostSendEmailResponse,
   PostSendEmailResponses,
   PostStressTestSmsData,
   PostStressTestSmsErrors,
+  PostStressTestSmsResponse,
   PostStressTestSmsResponses,
   PostTaskrouterWebhookData,
   PostTaskrouterWebhookErrors,
+  PostTaskrouterWebhookResponse,
   PostTaskrouterWebhookResponses,
   PostWebchatSendData,
+  PostWebchatSendError,
   PostWebchatSendErrors,
+  PostWebchatSendResponse,
   PostWebchatSendResponses,
 } from './types.gen';

package/src/generated/sdk.gen.ts

@@ -250,6 +250,8 @@ export const postOutboundCommunicationText = <ThrowOnError extends boolean = fal
 
 /**
  * POST /export-logs
+ *
+ * Manually triggers export of pending phone logs to Snowflake
  */
 export const postExportLogs = <ThrowOnError extends boolean = false>(
   options?: Options<PostExportLogsData, ThrowOnError>,
@@ -373,6 +375,8 @@ export const postAddMessage = <ThrowOnError extends boolean = false>(
 
 /**
  * POST /active-conversations/agent/claim
+ *
+ * Claims an unassigned campaign conversation so the requesting frontend owns it
  */
 export const postActiveConversationsAgentClaim = <ThrowOnError extends boolean = false>(
   options: Options<PostActiveConversationsAgentClaimData, ThrowOnError>,
@@ -397,6 +401,8 @@ export const postActiveConversationsAgentClaim = <ThrowOnError extends boolean =
 
 /**
  * GET /active-conversations/agent/:agentNumber
+ *
+ * Finds an unassigned campaign conversation for the given agent number (campaign polling)
  */
 export const getActiveConversationsAgentByAgentNumber = <ThrowOnError extends boolean = false>(
   options: Options<GetActiveConversationsAgentByAgentNumberData, ThrowOnError>,
@@ -521,7 +527,7 @@ export const getStressTest = <ThrowOnError extends boolean = false>(
 /**
  * POST /stress-test-sms
  *
- * Twilio webhook endpoint for stress testing voice calls
+ * Twilio webhook endpoint for SMS messages during stress test calls
  */
 export const postStressTestSms = <ThrowOnError extends boolean = false>(
   options: Options<PostStressTestSmsData, ThrowOnError>,
@@ -579,6 +585,8 @@ export const postCintelOperators = <ThrowOnError extends boolean = false>(
 
 /**
  * POST /flex-transcription
+ *
+ * Twilio real-time transcription webhook for Flex calls
  */
 export const postFlexTranscription = <ThrowOnError extends boolean = false>(
   options: Options<PostFlexTranscriptionData, ThrowOnError>,
@@ -598,6 +606,8 @@ export const postFlexTranscription = <ThrowOnError extends boolean = false>(
 
 /**
  * POST /taskrouter-webhook
+ *
+ * Twilio TaskRouter event webhook
  */
 export const postTaskrouterWebhook = <ThrowOnError extends boolean = false>(
   options: Options<PostTaskrouterWebhookData, ThrowOnError>,