getricky 0.1.17 → 0.1.18
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/cjs/generated/index.d.ts +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +33 -1
- package/dist/cjs/generated/sdk.gen.js +60 -0
- package/dist/cjs/generated/types.gen.d.ts +595 -0
- package/dist/esm/generated/index.d.ts +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +33 -1
- package/dist/esm/generated/sdk.gen.js +60 -0
- package/dist/esm/generated/types.gen.d.ts +595 -0
- package/package.json +1 -1
|
@@ -25,6 +25,341 @@ export type Error = {
|
|
|
25
25
|
request_id: string;
|
|
26
26
|
};
|
|
27
27
|
};
|
|
28
|
+
/**
|
|
29
|
+
* A campaign of a connected ad account.
|
|
30
|
+
*/
|
|
31
|
+
export type MetaAdsCampaign = {
|
|
32
|
+
/**
|
|
33
|
+
* Campaign ID at Meta.
|
|
34
|
+
*/
|
|
35
|
+
id: string;
|
|
36
|
+
/**
|
|
37
|
+
* Ad account ID at Meta.
|
|
38
|
+
*/
|
|
39
|
+
account_id: string;
|
|
40
|
+
/**
|
|
41
|
+
* Name in Meta.
|
|
42
|
+
*/
|
|
43
|
+
name: string;
|
|
44
|
+
/**
|
|
45
|
+
* Objective, such as `OUTCOME_ENGAGEMENT`.
|
|
46
|
+
*/
|
|
47
|
+
objective: string | null;
|
|
48
|
+
/**
|
|
49
|
+
* Status the advertiser set: `ACTIVE`, `PAUSED`, …
|
|
50
|
+
*/
|
|
51
|
+
status: string;
|
|
52
|
+
/**
|
|
53
|
+
* Delivery status, including a parent paused: `ACTIVE`, `CAMPAIGN_PAUSED`, …
|
|
54
|
+
*/
|
|
55
|
+
effective_status: string;
|
|
56
|
+
/**
|
|
57
|
+
* `AUCTION` or `RESERVED`.
|
|
58
|
+
*/
|
|
59
|
+
buying_type: string | null;
|
|
60
|
+
/**
|
|
61
|
+
* Bid strategy, when the campaign sets one.
|
|
62
|
+
*/
|
|
63
|
+
bid_strategy: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* Budget as Meta reports it, in the ad account currency.
|
|
66
|
+
*/
|
|
67
|
+
budget: {
|
|
68
|
+
/**
|
|
69
|
+
* Daily budget in the account currency; null when not set.
|
|
70
|
+
*/
|
|
71
|
+
daily: number | null;
|
|
72
|
+
/**
|
|
73
|
+
* Lifetime budget in the account currency; null when not set.
|
|
74
|
+
*/
|
|
75
|
+
lifetime: number | null;
|
|
76
|
+
/**
|
|
77
|
+
* Budget left in the account currency.
|
|
78
|
+
*/
|
|
79
|
+
remaining: number | null;
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
83
|
+
*/
|
|
84
|
+
start_time: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
87
|
+
*/
|
|
88
|
+
stop_time: string | null;
|
|
89
|
+
/**
|
|
90
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
91
|
+
*/
|
|
92
|
+
created_time: string | null;
|
|
93
|
+
/**
|
|
94
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
95
|
+
*/
|
|
96
|
+
updated_time: string | null;
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* An ad set of a connected ad account.
|
|
100
|
+
*/
|
|
101
|
+
export type MetaAdsAdSet = {
|
|
102
|
+
/**
|
|
103
|
+
* Ad set ID at Meta.
|
|
104
|
+
*/
|
|
105
|
+
id: string;
|
|
106
|
+
/**
|
|
107
|
+
* Ad account ID at Meta.
|
|
108
|
+
*/
|
|
109
|
+
account_id: string;
|
|
110
|
+
/**
|
|
111
|
+
* Campaign ID at Meta.
|
|
112
|
+
*/
|
|
113
|
+
campaign_id: string;
|
|
114
|
+
/**
|
|
115
|
+
* Name in Meta.
|
|
116
|
+
*/
|
|
117
|
+
name: string;
|
|
118
|
+
/**
|
|
119
|
+
* Status the advertiser set: `ACTIVE`, `PAUSED`, …
|
|
120
|
+
*/
|
|
121
|
+
status: string;
|
|
122
|
+
/**
|
|
123
|
+
* Delivery status, including a parent paused: `ACTIVE`, `CAMPAIGN_PAUSED`, …
|
|
124
|
+
*/
|
|
125
|
+
effective_status: string;
|
|
126
|
+
/**
|
|
127
|
+
* What Meta optimizes delivery for.
|
|
128
|
+
*/
|
|
129
|
+
optimization_goal: string | null;
|
|
130
|
+
/**
|
|
131
|
+
* What Meta charges for.
|
|
132
|
+
*/
|
|
133
|
+
billing_event: string | null;
|
|
134
|
+
/**
|
|
135
|
+
* Bid strategy, when the campaign sets one.
|
|
136
|
+
*/
|
|
137
|
+
bid_strategy: string | null;
|
|
138
|
+
/**
|
|
139
|
+
* Budget as Meta reports it, in the ad account currency.
|
|
140
|
+
*/
|
|
141
|
+
budget: {
|
|
142
|
+
/**
|
|
143
|
+
* Daily budget in the account currency; null when not set.
|
|
144
|
+
*/
|
|
145
|
+
daily: number | null;
|
|
146
|
+
/**
|
|
147
|
+
* Lifetime budget in the account currency; null when not set.
|
|
148
|
+
*/
|
|
149
|
+
lifetime: number | null;
|
|
150
|
+
/**
|
|
151
|
+
* Budget left in the account currency.
|
|
152
|
+
*/
|
|
153
|
+
remaining: number | null;
|
|
154
|
+
};
|
|
155
|
+
/**
|
|
156
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
157
|
+
*/
|
|
158
|
+
start_time: string | null;
|
|
159
|
+
/**
|
|
160
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
161
|
+
*/
|
|
162
|
+
end_time: string | null;
|
|
163
|
+
/**
|
|
164
|
+
* Meta's targeting spec as Meta returns it: ages, locations, interests, …
|
|
165
|
+
*/
|
|
166
|
+
targeting: unknown;
|
|
167
|
+
/**
|
|
168
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
169
|
+
*/
|
|
170
|
+
created_time: string | null;
|
|
171
|
+
/**
|
|
172
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
173
|
+
*/
|
|
174
|
+
updated_time: string | null;
|
|
175
|
+
};
|
|
176
|
+
/**
|
|
177
|
+
* An ad of a connected ad account, with its creative copy.
|
|
178
|
+
*/
|
|
179
|
+
export type MetaAdsAd = {
|
|
180
|
+
/**
|
|
181
|
+
* Ad ID at Meta.
|
|
182
|
+
*/
|
|
183
|
+
id: string;
|
|
184
|
+
/**
|
|
185
|
+
* Ad account ID at Meta.
|
|
186
|
+
*/
|
|
187
|
+
account_id: string;
|
|
188
|
+
/**
|
|
189
|
+
* Campaign ID at Meta.
|
|
190
|
+
*/
|
|
191
|
+
campaign_id: string;
|
|
192
|
+
/**
|
|
193
|
+
* Ad set ID at Meta.
|
|
194
|
+
*/
|
|
195
|
+
ad_set_id: string;
|
|
196
|
+
/**
|
|
197
|
+
* Name in Meta.
|
|
198
|
+
*/
|
|
199
|
+
name: string;
|
|
200
|
+
/**
|
|
201
|
+
* Status the advertiser set: `ACTIVE`, `PAUSED`, …
|
|
202
|
+
*/
|
|
203
|
+
status: string;
|
|
204
|
+
/**
|
|
205
|
+
* Delivery status, including a parent paused: `ACTIVE`, `CAMPAIGN_PAUSED`, …
|
|
206
|
+
*/
|
|
207
|
+
effective_status: string;
|
|
208
|
+
/**
|
|
209
|
+
* The creative the ad runs; null when Meta returns none.
|
|
210
|
+
*/
|
|
211
|
+
creative: {
|
|
212
|
+
/**
|
|
213
|
+
* Creative ID at Meta.
|
|
214
|
+
*/
|
|
215
|
+
id: string;
|
|
216
|
+
/**
|
|
217
|
+
* Headline.
|
|
218
|
+
*/
|
|
219
|
+
title: string | null;
|
|
220
|
+
/**
|
|
221
|
+
* Primary text.
|
|
222
|
+
*/
|
|
223
|
+
body: string | null;
|
|
224
|
+
/**
|
|
225
|
+
* Button, such as `LEARN_MORE`.
|
|
226
|
+
*/
|
|
227
|
+
call_to_action_type: string | null;
|
|
228
|
+
/**
|
|
229
|
+
* Image URL Meta returns.
|
|
230
|
+
*/
|
|
231
|
+
image_url: string | null;
|
|
232
|
+
/**
|
|
233
|
+
* Thumbnail URL Meta returns; it expires.
|
|
234
|
+
*/
|
|
235
|
+
thumbnail_url: string | null;
|
|
236
|
+
/**
|
|
237
|
+
* The Instagram post it runs.
|
|
238
|
+
*/
|
|
239
|
+
instagram_permalink_url: string | null;
|
|
240
|
+
/**
|
|
241
|
+
* Meta's story spec as Meta returns it: page, link, message and media.
|
|
242
|
+
*/
|
|
243
|
+
object_story_spec: unknown;
|
|
244
|
+
} | null;
|
|
245
|
+
/**
|
|
246
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
247
|
+
*/
|
|
248
|
+
created_time: string | null;
|
|
249
|
+
/**
|
|
250
|
+
* ISO 8601 time as Meta reports it; null if unset.
|
|
251
|
+
*/
|
|
252
|
+
updated_time: string | null;
|
|
253
|
+
};
|
|
254
|
+
/**
|
|
255
|
+
* Performance Meta computed for one row of the requested level, period and breakdowns.
|
|
256
|
+
*/
|
|
257
|
+
export type MetaAdsInsight = {
|
|
258
|
+
/**
|
|
259
|
+
* Ad account ID at Meta.
|
|
260
|
+
*/
|
|
261
|
+
account_id: string;
|
|
262
|
+
/**
|
|
263
|
+
* Campaign ID, at campaign level or below.
|
|
264
|
+
*/
|
|
265
|
+
campaign_id: string | null;
|
|
266
|
+
/**
|
|
267
|
+
* Campaign name, at campaign level or below.
|
|
268
|
+
*/
|
|
269
|
+
campaign_name: string | null;
|
|
270
|
+
/**
|
|
271
|
+
* Ad set ID, at ad set level or below.
|
|
272
|
+
*/
|
|
273
|
+
ad_set_id: string | null;
|
|
274
|
+
/**
|
|
275
|
+
* Ad set name, at ad set level or below.
|
|
276
|
+
*/
|
|
277
|
+
ad_set_name: string | null;
|
|
278
|
+
/**
|
|
279
|
+
* Ad ID, at ad level.
|
|
280
|
+
*/
|
|
281
|
+
ad_id: string | null;
|
|
282
|
+
/**
|
|
283
|
+
* Ad name, at ad level.
|
|
284
|
+
*/
|
|
285
|
+
ad_name: string | null;
|
|
286
|
+
/**
|
|
287
|
+
* First day of the row, in the ad account's time zone.
|
|
288
|
+
*/
|
|
289
|
+
date_start: string;
|
|
290
|
+
/**
|
|
291
|
+
* Last day of the row, in the ad account's time zone.
|
|
292
|
+
*/
|
|
293
|
+
date_stop: string;
|
|
294
|
+
/**
|
|
295
|
+
* The value of each requested breakdown for this row, such as `{"age": "25-34"}`.
|
|
296
|
+
*/
|
|
297
|
+
breakdown: {
|
|
298
|
+
[key: string]: string;
|
|
299
|
+
};
|
|
300
|
+
/**
|
|
301
|
+
* ISO 4217 currency of the ad account.
|
|
302
|
+
*/
|
|
303
|
+
currency_code: string;
|
|
304
|
+
/**
|
|
305
|
+
* Spend in the account currency.
|
|
306
|
+
*/
|
|
307
|
+
spend: number | null;
|
|
308
|
+
/**
|
|
309
|
+
* Impressions.
|
|
310
|
+
*/
|
|
311
|
+
impressions: number | null;
|
|
312
|
+
/**
|
|
313
|
+
* People reached.
|
|
314
|
+
*/
|
|
315
|
+
reach: number | null;
|
|
316
|
+
/**
|
|
317
|
+
* Impressions per person reached.
|
|
318
|
+
*/
|
|
319
|
+
frequency: number | null;
|
|
320
|
+
/**
|
|
321
|
+
* Clicks.
|
|
322
|
+
*/
|
|
323
|
+
clicks: number | null;
|
|
324
|
+
/**
|
|
325
|
+
* Click-through rate, in percent.
|
|
326
|
+
*/
|
|
327
|
+
ctr: number | null;
|
|
328
|
+
/**
|
|
329
|
+
* Cost per click.
|
|
330
|
+
*/
|
|
331
|
+
cpc: number | null;
|
|
332
|
+
/**
|
|
333
|
+
* Cost per 1,000 impressions.
|
|
334
|
+
*/
|
|
335
|
+
cpm: number | null;
|
|
336
|
+
/**
|
|
337
|
+
* Actions Meta counted, per action type.
|
|
338
|
+
*/
|
|
339
|
+
actions: Array<{
|
|
340
|
+
/**
|
|
341
|
+
* Meta's action type, such as `link_click` or `onsite_conversion.messaging_conversation_started_7d`.
|
|
342
|
+
*/
|
|
343
|
+
action_type: string;
|
|
344
|
+
/**
|
|
345
|
+
* Count, or cost in the account currency.
|
|
346
|
+
*/
|
|
347
|
+
value: number;
|
|
348
|
+
}>;
|
|
349
|
+
/**
|
|
350
|
+
* Cost of each action type.
|
|
351
|
+
*/
|
|
352
|
+
cost_per_action: Array<{
|
|
353
|
+
/**
|
|
354
|
+
* Meta's action type, such as `link_click` or `onsite_conversion.messaging_conversation_started_7d`.
|
|
355
|
+
*/
|
|
356
|
+
action_type: string;
|
|
357
|
+
/**
|
|
358
|
+
* Count, or cost in the account currency.
|
|
359
|
+
*/
|
|
360
|
+
value: number;
|
|
361
|
+
}>;
|
|
362
|
+
};
|
|
28
363
|
/**
|
|
29
364
|
* An AI agent that answers conversations alongside the team.
|
|
30
365
|
*/
|
|
@@ -7404,6 +7739,266 @@ export type GetAdsReportResponses = {
|
|
|
7404
7739
|
};
|
|
7405
7740
|
};
|
|
7406
7741
|
export type GetAdsReportResponse = GetAdsReportResponses[keyof GetAdsReportResponses];
|
|
7742
|
+
export type ListMetaAdsCampaignsData = {
|
|
7743
|
+
body?: never;
|
|
7744
|
+
path?: never;
|
|
7745
|
+
query?: {
|
|
7746
|
+
/**
|
|
7747
|
+
* Only this connected ad account.
|
|
7748
|
+
*/
|
|
7749
|
+
account_id?: string;
|
|
7750
|
+
/**
|
|
7751
|
+
* `true` returns only what Meta is delivering now (effective status `ACTIVE`).
|
|
7752
|
+
*/
|
|
7753
|
+
active_only?: 'true' | 'false';
|
|
7754
|
+
};
|
|
7755
|
+
url: '/ads/campaigns';
|
|
7756
|
+
};
|
|
7757
|
+
export type ListMetaAdsCampaignsErrors = {
|
|
7758
|
+
/**
|
|
7759
|
+
* `invalid_input`: A parameter or body field is invalid; `param` names it when known.
|
|
7760
|
+
*/
|
|
7761
|
+
400: Error;
|
|
7762
|
+
/**
|
|
7763
|
+
* `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
|
|
7764
|
+
*/
|
|
7765
|
+
401: Error;
|
|
7766
|
+
/**
|
|
7767
|
+
* `forbidden`: The organization does not allow the operation.
|
|
7768
|
+
*
|
|
7769
|
+
* `insufficient_scope`: The key lacks the scope this operation requires.
|
|
7770
|
+
*/
|
|
7771
|
+
403: Error;
|
|
7772
|
+
/**
|
|
7773
|
+
* `rule_violation`: The request breaks a business rule; `message` says which.
|
|
7774
|
+
*/
|
|
7775
|
+
422: Error;
|
|
7776
|
+
/**
|
|
7777
|
+
* `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
|
|
7778
|
+
*/
|
|
7779
|
+
429: Error;
|
|
7780
|
+
/**
|
|
7781
|
+
* `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
|
|
7782
|
+
*/
|
|
7783
|
+
500: Error;
|
|
7784
|
+
};
|
|
7785
|
+
export type ListMetaAdsCampaignsError = ListMetaAdsCampaignsErrors[keyof ListMetaAdsCampaignsErrors];
|
|
7786
|
+
export type ListMetaAdsCampaignsResponses = {
|
|
7787
|
+
/**
|
|
7788
|
+
* Success.
|
|
7789
|
+
*/
|
|
7790
|
+
200: {
|
|
7791
|
+
data: Array<MetaAdsCampaign>;
|
|
7792
|
+
/**
|
|
7793
|
+
* Pass as `cursor` for the next page; null on the last page.
|
|
7794
|
+
*/
|
|
7795
|
+
next_cursor: string | null;
|
|
7796
|
+
};
|
|
7797
|
+
};
|
|
7798
|
+
export type ListMetaAdsCampaignsResponse = ListMetaAdsCampaignsResponses[keyof ListMetaAdsCampaignsResponses];
|
|
7799
|
+
export type ListMetaAdsAdSetsData = {
|
|
7800
|
+
body?: never;
|
|
7801
|
+
path?: never;
|
|
7802
|
+
query?: {
|
|
7803
|
+
/**
|
|
7804
|
+
* Only this connected ad account.
|
|
7805
|
+
*/
|
|
7806
|
+
account_id?: string;
|
|
7807
|
+
/**
|
|
7808
|
+
* Only the ad sets of this campaign.
|
|
7809
|
+
*/
|
|
7810
|
+
campaign_id?: string;
|
|
7811
|
+
/**
|
|
7812
|
+
* `true` returns only what Meta is delivering now (effective status `ACTIVE`).
|
|
7813
|
+
*/
|
|
7814
|
+
active_only?: 'true' | 'false';
|
|
7815
|
+
};
|
|
7816
|
+
url: '/ads/ad-sets';
|
|
7817
|
+
};
|
|
7818
|
+
export type ListMetaAdsAdSetsErrors = {
|
|
7819
|
+
/**
|
|
7820
|
+
* `invalid_input`: A parameter or body field is invalid; `param` names it when known.
|
|
7821
|
+
*/
|
|
7822
|
+
400: Error;
|
|
7823
|
+
/**
|
|
7824
|
+
* `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
|
|
7825
|
+
*/
|
|
7826
|
+
401: Error;
|
|
7827
|
+
/**
|
|
7828
|
+
* `forbidden`: The organization does not allow the operation.
|
|
7829
|
+
*
|
|
7830
|
+
* `insufficient_scope`: The key lacks the scope this operation requires.
|
|
7831
|
+
*/
|
|
7832
|
+
403: Error;
|
|
7833
|
+
/**
|
|
7834
|
+
* `rule_violation`: The request breaks a business rule; `message` says which.
|
|
7835
|
+
*/
|
|
7836
|
+
422: Error;
|
|
7837
|
+
/**
|
|
7838
|
+
* `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
|
|
7839
|
+
*/
|
|
7840
|
+
429: Error;
|
|
7841
|
+
/**
|
|
7842
|
+
* `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
|
|
7843
|
+
*/
|
|
7844
|
+
500: Error;
|
|
7845
|
+
};
|
|
7846
|
+
export type ListMetaAdsAdSetsError = ListMetaAdsAdSetsErrors[keyof ListMetaAdsAdSetsErrors];
|
|
7847
|
+
export type ListMetaAdsAdSetsResponses = {
|
|
7848
|
+
/**
|
|
7849
|
+
* Success.
|
|
7850
|
+
*/
|
|
7851
|
+
200: {
|
|
7852
|
+
data: Array<MetaAdsAdSet>;
|
|
7853
|
+
/**
|
|
7854
|
+
* Pass as `cursor` for the next page; null on the last page.
|
|
7855
|
+
*/
|
|
7856
|
+
next_cursor: string | null;
|
|
7857
|
+
};
|
|
7858
|
+
};
|
|
7859
|
+
export type ListMetaAdsAdSetsResponse = ListMetaAdsAdSetsResponses[keyof ListMetaAdsAdSetsResponses];
|
|
7860
|
+
export type ListMetaAdsData = {
|
|
7861
|
+
body?: never;
|
|
7862
|
+
path?: never;
|
|
7863
|
+
query?: {
|
|
7864
|
+
/**
|
|
7865
|
+
* Only this connected ad account.
|
|
7866
|
+
*/
|
|
7867
|
+
account_id?: string;
|
|
7868
|
+
/**
|
|
7869
|
+
* Only the ads of this campaign.
|
|
7870
|
+
*/
|
|
7871
|
+
campaign_id?: string;
|
|
7872
|
+
/**
|
|
7873
|
+
* Only the ads of this ad set.
|
|
7874
|
+
*/
|
|
7875
|
+
ad_set_id?: string;
|
|
7876
|
+
/**
|
|
7877
|
+
* `true` returns only what Meta is delivering now (effective status `ACTIVE`).
|
|
7878
|
+
*/
|
|
7879
|
+
active_only?: 'true' | 'false';
|
|
7880
|
+
};
|
|
7881
|
+
url: '/ads/ads';
|
|
7882
|
+
};
|
|
7883
|
+
export type ListMetaAdsErrors = {
|
|
7884
|
+
/**
|
|
7885
|
+
* `invalid_input`: A parameter or body field is invalid; `param` names it when known.
|
|
7886
|
+
*/
|
|
7887
|
+
400: Error;
|
|
7888
|
+
/**
|
|
7889
|
+
* `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
|
|
7890
|
+
*/
|
|
7891
|
+
401: Error;
|
|
7892
|
+
/**
|
|
7893
|
+
* `forbidden`: The organization does not allow the operation.
|
|
7894
|
+
*
|
|
7895
|
+
* `insufficient_scope`: The key lacks the scope this operation requires.
|
|
7896
|
+
*/
|
|
7897
|
+
403: Error;
|
|
7898
|
+
/**
|
|
7899
|
+
* `rule_violation`: The request breaks a business rule; `message` says which.
|
|
7900
|
+
*/
|
|
7901
|
+
422: Error;
|
|
7902
|
+
/**
|
|
7903
|
+
* `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
|
|
7904
|
+
*/
|
|
7905
|
+
429: Error;
|
|
7906
|
+
/**
|
|
7907
|
+
* `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
|
|
7908
|
+
*/
|
|
7909
|
+
500: Error;
|
|
7910
|
+
};
|
|
7911
|
+
export type ListMetaAdsError = ListMetaAdsErrors[keyof ListMetaAdsErrors];
|
|
7912
|
+
export type ListMetaAdsResponses = {
|
|
7913
|
+
/**
|
|
7914
|
+
* Success.
|
|
7915
|
+
*/
|
|
7916
|
+
200: {
|
|
7917
|
+
data: Array<MetaAdsAd>;
|
|
7918
|
+
/**
|
|
7919
|
+
* Pass as `cursor` for the next page; null on the last page.
|
|
7920
|
+
*/
|
|
7921
|
+
next_cursor: string | null;
|
|
7922
|
+
};
|
|
7923
|
+
};
|
|
7924
|
+
export type ListMetaAdsResponse = ListMetaAdsResponses[keyof ListMetaAdsResponses];
|
|
7925
|
+
export type GetMetaAdsInsightsData = {
|
|
7926
|
+
body?: never;
|
|
7927
|
+
path?: never;
|
|
7928
|
+
query: {
|
|
7929
|
+
/**
|
|
7930
|
+
* Only this connected ad account.
|
|
7931
|
+
*/
|
|
7932
|
+
account_id?: string;
|
|
7933
|
+
/**
|
|
7934
|
+
* One row per ad account, campaign, ad set or ad.
|
|
7935
|
+
*/
|
|
7936
|
+
level?: 'account' | 'campaign' | 'ad_set' | 'ad';
|
|
7937
|
+
/**
|
|
7938
|
+
* First day, `YYYY-MM-DD`, in the ad account's time zone.
|
|
7939
|
+
*/
|
|
7940
|
+
from: string;
|
|
7941
|
+
/**
|
|
7942
|
+
* Last day, `YYYY-MM-DD`, inclusive. At most 400 days after `from`.
|
|
7943
|
+
*/
|
|
7944
|
+
to: string;
|
|
7945
|
+
/**
|
|
7946
|
+
* Split rows by up to two of `age`, `gender`, `country`, `region`, `publisher_platform`, `platform_position`, `device_platform`, comma-separated.
|
|
7947
|
+
*/
|
|
7948
|
+
breakdowns?: string;
|
|
7949
|
+
/**
|
|
7950
|
+
* `true` returns one row per day instead of one for the period.
|
|
7951
|
+
*/
|
|
7952
|
+
daily?: 'true' | 'false';
|
|
7953
|
+
/**
|
|
7954
|
+
* Only this campaign, ad set or ad.
|
|
7955
|
+
*/
|
|
7956
|
+
object_id?: string;
|
|
7957
|
+
};
|
|
7958
|
+
url: '/ads/insights';
|
|
7959
|
+
};
|
|
7960
|
+
export type GetMetaAdsInsightsErrors = {
|
|
7961
|
+
/**
|
|
7962
|
+
* `invalid_input`: A parameter or body field is invalid; `param` names it when known.
|
|
7963
|
+
*/
|
|
7964
|
+
400: Error;
|
|
7965
|
+
/**
|
|
7966
|
+
* `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
|
|
7967
|
+
*/
|
|
7968
|
+
401: Error;
|
|
7969
|
+
/**
|
|
7970
|
+
* `forbidden`: The organization does not allow the operation.
|
|
7971
|
+
*
|
|
7972
|
+
* `insufficient_scope`: The key lacks the scope this operation requires.
|
|
7973
|
+
*/
|
|
7974
|
+
403: Error;
|
|
7975
|
+
/**
|
|
7976
|
+
* `rule_violation`: The request breaks a business rule; `message` says which.
|
|
7977
|
+
*/
|
|
7978
|
+
422: Error;
|
|
7979
|
+
/**
|
|
7980
|
+
* `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
|
|
7981
|
+
*/
|
|
7982
|
+
429: Error;
|
|
7983
|
+
/**
|
|
7984
|
+
* `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
|
|
7985
|
+
*/
|
|
7986
|
+
500: Error;
|
|
7987
|
+
};
|
|
7988
|
+
export type GetMetaAdsInsightsError = GetMetaAdsInsightsErrors[keyof GetMetaAdsInsightsErrors];
|
|
7989
|
+
export type GetMetaAdsInsightsResponses = {
|
|
7990
|
+
/**
|
|
7991
|
+
* Success.
|
|
7992
|
+
*/
|
|
7993
|
+
200: {
|
|
7994
|
+
data: Array<MetaAdsInsight>;
|
|
7995
|
+
/**
|
|
7996
|
+
* Pass as `cursor` for the next page; null on the last page.
|
|
7997
|
+
*/
|
|
7998
|
+
next_cursor: string | null;
|
|
7999
|
+
};
|
|
8000
|
+
};
|
|
8001
|
+
export type GetMetaAdsInsightsResponse = GetMetaAdsInsightsResponses[keyof GetMetaAdsInsightsResponses];
|
|
7407
8002
|
export type ListAgentsData = {
|
|
7408
8003
|
body?: never;
|
|
7409
8004
|
path?: never;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { type Options, RickyApi } from './sdk.gen.js';
|
|
2
|
-
export type { ActivateWorkflowData, ActivateWorkflowError, ActivateWorkflowErrors, ActivateWorkflowResponse, ActivateWorkflowResponses, AddContactNote, AddContactNoteData, AddContactNoteError, AddContactNoteErrors, AddContactNoteResponse, AddContactNoteResponses, AdsReport, Agent, AgentOptions, AppointmentState, ArchiveAgentData, ArchiveAgentError, ArchiveAgentErrors, ArchiveAgentResponse, ArchiveAgentResponses, AssignConversation, AssignConversationAgent, AssignConversationAgentData, AssignConversationAgentError, AssignConversationAgentErrors, AssignConversationAgentResponse, AssignConversationAgentResponses, AssignConversationData, AssignConversationError, AssignConversationErrors, AssignConversationResponse, AssignConversationResponses, AssignConversations, AssignConversationsData, AssignConversationsError, AssignConversationsErrors, AssignConversationsResponse, AssignConversationsResponses, Broadcast, BroadcastAudiencePreview, BroadcastRecipient, BroadcastsReport, CancelBroadcastData, CancelBroadcastError, CancelBroadcastErrors, CancelBroadcastResponse, CancelBroadcastResponses, ChangeContactsTags, ChangeContactsTagsData, ChangeContactsTagsError, ChangeContactsTagsErrors, ChangeContactsTagsResponse, ChangeContactsTagsResponses, ChangeConversationTags, ChangeConversationTagsData, ChangeConversationTagsError, ChangeConversationTagsErrors, ChangeConversationTagsResponse, ChangeConversationTagsResponses, Channel, ClientOptions, CloseConversation, CloseConversationData, CloseConversationError, CloseConversationErrors, CloseConversationResponse, CloseConversationResponses, CompleteKnowledgeFile, CompleteKnowledgeFileData, CompleteKnowledgeFileError, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponse, CompleteKnowledgeFileResponses, CompleteProfilePhotoUpload, CompleteProfilePhotoUploadData, CompleteProfilePhotoUploadError, CompleteProfilePhotoUploadErrors, CompleteProfilePhotoUploadResponse, CompleteProfilePhotoUploadResponses, CompleteTemplateMediaUpload, CompleteTemplateMediaUploadData, CompleteTemplateMediaUploadError, CompleteTemplateMediaUploadErrors, CompleteTemplateMediaUploadResponse, CompleteTemplateMediaUploadResponses, Contact, ContactField, ContactIdentity, ContactTagChange, Conversation, ConversationAssignmentResult, ConversationHandoff, ConversationsReport, CreateAgent, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateBroadcast, CreateBroadcastData, CreateBroadcastError, CreateBroadcastErrors, CreateBroadcastResponse, CreateBroadcastResponses, CreateContact, CreateContactData, CreateContactError, CreateContactErrors, CreateContactField, CreateContactFieldData, CreateContactFieldError, CreateContactFieldErrors, CreateContactFieldResponse, CreateContactFieldResponses, CreateContactResponse, CreateContactResponses, CreatedWebhook, CreateKnowledgeContact, CreateKnowledgeContactData, CreateKnowledgeContactError, CreateKnowledgeContactErrors, CreateKnowledgeContactResponse, CreateKnowledgeContactResponses, CreateKnowledgeFile, CreateKnowledgeFileData, CreateKnowledgeFileError, CreateKnowledgeFileErrors, CreateKnowledgeFileResponse, CreateKnowledgeFileResponses, CreateKnowledgeLocation, CreateKnowledgeLocationData, CreateKnowledgeLocationError, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponse, CreateKnowledgeLocationResponses, CreateProfilePhotoUpload, CreateProfilePhotoUploadData, CreateProfilePhotoUploadError, CreateProfilePhotoUploadErrors, CreateProfilePhotoUploadResponse, CreateProfilePhotoUploadResponses, CreateQuickReply, CreateQuickReplyData, CreateQuickReplyError, CreateQuickReplyErrors, CreateQuickReplyResponse, CreateQuickReplyResponses, CreateTag, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, CreateTemplate, CreateTemplateData, CreateTemplateError, CreateTemplateErrors, CreateTemplateMediaUpload, CreateTemplateMediaUploadData, CreateTemplateMediaUploadError, CreateTemplateMediaUploadErrors, CreateTemplateMediaUploadResponse, CreateTemplateMediaUploadResponses, CreateTemplateResponse, CreateTemplateResponses, CreateWebhook, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflow, CreateWorkflowData, CreateWorkflowError, CreateWorkflowErrors, CreateWorkflowResponse, CreateWorkflowResponses, DashboardReport, DeleteContactFieldData, DeleteContactFieldError, DeleteContactFieldErrors, DeleteContactFieldResponse, DeleteContactFieldResponses, DeletedTemplate, DeleteKnowledgeContactData, DeleteKnowledgeContactError, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponse, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileError, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponse, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationError, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponse, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyError, DeleteQuickReplyErrors, DeleteQuickReplyResponse, DeleteQuickReplyResponses, DeleteTagData, DeleteTagError, DeleteTagErrors, DeleteTagResponse, DeleteTagResponses, DeleteTemplateData, DeleteTemplateError, DeleteTemplateErrors, DeleteTemplateResponse, DeleteTemplateResponses, DeleteWorkflowData, DeleteWorkflowError, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookError, DisableWebhookErrors, DisableWebhookResponse, DisableWebhookResponses, DisplayNameRequest, Error, FetchMessageMediaData, FetchMessageMediaError, FetchMessageMediaErrors, FetchMessageMediaResponse, FetchMessageMediaResponses, GetAdsReportData, GetAdsReportError, GetAdsReportErrors, GetAdsReportResponse, GetAdsReportResponses, GetAgentData, GetAgentError, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsError, GetAgentOptionsErrors, GetAgentOptionsResponse, GetAgentOptionsResponses, GetAgentResponse, GetAgentResponses, GetBroadcastData, GetBroadcastError, GetBroadcastErrors, GetBroadcastResponse, GetBroadcastResponses, GetBroadcastsReportData, GetBroadcastsReportError, GetBroadcastsReportErrors, GetBroadcastsReportResponse, GetBroadcastsReportResponses, GetContactData, GetContactError, GetContactErrors, GetContactResponse, GetContactResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationsReportData, GetConversationsReportError, GetConversationsReportErrors, GetConversationsReportResponse, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportError, GetDashboardReportErrors, GetDashboardReportResponse, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactError, GetKnowledgeContactErrors, GetKnowledgeContactResponse, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileError, GetKnowledgeFileErrors, GetKnowledgeFileResponse, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationError, GetKnowledgeLocationErrors, GetKnowledgeLocationResponse, GetKnowledgeLocationResponses, GetMessageData, GetMessageError, GetMessageErrors, GetMessageResponse, GetMessageResponses, GetMessagesReportData, GetMessagesReportError, GetMessagesReportErrors, GetMessagesReportResponse, GetMessagesReportResponses, GetQuickReplyData, GetQuickReplyError, GetQuickReplyErrors, GetQuickReplyResponse, GetQuickReplyResponses, GetResolutionsReportData, GetResolutionsReportError, GetResolutionsReportErrors, GetResolutionsReportResponse, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportError, GetResponsesReportErrors, GetResponsesReportResponse, GetResponsesReportResponses, GetSendData, GetSendError, GetSendErrors, GetSendResponse, GetSendResponses, GetTeamReportData, GetTeamReportError, GetTeamReportErrors, GetTeamReportResponse, GetTeamReportResponses, GetTemplateData, GetTemplateError, GetTemplateErrors, GetTemplateFieldMappingsData, GetTemplateFieldMappingsError, GetTemplateFieldMappingsErrors, GetTemplateFieldMappingsResponse, GetTemplateFieldMappingsResponses, GetTemplateResponse, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberError, GetWhatsAppNumberErrors, GetWhatsAppNumberResponse, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowError, GetWorkflowErrors, GetWorkflowReminderHistoryData, GetWorkflowReminderHistoryError, GetWorkflowReminderHistoryErrors, GetWorkflowReminderHistoryResponse, GetWorkflowReminderHistoryResponses, GetWorkflowResponse, GetWorkflowResponses, IdempotencyKey, KnowledgeContact, KnowledgeFile, KnowledgeFileUpload, KnowledgeLocation, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsError, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponse, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsError, ListBroadcastsErrors, ListBroadcastsResponse, ListBroadcastsResponses, ListChannelsData, ListChannelsError, ListChannelsErrors, ListChannelsResponse, ListChannelsResponses, ListContactFieldsData, ListContactFieldsError, ListContactFieldsErrors, ListContactFieldsResponse, ListContactFieldsResponses, ListContactsData, ListContactsError, ListContactsErrors, ListContactsResponse, ListContactsResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsError, ListKnowledgeContactsErrors, ListKnowledgeContactsResponse, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesError, ListKnowledgeFilesErrors, ListKnowledgeFilesResponse, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsError, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponse, ListKnowledgeLocationsResponses, ListMembersData, ListMembersError, ListMembersErrors, ListMembersResponse, ListMembersResponses, ListMessagesData, ListMessagesError, ListMessagesErrors, ListMessagesResponse, ListMessagesResponses, ListQuickRepliesData, ListQuickRepliesError, ListQuickRepliesErrors, ListQuickRepliesResponse, ListQuickRepliesResponses, ListTagsData, ListTagsError, ListTagsErrors, ListTagsResponse, ListTagsResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesError, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWhatsAppNumbersData, ListWhatsAppNumbersError, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponse, ListWhatsAppNumbersResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsError, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponse, ListWorkflowExecutionsResponses, ListWorkflowReminderStatesData, ListWorkflowReminderStatesError, ListWorkflowReminderStatesErrors, ListWorkflowReminderStatesResponse, ListWorkflowReminderStatesResponses, ListWorkflowsData, ListWorkflowsError, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadError, MarkConversationReadErrors, MarkConversationReadResponse, MarkConversationReadResponses, MarkConversationUnreadData, MarkConversationUnreadError, MarkConversationUnreadErrors, MarkConversationUnreadResponse, MarkConversationUnreadResponses, MediaMessage, MediaUpload, Member, Message, MessageSearchResult, MessagesReport, PauseWorkflowData, PauseWorkflowError, PauseWorkflowErrors, PauseWorkflowResponse, PauseWorkflowResponses, PreviewBroadcastAudience, PreviewBroadcastAudienceData, PreviewBroadcastAudienceError, PreviewBroadcastAudienceErrors, PreviewBroadcastAudienceResponse, PreviewBroadcastAudienceResponses, PreviewWorkflowRemindersData, PreviewWorkflowRemindersError, PreviewWorkflowRemindersErrors, PreviewWorkflowRemindersResponse, PreviewWorkflowRemindersResponses, QuickReply, RefreshWhatsAppNumberData, RefreshWhatsAppNumberError, RefreshWhatsAppNumberErrors, RefreshWhatsAppNumberResponse, RefreshWhatsAppNumberResponses, ReminderHistory, ReminderPreview, ReopenConversationData, ReopenConversationError, ReopenConversationErrors, ReopenConversationResponse, ReopenConversationResponses, ReplaceTemplateFieldMappings, ReplaceTemplateFieldMappingsData, ReplaceTemplateFieldMappingsError, ReplaceTemplateFieldMappingsErrors, ReplaceTemplateFieldMappingsResponse, ReplaceTemplateFieldMappingsResponses, ReportPeriod, RequestDisplayName, RequestWhatsAppDisplayNameData, RequestWhatsAppDisplayNameError, RequestWhatsAppDisplayNameErrors, RequestWhatsAppDisplayNameResponse, RequestWhatsAppDisplayNameResponses, ResolutionsReport, ResolveConversationHandoffData, ResolveConversationHandoffError, ResolveConversationHandoffErrors, ResolveConversationHandoffResponse, ResolveConversationHandoffResponses, ResolveHandoff, ResponsesReport, RetryWebhookDeliveryData, RetryWebhookDeliveryError, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponse, RetryWebhookDeliveryResponses, RotateWebhookSecret, RotateWebhookSecretData, RotateWebhookSecretError, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsError, SearchConversationsErrors, SearchConversationsResponse, SearchConversationsResponses, SearchMessagesData, SearchMessagesError, SearchMessagesErrors, SearchMessagesResponse, SearchMessagesResponses, Send, SendMessage, SendMessageData, SendMessageError, SendMessageErrors, SendMessageResponse, SendMessageResponses, StartConversation, StartConversationData, StartConversationError, StartConversationErrors, StartConversationResponse, StartConversationResponses, Tag, TeamReport, Template, TemplateFieldMappings, TemplateMedia, TemplateMessage, TemplateValidation, TestWebhookData, TestWebhookError, TestWebhookErrors, TestWebhookResponse, TestWebhookResponses, UpdateAgent, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentResponse, UpdateAgentResponses, UpdateContact, UpdateContactData, UpdateContactError, UpdateContactErrors, UpdateContactResponse, UpdateContactResponses, UpdateKnowledgeContact, UpdateKnowledgeContactData, UpdateKnowledgeContactError, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponse, UpdateKnowledgeContactResponses, UpdateKnowledgeFile, UpdateKnowledgeFileData, UpdateKnowledgeFileError, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponse, UpdateKnowledgeFileResponses, UpdateKnowledgeLocation, UpdateKnowledgeLocationData, UpdateKnowledgeLocationError, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponse, UpdateKnowledgeLocationResponses, UpdateQuickReply, UpdateQuickReplyData, UpdateQuickReplyError, UpdateQuickReplyErrors, UpdateQuickReplyResponse, UpdateQuickReplyResponses, UpdateTag, UpdateTagData, UpdateTagError, UpdateTagErrors, UpdateTagResponse, UpdateTagResponses, UpdateTemplate, UpdateTemplateData, UpdateTemplateError, UpdateTemplateErrors, UpdateTemplateResponse, UpdateTemplateResponses, UpdateWhatsAppBusinessProfile, UpdateWhatsAppBusinessProfileData, UpdateWhatsAppBusinessProfileError, UpdateWhatsAppBusinessProfileErrors, UpdateWhatsAppBusinessProfileResponse, UpdateWhatsAppBusinessProfileResponses, UpdateWhatsAppNumber, UpdateWhatsAppNumberData, UpdateWhatsAppNumberError, UpdateWhatsAppNumberErrors, UpdateWhatsAppNumberResponse, UpdateWhatsAppNumberResponses, UpdateWorkflow, UpdateWorkflowData, UpdateWorkflowError, UpdateWorkflowErrors, UpdateWorkflowResponse, UpdateWorkflowResponses, UploadWorkflowHeaderMedia, UploadWorkflowHeaderMediaData, UploadWorkflowHeaderMediaError, UploadWorkflowHeaderMediaErrors, UploadWorkflowHeaderMediaResponse, UploadWorkflowHeaderMediaResponses, ValidateTemplate, ValidateTemplateData, ValidateTemplateError, ValidateTemplateErrors, ValidateTemplateResponse, ValidateTemplateResponses, Webhook, WebhookBroadcastCompletedWebhookPayload, WebhookBroadcastCompletedWebhookRequest, WebhookBroadcastFailedWebhookPayload, WebhookBroadcastFailedWebhookRequest, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactTagsChangedWebhookPayload, WebhookContactTagsChangedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAgentChangedWebhookPayload, WebhookConversationAgentChangedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationHandoffRequestedWebhookPayload, WebhookConversationHandoffRequestedWebhookRequest, WebhookConversationHandoffResolvedWebhookPayload, WebhookConversationHandoffResolvedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookKnowledgeFileReadyWebhookPayload, WebhookKnowledgeFileReadyWebhookRequest, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTemplateStatusChangedWebhookPayload, WebhookTemplateStatusChangedWebhookRequest, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, WebhookWorkflowExecutionFailedWebhookPayload, WebhookWorkflowExecutionFailedWebhookRequest, WhatsAppNumber, Workflow, WorkflowExecution } from './types.gen.js';
|
|
2
|
+
export type { ActivateWorkflowData, ActivateWorkflowError, ActivateWorkflowErrors, ActivateWorkflowResponse, ActivateWorkflowResponses, AddContactNote, AddContactNoteData, AddContactNoteError, AddContactNoteErrors, AddContactNoteResponse, AddContactNoteResponses, AdsReport, Agent, AgentOptions, AppointmentState, ArchiveAgentData, ArchiveAgentError, ArchiveAgentErrors, ArchiveAgentResponse, ArchiveAgentResponses, AssignConversation, AssignConversationAgent, AssignConversationAgentData, AssignConversationAgentError, AssignConversationAgentErrors, AssignConversationAgentResponse, AssignConversationAgentResponses, AssignConversationData, AssignConversationError, AssignConversationErrors, AssignConversationResponse, AssignConversationResponses, AssignConversations, AssignConversationsData, AssignConversationsError, AssignConversationsErrors, AssignConversationsResponse, AssignConversationsResponses, Broadcast, BroadcastAudiencePreview, BroadcastRecipient, BroadcastsReport, CancelBroadcastData, CancelBroadcastError, CancelBroadcastErrors, CancelBroadcastResponse, CancelBroadcastResponses, ChangeContactsTags, ChangeContactsTagsData, ChangeContactsTagsError, ChangeContactsTagsErrors, ChangeContactsTagsResponse, ChangeContactsTagsResponses, ChangeConversationTags, ChangeConversationTagsData, ChangeConversationTagsError, ChangeConversationTagsErrors, ChangeConversationTagsResponse, ChangeConversationTagsResponses, Channel, ClientOptions, CloseConversation, CloseConversationData, CloseConversationError, CloseConversationErrors, CloseConversationResponse, CloseConversationResponses, CompleteKnowledgeFile, CompleteKnowledgeFileData, CompleteKnowledgeFileError, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponse, CompleteKnowledgeFileResponses, CompleteProfilePhotoUpload, CompleteProfilePhotoUploadData, CompleteProfilePhotoUploadError, CompleteProfilePhotoUploadErrors, CompleteProfilePhotoUploadResponse, CompleteProfilePhotoUploadResponses, CompleteTemplateMediaUpload, CompleteTemplateMediaUploadData, CompleteTemplateMediaUploadError, CompleteTemplateMediaUploadErrors, CompleteTemplateMediaUploadResponse, CompleteTemplateMediaUploadResponses, Contact, ContactField, ContactIdentity, ContactTagChange, Conversation, ConversationAssignmentResult, ConversationHandoff, ConversationsReport, CreateAgent, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateBroadcast, CreateBroadcastData, CreateBroadcastError, CreateBroadcastErrors, CreateBroadcastResponse, CreateBroadcastResponses, CreateContact, CreateContactData, CreateContactError, CreateContactErrors, CreateContactField, CreateContactFieldData, CreateContactFieldError, CreateContactFieldErrors, CreateContactFieldResponse, CreateContactFieldResponses, CreateContactResponse, CreateContactResponses, CreatedWebhook, CreateKnowledgeContact, CreateKnowledgeContactData, CreateKnowledgeContactError, CreateKnowledgeContactErrors, CreateKnowledgeContactResponse, CreateKnowledgeContactResponses, CreateKnowledgeFile, CreateKnowledgeFileData, CreateKnowledgeFileError, CreateKnowledgeFileErrors, CreateKnowledgeFileResponse, CreateKnowledgeFileResponses, CreateKnowledgeLocation, CreateKnowledgeLocationData, CreateKnowledgeLocationError, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponse, CreateKnowledgeLocationResponses, CreateProfilePhotoUpload, CreateProfilePhotoUploadData, CreateProfilePhotoUploadError, CreateProfilePhotoUploadErrors, CreateProfilePhotoUploadResponse, CreateProfilePhotoUploadResponses, CreateQuickReply, CreateQuickReplyData, CreateQuickReplyError, CreateQuickReplyErrors, CreateQuickReplyResponse, CreateQuickReplyResponses, CreateTag, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, CreateTemplate, CreateTemplateData, CreateTemplateError, CreateTemplateErrors, CreateTemplateMediaUpload, CreateTemplateMediaUploadData, CreateTemplateMediaUploadError, CreateTemplateMediaUploadErrors, CreateTemplateMediaUploadResponse, CreateTemplateMediaUploadResponses, CreateTemplateResponse, CreateTemplateResponses, CreateWebhook, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflow, CreateWorkflowData, CreateWorkflowError, CreateWorkflowErrors, CreateWorkflowResponse, CreateWorkflowResponses, DashboardReport, DeleteContactFieldData, DeleteContactFieldError, DeleteContactFieldErrors, DeleteContactFieldResponse, DeleteContactFieldResponses, DeletedTemplate, DeleteKnowledgeContactData, DeleteKnowledgeContactError, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponse, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileError, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponse, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationError, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponse, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyError, DeleteQuickReplyErrors, DeleteQuickReplyResponse, DeleteQuickReplyResponses, DeleteTagData, DeleteTagError, DeleteTagErrors, DeleteTagResponse, DeleteTagResponses, DeleteTemplateData, DeleteTemplateError, DeleteTemplateErrors, DeleteTemplateResponse, DeleteTemplateResponses, DeleteWorkflowData, DeleteWorkflowError, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookError, DisableWebhookErrors, DisableWebhookResponse, DisableWebhookResponses, DisplayNameRequest, Error, FetchMessageMediaData, FetchMessageMediaError, FetchMessageMediaErrors, FetchMessageMediaResponse, FetchMessageMediaResponses, GetAdsReportData, GetAdsReportError, GetAdsReportErrors, GetAdsReportResponse, GetAdsReportResponses, GetAgentData, GetAgentError, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsError, GetAgentOptionsErrors, GetAgentOptionsResponse, GetAgentOptionsResponses, GetAgentResponse, GetAgentResponses, GetBroadcastData, GetBroadcastError, GetBroadcastErrors, GetBroadcastResponse, GetBroadcastResponses, GetBroadcastsReportData, GetBroadcastsReportError, GetBroadcastsReportErrors, GetBroadcastsReportResponse, GetBroadcastsReportResponses, GetContactData, GetContactError, GetContactErrors, GetContactResponse, GetContactResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationsReportData, GetConversationsReportError, GetConversationsReportErrors, GetConversationsReportResponse, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportError, GetDashboardReportErrors, GetDashboardReportResponse, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactError, GetKnowledgeContactErrors, GetKnowledgeContactResponse, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileError, GetKnowledgeFileErrors, GetKnowledgeFileResponse, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationError, GetKnowledgeLocationErrors, GetKnowledgeLocationResponse, GetKnowledgeLocationResponses, GetMessageData, GetMessageError, GetMessageErrors, GetMessageResponse, GetMessageResponses, GetMessagesReportData, GetMessagesReportError, GetMessagesReportErrors, GetMessagesReportResponse, GetMessagesReportResponses, GetMetaAdsInsightsData, GetMetaAdsInsightsError, GetMetaAdsInsightsErrors, GetMetaAdsInsightsResponse, GetMetaAdsInsightsResponses, GetQuickReplyData, GetQuickReplyError, GetQuickReplyErrors, GetQuickReplyResponse, GetQuickReplyResponses, GetResolutionsReportData, GetResolutionsReportError, GetResolutionsReportErrors, GetResolutionsReportResponse, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportError, GetResponsesReportErrors, GetResponsesReportResponse, GetResponsesReportResponses, GetSendData, GetSendError, GetSendErrors, GetSendResponse, GetSendResponses, GetTeamReportData, GetTeamReportError, GetTeamReportErrors, GetTeamReportResponse, GetTeamReportResponses, GetTemplateData, GetTemplateError, GetTemplateErrors, GetTemplateFieldMappingsData, GetTemplateFieldMappingsError, GetTemplateFieldMappingsErrors, GetTemplateFieldMappingsResponse, GetTemplateFieldMappingsResponses, GetTemplateResponse, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberError, GetWhatsAppNumberErrors, GetWhatsAppNumberResponse, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowError, GetWorkflowErrors, GetWorkflowReminderHistoryData, GetWorkflowReminderHistoryError, GetWorkflowReminderHistoryErrors, GetWorkflowReminderHistoryResponse, GetWorkflowReminderHistoryResponses, GetWorkflowResponse, GetWorkflowResponses, IdempotencyKey, KnowledgeContact, KnowledgeFile, KnowledgeFileUpload, KnowledgeLocation, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsError, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponse, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsError, ListBroadcastsErrors, ListBroadcastsResponse, ListBroadcastsResponses, ListChannelsData, ListChannelsError, ListChannelsErrors, ListChannelsResponse, ListChannelsResponses, ListContactFieldsData, ListContactFieldsError, ListContactFieldsErrors, ListContactFieldsResponse, ListContactFieldsResponses, ListContactsData, ListContactsError, ListContactsErrors, ListContactsResponse, ListContactsResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsError, ListKnowledgeContactsErrors, ListKnowledgeContactsResponse, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesError, ListKnowledgeFilesErrors, ListKnowledgeFilesResponse, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsError, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponse, ListKnowledgeLocationsResponses, ListMembersData, ListMembersError, ListMembersErrors, ListMembersResponse, ListMembersResponses, ListMessagesData, ListMessagesError, ListMessagesErrors, ListMessagesResponse, ListMessagesResponses, ListMetaAdsAdSetsData, ListMetaAdsAdSetsError, ListMetaAdsAdSetsErrors, ListMetaAdsAdSetsResponse, ListMetaAdsAdSetsResponses, ListMetaAdsCampaignsData, ListMetaAdsCampaignsError, ListMetaAdsCampaignsErrors, ListMetaAdsCampaignsResponse, ListMetaAdsCampaignsResponses, ListMetaAdsData, ListMetaAdsError, ListMetaAdsErrors, ListMetaAdsResponse, ListMetaAdsResponses, ListQuickRepliesData, ListQuickRepliesError, ListQuickRepliesErrors, ListQuickRepliesResponse, ListQuickRepliesResponses, ListTagsData, ListTagsError, ListTagsErrors, ListTagsResponse, ListTagsResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesError, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWhatsAppNumbersData, ListWhatsAppNumbersError, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponse, ListWhatsAppNumbersResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsError, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponse, ListWorkflowExecutionsResponses, ListWorkflowReminderStatesData, ListWorkflowReminderStatesError, ListWorkflowReminderStatesErrors, ListWorkflowReminderStatesResponse, ListWorkflowReminderStatesResponses, ListWorkflowsData, ListWorkflowsError, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadError, MarkConversationReadErrors, MarkConversationReadResponse, MarkConversationReadResponses, MarkConversationUnreadData, MarkConversationUnreadError, MarkConversationUnreadErrors, MarkConversationUnreadResponse, MarkConversationUnreadResponses, MediaMessage, MediaUpload, Member, Message, MessageSearchResult, MessagesReport, MetaAdsAd, MetaAdsAdSet, MetaAdsCampaign, MetaAdsInsight, PauseWorkflowData, PauseWorkflowError, PauseWorkflowErrors, PauseWorkflowResponse, PauseWorkflowResponses, PreviewBroadcastAudience, PreviewBroadcastAudienceData, PreviewBroadcastAudienceError, PreviewBroadcastAudienceErrors, PreviewBroadcastAudienceResponse, PreviewBroadcastAudienceResponses, PreviewWorkflowRemindersData, PreviewWorkflowRemindersError, PreviewWorkflowRemindersErrors, PreviewWorkflowRemindersResponse, PreviewWorkflowRemindersResponses, QuickReply, RefreshWhatsAppNumberData, RefreshWhatsAppNumberError, RefreshWhatsAppNumberErrors, RefreshWhatsAppNumberResponse, RefreshWhatsAppNumberResponses, ReminderHistory, ReminderPreview, ReopenConversationData, ReopenConversationError, ReopenConversationErrors, ReopenConversationResponse, ReopenConversationResponses, ReplaceTemplateFieldMappings, ReplaceTemplateFieldMappingsData, ReplaceTemplateFieldMappingsError, ReplaceTemplateFieldMappingsErrors, ReplaceTemplateFieldMappingsResponse, ReplaceTemplateFieldMappingsResponses, ReportPeriod, RequestDisplayName, RequestWhatsAppDisplayNameData, RequestWhatsAppDisplayNameError, RequestWhatsAppDisplayNameErrors, RequestWhatsAppDisplayNameResponse, RequestWhatsAppDisplayNameResponses, ResolutionsReport, ResolveConversationHandoffData, ResolveConversationHandoffError, ResolveConversationHandoffErrors, ResolveConversationHandoffResponse, ResolveConversationHandoffResponses, ResolveHandoff, ResponsesReport, RetryWebhookDeliveryData, RetryWebhookDeliveryError, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponse, RetryWebhookDeliveryResponses, RotateWebhookSecret, RotateWebhookSecretData, RotateWebhookSecretError, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsError, SearchConversationsErrors, SearchConversationsResponse, SearchConversationsResponses, SearchMessagesData, SearchMessagesError, SearchMessagesErrors, SearchMessagesResponse, SearchMessagesResponses, Send, SendMessage, SendMessageData, SendMessageError, SendMessageErrors, SendMessageResponse, SendMessageResponses, StartConversation, StartConversationData, StartConversationError, StartConversationErrors, StartConversationResponse, StartConversationResponses, Tag, TeamReport, Template, TemplateFieldMappings, TemplateMedia, TemplateMessage, TemplateValidation, TestWebhookData, TestWebhookError, TestWebhookErrors, TestWebhookResponse, TestWebhookResponses, UpdateAgent, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentResponse, UpdateAgentResponses, UpdateContact, UpdateContactData, UpdateContactError, UpdateContactErrors, UpdateContactResponse, UpdateContactResponses, UpdateKnowledgeContact, UpdateKnowledgeContactData, UpdateKnowledgeContactError, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponse, UpdateKnowledgeContactResponses, UpdateKnowledgeFile, UpdateKnowledgeFileData, UpdateKnowledgeFileError, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponse, UpdateKnowledgeFileResponses, UpdateKnowledgeLocation, UpdateKnowledgeLocationData, UpdateKnowledgeLocationError, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponse, UpdateKnowledgeLocationResponses, UpdateQuickReply, UpdateQuickReplyData, UpdateQuickReplyError, UpdateQuickReplyErrors, UpdateQuickReplyResponse, UpdateQuickReplyResponses, UpdateTag, UpdateTagData, UpdateTagError, UpdateTagErrors, UpdateTagResponse, UpdateTagResponses, UpdateTemplate, UpdateTemplateData, UpdateTemplateError, UpdateTemplateErrors, UpdateTemplateResponse, UpdateTemplateResponses, UpdateWhatsAppBusinessProfile, UpdateWhatsAppBusinessProfileData, UpdateWhatsAppBusinessProfileError, UpdateWhatsAppBusinessProfileErrors, UpdateWhatsAppBusinessProfileResponse, UpdateWhatsAppBusinessProfileResponses, UpdateWhatsAppNumber, UpdateWhatsAppNumberData, UpdateWhatsAppNumberError, UpdateWhatsAppNumberErrors, UpdateWhatsAppNumberResponse, UpdateWhatsAppNumberResponses, UpdateWorkflow, UpdateWorkflowData, UpdateWorkflowError, UpdateWorkflowErrors, UpdateWorkflowResponse, UpdateWorkflowResponses, UploadWorkflowHeaderMedia, UploadWorkflowHeaderMediaData, UploadWorkflowHeaderMediaError, UploadWorkflowHeaderMediaErrors, UploadWorkflowHeaderMediaResponse, UploadWorkflowHeaderMediaResponses, ValidateTemplate, ValidateTemplateData, ValidateTemplateError, ValidateTemplateErrors, ValidateTemplateResponse, ValidateTemplateResponses, Webhook, WebhookBroadcastCompletedWebhookPayload, WebhookBroadcastCompletedWebhookRequest, WebhookBroadcastFailedWebhookPayload, WebhookBroadcastFailedWebhookRequest, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactTagsChangedWebhookPayload, WebhookContactTagsChangedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAgentChangedWebhookPayload, WebhookConversationAgentChangedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationHandoffRequestedWebhookPayload, WebhookConversationHandoffRequestedWebhookRequest, WebhookConversationHandoffResolvedWebhookPayload, WebhookConversationHandoffResolvedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookKnowledgeFileReadyWebhookPayload, WebhookKnowledgeFileReadyWebhookRequest, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTemplateStatusChangedWebhookPayload, WebhookTemplateStatusChangedWebhookRequest, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, WebhookWorkflowExecutionFailedWebhookPayload, WebhookWorkflowExecutionFailedWebhookRequest, WhatsAppNumber, Workflow, WorkflowExecution } from './types.gen.js';
|