syllable-sdk 0.1.0-alpha.75 → 0.1.0-alpha.76

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/docs/sdks/batches/README.md +20 -6
  2. package/docs/sdks/campaigns/README.md +6 -14
  3. package/funcs/outboundBatchesUpdate.js +1 -1
  4. package/funcs/outboundBatchesUpdate.js.map +1 -1
  5. package/jsr.json +1 -1
  6. package/lib/config.d.ts +2 -2
  7. package/lib/config.js +2 -2
  8. package/models/components/batchdetails.d.ts +3 -8
  9. package/models/components/batchdetails.d.ts.map +1 -1
  10. package/models/components/batchdetails.js +2 -8
  11. package/models/components/batchdetails.js.map +1 -1
  12. package/models/components/batchstatus.d.ts +3 -3
  13. package/models/components/batchstatus.js +1 -1
  14. package/models/components/batchstatus.js.map +1 -1
  15. package/models/components/communicationbatch.d.ts +3 -8
  16. package/models/components/communicationbatch.d.ts.map +1 -1
  17. package/models/components/communicationbatch.js +2 -8
  18. package/models/components/communicationbatch.js.map +1 -1
  19. package/models/components/communicationrequestresult.d.ts +0 -6
  20. package/models/components/communicationrequestresult.d.ts.map +1 -1
  21. package/models/components/communicationrequestresult.js +0 -5
  22. package/models/components/communicationrequestresult.js.map +1 -1
  23. package/models/components/index.d.ts +0 -3
  24. package/models/components/index.d.ts.map +1 -1
  25. package/models/components/index.js +0 -3
  26. package/models/components/index.js.map +1 -1
  27. package/models/components/outboundcampaign.d.ts +6 -7
  28. package/models/components/outboundcampaign.d.ts.map +1 -1
  29. package/models/components/outboundcampaign.js +6 -9
  30. package/models/components/outboundcampaign.js.map +1 -1
  31. package/models/components/outboundcampaigninput.d.ts +6 -7
  32. package/models/components/outboundcampaigninput.d.ts.map +1 -1
  33. package/models/components/outboundcampaigninput.js +6 -9
  34. package/models/components/outboundcampaigninput.js.map +1 -1
  35. package/models/operations/outboundbatchupdate.d.ts +2 -2
  36. package/models/operations/outboundbatchupdate.d.ts.map +1 -1
  37. package/models/operations/outboundbatchupdate.js +4 -4
  38. package/models/operations/outboundbatchupdate.js.map +1 -1
  39. package/models/operations/outboundcampaigngetbyid.d.ts +2 -2
  40. package/models/operations/outboundcampaigngetbyid.js +2 -2
  41. package/models/operations/outboundcampaigngetbyid.js.map +1 -1
  42. package/openapi.json +18744 -18847
  43. package/package.json +1 -1
  44. package/src/funcs/outboundBatchesUpdate.ts +1 -1
  45. package/src/lib/config.ts +2 -2
  46. package/src/models/components/batchdetails.ts +5 -16
  47. package/src/models/components/batchstatus.ts +1 -1
  48. package/src/models/components/communicationbatch.ts +5 -16
  49. package/src/models/components/communicationrequestresult.ts +0 -14
  50. package/src/models/components/index.ts +0 -3
  51. package/src/models/components/outboundcampaign.ts +12 -19
  52. package/src/models/components/outboundcampaigninput.ts +12 -19
  53. package/src/models/operations/outboundbatchupdate.ts +6 -6
  54. package/src/models/operations/outboundcampaigngetbyid.ts +4 -4
  55. package/models/components/communicationbatchupdate.d.ts +0 -37
  56. package/models/components/communicationbatchupdate.d.ts.map +0 -1
  57. package/models/components/communicationbatchupdate.js +0 -70
  58. package/models/components/communicationbatchupdate.js.map +0 -1
  59. package/models/components/daysofweek.d.ts +0 -49
  60. package/models/components/daysofweek.d.ts.map +0 -1
  61. package/models/components/daysofweek.js +0 -59
  62. package/models/components/daysofweek.js.map +0 -1
  63. package/models/components/requeststatus.d.ts +0 -46
  64. package/models/components/requeststatus.d.ts.map +0 -1
  65. package/models/components/requeststatus.js +0 -57
  66. package/models/components/requeststatus.js.map +0 -1
  67. package/src/models/components/communicationbatchupdate.ts +0 -85
  68. package/src/models/components/daysofweek.ts +0 -42
  69. package/src/models/components/requeststatus.ts +0 -43
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "syllable-sdk",
3
- "version": "0.1.0-alpha.75",
3
+ "version": "0.1.0-alpha.76",
4
4
  "author": "Syllable",
5
5
  "main": "./index.js",
6
6
  "sideEffects": false,
@@ -54,7 +54,7 @@ export async function outboundBatchesUpdate(
54
54
  return parsed;
55
55
  }
56
56
  const payload = parsed.value;
57
- const body = encodeJSON("body", payload.CommunicationBatchUpdate, {
57
+ const body = encodeJSON("body", payload.CommunicationBatch, {
58
58
  explode: true,
59
59
  });
60
60
 
package/src/lib/config.ts CHANGED
@@ -57,8 +57,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
57
57
  export const SDK_METADATA = {
58
58
  language: "typescript",
59
59
  openapiDocVersion: "0.0.2",
60
- sdkVersion: "0.1.0-alpha.75",
60
+ sdkVersion: "0.1.0-alpha.76",
61
61
  genVersion: "2.512.4",
62
62
  userAgent:
63
- "speakeasy-sdk/typescript 0.1.0-alpha.75 2.512.4 0.0.2 syllable-sdk",
63
+ "speakeasy-sdk/typescript 0.1.0-alpha.76 2.512.4 0.0.2 syllable-sdk",
64
64
  } as const;
@@ -33,9 +33,9 @@ export type BatchDetails = {
33
33
  */
34
34
  status?: BatchStatus | undefined;
35
35
  /**
36
- * Name of file used to create batch
36
+ * Number of requests in batch
37
37
  */
38
- uploadFilename?: string | null | undefined;
38
+ count?: number | null | undefined;
39
39
  /**
40
40
  * Timestamp of batch creation
41
41
  */
@@ -56,10 +56,6 @@ export type BatchDetails = {
56
56
  * Email of user who last updated campaign
57
57
  */
58
58
  lastUpdatedBy: string;
59
- /**
60
- * Error message if batch upload failed
61
- */
62
- errorMessage?: string | null | undefined;
63
59
  /**
64
60
  * Counts of requests by status
65
61
  */
@@ -120,13 +116,12 @@ export const BatchDetails$inboundSchema: z.ZodType<
120
116
  campaign_id: z.number().int(),
121
117
  expires_on: z.nullable(z.string()).optional(),
122
118
  status: BatchStatus$inboundSchema.optional(),
123
- upload_filename: z.nullable(z.string()).optional(),
119
+ count: z.nullable(z.number().int()).optional(),
124
120
  created_at: z.string().optional(),
125
121
  deleted_at: z.nullable(z.string()).optional(),
126
122
  deleted_reason: z.nullable(z.string()).optional(),
127
123
  last_worked_on: z.nullable(z.string()).optional(),
128
124
  last_updated_by: z.string(),
129
- error_message: z.nullable(z.string()).optional(),
130
125
  status_counts: z.nullable(z.lazy(() => StatusCounts$inboundSchema))
131
126
  .optional(),
132
127
  }).transform((v) => {
@@ -134,13 +129,11 @@ export const BatchDetails$inboundSchema: z.ZodType<
134
129
  "batch_id": "batchId",
135
130
  "campaign_id": "campaignId",
136
131
  "expires_on": "expiresOn",
137
- "upload_filename": "uploadFilename",
138
132
  "created_at": "createdAt",
139
133
  "deleted_at": "deletedAt",
140
134
  "deleted_reason": "deletedReason",
141
135
  "last_worked_on": "lastWorkedOn",
142
136
  "last_updated_by": "lastUpdatedBy",
143
- "error_message": "errorMessage",
144
137
  "status_counts": "statusCounts",
145
138
  });
146
139
  });
@@ -151,13 +144,12 @@ export type BatchDetails$Outbound = {
151
144
  campaign_id: number;
152
145
  expires_on?: string | null | undefined;
153
146
  status?: string | undefined;
154
- upload_filename?: string | null | undefined;
147
+ count?: number | null | undefined;
155
148
  created_at?: string | undefined;
156
149
  deleted_at?: string | null | undefined;
157
150
  deleted_reason?: string | null | undefined;
158
151
  last_worked_on?: string | null | undefined;
159
152
  last_updated_by: string;
160
- error_message?: string | null | undefined;
161
153
  status_counts?: StatusCounts$Outbound | null | undefined;
162
154
  };
163
155
 
@@ -171,13 +163,12 @@ export const BatchDetails$outboundSchema: z.ZodType<
171
163
  campaignId: z.number().int(),
172
164
  expiresOn: z.nullable(z.string()).optional(),
173
165
  status: BatchStatus$outboundSchema.optional(),
174
- uploadFilename: z.nullable(z.string()).optional(),
166
+ count: z.nullable(z.number().int()).optional(),
175
167
  createdAt: z.string().optional(),
176
168
  deletedAt: z.nullable(z.string()).optional(),
177
169
  deletedReason: z.nullable(z.string()).optional(),
178
170
  lastWorkedOn: z.nullable(z.string()).optional(),
179
171
  lastUpdatedBy: z.string(),
180
- errorMessage: z.nullable(z.string()).optional(),
181
172
  statusCounts: z.nullable(z.lazy(() => StatusCounts$outboundSchema))
182
173
  .optional(),
183
174
  }).transform((v) => {
@@ -185,13 +176,11 @@ export const BatchDetails$outboundSchema: z.ZodType<
185
176
  batchId: "batch_id",
186
177
  campaignId: "campaign_id",
187
178
  expiresOn: "expires_on",
188
- uploadFilename: "upload_filename",
189
179
  createdAt: "created_at",
190
180
  deletedAt: "deleted_at",
191
181
  deletedReason: "deleted_reason",
192
182
  lastWorkedOn: "last_worked_on",
193
183
  lastUpdatedBy: "last_updated_by",
194
- errorMessage: "error_message",
195
184
  statusCounts: "status_counts",
196
185
  });
197
186
  });
@@ -12,7 +12,7 @@ export const BatchStatus = {
12
12
  Pending: "PENDING",
13
13
  Active: "ACTIVE",
14
14
  Paused: "PAUSED",
15
- Failed: "FAILED",
15
+ Idle: "IDLE",
16
16
  Canceled: "CANCELED",
17
17
  Expired: "EXPIRED",
18
18
  } as const;
@@ -31,9 +31,9 @@ export type CommunicationBatch = {
31
31
  */
32
32
  status?: BatchStatus | undefined;
33
33
  /**
34
- * Name of file used to create batch
34
+ * Number of requests in batch
35
35
  */
36
- uploadFilename?: string | null | undefined;
36
+ count?: number | null | undefined;
37
37
  /**
38
38
  * Timestamp of batch creation
39
39
  */
@@ -54,10 +54,6 @@ export type CommunicationBatch = {
54
54
  * Email of user who last updated campaign
55
55
  */
56
56
  lastUpdatedBy: string;
57
- /**
58
- * Error message if batch upload failed
59
- */
60
- errorMessage?: string | null | undefined;
61
57
  };
62
58
 
63
59
  /** @internal */
@@ -70,25 +66,22 @@ export const CommunicationBatch$inboundSchema: z.ZodType<
70
66
  campaign_id: z.number().int(),
71
67
  expires_on: z.nullable(z.string()).optional(),
72
68
  status: BatchStatus$inboundSchema.optional(),
73
- upload_filename: z.nullable(z.string()).optional(),
69
+ count: z.nullable(z.number().int()).optional(),
74
70
  created_at: z.string().optional(),
75
71
  deleted_at: z.nullable(z.string()).optional(),
76
72
  deleted_reason: z.nullable(z.string()).optional(),
77
73
  last_worked_on: z.nullable(z.string()).optional(),
78
74
  last_updated_by: z.string(),
79
- error_message: z.nullable(z.string()).optional(),
80
75
  }).transform((v) => {
81
76
  return remap$(v, {
82
77
  "batch_id": "batchId",
83
78
  "campaign_id": "campaignId",
84
79
  "expires_on": "expiresOn",
85
- "upload_filename": "uploadFilename",
86
80
  "created_at": "createdAt",
87
81
  "deleted_at": "deletedAt",
88
82
  "deleted_reason": "deletedReason",
89
83
  "last_worked_on": "lastWorkedOn",
90
84
  "last_updated_by": "lastUpdatedBy",
91
- "error_message": "errorMessage",
92
85
  });
93
86
  });
94
87
 
@@ -98,13 +91,12 @@ export type CommunicationBatch$Outbound = {
98
91
  campaign_id: number;
99
92
  expires_on?: string | null | undefined;
100
93
  status?: string | undefined;
101
- upload_filename?: string | null | undefined;
94
+ count?: number | null | undefined;
102
95
  created_at?: string | undefined;
103
96
  deleted_at?: string | null | undefined;
104
97
  deleted_reason?: string | null | undefined;
105
98
  last_worked_on?: string | null | undefined;
106
99
  last_updated_by: string;
107
- error_message?: string | null | undefined;
108
100
  };
109
101
 
110
102
  /** @internal */
@@ -117,25 +109,22 @@ export const CommunicationBatch$outboundSchema: z.ZodType<
117
109
  campaignId: z.number().int(),
118
110
  expiresOn: z.nullable(z.string()).optional(),
119
111
  status: BatchStatus$outboundSchema.optional(),
120
- uploadFilename: z.nullable(z.string()).optional(),
112
+ count: z.nullable(z.number().int()).optional(),
121
113
  createdAt: z.string().optional(),
122
114
  deletedAt: z.nullable(z.string()).optional(),
123
115
  deletedReason: z.nullable(z.string()).optional(),
124
116
  lastWorkedOn: z.nullable(z.string()).optional(),
125
117
  lastUpdatedBy: z.string(),
126
- errorMessage: z.nullable(z.string()).optional(),
127
118
  }).transform((v) => {
128
119
  return remap$(v, {
129
120
  batchId: "batch_id",
130
121
  campaignId: "campaign_id",
131
122
  expiresOn: "expires_on",
132
- uploadFilename: "upload_filename",
133
123
  createdAt: "created_at",
134
124
  deletedAt: "deleted_at",
135
125
  deletedReason: "deleted_reason",
136
126
  lastWorkedOn: "last_worked_on",
137
127
  lastUpdatedBy: "last_updated_by",
138
- errorMessage: "error_message",
139
128
  });
140
129
  });
141
130
 
@@ -7,11 +7,6 @@ import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
- import {
11
- RequestStatus,
12
- RequestStatus$inboundSchema,
13
- RequestStatus$outboundSchema,
14
- } from "./requeststatus.js";
15
10
 
16
11
  /**
17
12
  * Variables for request
@@ -57,10 +52,6 @@ export type CommunicationRequestResult = {
57
52
  * Unique ID for conversation
58
53
  */
59
54
  conversationId?: number | null | undefined;
60
- /**
61
- * Status of a communication request.
62
- */
63
- requestStatus?: RequestStatus | undefined;
64
55
  /**
65
56
  * Status of request in channel manager
66
57
  */
@@ -182,7 +173,6 @@ export const CommunicationRequestResult$inboundSchema: z.ZodType<
182
173
  attempt_count: z.number().int().default(0),
183
174
  session_id: z.nullable(z.number().int()).optional(),
184
175
  conversation_id: z.nullable(z.number().int()).optional(),
185
- request_status: RequestStatus$inboundSchema.optional(),
186
176
  channel_manager_status: z.nullable(z.string()).optional(),
187
177
  insights_status: z.nullable(z.string()).optional(),
188
178
  insights: z.nullable(z.lazy(() => Insights$inboundSchema)).optional(),
@@ -196,7 +186,6 @@ export const CommunicationRequestResult$inboundSchema: z.ZodType<
196
186
  "attempt_count": "attemptCount",
197
187
  "session_id": "sessionId",
198
188
  "conversation_id": "conversationId",
199
- "request_status": "requestStatus",
200
189
  "channel_manager_status": "channelManagerStatus",
201
190
  "insights_status": "insightsStatus",
202
191
  });
@@ -213,7 +202,6 @@ export type CommunicationRequestResult$Outbound = {
213
202
  attempt_count: number;
214
203
  session_id?: number | null | undefined;
215
204
  conversation_id?: number | null | undefined;
216
- request_status?: string | undefined;
217
205
  channel_manager_status?: string | null | undefined;
218
206
  insights_status?: string | null | undefined;
219
207
  insights?: Insights$Outbound | null | undefined;
@@ -234,7 +222,6 @@ export const CommunicationRequestResult$outboundSchema: z.ZodType<
234
222
  attemptCount: z.number().int().default(0),
235
223
  sessionId: z.nullable(z.number().int()).optional(),
236
224
  conversationId: z.nullable(z.number().int()).optional(),
237
- requestStatus: RequestStatus$outboundSchema.optional(),
238
225
  channelManagerStatus: z.nullable(z.string()).optional(),
239
226
  insightsStatus: z.nullable(z.string()).optional(),
240
227
  insights: z.nullable(z.lazy(() => Insights$outboundSchema)).optional(),
@@ -248,7 +235,6 @@ export const CommunicationRequestResult$outboundSchema: z.ZodType<
248
235
  attemptCount: "attempt_count",
249
236
  sessionId: "session_id",
250
237
  conversationId: "conversation_id",
251
- requestStatus: "request_status",
252
238
  channelManagerStatus: "channel_manager_status",
253
239
  insightsStatus: "insights_status",
254
240
  });
@@ -33,7 +33,6 @@ export * from "./channeltargetresponse.js";
33
33
  export * from "./channeltargetupdaterequest.js";
34
34
  export * from "./communicationbatch.js";
35
35
  export * from "./communicationbatchinput.js";
36
- export * from "./communicationbatchupdate.js";
37
36
  export * from "./communicationrequest.js";
38
37
  export * from "./communicationrequestresult.js";
39
38
  export * from "./conversation.js";
@@ -54,7 +53,6 @@ export * from "./datasourcemetadataresponse.js";
54
53
  export * from "./datasourceproperties.js";
55
54
  export * from "./datasourceupdaterequest.js";
56
55
  export * from "./dayofweek.js";
57
- export * from "./daysofweek.js";
58
56
  export * from "./dialogmessage.js";
59
57
  export * from "./dialogrole.js";
60
58
  export * from "./dialogtoolcall.js";
@@ -119,7 +117,6 @@ export * from "./promptllmprovider.js";
119
117
  export * from "./promptproperties.js";
120
118
  export * from "./promptresponse.js";
121
119
  export * from "./promptupdaterequest.js";
122
- export * from "./requeststatus.js";
123
120
  export * from "./security.js";
124
121
  export * from "./servicecreaterequest.js";
125
122
  export * from "./serviceproperties.js";
@@ -7,11 +7,6 @@ import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
- import {
11
- DaysOfWeek,
12
- DaysOfWeek$inboundSchema,
13
- DaysOfWeek$outboundSchema,
14
- } from "./daysofweek.js";
15
10
 
16
11
  /**
17
12
  * Variables for campaign
@@ -56,9 +51,9 @@ export type OutboundCampaign = {
56
51
  */
57
52
  callerId: string | null;
58
53
  /**
59
- * Target number of outreach calls per hour
54
+ * Target number of outreach calls per minute
60
55
  */
61
- hourlyRate?: number | undefined;
56
+ rate?: number | undefined;
62
57
  /**
63
58
  * Number of retries per target
64
59
  */
@@ -68,9 +63,9 @@ export type OutboundCampaign = {
68
63
  */
69
64
  retryInterval?: string | null | undefined;
70
65
  /**
71
- * Days of the week when campaign is active
66
+ * How many seconds to pause between queueing calls. Useful when rate should be less than 1 per minute
72
67
  */
73
- activeDays: Array<DaysOfWeek>;
68
+ pauseSeconds?: number | null | undefined;
74
69
  /**
75
70
  * Unique ID for campaign
76
71
  */
@@ -152,10 +147,10 @@ export const OutboundCampaign$inboundSchema: z.ZodType<
152
147
  timezone: z.string(),
153
148
  source: z.nullable(z.string()).optional(),
154
149
  caller_id: z.nullable(z.string()),
155
- hourly_rate: z.number().int().default(1),
150
+ rate: z.number().int().default(1),
156
151
  retry_count: z.number().int().default(0),
157
152
  retry_interval: z.nullable(z.string()).optional(),
158
- active_days: z.array(DaysOfWeek$inboundSchema),
153
+ pause_seconds: z.nullable(z.number().int()).optional(),
159
154
  id: z.number().int(),
160
155
  created_at: z.string().optional(),
161
156
  updated_at: z.string().optional(),
@@ -167,10 +162,9 @@ export const OutboundCampaign$inboundSchema: z.ZodType<
167
162
  "daily_start_time": "dailyStartTime",
168
163
  "daily_end_time": "dailyEndTime",
169
164
  "caller_id": "callerId",
170
- "hourly_rate": "hourlyRate",
171
165
  "retry_count": "retryCount",
172
166
  "retry_interval": "retryInterval",
173
- "active_days": "activeDays",
167
+ "pause_seconds": "pauseSeconds",
174
168
  "created_at": "createdAt",
175
169
  "updated_at": "updatedAt",
176
170
  "last_updated_by": "lastUpdatedBy",
@@ -188,10 +182,10 @@ export type OutboundCampaign$Outbound = {
188
182
  timezone: string;
189
183
  source?: string | null | undefined;
190
184
  caller_id: string | null;
191
- hourly_rate: number;
185
+ rate: number;
192
186
  retry_count: number;
193
187
  retry_interval?: string | null | undefined;
194
- active_days: Array<string>;
188
+ pause_seconds?: number | null | undefined;
195
189
  id: number;
196
190
  created_at?: string | undefined;
197
191
  updated_at?: string | undefined;
@@ -213,10 +207,10 @@ export const OutboundCampaign$outboundSchema: z.ZodType<
213
207
  timezone: z.string(),
214
208
  source: z.nullable(z.string()).optional(),
215
209
  callerId: z.nullable(z.string()),
216
- hourlyRate: z.number().int().default(1),
210
+ rate: z.number().int().default(1),
217
211
  retryCount: z.number().int().default(0),
218
212
  retryInterval: z.nullable(z.string()).optional(),
219
- activeDays: z.array(DaysOfWeek$outboundSchema),
213
+ pauseSeconds: z.nullable(z.number().int()).optional(),
220
214
  id: z.number().int(),
221
215
  createdAt: z.string().optional(),
222
216
  updatedAt: z.string().optional(),
@@ -228,10 +222,9 @@ export const OutboundCampaign$outboundSchema: z.ZodType<
228
222
  dailyStartTime: "daily_start_time",
229
223
  dailyEndTime: "daily_end_time",
230
224
  callerId: "caller_id",
231
- hourlyRate: "hourly_rate",
232
225
  retryCount: "retry_count",
233
226
  retryInterval: "retry_interval",
234
- activeDays: "active_days",
227
+ pauseSeconds: "pause_seconds",
235
228
  createdAt: "created_at",
236
229
  updatedAt: "updated_at",
237
230
  lastUpdatedBy: "last_updated_by",
@@ -7,11 +7,6 @@ import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
- import {
11
- DaysOfWeek,
12
- DaysOfWeek$inboundSchema,
13
- DaysOfWeek$outboundSchema,
14
- } from "./daysofweek.js";
15
10
 
16
11
  /**
17
12
  * Variables for campaign
@@ -56,9 +51,9 @@ export type OutboundCampaignInput = {
56
51
  */
57
52
  callerId: string | null;
58
53
  /**
59
- * Target number of outreach calls per hour
54
+ * Target number of outreach calls per minute
60
55
  */
61
- hourlyRate?: number | undefined;
56
+ rate?: number | undefined;
62
57
  /**
63
58
  * Number of retries per target
64
59
  */
@@ -68,9 +63,9 @@ export type OutboundCampaignInput = {
68
63
  */
69
64
  retryInterval?: string | null | undefined;
70
65
  /**
71
- * Days of the week when campaign is active
66
+ * How many seconds to pause between queueing calls. Useful when rate should be less than 1 per minute
72
67
  */
73
- activeDays: Array<DaysOfWeek>;
68
+ pauseSeconds?: number | null | undefined;
74
69
  };
75
70
 
76
71
  /** @internal */
@@ -144,10 +139,10 @@ export const OutboundCampaignInput$inboundSchema: z.ZodType<
144
139
  timezone: z.string(),
145
140
  source: z.nullable(z.string()).optional(),
146
141
  caller_id: z.nullable(z.string()),
147
- hourly_rate: z.number().int().default(1),
142
+ rate: z.number().int().default(1),
148
143
  retry_count: z.number().int().default(0),
149
144
  retry_interval: z.nullable(z.string()).optional(),
150
- active_days: z.array(DaysOfWeek$inboundSchema),
145
+ pause_seconds: z.nullable(z.number().int()).optional(),
151
146
  }).transform((v) => {
152
147
  return remap$(v, {
153
148
  "campaign_name": "campaignName",
@@ -155,10 +150,9 @@ export const OutboundCampaignInput$inboundSchema: z.ZodType<
155
150
  "daily_start_time": "dailyStartTime",
156
151
  "daily_end_time": "dailyEndTime",
157
152
  "caller_id": "callerId",
158
- "hourly_rate": "hourlyRate",
159
153
  "retry_count": "retryCount",
160
154
  "retry_interval": "retryInterval",
161
- "active_days": "activeDays",
155
+ "pause_seconds": "pauseSeconds",
162
156
  });
163
157
  });
164
158
 
@@ -173,10 +167,10 @@ export type OutboundCampaignInput$Outbound = {
173
167
  timezone: string;
174
168
  source?: string | null | undefined;
175
169
  caller_id: string | null;
176
- hourly_rate: number;
170
+ rate: number;
177
171
  retry_count: number;
178
172
  retry_interval?: string | null | undefined;
179
- active_days: Array<string>;
173
+ pause_seconds?: number | null | undefined;
180
174
  };
181
175
 
182
176
  /** @internal */
@@ -196,10 +190,10 @@ export const OutboundCampaignInput$outboundSchema: z.ZodType<
196
190
  timezone: z.string(),
197
191
  source: z.nullable(z.string()).optional(),
198
192
  callerId: z.nullable(z.string()),
199
- hourlyRate: z.number().int().default(1),
193
+ rate: z.number().int().default(1),
200
194
  retryCount: z.number().int().default(0),
201
195
  retryInterval: z.nullable(z.string()).optional(),
202
- activeDays: z.array(DaysOfWeek$outboundSchema),
196
+ pauseSeconds: z.nullable(z.number().int()).optional(),
203
197
  }).transform((v) => {
204
198
  return remap$(v, {
205
199
  campaignName: "campaign_name",
@@ -207,10 +201,9 @@ export const OutboundCampaignInput$outboundSchema: z.ZodType<
207
201
  dailyStartTime: "daily_start_time",
208
202
  dailyEndTime: "daily_end_time",
209
203
  callerId: "caller_id",
210
- hourlyRate: "hourly_rate",
211
204
  retryCount: "retry_count",
212
205
  retryInterval: "retry_interval",
213
- activeDays: "active_days",
206
+ pauseSeconds: "pause_seconds",
214
207
  });
215
208
  });
216
209
 
@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
11
 
12
12
  export type OutboundBatchUpdateRequest = {
13
13
  batchId: string;
14
- communicationBatchUpdate: components.CommunicationBatchUpdate;
14
+ communicationBatch: components.CommunicationBatch;
15
15
  };
16
16
 
17
17
  /** @internal */
@@ -21,18 +21,18 @@ export const OutboundBatchUpdateRequest$inboundSchema: z.ZodType<
21
21
  unknown
22
22
  > = z.object({
23
23
  batch_id: z.string(),
24
- CommunicationBatchUpdate: components.CommunicationBatchUpdate$inboundSchema,
24
+ CommunicationBatch: components.CommunicationBatch$inboundSchema,
25
25
  }).transform((v) => {
26
26
  return remap$(v, {
27
27
  "batch_id": "batchId",
28
- "CommunicationBatchUpdate": "communicationBatchUpdate",
28
+ "CommunicationBatch": "communicationBatch",
29
29
  });
30
30
  });
31
31
 
32
32
  /** @internal */
33
33
  export type OutboundBatchUpdateRequest$Outbound = {
34
34
  batch_id: string;
35
- CommunicationBatchUpdate: components.CommunicationBatchUpdate$Outbound;
35
+ CommunicationBatch: components.CommunicationBatch$Outbound;
36
36
  };
37
37
 
38
38
  /** @internal */
@@ -42,11 +42,11 @@ export const OutboundBatchUpdateRequest$outboundSchema: z.ZodType<
42
42
  OutboundBatchUpdateRequest
43
43
  > = z.object({
44
44
  batchId: z.string(),
45
- communicationBatchUpdate: components.CommunicationBatchUpdate$outboundSchema,
45
+ communicationBatch: components.CommunicationBatch$outboundSchema,
46
46
  }).transform((v) => {
47
47
  return remap$(v, {
48
48
  batchId: "batch_id",
49
- communicationBatchUpdate: "CommunicationBatchUpdate",
49
+ communicationBatch: "CommunicationBatch",
50
50
  });
51
51
  });
52
52
 
@@ -9,7 +9,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  export type OutboundCampaignGetByIdRequest = {
12
- campaignId: number;
12
+ campaignId: string;
13
13
  };
14
14
 
15
15
  /** @internal */
@@ -18,7 +18,7 @@ export const OutboundCampaignGetByIdRequest$inboundSchema: z.ZodType<
18
18
  z.ZodTypeDef,
19
19
  unknown
20
20
  > = z.object({
21
- campaign_id: z.number().int(),
21
+ campaign_id: z.string(),
22
22
  }).transform((v) => {
23
23
  return remap$(v, {
24
24
  "campaign_id": "campaignId",
@@ -27,7 +27,7 @@ export const OutboundCampaignGetByIdRequest$inboundSchema: z.ZodType<
27
27
 
28
28
  /** @internal */
29
29
  export type OutboundCampaignGetByIdRequest$Outbound = {
30
- campaign_id: number;
30
+ campaign_id: string;
31
31
  };
32
32
 
33
33
  /** @internal */
@@ -36,7 +36,7 @@ export const OutboundCampaignGetByIdRequest$outboundSchema: z.ZodType<
36
36
  z.ZodTypeDef,
37
37
  OutboundCampaignGetByIdRequest
38
38
  > = z.object({
39
- campaignId: z.number().int(),
39
+ campaignId: z.string(),
40
40
  }).transform((v) => {
41
41
  return remap$(v, {
42
42
  campaignId: "campaign_id",
@@ -1,37 +0,0 @@
1
- import * as z from "zod";
2
- import { Result as SafeParseResult } from "../../types/fp.js";
3
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
- export type CommunicationBatchUpdate = {
5
- /**
6
- * Whether the batch is on HOLD. When on HOLD, no outreach will be made.
7
- */
8
- paused?: boolean | null | undefined;
9
- /**
10
- * Timestamp of batch expiration
11
- */
12
- expiresOn?: string | null | undefined;
13
- };
14
- /** @internal */
15
- export declare const CommunicationBatchUpdate$inboundSchema: z.ZodType<CommunicationBatchUpdate, z.ZodTypeDef, unknown>;
16
- /** @internal */
17
- export type CommunicationBatchUpdate$Outbound = {
18
- paused?: boolean | null | undefined;
19
- expires_on?: string | null | undefined;
20
- };
21
- /** @internal */
22
- export declare const CommunicationBatchUpdate$outboundSchema: z.ZodType<CommunicationBatchUpdate$Outbound, z.ZodTypeDef, CommunicationBatchUpdate>;
23
- /**
24
- * @internal
25
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
26
- */
27
- export declare namespace CommunicationBatchUpdate$ {
28
- /** @deprecated use `CommunicationBatchUpdate$inboundSchema` instead. */
29
- const inboundSchema: z.ZodType<CommunicationBatchUpdate, z.ZodTypeDef, unknown>;
30
- /** @deprecated use `CommunicationBatchUpdate$outboundSchema` instead. */
31
- const outboundSchema: z.ZodType<CommunicationBatchUpdate$Outbound, z.ZodTypeDef, CommunicationBatchUpdate>;
32
- /** @deprecated use `CommunicationBatchUpdate$Outbound` instead. */
33
- type Outbound = CommunicationBatchUpdate$Outbound;
34
- }
35
- export declare function communicationBatchUpdateToJSON(communicationBatchUpdate: CommunicationBatchUpdate): string;
36
- export declare function communicationBatchUpdateFromJSON(jsonString: string): SafeParseResult<CommunicationBatchUpdate, SDKValidationError>;
37
- //# sourceMappingURL=communicationbatchupdate.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"communicationbatchupdate.d.ts","sourceRoot":"","sources":["../../src/models/components/communicationbatchupdate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAQP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,iCAAiC,GAAG;IAC9C,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACxC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,wBAAwB,CAQxB,CAAC;AAEH;;;GAGG;AACH,yBAAiB,yBAAyB,CAAC;IACzC,wEAAwE;IACjE,MAAM,aAAa,4DAAyC,CAAC;IACpE,yEAAyE;IAClE,MAAM,cAAc,sFAA0C,CAAC;IACtE,mEAAmE;IACnE,KAAY,QAAQ,GAAG,iCAAiC,CAAC;CAC1D;AAED,wBAAgB,8BAA8B,CAC5C,wBAAwB,EAAE,wBAAwB,GACjD,MAAM,CAIR;AAED,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D"}