@automate.ax/integration-contracts 0.139.2 → 0.141.0
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.
- package/dist/closebot/api.d.ts +39 -0
- package/dist/closebot/api.js +117 -0
- package/dist/closebot/index.d.ts +2 -0
- package/dist/closebot/index.js +2 -0
- package/dist/closebot/schemas.d.ts +775 -0
- package/dist/closebot/schemas.js +467 -0
- package/dist/meta-ads/api.d.ts +90 -0
- package/dist/meta-ads/api.js +260 -0
- package/dist/meta-ads/events.d.ts +391 -0
- package/dist/meta-ads/events.js +193 -0
- package/dist/meta-ads/index.d.ts +3 -0
- package/dist/meta-ads/index.js +3 -0
- package/dist/meta-ads/schemas.d.ts +184 -0
- package/dist/meta-ads/schemas.js +181 -0
- package/dist/triggers.d.ts +2 -1
- package/package.json +14 -2
- package/src/closebot/api.ts +157 -0
- package/src/closebot/index.ts +2 -0
- package/src/closebot/schemas.ts +517 -0
- package/src/meta-ads/api.ts +327 -0
- package/src/meta-ads/events.ts +218 -0
- package/src/meta-ads/index.ts +3 -0
- package/src/meta-ads/schemas.ts +206 -0
- package/src/triggers.ts +2 -0
|
@@ -0,0 +1,467 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
export const CLOSEBOT_ID_SCHEMA = z.string().trim().min(1);
|
|
3
|
+
export const CLOSEBOT_DATE_SCHEMA = z
|
|
4
|
+
.union([z.date(), z.iso.datetime({ offset: true })])
|
|
5
|
+
.transform((value) => (value instanceof Date ? value : new Date(value)));
|
|
6
|
+
const OPTIONAL_STRING = z.string().nullable().optional();
|
|
7
|
+
const OPTIONAL_BOOLEAN = z.boolean().optional();
|
|
8
|
+
const OPTIONAL_INTEGER = z.number().int().optional();
|
|
9
|
+
const OPTIONAL_DATE = CLOSEBOT_DATE_SCHEMA.nullable().optional();
|
|
10
|
+
export const CLOSEBOT_AGENCY_MEMBER_SCHEMA = z.object({
|
|
11
|
+
accountId: OPTIONAL_STRING,
|
|
12
|
+
authId: OPTIONAL_STRING,
|
|
13
|
+
email: OPTIONAL_STRING,
|
|
14
|
+
name: OPTIONAL_STRING,
|
|
15
|
+
role: OPTIONAL_STRING,
|
|
16
|
+
status: OPTIONAL_STRING,
|
|
17
|
+
});
|
|
18
|
+
export const CLOSEBOT_AGENCY_SCHEMA = z.object({
|
|
19
|
+
betaTester: OPTIONAL_BOOLEAN,
|
|
20
|
+
id: OPTIONAL_STRING,
|
|
21
|
+
members: CLOSEBOT_AGENCY_MEMBER_SCHEMA.array().nullable().optional(),
|
|
22
|
+
name: OPTIONAL_STRING,
|
|
23
|
+
});
|
|
24
|
+
export const CLOSEBOT_FOLLOW_UP_SEQUENCE_SCHEMA = z.object({
|
|
25
|
+
duration: OPTIONAL_INTEGER,
|
|
26
|
+
order: OPTIONAL_INTEGER,
|
|
27
|
+
unit: OPTIONAL_STRING,
|
|
28
|
+
});
|
|
29
|
+
export const CLOSEBOT_FOLLOW_UP_STATE_SCHEMA = z.object({
|
|
30
|
+
extraPrompt: OPTIONAL_STRING,
|
|
31
|
+
id: OPTIONAL_INTEGER,
|
|
32
|
+
isDefault: OPTIONAL_BOOLEAN,
|
|
33
|
+
name: OPTIONAL_STRING,
|
|
34
|
+
order: OPTIONAL_INTEGER,
|
|
35
|
+
repeatFinal: OPTIONAL_BOOLEAN,
|
|
36
|
+
sequences: CLOSEBOT_FOLLOW_UP_SEQUENCE_SCHEMA.array().nullable().optional(),
|
|
37
|
+
});
|
|
38
|
+
export const CLOSEBOT_TAG_SCHEMA = z.object({
|
|
39
|
+
approveDeny: OPTIONAL_BOOLEAN,
|
|
40
|
+
id: OPTIONAL_STRING,
|
|
41
|
+
name: OPTIONAL_STRING,
|
|
42
|
+
});
|
|
43
|
+
export const CLOSEBOT_TAG_FILTER_SCHEMA = z.object({
|
|
44
|
+
groups: z
|
|
45
|
+
.object({
|
|
46
|
+
operator: OPTIONAL_STRING,
|
|
47
|
+
rules: z
|
|
48
|
+
.object({
|
|
49
|
+
condition: OPTIONAL_STRING,
|
|
50
|
+
tagId: OPTIONAL_STRING,
|
|
51
|
+
tagName: OPTIONAL_STRING,
|
|
52
|
+
})
|
|
53
|
+
.array()
|
|
54
|
+
.nullable()
|
|
55
|
+
.optional(),
|
|
56
|
+
})
|
|
57
|
+
.array()
|
|
58
|
+
.nullable()
|
|
59
|
+
.optional(),
|
|
60
|
+
operator: OPTIONAL_STRING,
|
|
61
|
+
});
|
|
62
|
+
export const CLOSEBOT_CHANNEL_RULES_SCHEMA = z.object({
|
|
63
|
+
channels: z
|
|
64
|
+
.object({
|
|
65
|
+
channel: OPTIONAL_STRING,
|
|
66
|
+
rules: z
|
|
67
|
+
.object({ operator: OPTIONAL_STRING, value: OPTIONAL_STRING })
|
|
68
|
+
.array()
|
|
69
|
+
.nullable()
|
|
70
|
+
.optional(),
|
|
71
|
+
type: OPTIONAL_STRING,
|
|
72
|
+
})
|
|
73
|
+
.array()
|
|
74
|
+
.nullable()
|
|
75
|
+
.optional(),
|
|
76
|
+
});
|
|
77
|
+
export const CLOSEBOT_BOT_SOURCE_SCHEMA = z.object({
|
|
78
|
+
category: OPTIONAL_STRING,
|
|
79
|
+
channelList: z.string().array().nullable().optional(),
|
|
80
|
+
channelRules: CLOSEBOT_CHANNEL_RULES_SCHEMA.optional(),
|
|
81
|
+
enabled: OPTIONAL_BOOLEAN,
|
|
82
|
+
flowVariableValues: z.record(z.string(), z.string()).nullable().optional(),
|
|
83
|
+
id: OPTIONAL_STRING,
|
|
84
|
+
key: OPTIONAL_STRING,
|
|
85
|
+
name: OPTIONAL_STRING,
|
|
86
|
+
personaNameOverride: OPTIONAL_STRING,
|
|
87
|
+
tagFilterConfig: CLOSEBOT_TAG_FILTER_SCHEMA.optional(),
|
|
88
|
+
tags: CLOSEBOT_TAG_SCHEMA.array().nullable().optional(),
|
|
89
|
+
});
|
|
90
|
+
export const CLOSEBOT_BOT_VERSION_SCHEMA = z.object({
|
|
91
|
+
modifiedAt: CLOSEBOT_DATE_SCHEMA.optional(),
|
|
92
|
+
modifiedBy: OPTIONAL_STRING,
|
|
93
|
+
name: OPTIONAL_STRING,
|
|
94
|
+
published: OPTIONAL_BOOLEAN,
|
|
95
|
+
version: OPTIONAL_STRING,
|
|
96
|
+
});
|
|
97
|
+
export const CLOSEBOT_PERSONA_SPLIT_TEST_SOURCE_RESULT_SCHEMA = z.object({
|
|
98
|
+
averageLeadScore: z.number().optional(),
|
|
99
|
+
responseCount: OPTIONAL_INTEGER,
|
|
100
|
+
sourceId: OPTIONAL_STRING,
|
|
101
|
+
sourceName: OPTIONAL_STRING,
|
|
102
|
+
totalInstances: OPTIONAL_INTEGER,
|
|
103
|
+
});
|
|
104
|
+
export const CLOSEBOT_PERSONA_SPLIT_TEST_RESULTS_SCHEMA = z.object({
|
|
105
|
+
averageLeadScore: z.number().optional(),
|
|
106
|
+
computedAt: CLOSEBOT_DATE_SCHEMA.optional(),
|
|
107
|
+
personaId: OPTIONAL_STRING,
|
|
108
|
+
personaName: OPTIONAL_STRING,
|
|
109
|
+
responseCount: OPTIONAL_INTEGER,
|
|
110
|
+
sources: CLOSEBOT_PERSONA_SPLIT_TEST_SOURCE_RESULT_SCHEMA.array()
|
|
111
|
+
.nullable()
|
|
112
|
+
.optional(),
|
|
113
|
+
splitWeight: OPTIONAL_INTEGER,
|
|
114
|
+
totalInstances: OPTIONAL_INTEGER,
|
|
115
|
+
});
|
|
116
|
+
export const CLOSEBOT_PERSONA_SPLIT_TEST_SCHEMA = z.object({
|
|
117
|
+
endedAt: OPTIONAL_DATE,
|
|
118
|
+
id: OPTIONAL_STRING,
|
|
119
|
+
isActive: OPTIONAL_BOOLEAN,
|
|
120
|
+
personas: z
|
|
121
|
+
.object({
|
|
122
|
+
order: OPTIONAL_INTEGER,
|
|
123
|
+
personaId: OPTIONAL_STRING,
|
|
124
|
+
results: CLOSEBOT_PERSONA_SPLIT_TEST_RESULTS_SCHEMA.optional(),
|
|
125
|
+
weight: OPTIONAL_INTEGER,
|
|
126
|
+
})
|
|
127
|
+
.array()
|
|
128
|
+
.nullable()
|
|
129
|
+
.optional(),
|
|
130
|
+
startedAt: OPTIONAL_DATE,
|
|
131
|
+
});
|
|
132
|
+
export const CLOSEBOT_BOT_TEMPLATE_SCHEMA = z.object({
|
|
133
|
+
description: OPTIONAL_STRING,
|
|
134
|
+
id: OPTIONAL_STRING,
|
|
135
|
+
industry: OPTIONAL_STRING,
|
|
136
|
+
level: OPTIONAL_STRING,
|
|
137
|
+
name: OPTIONAL_STRING,
|
|
138
|
+
previewUrl: OPTIONAL_STRING,
|
|
139
|
+
tags: z.string().array().nullable().optional(),
|
|
140
|
+
tier: OPTIONAL_STRING,
|
|
141
|
+
videoUrl: OPTIONAL_STRING,
|
|
142
|
+
});
|
|
143
|
+
export const CLOSEBOT_FOLDER_SCHEMA = z.object({
|
|
144
|
+
bots: z.string().array().nullable(),
|
|
145
|
+
children: z.string().array().nullable(),
|
|
146
|
+
id: z.string().nullable(),
|
|
147
|
+
name: z.string().nullable(),
|
|
148
|
+
personas: z.string().array().nullable(),
|
|
149
|
+
});
|
|
150
|
+
export const CLOSEBOT_FOLDER_CREATED_SCHEMA = z.object({
|
|
151
|
+
id: z.string().nullable(),
|
|
152
|
+
});
|
|
153
|
+
export const CLOSEBOT_BOT_SCHEMA = z.object({
|
|
154
|
+
category: OPTIONAL_STRING,
|
|
155
|
+
favorited: OPTIONAL_BOOLEAN,
|
|
156
|
+
folderId: OPTIONAL_STRING,
|
|
157
|
+
followUpActive: OPTIONAL_BOOLEAN,
|
|
158
|
+
followUpExtraPrompt: OPTIONAL_STRING,
|
|
159
|
+
followUpRepeat: OPTIONAL_BOOLEAN,
|
|
160
|
+
followUpSequences: CLOSEBOT_FOLLOW_UP_SEQUENCE_SCHEMA.array()
|
|
161
|
+
.nullable()
|
|
162
|
+
.optional(),
|
|
163
|
+
followUpStates: CLOSEBOT_FOLLOW_UP_STATE_SCHEMA.array().nullable().optional(),
|
|
164
|
+
followUpVarianceMinutes: OPTIONAL_INTEGER,
|
|
165
|
+
id: OPTIONAL_STRING,
|
|
166
|
+
locked: OPTIONAL_BOOLEAN,
|
|
167
|
+
modifiedAt: OPTIONAL_STRING,
|
|
168
|
+
modifiedBy: OPTIONAL_STRING,
|
|
169
|
+
name: OPTIONAL_STRING,
|
|
170
|
+
personaIds: z.string().array().nullable().optional(),
|
|
171
|
+
personaSplitTest: CLOSEBOT_PERSONA_SPLIT_TEST_SCHEMA.optional(),
|
|
172
|
+
personaWeights: z.record(z.string(), z.number().int()).nullable().optional(),
|
|
173
|
+
reschedulingEnabled: OPTIONAL_BOOLEAN,
|
|
174
|
+
smartFollowUp: OPTIONAL_BOOLEAN,
|
|
175
|
+
sources: CLOSEBOT_BOT_SOURCE_SCHEMA.array().nullable().optional(),
|
|
176
|
+
tools: z
|
|
177
|
+
.object({
|
|
178
|
+
enabled: OPTIONAL_BOOLEAN,
|
|
179
|
+
id: OPTIONAL_STRING,
|
|
180
|
+
options: z.object({}).optional(),
|
|
181
|
+
type: OPTIONAL_STRING,
|
|
182
|
+
})
|
|
183
|
+
.array()
|
|
184
|
+
.nullable()
|
|
185
|
+
.optional(),
|
|
186
|
+
versions: CLOSEBOT_BOT_VERSION_SCHEMA.array().nullable().optional(),
|
|
187
|
+
});
|
|
188
|
+
export const CLOSEBOT_PUBLISH_BOT_RESULT_SCHEMA = z.object({
|
|
189
|
+
message: z.json().optional(),
|
|
190
|
+
version: OPTIONAL_STRING,
|
|
191
|
+
});
|
|
192
|
+
export const CLOSEBOT_LEAD_FIELD_SCHEMA = z.object({
|
|
193
|
+
aiProduced: OPTIONAL_BOOLEAN,
|
|
194
|
+
field: OPTIONAL_STRING,
|
|
195
|
+
name: OPTIONAL_STRING,
|
|
196
|
+
value: OPTIONAL_STRING,
|
|
197
|
+
});
|
|
198
|
+
export const CLOSEBOT_BOT_INSTANCE_SCHEMA = z.object({
|
|
199
|
+
botId: OPTIONAL_STRING,
|
|
200
|
+
botVersion: OPTIONAL_STRING,
|
|
201
|
+
followUpTime: OPTIONAL_DATE,
|
|
202
|
+
followUpTimezone: OPTIONAL_STRING,
|
|
203
|
+
followUpTimezoneKind: OPTIONAL_STRING,
|
|
204
|
+
isSmartFollowUpTime: OPTIONAL_BOOLEAN,
|
|
205
|
+
scheduleRespondTime: OPTIONAL_DATE,
|
|
206
|
+
});
|
|
207
|
+
export const CLOSEBOT_LEAD_SCHEMA = z.object({
|
|
208
|
+
contactId: OPTIONAL_STRING,
|
|
209
|
+
fields: CLOSEBOT_LEAD_FIELD_SCHEMA.array().nullable().optional(),
|
|
210
|
+
id: OPTIONAL_STRING,
|
|
211
|
+
instances: CLOSEBOT_BOT_INSTANCE_SCHEMA.array().nullable().optional(),
|
|
212
|
+
lastMessage: OPTIONAL_STRING,
|
|
213
|
+
lastMessageBotId: OPTIONAL_STRING,
|
|
214
|
+
lastMessageDirection: OPTIONAL_STRING,
|
|
215
|
+
lastMessageIsNote: OPTIONAL_BOOLEAN,
|
|
216
|
+
lastMessageTime: OPTIONAL_DATE,
|
|
217
|
+
mentionedMe: OPTIONAL_BOOLEAN,
|
|
218
|
+
mimicSourceId: OPTIONAL_STRING,
|
|
219
|
+
mostRecentFailureReason: OPTIONAL_STRING,
|
|
220
|
+
name: OPTIONAL_STRING,
|
|
221
|
+
score: z.number().int().nullable().optional(),
|
|
222
|
+
source: z.object({ id: OPTIONAL_STRING, name: OPTIONAL_STRING }).optional(),
|
|
223
|
+
starred: OPTIONAL_BOOLEAN,
|
|
224
|
+
tags: z.string().array().nullable().optional(),
|
|
225
|
+
unread: OPTIONAL_BOOLEAN,
|
|
226
|
+
wontRespondUntil: OPTIONAL_DATE,
|
|
227
|
+
});
|
|
228
|
+
export const CLOSEBOT_LEAD_PAGE_SCHEMA = z.object({
|
|
229
|
+
mentionsTotal: z.number().int().nullable().optional(),
|
|
230
|
+
page: z.number().int(),
|
|
231
|
+
pageSize: z.number().int(),
|
|
232
|
+
results: CLOSEBOT_LEAD_SCHEMA.array().nullable(),
|
|
233
|
+
starredTotal: z.number().int().nullable().optional(),
|
|
234
|
+
total: z.number().int(),
|
|
235
|
+
});
|
|
236
|
+
export const CLOSEBOT_LEAD_SEARCH_RESULT_SCHEMA = z.object({
|
|
237
|
+
leads: CLOSEBOT_LEAD_SCHEMA.array().nullable(),
|
|
238
|
+
mentionsTotal: z.number().int().nullable().optional(),
|
|
239
|
+
starredTotal: z.number().int().nullable().optional(),
|
|
240
|
+
total: z.number().int(),
|
|
241
|
+
});
|
|
242
|
+
export const CLOSEBOT_LEAD_AI_STATUS_SCHEMA = z.object({
|
|
243
|
+
applicable: OPTIONAL_BOOLEAN,
|
|
244
|
+
enabled: OPTIONAL_BOOLEAN,
|
|
245
|
+
reason: OPTIONAL_STRING,
|
|
246
|
+
});
|
|
247
|
+
export const CLOSEBOT_LEAD_HISTORY_EVENT_SCHEMA = z.object({
|
|
248
|
+
actionKey: OPTIONAL_STRING,
|
|
249
|
+
domain: OPTIONAL_STRING,
|
|
250
|
+
eventType: OPTIONAL_STRING,
|
|
251
|
+
id: OPTIONAL_STRING,
|
|
252
|
+
path: OPTIONAL_STRING,
|
|
253
|
+
points: z.number().int().nullable().optional(),
|
|
254
|
+
title: OPTIONAL_STRING,
|
|
255
|
+
triggerType: OPTIONAL_STRING,
|
|
256
|
+
url: OPTIONAL_STRING,
|
|
257
|
+
visitedAt: CLOSEBOT_DATE_SCHEMA.optional(),
|
|
258
|
+
});
|
|
259
|
+
export const CLOSEBOT_NOTE_RESULT_SCHEMA = z.object({
|
|
260
|
+
aiVisible: z.boolean(),
|
|
261
|
+
noteId: z.string().nullable(),
|
|
262
|
+
});
|
|
263
|
+
export const CLOSEBOT_SCHEDULED_MESSAGE_SCHEMA = z.object({
|
|
264
|
+
body: OPTIONAL_STRING,
|
|
265
|
+
botId: OPTIONAL_STRING,
|
|
266
|
+
cancelOnReply: z.boolean(),
|
|
267
|
+
channel: OPTIONAL_STRING,
|
|
268
|
+
createdAt: CLOSEBOT_DATE_SCHEMA,
|
|
269
|
+
createdByAccountId: z.string().nullable(),
|
|
270
|
+
createdByIconUrl: OPTIONAL_STRING,
|
|
271
|
+
createdByName: OPTIONAL_STRING,
|
|
272
|
+
id: z.string().nullable(),
|
|
273
|
+
kind: z.string().nullable(),
|
|
274
|
+
leadId: z.string().nullable(),
|
|
275
|
+
sendAt: CLOSEBOT_DATE_SCHEMA,
|
|
276
|
+
sentMessageId: OPTIONAL_STRING,
|
|
277
|
+
sourceId: OPTIONAL_STRING,
|
|
278
|
+
status: z.string().nullable(),
|
|
279
|
+
statusReason: OPTIONAL_STRING,
|
|
280
|
+
});
|
|
281
|
+
export const CLOSEBOT_SEND_MESSAGE_RESULT_SCHEMA = z.object({
|
|
282
|
+
messageId: z.string().nullable(),
|
|
283
|
+
});
|
|
284
|
+
export const CLOSEBOT_SOURCE_AVAILABILITY_SCHEMA = z.object({
|
|
285
|
+
dayOfWeekUtc: OPTIONAL_STRING,
|
|
286
|
+
duration: OPTIONAL_STRING,
|
|
287
|
+
startTimeUtc: OPTIONAL_STRING,
|
|
288
|
+
});
|
|
289
|
+
export const CLOSEBOT_BOT_SOURCE_AVAILABILITY_SCHEMA = CLOSEBOT_SOURCE_AVAILABILITY_SCHEMA.extend({ channel: OPTIONAL_STRING });
|
|
290
|
+
export const CLOSEBOT_DO_NOT_RESPOND_WINDOW_SCHEMA = z.object({
|
|
291
|
+
end: CLOSEBOT_DATE_SCHEMA.optional(),
|
|
292
|
+
start: CLOSEBOT_DATE_SCHEMA.optional(),
|
|
293
|
+
});
|
|
294
|
+
export const CLOSEBOT_SOURCE_SCHEMA = z.object({
|
|
295
|
+
accountsWithAccess: z.string().array().nullable().optional(),
|
|
296
|
+
address: OPTIONAL_STRING,
|
|
297
|
+
agencyId: OPTIONAL_STRING,
|
|
298
|
+
autoShutoff: OPTIONAL_BOOLEAN,
|
|
299
|
+
botRespondWindows: CLOSEBOT_BOT_SOURCE_AVAILABILITY_SCHEMA.array()
|
|
300
|
+
.nullable()
|
|
301
|
+
.optional(),
|
|
302
|
+
bots: z
|
|
303
|
+
.object({
|
|
304
|
+
botName: OPTIONAL_STRING,
|
|
305
|
+
channelRules: CLOSEBOT_CHANNEL_RULES_SCHEMA.optional(),
|
|
306
|
+
channels: z.string().array().nullable().optional(),
|
|
307
|
+
enabled: OPTIONAL_BOOLEAN,
|
|
308
|
+
id: OPTIONAL_STRING,
|
|
309
|
+
personaNameOverride: OPTIONAL_STRING,
|
|
310
|
+
tagFilterConfig: CLOSEBOT_TAG_FILTER_SCHEMA.optional(),
|
|
311
|
+
tags: CLOSEBOT_TAG_SCHEMA.array().nullable().optional(),
|
|
312
|
+
})
|
|
313
|
+
.array()
|
|
314
|
+
.nullable()
|
|
315
|
+
.optional(),
|
|
316
|
+
category: OPTIONAL_STRING,
|
|
317
|
+
connected: OPTIONAL_BOOLEAN,
|
|
318
|
+
doNotRespondWindows: CLOSEBOT_DO_NOT_RESPOND_WINDOW_SCHEMA.array()
|
|
319
|
+
.nullable()
|
|
320
|
+
.optional(),
|
|
321
|
+
gracefulGoodbye: OPTIONAL_BOOLEAN,
|
|
322
|
+
hubSpotOwnerId: OPTIONAL_STRING,
|
|
323
|
+
isAvailabilityContactTimezone: OPTIONAL_BOOLEAN,
|
|
324
|
+
isBotRespondWindowsQuietHours: OPTIONAL_BOOLEAN,
|
|
325
|
+
key: OPTIONAL_STRING,
|
|
326
|
+
markConversationAsUnread: OPTIONAL_BOOLEAN,
|
|
327
|
+
name: OPTIONAL_STRING,
|
|
328
|
+
respondToReactions: OPTIONAL_BOOLEAN,
|
|
329
|
+
respondWindows: CLOSEBOT_SOURCE_AVAILABILITY_SCHEMA.array()
|
|
330
|
+
.nullable()
|
|
331
|
+
.optional(),
|
|
332
|
+
scriptDomainAllowList: z.string().array().nullable().optional(),
|
|
333
|
+
scriptInstalled: OPTIONAL_BOOLEAN,
|
|
334
|
+
scriptLastSeenAt: OPTIONAL_DATE,
|
|
335
|
+
scriptLastSeenDomain: OPTIONAL_STRING,
|
|
336
|
+
scriptLastSeenEndpoint: OPTIONAL_STRING,
|
|
337
|
+
sourceId: OPTIONAL_STRING,
|
|
338
|
+
summarizeAttachments: OPTIONAL_BOOLEAN,
|
|
339
|
+
timezone: OPTIONAL_STRING,
|
|
340
|
+
webhookCallback: OPTIONAL_STRING,
|
|
341
|
+
});
|
|
342
|
+
export const CLOSEBOT_SOURCE_PAGE_SCHEMA = z.object({
|
|
343
|
+
page: z.number().int(),
|
|
344
|
+
pageSize: z.number().int(),
|
|
345
|
+
results: CLOSEBOT_SOURCE_SCHEMA.array().nullable(),
|
|
346
|
+
total: z.number().int(),
|
|
347
|
+
});
|
|
348
|
+
export const CLOSEBOT_SOURCE_CALENDAR_SCHEMA = z.object({
|
|
349
|
+
id: OPTIONAL_STRING,
|
|
350
|
+
name: OPTIONAL_STRING,
|
|
351
|
+
});
|
|
352
|
+
export const CLOSEBOT_SOURCE_CHANNEL_SCHEMA = z.object({
|
|
353
|
+
filterType: OPTIONAL_STRING,
|
|
354
|
+
id: OPTIONAL_STRING,
|
|
355
|
+
name: OPTIONAL_STRING,
|
|
356
|
+
source: OPTIONAL_STRING,
|
|
357
|
+
});
|
|
358
|
+
export const CLOSEBOT_SOURCE_FIELD_SCHEMA = z.object({
|
|
359
|
+
dataType: OPTIONAL_STRING,
|
|
360
|
+
fieldKey: OPTIONAL_STRING,
|
|
361
|
+
name: OPTIONAL_STRING,
|
|
362
|
+
});
|
|
363
|
+
export const CLOSEBOT_SOURCE_FIELDS_SCHEMA = z.object({
|
|
364
|
+
contact: CLOSEBOT_SOURCE_FIELD_SCHEMA.array().nullable().optional(),
|
|
365
|
+
customValue: CLOSEBOT_SOURCE_FIELD_SCHEMA.array().nullable().optional(),
|
|
366
|
+
location: CLOSEBOT_SOURCE_FIELD_SCHEMA.array().nullable().optional(),
|
|
367
|
+
});
|
|
368
|
+
export const CLOSEBOT_SOURCE_TAG_SCHEMA = z.object({
|
|
369
|
+
id: OPTIONAL_STRING,
|
|
370
|
+
name: OPTIONAL_STRING,
|
|
371
|
+
});
|
|
372
|
+
export const CLOSEBOT_SOURCE_OWNER_SCHEMA = z.object({
|
|
373
|
+
email: OPTIONAL_STRING,
|
|
374
|
+
firstName: OPTIONAL_STRING,
|
|
375
|
+
lastName: OPTIONAL_STRING,
|
|
376
|
+
ownerId: OPTIONAL_STRING,
|
|
377
|
+
});
|
|
378
|
+
export const CLOSEBOT_LIBRARY_FILE_SOURCE_SCHEMA = z.object({
|
|
379
|
+
category: OPTIONAL_STRING,
|
|
380
|
+
id: OPTIONAL_STRING,
|
|
381
|
+
name: OPTIONAL_STRING,
|
|
382
|
+
});
|
|
383
|
+
export const CLOSEBOT_LIBRARY_FILE_SCHEMA = z.object({
|
|
384
|
+
accountId: OPTIONAL_STRING,
|
|
385
|
+
estimatedFileSize: z.number().int().optional(),
|
|
386
|
+
externalItemId: OPTIONAL_STRING,
|
|
387
|
+
externalLibraryResourceSyncId: OPTIONAL_STRING,
|
|
388
|
+
externalProvider: OPTIONAL_STRING,
|
|
389
|
+
externalResourceId: OPTIONAL_STRING,
|
|
390
|
+
externalResourceName: OPTIONAL_STRING,
|
|
391
|
+
externalResourceType: OPTIONAL_STRING,
|
|
392
|
+
faviconUrl: OPTIONAL_STRING,
|
|
393
|
+
fileId: OPTIONAL_STRING,
|
|
394
|
+
fileName: OPTIONAL_STRING,
|
|
395
|
+
fileSize: z.number().int().optional(),
|
|
396
|
+
fileStatus: OPTIONAL_STRING,
|
|
397
|
+
fileType: OPTIONAL_STRING,
|
|
398
|
+
lastModified: CLOSEBOT_DATE_SCHEMA.optional(),
|
|
399
|
+
lastUse: OPTIONAL_DATE,
|
|
400
|
+
sources: CLOSEBOT_LIBRARY_FILE_SOURCE_SCHEMA.array().nullable().optional(),
|
|
401
|
+
uri: OPTIONAL_STRING,
|
|
402
|
+
uses: z.number().int().nullable().optional(),
|
|
403
|
+
});
|
|
404
|
+
export const CLOSEBOT_LIBRARY_FILE_PREVIEW_SCHEMA = z.object({
|
|
405
|
+
chunks: z
|
|
406
|
+
.object({ chunkIndex: OPTIONAL_INTEGER, content: OPTIONAL_STRING })
|
|
407
|
+
.array()
|
|
408
|
+
.nullable()
|
|
409
|
+
.optional(),
|
|
410
|
+
content: OPTIONAL_STRING,
|
|
411
|
+
errorMessage: OPTIONAL_STRING,
|
|
412
|
+
fileId: OPTIONAL_STRING,
|
|
413
|
+
fileName: OPTIONAL_STRING,
|
|
414
|
+
fileSize: z.number().int().optional(),
|
|
415
|
+
fileStatus: OPTIONAL_STRING,
|
|
416
|
+
fileType: OPTIONAL_STRING,
|
|
417
|
+
lastModified: CLOSEBOT_DATE_SCHEMA.optional(),
|
|
418
|
+
previewSource: OPTIONAL_STRING,
|
|
419
|
+
});
|
|
420
|
+
export const CLOSEBOT_WEB_SCRAPE_PAGE_SCHEMA = z.object({
|
|
421
|
+
enabled: OPTIONAL_BOOLEAN,
|
|
422
|
+
url: OPTIONAL_STRING,
|
|
423
|
+
});
|
|
424
|
+
export const CLOSEBOT_BOT_VARIABLE_SCHEMA = z.object({
|
|
425
|
+
id: z.string().nullable(),
|
|
426
|
+
name: z.string().nullable(),
|
|
427
|
+
value: z.string().nullable(),
|
|
428
|
+
});
|
|
429
|
+
export const CLOSEBOT_PERSONA_SCHEMA = z.object({
|
|
430
|
+
agencyId: OPTIONAL_STRING,
|
|
431
|
+
aiProviderPreferences: z.string().array().nullable().optional(),
|
|
432
|
+
botIds: z.string().array().nullable().optional(),
|
|
433
|
+
bots: z
|
|
434
|
+
.object({ id: OPTIONAL_STRING, name: OPTIONAL_STRING })
|
|
435
|
+
.array()
|
|
436
|
+
.nullable()
|
|
437
|
+
.optional(),
|
|
438
|
+
breakupLargeMessagePercent: OPTIONAL_INTEGER,
|
|
439
|
+
color: OPTIONAL_STRING,
|
|
440
|
+
default: OPTIONAL_BOOLEAN,
|
|
441
|
+
description: OPTIONAL_STRING,
|
|
442
|
+
favorited: OPTIONAL_BOOLEAN,
|
|
443
|
+
folderId: OPTIONAL_STRING,
|
|
444
|
+
howToRespond: OPTIONAL_STRING,
|
|
445
|
+
id: OPTIONAL_STRING,
|
|
446
|
+
imageUri: OPTIONAL_STRING,
|
|
447
|
+
modifiedAt: OPTIONAL_STRING,
|
|
448
|
+
modifiedBy: OPTIONAL_STRING,
|
|
449
|
+
personaName: OPTIONAL_STRING,
|
|
450
|
+
responseDelay: OPTIONAL_INTEGER,
|
|
451
|
+
responseTime: OPTIONAL_STRING,
|
|
452
|
+
typoPercent: OPTIONAL_INTEGER,
|
|
453
|
+
voiceStyles: OPTIONAL_STRING,
|
|
454
|
+
});
|
|
455
|
+
export const CLOSEBOT_SMART_FAQ_STATE_SCHEMA = z.union([
|
|
456
|
+
z.literal(0),
|
|
457
|
+
z.literal(1),
|
|
458
|
+
]);
|
|
459
|
+
export const CLOSEBOT_SMART_FAQ_SCHEMA = z.object({
|
|
460
|
+
agencyId: OPTIONAL_STRING,
|
|
461
|
+
answer: OPTIONAL_STRING,
|
|
462
|
+
id: OPTIONAL_STRING,
|
|
463
|
+
leadIds: z.string().array().nullable().optional(),
|
|
464
|
+
question: OPTIONAL_STRING,
|
|
465
|
+
sourceId: OPTIONAL_STRING,
|
|
466
|
+
state: CLOSEBOT_SMART_FAQ_STATE_SCHEMA.optional(),
|
|
467
|
+
});
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import type { Encodable } from "@automate.ax/codec";
|
|
2
|
+
import * as z from "zod";
|
|
3
|
+
import { META_ADS_PAGE_INFO_SCHEMA } from "./schemas.js";
|
|
4
|
+
export declare const META_ADS_GRAPH_API_VERSION = "v26.0";
|
|
5
|
+
export declare const META_ADS_OAUTH_SECRET_SCHEMA: z.ZodObject<{
|
|
6
|
+
accessToken: z.ZodString;
|
|
7
|
+
expiresAt: z.ZodNullable<z.ZodNumber>;
|
|
8
|
+
tokenType: z.ZodString;
|
|
9
|
+
}, z.core.$strip>;
|
|
10
|
+
declare const META_ERROR_SCHEMA: z.ZodObject<{
|
|
11
|
+
code: z.ZodOptional<z.ZodNumber>;
|
|
12
|
+
errorSubcode: z.ZodOptional<z.ZodNumber>;
|
|
13
|
+
errorUserMessage: z.ZodOptional<z.ZodString>;
|
|
14
|
+
fbtraceId: z.ZodOptional<z.ZodString>;
|
|
15
|
+
isTransient: z.ZodOptional<z.ZodBoolean>;
|
|
16
|
+
message: z.ZodString;
|
|
17
|
+
type: z.ZodOptional<z.ZodString>;
|
|
18
|
+
}, z.core.$loose>;
|
|
19
|
+
/** Query values serialized by the shared Graph client. */
|
|
20
|
+
type QueryValue = boolean | number | string | string[] | undefined;
|
|
21
|
+
export interface MetaAdsResolvedAccount {
|
|
22
|
+
connectionMethodId: string;
|
|
23
|
+
secret: Record<string, unknown>;
|
|
24
|
+
serviceId: "meta-ads";
|
|
25
|
+
}
|
|
26
|
+
export interface MetaAdsRequestOptions<TSchema extends z.ZodType> {
|
|
27
|
+
body?: Encodable;
|
|
28
|
+
method?: "DELETE" | "GET" | "PATCH" | "POST";
|
|
29
|
+
query?: Record<string, QueryValue>;
|
|
30
|
+
responseSchema: TSchema;
|
|
31
|
+
}
|
|
32
|
+
export interface MetaAdsPage<T> {
|
|
33
|
+
items: T;
|
|
34
|
+
pageInfo?: z.output<typeof META_ADS_PAGE_INFO_SCHEMA>;
|
|
35
|
+
}
|
|
36
|
+
/** Structured Graph API failure with Meta quota and trace diagnostics. */
|
|
37
|
+
export declare class MetaAdsApiError extends Error {
|
|
38
|
+
readonly appUsage?: string;
|
|
39
|
+
readonly businessUseCaseUsage?: string;
|
|
40
|
+
readonly code?: number;
|
|
41
|
+
readonly fbtraceId?: string;
|
|
42
|
+
readonly isTransient: boolean;
|
|
43
|
+
readonly adAccountUsage?: string;
|
|
44
|
+
readonly errorSubcode?: number;
|
|
45
|
+
readonly retryAfter?: number;
|
|
46
|
+
readonly status: number;
|
|
47
|
+
/**
|
|
48
|
+
* Creates a structured Meta Ads failure.
|
|
49
|
+
*
|
|
50
|
+
* @param options - Transport, provider, and quota details.
|
|
51
|
+
* @param options.adAccountUsage - Raw ad-account usage header.
|
|
52
|
+
* @param options.appUsage - Raw app usage header.
|
|
53
|
+
* @param options.businessUseCaseUsage - Raw business-use-case usage header.
|
|
54
|
+
* @param options.error - Parsed provider error.
|
|
55
|
+
* @param options.retryAfter - Retry delay in seconds.
|
|
56
|
+
* @param options.status - HTTP response status.
|
|
57
|
+
*/
|
|
58
|
+
constructor(options: {
|
|
59
|
+
adAccountUsage?: string;
|
|
60
|
+
appUsage?: string;
|
|
61
|
+
businessUseCaseUsage?: string;
|
|
62
|
+
error?: z.output<typeof META_ERROR_SCHEMA>;
|
|
63
|
+
retryAfter?: number;
|
|
64
|
+
status: number;
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Creates the authenticated Graph API helper used by packaged and custom
|
|
69
|
+
* actions.
|
|
70
|
+
*
|
|
71
|
+
* @param account - Resolved Meta Ads OAuth account.
|
|
72
|
+
* @throws When the connection method or stored credential is invalid.
|
|
73
|
+
*/
|
|
74
|
+
export declare function getMetaAdsApi(account: MetaAdsResolvedAccount): {
|
|
75
|
+
call: <TSchema extends z.ZodType>(path: string, options: MetaAdsRequestOptions<TSchema>) => Promise<z.output<TSchema>>;
|
|
76
|
+
page: <TSchema extends z.ZodType>(path: string, options: MetaAdsRequestOptions<TSchema>) => Promise<MetaAdsPage<z.output<TSchema>>>;
|
|
77
|
+
};
|
|
78
|
+
/**
|
|
79
|
+
* Converts public camelCase object keys to Meta wire keys recursively.
|
|
80
|
+
*
|
|
81
|
+
* @param value - Codec-safe public value.
|
|
82
|
+
*/
|
|
83
|
+
export declare function toMeta(value: Encodable): Encodable;
|
|
84
|
+
/**
|
|
85
|
+
* Converts Meta wire keys to public camelCase keys recursively.
|
|
86
|
+
*
|
|
87
|
+
* @param value - Provider value.
|
|
88
|
+
*/
|
|
89
|
+
export declare function fromMeta(value: unknown): unknown;
|
|
90
|
+
export {};
|