@apteva/integrations 0.15.7 → 0.15.8

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.
@@ -65,9 +65,19 @@
65
65
  "input_schema": {
66
66
  "type": "object",
67
67
  "properties": {
68
- "include_shared_accounts": { "type": "boolean", "default": true },
69
- "page_size": { "type": "integer", "default": 25, "description": "Max 250" },
70
- "bookmark": { "type": "string", "description": "Pagination cursor from previous response" }
68
+ "include_shared_accounts": {
69
+ "type": "boolean",
70
+ "default": true
71
+ },
72
+ "page_size": {
73
+ "type": "integer",
74
+ "default": 25,
75
+ "description": "Max 250"
76
+ },
77
+ "bookmark": {
78
+ "type": "string",
79
+ "description": "Pagination cursor from previous response"
80
+ }
71
81
  }
72
82
  }
73
83
  },
@@ -79,14 +89,45 @@
79
89
  "input_schema": {
80
90
  "type": "object",
81
91
  "properties": {
82
- "ad_account_id": { "type": "string" },
83
- "campaign_ids": { "type": "array", "items": { "type": "string" } },
84
- "entity_statuses": { "type": "array", "items": { "type": "string", "enum": ["ACTIVE", "PAUSED", "ARCHIVED", "DRAFT"] } },
85
- "page_size": { "type": "integer", "default": 25 },
86
- "order": { "type": "string", "enum": ["ASCENDING", "DESCENDING"] },
87
- "bookmark": { "type": "string" }
92
+ "ad_account_id": {
93
+ "type": "string"
94
+ },
95
+ "campaign_ids": {
96
+ "type": "array",
97
+ "items": {
98
+ "type": "string"
99
+ }
100
+ },
101
+ "entity_statuses": {
102
+ "type": "array",
103
+ "items": {
104
+ "type": "string",
105
+ "enum": [
106
+ "ACTIVE",
107
+ "PAUSED",
108
+ "ARCHIVED",
109
+ "DRAFT"
110
+ ]
111
+ }
112
+ },
113
+ "page_size": {
114
+ "type": "integer",
115
+ "default": 25
116
+ },
117
+ "order": {
118
+ "type": "string",
119
+ "enum": [
120
+ "ASCENDING",
121
+ "DESCENDING"
122
+ ]
123
+ },
124
+ "bookmark": {
125
+ "type": "string"
126
+ }
88
127
  },
89
- "required": ["ad_account_id"]
128
+ "required": [
129
+ "ad_account_id"
130
+ ]
90
131
  }
91
132
  },
92
133
  {
@@ -97,14 +138,21 @@
97
138
  "input_schema": {
98
139
  "type": "object",
99
140
  "properties": {
100
- "ad_account_id": { "type": "string" },
141
+ "ad_account_id": {
142
+ "type": "string"
143
+ },
101
144
  "campaigns": {
102
145
  "type": "array",
103
- "items": { "type": "object" },
146
+ "items": {
147
+ "type": "object"
148
+ },
104
149
  "description": "Each: {name, objective_type, status, daily_spend_cap?, lifetime_spend_cap?, start_time?, end_time?, default_ad_group_budget_in_micro_currency?}"
105
150
  }
106
151
  },
107
- "required": ["ad_account_id", "campaigns"]
152
+ "required": [
153
+ "ad_account_id",
154
+ "campaigns"
155
+ ]
108
156
  }
109
157
  },
110
158
  {
@@ -115,10 +163,20 @@
115
163
  "input_schema": {
116
164
  "type": "object",
117
165
  "properties": {
118
- "ad_account_id": { "type": "string" },
119
- "campaigns": { "type": "array", "items": { "type": "object" } }
166
+ "ad_account_id": {
167
+ "type": "string"
168
+ },
169
+ "campaigns": {
170
+ "type": "array",
171
+ "items": {
172
+ "type": "object"
173
+ }
174
+ }
120
175
  },
121
- "required": ["ad_account_id", "campaigns"]
176
+ "required": [
177
+ "ad_account_id",
178
+ "campaigns"
179
+ ]
122
180
  }
123
181
  },
124
182
  {
@@ -129,14 +187,38 @@
129
187
  "input_schema": {
130
188
  "type": "object",
131
189
  "properties": {
132
- "ad_account_id": { "type": "string" },
133
- "campaign_ids": { "type": "array", "items": { "type": "string" } },
134
- "ad_group_ids": { "type": "array", "items": { "type": "string" } },
135
- "entity_statuses": { "type": "array", "items": { "type": "string" } },
136
- "page_size": { "type": "integer", "default": 25 },
137
- "bookmark": { "type": "string" }
190
+ "ad_account_id": {
191
+ "type": "string"
192
+ },
193
+ "campaign_ids": {
194
+ "type": "array",
195
+ "items": {
196
+ "type": "string"
197
+ }
198
+ },
199
+ "ad_group_ids": {
200
+ "type": "array",
201
+ "items": {
202
+ "type": "string"
203
+ }
204
+ },
205
+ "entity_statuses": {
206
+ "type": "array",
207
+ "items": {
208
+ "type": "string"
209
+ }
210
+ },
211
+ "page_size": {
212
+ "type": "integer",
213
+ "default": 25
214
+ },
215
+ "bookmark": {
216
+ "type": "string"
217
+ }
138
218
  },
139
- "required": ["ad_account_id"]
219
+ "required": [
220
+ "ad_account_id"
221
+ ]
140
222
  }
141
223
  },
142
224
  {
@@ -147,10 +229,20 @@
147
229
  "input_schema": {
148
230
  "type": "object",
149
231
  "properties": {
150
- "ad_account_id": { "type": "string" },
151
- "ad_groups": { "type": "array", "items": { "type": "object" } }
232
+ "ad_account_id": {
233
+ "type": "string"
234
+ },
235
+ "ad_groups": {
236
+ "type": "array",
237
+ "items": {
238
+ "type": "object"
239
+ }
240
+ }
152
241
  },
153
- "required": ["ad_account_id", "ad_groups"]
242
+ "required": [
243
+ "ad_account_id",
244
+ "ad_groups"
245
+ ]
154
246
  }
155
247
  },
156
248
  {
@@ -161,15 +253,44 @@
161
253
  "input_schema": {
162
254
  "type": "object",
163
255
  "properties": {
164
- "ad_account_id": { "type": "string" },
165
- "campaign_ids": { "type": "array", "items": { "type": "string" } },
166
- "ad_group_ids": { "type": "array", "items": { "type": "string" } },
167
- "ad_ids": { "type": "array", "items": { "type": "string" } },
168
- "entity_statuses": { "type": "array", "items": { "type": "string" } },
169
- "page_size": { "type": "integer", "default": 25 },
170
- "bookmark": { "type": "string" }
256
+ "ad_account_id": {
257
+ "type": "string"
258
+ },
259
+ "campaign_ids": {
260
+ "type": "array",
261
+ "items": {
262
+ "type": "string"
263
+ }
264
+ },
265
+ "ad_group_ids": {
266
+ "type": "array",
267
+ "items": {
268
+ "type": "string"
269
+ }
270
+ },
271
+ "ad_ids": {
272
+ "type": "array",
273
+ "items": {
274
+ "type": "string"
275
+ }
276
+ },
277
+ "entity_statuses": {
278
+ "type": "array",
279
+ "items": {
280
+ "type": "string"
281
+ }
282
+ },
283
+ "page_size": {
284
+ "type": "integer",
285
+ "default": 25
286
+ },
287
+ "bookmark": {
288
+ "type": "string"
289
+ }
171
290
  },
172
- "required": ["ad_account_id"]
291
+ "required": [
292
+ "ad_account_id"
293
+ ]
173
294
  }
174
295
  },
175
296
  {
@@ -180,10 +301,20 @@
180
301
  "input_schema": {
181
302
  "type": "object",
182
303
  "properties": {
183
- "ad_account_id": { "type": "string" },
184
- "ads": { "type": "array", "items": { "type": "object" } }
304
+ "ad_account_id": {
305
+ "type": "string"
306
+ },
307
+ "ads": {
308
+ "type": "array",
309
+ "items": {
310
+ "type": "object"
311
+ }
312
+ }
185
313
  },
186
- "required": ["ad_account_id", "ads"]
314
+ "required": [
315
+ "ad_account_id",
316
+ "ads"
317
+ ]
187
318
  }
188
319
  },
189
320
  {
@@ -194,11 +325,20 @@
194
325
  "input_schema": {
195
326
  "type": "object",
196
327
  "properties": {
197
- "ad_account_id": { "type": "string" },
198
- "page_size": { "type": "integer", "default": 25 },
199
- "bookmark": { "type": "string" }
328
+ "ad_account_id": {
329
+ "type": "string"
330
+ },
331
+ "page_size": {
332
+ "type": "integer",
333
+ "default": 25
334
+ },
335
+ "bookmark": {
336
+ "type": "string"
337
+ }
200
338
  },
201
- "required": ["ad_account_id"]
339
+ "required": [
340
+ "ad_account_id"
341
+ ]
202
342
  }
203
343
  },
204
344
  {
@@ -209,13 +349,34 @@
209
349
  "input_schema": {
210
350
  "type": "object",
211
351
  "properties": {
212
- "ad_account_id": { "type": "string" },
213
- "name": { "type": "string" },
214
- "audience_type": { "type": "string", "enum": ["CUSTOMER_LIST", "VISITOR", "ENGAGEMENT", "ACTALIKE"] },
215
- "description": { "type": "string" },
216
- "rule": { "type": "object" }
352
+ "ad_account_id": {
353
+ "type": "string"
354
+ },
355
+ "name": {
356
+ "type": "string"
357
+ },
358
+ "audience_type": {
359
+ "type": "string",
360
+ "enum": [
361
+ "CUSTOMER_LIST",
362
+ "VISITOR",
363
+ "ENGAGEMENT",
364
+ "ACTALIKE"
365
+ ]
366
+ },
367
+ "description": {
368
+ "type": "string"
369
+ },
370
+ "rule": {
371
+ "type": "object"
372
+ }
217
373
  },
218
- "required": ["ad_account_id", "name", "audience_type", "rule"]
374
+ "required": [
375
+ "ad_account_id",
376
+ "name",
377
+ "audience_type",
378
+ "rule"
379
+ ]
219
380
  }
220
381
  },
221
382
  {
@@ -226,17 +387,82 @@
226
387
  "input_schema": {
227
388
  "type": "object",
228
389
  "properties": {
229
- "ad_account_id": { "type": "string" },
230
- "start_date": { "type": "string", "description": "YYYY-MM-DD" },
231
- "end_date": { "type": "string", "description": "YYYY-MM-DD" },
232
- "granularity": { "type": "string", "enum": ["TOTAL", "DAY", "HOUR", "WEEK", "MONTH"], "default": "DAY" },
233
- "columns": { "type": "array", "items": { "type": "string" } },
234
- "click_window_days": { "type": "integer", "enum": [1, 7, 14, 30, 60], "default": 30 },
235
- "engagement_window_days": { "type": "integer", "enum": [1, 7, 14, 30, 60], "default": 30 },
236
- "view_window_days": { "type": "integer", "enum": [1, 7, 14, 30, 60], "default": 1 },
237
- "conversion_report_time": { "type": "string", "enum": ["TIME_OF_AD_ACTION", "TIME_OF_CONVERSION"], "default": "TIME_OF_AD_ACTION" }
390
+ "ad_account_id": {
391
+ "type": "string"
392
+ },
393
+ "start_date": {
394
+ "type": "string",
395
+ "description": "YYYY-MM-DD"
396
+ },
397
+ "end_date": {
398
+ "type": "string",
399
+ "description": "YYYY-MM-DD"
400
+ },
401
+ "granularity": {
402
+ "type": "string",
403
+ "enum": [
404
+ "TOTAL",
405
+ "DAY",
406
+ "HOUR",
407
+ "WEEK",
408
+ "MONTH"
409
+ ],
410
+ "default": "DAY"
411
+ },
412
+ "columns": {
413
+ "type": "array",
414
+ "items": {
415
+ "type": "string"
416
+ }
417
+ },
418
+ "click_window_days": {
419
+ "type": "integer",
420
+ "enum": [
421
+ 1,
422
+ 7,
423
+ 14,
424
+ 30,
425
+ 60
426
+ ],
427
+ "default": 30
428
+ },
429
+ "engagement_window_days": {
430
+ "type": "integer",
431
+ "enum": [
432
+ 1,
433
+ 7,
434
+ 14,
435
+ 30,
436
+ 60
437
+ ],
438
+ "default": 30
439
+ },
440
+ "view_window_days": {
441
+ "type": "integer",
442
+ "enum": [
443
+ 1,
444
+ 7,
445
+ 14,
446
+ 30,
447
+ 60
448
+ ],
449
+ "default": 1
450
+ },
451
+ "conversion_report_time": {
452
+ "type": "string",
453
+ "enum": [
454
+ "TIME_OF_AD_ACTION",
455
+ "TIME_OF_CONVERSION"
456
+ ],
457
+ "default": "TIME_OF_AD_ACTION"
458
+ }
238
459
  },
239
- "required": ["ad_account_id", "start_date", "end_date", "columns"]
460
+ "required": [
461
+ "ad_account_id",
462
+ "start_date",
463
+ "end_date",
464
+ "columns"
465
+ ]
240
466
  }
241
467
  },
242
468
  {
@@ -247,14 +473,230 @@
247
473
  "input_schema": {
248
474
  "type": "object",
249
475
  "properties": {
250
- "ad_account_id": { "type": "string" },
251
- "campaign_ids": { "type": "array", "items": { "type": "string" } },
252
- "start_date": { "type": "string" },
253
- "end_date": { "type": "string" },
254
- "granularity": { "type": "string", "enum": ["TOTAL", "DAY", "HOUR", "WEEK", "MONTH"], "default": "DAY" },
255
- "columns": { "type": "array", "items": { "type": "string" } }
476
+ "ad_account_id": {
477
+ "type": "string"
478
+ },
479
+ "campaign_ids": {
480
+ "type": "array",
481
+ "items": {
482
+ "type": "string"
483
+ }
484
+ },
485
+ "start_date": {
486
+ "type": "string"
487
+ },
488
+ "end_date": {
489
+ "type": "string"
490
+ },
491
+ "granularity": {
492
+ "type": "string",
493
+ "enum": [
494
+ "TOTAL",
495
+ "DAY",
496
+ "HOUR",
497
+ "WEEK",
498
+ "MONTH"
499
+ ],
500
+ "default": "DAY"
501
+ },
502
+ "columns": {
503
+ "type": "array",
504
+ "items": {
505
+ "type": "string"
506
+ }
507
+ }
508
+ },
509
+ "required": [
510
+ "ad_account_id",
511
+ "campaign_ids",
512
+ "start_date",
513
+ "end_date",
514
+ "columns"
515
+ ]
516
+ }
517
+ },
518
+ {
519
+ "name": "update_ad_groups",
520
+ "description": "Update one or more ad groups. Each item must include id; set status/entity_status to PAUSED or ARCHIVED for pause/delete behavior.",
521
+ "method": "PATCH",
522
+ "path": "/ad_accounts/{ad_account_id}/ad_groups",
523
+ "input_schema": {
524
+ "type": "object",
525
+ "properties": {
526
+ "ad_account_id": {
527
+ "type": "string"
528
+ },
529
+ "ad_groups": {
530
+ "type": "array",
531
+ "items": {
532
+ "type": "object"
533
+ }
534
+ }
535
+ },
536
+ "required": [
537
+ "ad_account_id",
538
+ "ad_groups"
539
+ ]
540
+ }
541
+ },
542
+ {
543
+ "name": "update_ads",
544
+ "description": "Update one or more ads. Each item must include id; set status/entity_status to PAUSED or ARCHIVED for pause/delete behavior.",
545
+ "method": "PATCH",
546
+ "path": "/ad_accounts/{ad_account_id}/ads",
547
+ "input_schema": {
548
+ "type": "object",
549
+ "properties": {
550
+ "ad_account_id": {
551
+ "type": "string"
552
+ },
553
+ "ads": {
554
+ "type": "array",
555
+ "items": {
556
+ "type": "object"
557
+ }
558
+ }
559
+ },
560
+ "required": [
561
+ "ad_account_id",
562
+ "ads"
563
+ ]
564
+ }
565
+ },
566
+ {
567
+ "name": "list_pins",
568
+ "description": "List Pins available as ad creatives. Pinterest ads reference promoted Pins rather than a separate creative object.",
569
+ "method": "GET",
570
+ "path": "/pins",
571
+ "input_schema": {
572
+ "type": "object",
573
+ "properties": {
574
+ "bookmark": {
575
+ "type": "string"
576
+ },
577
+ "page_size": {
578
+ "type": "integer"
579
+ },
580
+ "pin_filter": {
581
+ "type": "string"
582
+ },
583
+ "include_protected_pins": {
584
+ "type": "boolean"
585
+ }
586
+ }
587
+ }
588
+ },
589
+ {
590
+ "name": "get_pin",
591
+ "description": "Get a Pin used as an ad creative.",
592
+ "method": "GET",
593
+ "path": "/pins/{pin_id}",
594
+ "input_schema": {
595
+ "type": "object",
596
+ "properties": {
597
+ "pin_id": {
598
+ "type": "string"
599
+ }
600
+ },
601
+ "required": [
602
+ "pin_id"
603
+ ]
604
+ }
605
+ },
606
+ {
607
+ "name": "create_pin",
608
+ "description": "Create a Pin that can be promoted as an ad creative.",
609
+ "method": "POST",
610
+ "path": "/pins",
611
+ "body_root_param": "body",
612
+ "input_schema": {
613
+ "type": "object",
614
+ "properties": {
615
+ "body": {
616
+ "type": "object",
617
+ "description": "Raw Pinterest Pin create payload: board_id, title, description, link, media_source, alt_text, etc."
618
+ }
619
+ },
620
+ "required": [
621
+ "body"
622
+ ]
623
+ }
624
+ },
625
+ {
626
+ "name": "update_audience",
627
+ "description": "Update a Pinterest audience.",
628
+ "method": "PATCH",
629
+ "path": "/ad_accounts/{ad_account_id}/audiences/{audience_id}",
630
+ "body_root_param": "body",
631
+ "input_schema": {
632
+ "type": "object",
633
+ "properties": {
634
+ "ad_account_id": {
635
+ "type": "string"
636
+ },
637
+ "audience_id": {
638
+ "type": "string"
639
+ },
640
+ "body": {
641
+ "type": "object",
642
+ "description": "Raw Pinterest audience update payload."
643
+ }
644
+ },
645
+ "required": [
646
+ "ad_account_id",
647
+ "audience_id",
648
+ "body"
649
+ ]
650
+ }
651
+ },
652
+ {
653
+ "name": "delete_ad_group",
654
+ "description": "Archive an ad group by PATCHing status/entity_status to ARCHIVED.",
655
+ "method": "PATCH",
656
+ "path": "/ad_accounts/{ad_account_id}/ad_groups",
657
+ "input_schema": {
658
+ "type": "object",
659
+ "properties": {
660
+ "ad_account_id": {
661
+ "type": "string"
662
+ },
663
+ "ad_groups": {
664
+ "type": "array",
665
+ "items": {
666
+ "type": "object"
667
+ },
668
+ "description": "Include id and archived status fields."
669
+ }
670
+ },
671
+ "required": [
672
+ "ad_account_id",
673
+ "ad_groups"
674
+ ]
675
+ }
676
+ },
677
+ {
678
+ "name": "delete_ad",
679
+ "description": "Archive an ad by PATCHing status/entity_status to ARCHIVED.",
680
+ "method": "PATCH",
681
+ "path": "/ad_accounts/{ad_account_id}/ads",
682
+ "input_schema": {
683
+ "type": "object",
684
+ "properties": {
685
+ "ad_account_id": {
686
+ "type": "string"
687
+ },
688
+ "ads": {
689
+ "type": "array",
690
+ "items": {
691
+ "type": "object"
692
+ },
693
+ "description": "Include id and archived status fields."
694
+ }
256
695
  },
257
- "required": ["ad_account_id", "campaign_ids", "start_date", "end_date", "columns"]
696
+ "required": [
697
+ "ad_account_id",
698
+ "ads"
699
+ ]
258
700
  }
259
701
  }
260
702
  ]