@epilot/automation-client 1.8.8 → 1.8.9

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/src/openapi.d.ts DELETED
@@ -1,1728 +0,0 @@
1
- /* eslint-disable */
2
- import type {
3
- OpenAPIClient,
4
- Parameters,
5
- UnknownParamsObject,
6
- OperationResponse,
7
- AxiosRequestConfig,
8
- } from 'openapi-client-axios';
9
-
10
- declare namespace Components {
11
- namespace Schemas {
12
- /**
13
- * example:
14
- * {
15
- * "target": {
16
- * "schema": "contact",
17
- * "tag": "primary",
18
- * "key": "address",
19
- * "value_json": "{\"_tags\": [\"billing\"],\"city\":\"steps[0][Adresse][city]\",\"country\":\"steps[0][Adresse][countryCode]\",\"postal_code\":\"steps[0][Adresse][zipCode]\",\"street\":\"steps[0][Adresse][streetName]\",\"street_number\":\"steps[0][Adresse][houseNumber]\",\"additional_info\":\"steps[0][Adresse][addressExtention]\"}",
20
- * "target_unique": [
21
- * "country",
22
- * "city",
23
- * "postal_code",
24
- * "street",
25
- * "street_number"
26
- * ]
27
- * },
28
- * "reference": {
29
- * "schema": "opportunity",
30
- * "key": "billing_address"
31
- * }
32
- * }
33
- */
34
- export interface AddressMapper {
35
- target: {
36
- /**
37
- * find target entity based on schema
38
- */
39
- schema: string;
40
- /**
41
- * find target entity based on entity tag
42
- */
43
- tag?: string;
44
- /**
45
- * find target entity based on relation tag on main entity relation
46
- */
47
- relation_tag?: string;
48
- /**
49
- * target field for where to store this address.
50
- */
51
- key: string;
52
- /**
53
- * stringified JSON for how to map address data
54
- */
55
- value_json: string;
56
- /**
57
- * Array of keys which should be used when checking for uniqueness. Eg: [country, city, postal_code]
58
- *
59
- */
60
- target_unique?: string[];
61
- };
62
- reference: {
63
- /**
64
- * Schema of the entity where the reference will be stored.
65
- */
66
- schema: string;
67
- /**
68
- * Field location to store the reference.
69
- */
70
- key: string;
71
- /**
72
- * Optional relation labels to give meaning to this reference.
73
- */
74
- labels?: string[];
75
- };
76
- }
77
- export type AnyAction = /**
78
- * example:
79
- * {
80
- * "id": "2520gja-2sgmsaga-0asg-822jgal",
81
- * "name": "Map Entity",
82
- * "type": "map-entity",
83
- * "config": {
84
- * "target_schema": "contact",
85
- * "target_unique": [
86
- * "email.0.email"
87
- * ],
88
- * "relation_attributes": [
89
- * {
90
- * "target": "company",
91
- * "mode": "append",
92
- * "source_filter": {
93
- * "schema": "account",
94
- * "limit": 1
95
- * }
96
- * }
97
- * ],
98
- * "mapping_attributes": [
99
- * {
100
- * "target": "_tags",
101
- * "operation": {
102
- * "_append": [
103
- * "primary",
104
- * "payer"
105
- * ],
106
- * "_uniq": true
107
- * }
108
- * },
109
- * {
110
- * "target": "email",
111
- * "operation": {
112
- * "_append": [
113
- * {
114
- * "email": {
115
- * "_copy": "billing_contact.email"
116
- * }
117
- * }
118
- * ]
119
- * }
120
- * },
121
- * {
122
- * "target": "first_name",
123
- * "operation": {
124
- * "_copy": "billing_contact.first_name"
125
- * }
126
- * },
127
- * {
128
- * "target": "last_name",
129
- * "operation": {
130
- * "_copy": "billing_contact.last_name"
131
- * }
132
- * },
133
- * {
134
- * "target": "contact_type",
135
- * "operation": {
136
- * "_set": "customer"
137
- * }
138
- * },
139
- * {
140
- * "target": "address",
141
- * "operation": {
142
- * "_append": [
143
- * {
144
- * "_tags": [
145
- * "billing",
146
- * "primary"
147
- * ],
148
- * "street_name": {
149
- * "_copy": "billing_contact.street_name"
150
- * },
151
- * "street_number": {
152
- * "_copy": "billing_contact.street_number"
153
- * },
154
- * "city": {
155
- * "_copy": "billing_contact.city"
156
- * },
157
- * "postal_code": {
158
- * "_copy": "billing_contact.postal_code"
159
- * },
160
- * "country": {
161
- * "_copy": "billing_contact.country"
162
- * }
163
- * },
164
- * {
165
- * "_tags": [
166
- * "delivery"
167
- * ],
168
- * "street_name": {
169
- * "_copy": "delivery_contact.street_name"
170
- * },
171
- * "street_number": {
172
- * "_copy": "delivery_contact.street_number"
173
- * },
174
- * "city": {
175
- * "_copy": "delivery_contact.city"
176
- * },
177
- * "postal_code": {
178
- * "_copy": "delivery_contact.postal_code"
179
- * },
180
- * "country": {
181
- * "_copy": "delivery_contact.country"
182
- * }
183
- * }
184
- * ],
185
- * "_uniq": [
186
- * "street_name",
187
- * "street_number",
188
- * "postal_code",
189
- * "country"
190
- * ]
191
- * }
192
- * }
193
- * ]
194
- * }
195
- * }
196
- */
197
- MapEntityAction | FillEntityAction | /**
198
- * example:
199
- * {
200
- * "id": "08g988-ojt2jtaga-292h-8978gsaga",
201
- * "name": "Trigger Workflow",
202
- * "type": "trigger-workflow",
203
- * "config": {
204
- * "target_workflow": "mfptvUMH",
205
- * "conditions": [
206
- * {
207
- * "schema": "ivy-opportunity",
208
- * "source": "customer.type",
209
- * "comparison": "equals",
210
- * "value": "PRIVATE"
211
- * }
212
- * ],
213
- * "assign_steps": [
214
- * {
215
- * "step_name": "Lead Sales",
216
- * "user_ids": [
217
- * 10010729
218
- * ]
219
- * },
220
- * {
221
- * "step_name": "Operations",
222
- * "user_ids": [
223
- * 10010728,
224
- * 10010729
225
- * ]
226
- * }
227
- * ]
228
- * }
229
- * }
230
- */
231
- TriggerWorkflowAction | /**
232
- * example:
233
- * {
234
- * "id": "2520gja-2sgmsaga-0asg-822jgal",
235
- * "name": "Trigger Webhook",
236
- * "type": "trigger-webhook",
237
- * "config": {
238
- * "entity_sources": [
239
- * "contact",
240
- * "account"
241
- * ],
242
- * "target_webhook_id": "25jg9ag2ga"
243
- * }
244
- * }
245
- */
246
- TriggerWebhookAction | /**
247
- * example:
248
- * {
249
- * "id": "08g988-ojt2jtaga-292h-8978gsaga",
250
- * "name": "Create Document",
251
- * "type": "create-document",
252
- * "config": {
253
- * "template_id": {
254
- * "type": "string",
255
- * "example": "112b08ba-789c-42f2-9940-43b302f641e8\""
256
- * },
257
- * "filename": {
258
- * "type": "string",
259
- * "example": "newsletter.pdf\""
260
- * }
261
- * }
262
- * }
263
- */
264
- CreateDocumentAction | /**
265
- * example:
266
- * {
267
- * "id": "25jga0-gkasl26-0asg-908sgaj2",
268
- * "name": "Send Email",
269
- * "type": "send-email",
270
- * "config": {
271
- * "email_template_id": "gasj02-29ug9asgm-29t9gsaghg2g-pkmbhx2",
272
- * "language_code": "de"
273
- * }
274
- * }
275
- */
276
- SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | AutomationAction;
277
- export type AnyTrigger = FrontendSubmitTrigger | JourneySubmitTrigger | ApiSubmissionTrigger | EntityOperationTrigger | EntityManualTrigger;
278
- export interface ApiSubmissionTrigger {
279
- type: "api_submission";
280
- configuration: {
281
- source_id?: string;
282
- };
283
- }
284
- export interface AppendValueMapper {
285
- mode: /**
286
- * - copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used together with value property.
287
- *
288
- */
289
- MappingAttributeMode;
290
- /**
291
- * JSON like target path for the attribute. Eg. last_name
292
- */
293
- target: string;
294
- /**
295
- * JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price
296
- *
297
- */
298
- source?: string;
299
- /**
300
- * To be provided only when mapping json objects into a target attribute. Eg array of addresses.
301
- *
302
- */
303
- value_json: string;
304
- /**
305
- * Array of keys which should be used when checking for uniqueness. Eg: [country, city, postal_code]
306
- *
307
- */
308
- target_unique?: string[];
309
- }
310
- /**
311
- * example:
312
- * [
313
- * {
314
- * "step_id": "xyh9t2ha",
315
- * "step_name": "Lead Sales",
316
- * "user_ids": [
317
- * 10010729
318
- * ]
319
- * },
320
- * {
321
- * "step_id": "29jgasl",
322
- * "step_name": "Operations",
323
- * "user_ids": [
324
- * 10010728,
325
- * 10010729
326
- * ]
327
- * }
328
- * ]
329
- */
330
- export interface AssignUsersToStep {
331
- step_id?: string;
332
- step_name?: string;
333
- user_ids?: number[];
334
- }
335
- export interface AutomationAction {
336
- id?: /**
337
- * example:
338
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
339
- */
340
- AutomationActionId;
341
- flow_action_id?: /**
342
- * example:
343
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
344
- */
345
- AutomationActionId;
346
- name?: string;
347
- type?: string;
348
- config?: {
349
- [name: string]: any;
350
- };
351
- execution_status?: ExecutionStatus;
352
- started_at?: string;
353
- updated_at?: string;
354
- /**
355
- * Whether to stop execution in a failed state if this action fails
356
- */
357
- allow_failure?: boolean;
358
- /**
359
- * Flag indicating whether the action was created automatically or manually
360
- */
361
- created_automatically?: boolean;
362
- /**
363
- * example:
364
- * {}
365
- */
366
- outputs?: {
367
- [name: string]: any;
368
- };
369
- error_output?: ErrorOutput;
370
- }
371
- /**
372
- * example:
373
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
374
- */
375
- export type AutomationActionId = string;
376
- export interface AutomationExecution {
377
- id: /**
378
- * example:
379
- * 9baf184f-bc81-4128-bca3-d974c90a12c4
380
- */
381
- AutomationExecutionId;
382
- execution_status?: ExecutionStatus;
383
- entity_id: /**
384
- * example:
385
- * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
386
- */
387
- EntityId;
388
- org_id: /**
389
- * example:
390
- * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
391
- */
392
- OrganizationId;
393
- flow_id: /**
394
- * example:
395
- * 7791b04a-16d2-44a2-9af9-2d59c25c512f
396
- */
397
- AutomationFlowId;
398
- /**
399
- * example:
400
- * Handle contact form
401
- */
402
- flow_name?: string;
403
- created_at?: string; // date-time
404
- updated_at?: string; // date-time
405
- current_action_id?: /**
406
- * example:
407
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
408
- */
409
- AutomationActionId;
410
- actions: AnyAction[];
411
- }
412
- /**
413
- * example:
414
- * 9baf184f-bc81-4128-bca3-d974c90a12c4
415
- */
416
- export type AutomationExecutionId = string;
417
- export interface AutomationFlow {
418
- id?: /**
419
- * example:
420
- * 7791b04a-16d2-44a2-9af9-2d59c25c512f
421
- */
422
- AutomationFlowId;
423
- /**
424
- * A descriptive name for the Automation
425
- * example:
426
- * Handle contact form
427
- */
428
- flow_name: string;
429
- /**
430
- * Whether the automation is enabled or not
431
- */
432
- enabled?: boolean;
433
- triggers: AnyTrigger[];
434
- trigger_conditions?: /**
435
- * example:
436
- * {
437
- * "source": "billing_contact.email",
438
- * "comparison": "exists"
439
- * }
440
- */
441
- TriggerCondition[];
442
- /**
443
- * The triggering entity schema
444
- * example:
445
- * submission
446
- */
447
- entity_schema?: string;
448
- actions: AnyAction[];
449
- /**
450
- * Number of automation executions that ran
451
- * example:
452
- * 7
453
- */
454
- runs?: number;
455
- created_at?: string; // date-time
456
- updated_at?: string; // date-time
457
- /**
458
- * User / service who created automation flow
459
- * example:
460
- * user:123
461
- */
462
- created_by?: string;
463
- /**
464
- * User / service who last updated automation flow
465
- * example:
466
- * user:123
467
- */
468
- last_updated_by?: string;
469
- }
470
- /**
471
- * example:
472
- * 7791b04a-16d2-44a2-9af9-2d59c25c512f
473
- */
474
- export type AutomationFlowId = string;
475
- /**
476
- * Creates an order entity with prices from journey
477
- */
478
- export interface CartCheckoutAction {
479
- id?: /**
480
- * example:
481
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
482
- */
483
- AutomationActionId;
484
- flow_action_id?: /**
485
- * example:
486
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
487
- */
488
- AutomationActionId;
489
- name?: string;
490
- type?: "cart-checkout";
491
- config?: CartCheckoutConfig;
492
- execution_status?: ExecutionStatus;
493
- started_at?: string;
494
- updated_at?: string;
495
- /**
496
- * Whether to stop execution in a failed state if this action fails
497
- */
498
- allow_failure?: boolean;
499
- /**
500
- * Flag indicating whether the action was created automatically or manually
501
- */
502
- created_automatically?: boolean;
503
- /**
504
- * example:
505
- * {}
506
- */
507
- outputs?: {
508
- [name: string]: any;
509
- };
510
- error_output?: ErrorOutput;
511
- }
512
- export interface CartCheckoutConfig {
513
- /**
514
- * Version of the config
515
- */
516
- version?: string;
517
- relation_attributes?: RelationAttribute[];
518
- mapping_attributes?: (/**
519
- * example:
520
- * {
521
- * "target": "_tags",
522
- * "operation": {
523
- * "_append": [
524
- * "new",
525
- * "tags"
526
- * ],
527
- * "_uniq": true
528
- * }
529
- * }
530
- */
531
- MappingAttributeV2 | MappingAttribute)[];
532
- /**
533
- * Relation attribute on the main entity where the target entity will be linked. Set to false to disable linkback
534
- *
535
- */
536
- linkback_relation_attribute?: string;
537
- /**
538
- * Relation tags (labels) to include in main entity linkback relation attribute
539
- */
540
- linkback_relation_tags?: string[];
541
- /**
542
- * Unique key for target entity (see upsertEntity of Entity API)
543
- */
544
- target_unique?: string[];
545
- }
546
- export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
547
- export interface CopyValueMapper {
548
- mode: /**
549
- * - copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used together with value property.
550
- *
551
- */
552
- MappingAttributeMode;
553
- /**
554
- * JSON like target path for the attribute. Eg. last_name
555
- */
556
- target: string;
557
- /**
558
- * JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price
559
- *
560
- */
561
- source: string;
562
- }
563
- /**
564
- * example:
565
- * {
566
- * "id": "08g988-ojt2jtaga-292h-8978gsaga",
567
- * "name": "Create Document",
568
- * "type": "create-document",
569
- * "config": {
570
- * "template_id": {
571
- * "type": "string",
572
- * "example": "112b08ba-789c-42f2-9940-43b302f641e8\""
573
- * },
574
- * "filename": {
575
- * "type": "string",
576
- * "example": "newsletter.pdf\""
577
- * }
578
- * }
579
- * }
580
- */
581
- export interface CreateDocumentAction {
582
- id?: /**
583
- * example:
584
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
585
- */
586
- AutomationActionId;
587
- flow_action_id?: /**
588
- * example:
589
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
590
- */
591
- AutomationActionId;
592
- name?: string;
593
- type?: "create-document";
594
- config?: CreateDocumentConfig;
595
- execution_status?: ExecutionStatus;
596
- started_at?: string;
597
- updated_at?: string;
598
- /**
599
- * Whether to stop execution in a failed state if this action fails
600
- */
601
- allow_failure?: boolean;
602
- /**
603
- * Flag indicating whether the action was created automatically or manually
604
- */
605
- created_automatically?: boolean;
606
- /**
607
- * example:
608
- * {}
609
- */
610
- outputs?: {
611
- [name: string]: any;
612
- };
613
- error_output?: ErrorOutput;
614
- }
615
- export interface CreateDocumentConfig {
616
- template_id?: string;
617
- filename?: string;
618
- }
619
- /**
620
- * example:
621
- * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
622
- */
623
- export type EntityId = string;
624
- export interface EntityManualTrigger {
625
- type: "entity_manual";
626
- configuration: {
627
- /**
628
- * Which entity type can this automation be triggered from
629
- * example:
630
- * submission
631
- */
632
- schema?: string;
633
- };
634
- }
635
- export interface EntityOperationTrigger {
636
- type: "entity_operation";
637
- configuration: {
638
- /**
639
- * example:
640
- * submission
641
- */
642
- schema?: string;
643
- operations?: ("createEntity" | "updateEntity" | "deleteEntity")[];
644
- };
645
- }
646
- export type ErrorCode = "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR";
647
- export interface ErrorOutput {
648
- error_code: ErrorCode;
649
- error_reason: string;
650
- }
651
- export type ExecutionStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled";
652
- export interface FillEntityAction {
653
- id?: /**
654
- * example:
655
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
656
- */
657
- AutomationActionId;
658
- flow_action_id?: /**
659
- * example:
660
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
661
- */
662
- AutomationActionId;
663
- name?: string;
664
- type?: "fill-entity";
665
- config: FillEntityConfig;
666
- execution_status?: ExecutionStatus;
667
- started_at?: string;
668
- updated_at?: string;
669
- /**
670
- * Whether to stop execution in a failed state if this action fails
671
- */
672
- allow_failure?: boolean;
673
- /**
674
- * Flag indicating whether the action was created automatically or manually
675
- */
676
- created_automatically?: boolean;
677
- /**
678
- * example:
679
- * {}
680
- */
681
- outputs?: {
682
- [name: string]: any;
683
- };
684
- error_output?: ErrorOutput;
685
- }
686
- export interface FillEntityConfig {
687
- mappings: /**
688
- * example:
689
- * {
690
- * "target": {
691
- * "schema": "contact",
692
- * "tag": "primary",
693
- * "key": "address",
694
- * "value_json": "{\"_tags\": [\"billing\"],\"city\":\"steps[0][Adresse][city]\",\"country\":\"steps[0][Adresse][countryCode]\",\"postal_code\":\"steps[0][Adresse][zipCode]\",\"street\":\"steps[0][Adresse][streetName]\",\"street_number\":\"steps[0][Adresse][houseNumber]\",\"additional_info\":\"steps[0][Adresse][addressExtention]\"}",
695
- * "target_unique": [
696
- * "country",
697
- * "city",
698
- * "postal_code",
699
- * "street",
700
- * "street_number"
701
- * ]
702
- * },
703
- * "reference": {
704
- * "schema": "opportunity",
705
- * "key": "billing_address"
706
- * }
707
- * }
708
- */
709
- AddressMapper[];
710
- }
711
- export interface FrontendSubmitTrigger {
712
- type: "frontend_submission";
713
- configuration: {
714
- /**
715
- * example:
716
- * 99
717
- */
718
- source_id?: string;
719
- };
720
- }
721
- export interface GetExecutionsResp {
722
- total: number;
723
- results: AutomationExecution[];
724
- }
725
- export interface JourneySubmitTrigger {
726
- type: "journey_submission";
727
- configuration: {
728
- source_id: string; // uuid
729
- };
730
- }
731
- /**
732
- * example:
733
- * {
734
- * "id": "2520gja-2sgmsaga-0asg-822jgal",
735
- * "name": "Map Entity",
736
- * "type": "map-entity",
737
- * "config": {
738
- * "target_schema": "contact",
739
- * "target_unique": [
740
- * "email.0.email"
741
- * ],
742
- * "relation_attributes": [
743
- * {
744
- * "target": "company",
745
- * "mode": "append",
746
- * "source_filter": {
747
- * "schema": "account",
748
- * "limit": 1
749
- * }
750
- * }
751
- * ],
752
- * "mapping_attributes": [
753
- * {
754
- * "target": "_tags",
755
- * "operation": {
756
- * "_append": [
757
- * "primary",
758
- * "payer"
759
- * ],
760
- * "_uniq": true
761
- * }
762
- * },
763
- * {
764
- * "target": "email",
765
- * "operation": {
766
- * "_append": [
767
- * {
768
- * "email": {
769
- * "_copy": "billing_contact.email"
770
- * }
771
- * }
772
- * ]
773
- * }
774
- * },
775
- * {
776
- * "target": "first_name",
777
- * "operation": {
778
- * "_copy": "billing_contact.first_name"
779
- * }
780
- * },
781
- * {
782
- * "target": "last_name",
783
- * "operation": {
784
- * "_copy": "billing_contact.last_name"
785
- * }
786
- * },
787
- * {
788
- * "target": "contact_type",
789
- * "operation": {
790
- * "_set": "customer"
791
- * }
792
- * },
793
- * {
794
- * "target": "address",
795
- * "operation": {
796
- * "_append": [
797
- * {
798
- * "_tags": [
799
- * "billing",
800
- * "primary"
801
- * ],
802
- * "street_name": {
803
- * "_copy": "billing_contact.street_name"
804
- * },
805
- * "street_number": {
806
- * "_copy": "billing_contact.street_number"
807
- * },
808
- * "city": {
809
- * "_copy": "billing_contact.city"
810
- * },
811
- * "postal_code": {
812
- * "_copy": "billing_contact.postal_code"
813
- * },
814
- * "country": {
815
- * "_copy": "billing_contact.country"
816
- * }
817
- * },
818
- * {
819
- * "_tags": [
820
- * "delivery"
821
- * ],
822
- * "street_name": {
823
- * "_copy": "delivery_contact.street_name"
824
- * },
825
- * "street_number": {
826
- * "_copy": "delivery_contact.street_number"
827
- * },
828
- * "city": {
829
- * "_copy": "delivery_contact.city"
830
- * },
831
- * "postal_code": {
832
- * "_copy": "delivery_contact.postal_code"
833
- * },
834
- * "country": {
835
- * "_copy": "delivery_contact.country"
836
- * }
837
- * }
838
- * ],
839
- * "_uniq": [
840
- * "street_name",
841
- * "street_number",
842
- * "postal_code",
843
- * "country"
844
- * ]
845
- * }
846
- * }
847
- * ]
848
- * }
849
- * }
850
- */
851
- export interface MapEntityAction {
852
- id?: /**
853
- * example:
854
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
855
- */
856
- AutomationActionId;
857
- flow_action_id?: /**
858
- * example:
859
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
860
- */
861
- AutomationActionId;
862
- name?: string;
863
- type?: "map-entity";
864
- config?: MapEntityActionConfig;
865
- execution_status?: ExecutionStatus;
866
- started_at?: string;
867
- updated_at?: string;
868
- /**
869
- * Whether to stop execution in a failed state if this action fails
870
- */
871
- allow_failure?: boolean;
872
- /**
873
- * Flag indicating whether the action was created automatically or manually
874
- */
875
- created_automatically?: boolean;
876
- /**
877
- * example:
878
- * {}
879
- */
880
- outputs?: {
881
- [name: string]: any;
882
- };
883
- error_output?: ErrorOutput;
884
- }
885
- export interface MapEntityActionConfig {
886
- /**
887
- * Schema of target entity
888
- */
889
- target_schema: string;
890
- /**
891
- * Unique key for target entity (see upsertEntity of Entity API)
892
- */
893
- target_unique?: string[];
894
- /**
895
- * Attribute mappings
896
- */
897
- mapping_attributes?: (/**
898
- * example:
899
- * {
900
- * "target": "_tags",
901
- * "operation": {
902
- * "_append": [
903
- * "new",
904
- * "tags"
905
- * ],
906
- * "_uniq": true
907
- * }
908
- * }
909
- */
910
- MappingAttributeV2 | MappingAttribute)[];
911
- /**
912
- * Relation mappings
913
- */
914
- relation_attributes?: RelationAttribute[];
915
- /**
916
- * Relation attribute on the main entity where the target entity will be linked. Set to false to disable linkback
917
- *
918
- */
919
- linkback_relation_attribute?: string;
920
- /**
921
- * Relation tags (labels) to include in main entity linkback relation attribute
922
- */
923
- linkback_relation_tags?: string[];
924
- }
925
- export type MappingAttribute = SetValueMapper | CopyValueMapper | AppendValueMapper;
926
- /**
927
- * - copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used together with value property.
928
- *
929
- */
930
- export type MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value";
931
- /**
932
- * example:
933
- * {
934
- * "target": "_tags",
935
- * "operation": {
936
- * "_append": [
937
- * "new",
938
- * "tags"
939
- * ],
940
- * "_uniq": true
941
- * }
942
- * }
943
- */
944
- export interface MappingAttributeV2 {
945
- /**
946
- * Target JSON path for the attribute to set
947
- */
948
- target?: string;
949
- operation: /* Mapping operation nodes are either primitive values or operation node objects */ OperationNode;
950
- }
951
- /**
952
- * Mapping operation nodes are either primitive values or operation node objects
953
- */
954
- export type OperationNode = /* Mapping operation nodes are either primitive values or operation node objects */ OperationObjectNode | /* Represents any primitive JSON value */ PrimitiveJSONValue;
955
- export interface OperationObjectNode {
956
- [name: string]: any;
957
- _set?: /* Represents any primitive JSON value */ PrimitiveJSONValue;
958
- /**
959
- * Append to array
960
- */
961
- _append?: any;
962
- /**
963
- * Unique array
964
- */
965
- _uniq?: /* Unique array */ boolean | string[];
966
- /**
967
- * Copy JSONPath value from source entity context
968
- * example:
969
- * contact.first_name
970
- */
971
- _copy?: string;
972
- }
973
- /**
974
- * example:
975
- * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
976
- */
977
- export type OrganizationId = string;
978
- /**
979
- * Represents any primitive JSON value
980
- */
981
- export type PrimitiveJSONValue = /* Represents any primitive JSON value */ string | boolean | number | {
982
- [name: string]: any;
983
- } | any[];
984
- export interface RelationAttribute {
985
- /**
986
- * Target attribute to store the relation in
987
- */
988
- target: string;
989
- /**
990
- * Relation tags (labels) to set for the stored relations
991
- */
992
- target_tags?: string[];
993
- /**
994
- * Include all relation tags (labels) present on the main entity relation
995
- */
996
- target_tags_include_source?: boolean;
997
- /**
998
- * A filter to identify which source entities to pick as relations from main entity
999
- */
1000
- source_filter?: {
1001
- /**
1002
- * Limit relations to maximum number (default, all matched relations)
1003
- */
1004
- limit?: number;
1005
- /**
1006
- * Filter by specific schema
1007
- */
1008
- schema?: string;
1009
- /**
1010
- * Filter by a specific relation attribute on the main entity
1011
- */
1012
- attribute?: string;
1013
- /**
1014
- * Filter by relation tag (label) on the main entity
1015
- */
1016
- relation_tag?: string;
1017
- /**
1018
- * Filter by a specific tag on the related entity
1019
- */
1020
- tag?: string;
1021
- /**
1022
- * Picks main entity as relation (overrides other filters)
1023
- */
1024
- self?: boolean;
1025
- };
1026
- related_to?: {
1027
- [name: string]: any;
1028
- };
1029
- mode: "append" | "prepend" | "set";
1030
- }
1031
- export interface SearchAutomationsResp {
1032
- total: number;
1033
- results: AutomationFlow[];
1034
- }
1035
- /**
1036
- * example:
1037
- * {
1038
- * "id": "25jga0-gkasl26-0asg-908sgaj2",
1039
- * "name": "Send Email",
1040
- * "type": "send-email",
1041
- * "config": {
1042
- * "email_template_id": "gasj02-29ug9asgm-29t9gsaghg2g-pkmbhx2",
1043
- * "language_code": "de"
1044
- * }
1045
- * }
1046
- */
1047
- export interface SendEmailAction {
1048
- id?: /**
1049
- * example:
1050
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
1051
- */
1052
- AutomationActionId;
1053
- flow_action_id?: /**
1054
- * example:
1055
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
1056
- */
1057
- AutomationActionId;
1058
- name?: string;
1059
- type?: "send-email";
1060
- config?: SendEmailActionConfig;
1061
- execution_status?: ExecutionStatus;
1062
- started_at?: string;
1063
- updated_at?: string;
1064
- /**
1065
- * Whether to stop execution in a failed state if this action fails
1066
- */
1067
- allow_failure?: boolean;
1068
- /**
1069
- * Flag indicating whether the action was created automatically or manually
1070
- */
1071
- created_automatically?: boolean;
1072
- /**
1073
- * example:
1074
- * {}
1075
- */
1076
- outputs?: {
1077
- [name: string]: any;
1078
- };
1079
- error_output?: ErrorOutput;
1080
- }
1081
- export interface SendEmailActionConfig {
1082
- email_template_id?: string;
1083
- language_code?: "de" | "en";
1084
- /**
1085
- * Include extra file attachments in sent email.
1086
- *
1087
- * Attachments in email template will be sent regardless of this configuration.
1088
- *
1089
- */
1090
- attachments?: {
1091
- /**
1092
- * Specify filters to match file entities related to main entity
1093
- */
1094
- source_filter?: {
1095
- /**
1096
- * Limit files to maximum number (default, all matched file relations)
1097
- * example:
1098
- * 1
1099
- */
1100
- limit?: number;
1101
- /**
1102
- * Match by filename. Regex syntax supported
1103
- * example:
1104
- * .*
1105
- */
1106
- filename_regex?: string;
1107
- /**
1108
- * Filter by a specific relation attribute on the main entity
1109
- * example:
1110
- * _files
1111
- */
1112
- attribute?: string;
1113
- /**
1114
- * Filter by relation tag (label) on the main entity
1115
- * example:
1116
- * contract
1117
- */
1118
- relation_tag?: string;
1119
- /**
1120
- * Filter by a specific tag on the related file entity
1121
- */
1122
- tag?: string;
1123
- /**
1124
- * Filter by a specific document type (e.g. document)
1125
- */
1126
- document_type?: "document" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
1127
- /**
1128
- * Picks main entity as file (only works if source entity is a file)
1129
- */
1130
- self?: boolean;
1131
- };
1132
- }[];
1133
- }
1134
- export interface SetValueMapper {
1135
- mode: /**
1136
- * - copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used together with value property.
1137
- *
1138
- */
1139
- MappingAttributeMode;
1140
- /**
1141
- * JSON like target path for the attribute. Eg. last_name
1142
- */
1143
- target: string;
1144
- /**
1145
- * Any value to be set: string, number, string[], number[], JSON object, etc. It will override existing values, if any.
1146
- *
1147
- */
1148
- value: any;
1149
- }
1150
- export interface StartExecutionRequest {
1151
- entity_id?: /**
1152
- * example:
1153
- * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
1154
- */
1155
- EntityId;
1156
- flow_id?: /**
1157
- * example:
1158
- * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1159
- */
1160
- AutomationFlowId;
1161
- }
1162
- /**
1163
- * example:
1164
- * {
1165
- * "source": "billing_contact.email",
1166
- * "comparison": "exists"
1167
- * }
1168
- */
1169
- export interface TriggerCondition {
1170
- source: string;
1171
- comparison: Comparison;
1172
- value?: string | number | string[] | number[];
1173
- }
1174
- /**
1175
- * example:
1176
- * {
1177
- * "id": "2520gja-2sgmsaga-0asg-822jgal",
1178
- * "name": "Trigger Webhook",
1179
- * "type": "trigger-webhook",
1180
- * "config": {
1181
- * "entity_sources": [
1182
- * "contact",
1183
- * "account"
1184
- * ],
1185
- * "target_webhook_id": "25jg9ag2ga"
1186
- * }
1187
- * }
1188
- */
1189
- export interface TriggerWebhookAction {
1190
- id?: /**
1191
- * example:
1192
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
1193
- */
1194
- AutomationActionId;
1195
- flow_action_id?: /**
1196
- * example:
1197
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
1198
- */
1199
- AutomationActionId;
1200
- name?: string;
1201
- type?: "trigger-webhook";
1202
- config?: TriggerWebhookActionConfig;
1203
- execution_status?: ExecutionStatus;
1204
- started_at?: string;
1205
- updated_at?: string;
1206
- /**
1207
- * Whether to stop execution in a failed state if this action fails
1208
- */
1209
- allow_failure?: boolean;
1210
- /**
1211
- * Flag indicating whether the action was created automatically or manually
1212
- */
1213
- created_automatically?: boolean;
1214
- /**
1215
- * example:
1216
- * {}
1217
- */
1218
- outputs?: {
1219
- [name: string]: any;
1220
- };
1221
- error_output?: ErrorOutput;
1222
- }
1223
- export interface TriggerWebhookActionConfig {
1224
- entity_sources?: string[];
1225
- target_webhook_id?: string;
1226
- }
1227
- /**
1228
- * example:
1229
- * {
1230
- * "id": "08g988-ojt2jtaga-292h-8978gsaga",
1231
- * "name": "Trigger Workflow",
1232
- * "type": "trigger-workflow",
1233
- * "config": {
1234
- * "target_workflow": "mfptvUMH",
1235
- * "conditions": [
1236
- * {
1237
- * "schema": "ivy-opportunity",
1238
- * "source": "customer.type",
1239
- * "comparison": "equals",
1240
- * "value": "PRIVATE"
1241
- * }
1242
- * ],
1243
- * "assign_steps": [
1244
- * {
1245
- * "step_name": "Lead Sales",
1246
- * "user_ids": [
1247
- * 10010729
1248
- * ]
1249
- * },
1250
- * {
1251
- * "step_name": "Operations",
1252
- * "user_ids": [
1253
- * 10010728,
1254
- * 10010729
1255
- * ]
1256
- * }
1257
- * ]
1258
- * }
1259
- * }
1260
- */
1261
- export interface TriggerWorkflowAction {
1262
- id?: /**
1263
- * example:
1264
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
1265
- */
1266
- AutomationActionId;
1267
- flow_action_id?: /**
1268
- * example:
1269
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
1270
- */
1271
- AutomationActionId;
1272
- name?: string;
1273
- type?: "trigger-workflow";
1274
- config?: TriggerWorkflowConfig;
1275
- execution_status?: ExecutionStatus;
1276
- started_at?: string;
1277
- updated_at?: string;
1278
- /**
1279
- * Whether to stop execution in a failed state if this action fails
1280
- */
1281
- allow_failure?: boolean;
1282
- /**
1283
- * Flag indicating whether the action was created automatically or manually
1284
- */
1285
- created_automatically?: boolean;
1286
- /**
1287
- * example:
1288
- * {}
1289
- */
1290
- outputs?: {
1291
- [name: string]: any;
1292
- };
1293
- error_output?: ErrorOutput;
1294
- }
1295
- /**
1296
- * example:
1297
- * {
1298
- * "source": "email",
1299
- * "comparison": "equals",
1300
- * "schema": "contact",
1301
- * "value": "test@epilot.cloud"
1302
- * }
1303
- */
1304
- export interface TriggerWorkflowCondition {
1305
- source: string;
1306
- comparison: Comparison;
1307
- value?: string | number | string[] | number[];
1308
- schema: string;
1309
- }
1310
- export interface TriggerWorkflowConfig {
1311
- target_workflow?: string;
1312
- conditions?: /**
1313
- * example:
1314
- * {
1315
- * "source": "email",
1316
- * "comparison": "equals",
1317
- * "schema": "contact",
1318
- * "value": "test@epilot.cloud"
1319
- * }
1320
- */
1321
- TriggerWorkflowCondition[];
1322
- assignees?: string[];
1323
- assign_steps?: /**
1324
- * example:
1325
- * [
1326
- * {
1327
- * "step_id": "xyh9t2ha",
1328
- * "step_name": "Lead Sales",
1329
- * "user_ids": [
1330
- * 10010729
1331
- * ]
1332
- * },
1333
- * {
1334
- * "step_id": "29jgasl",
1335
- * "step_name": "Operations",
1336
- * "user_ids": [
1337
- * 10010728,
1338
- * 10010729
1339
- * ]
1340
- * }
1341
- * ]
1342
- */
1343
- AssignUsersToStep[];
1344
- }
1345
- }
1346
- }
1347
- declare namespace Paths {
1348
- namespace CancelExecution {
1349
- namespace Parameters {
1350
- export type ExecutionId = /**
1351
- * example:
1352
- * 9baf184f-bc81-4128-bca3-d974c90a12c4
1353
- */
1354
- Components.Schemas.AutomationExecutionId;
1355
- }
1356
- export interface PathParameters {
1357
- execution_id: Parameters.ExecutionId;
1358
- }
1359
- namespace Responses {
1360
- export type $200 = Components.Schemas.AutomationExecution;
1361
- }
1362
- }
1363
- namespace CreateFlow {
1364
- export type RequestBody = Components.Schemas.AutomationFlow;
1365
- namespace Responses {
1366
- export type $201 = Components.Schemas.AutomationFlow;
1367
- }
1368
- }
1369
- namespace DeleteFlow {
1370
- namespace Parameters {
1371
- export type FlowId = /**
1372
- * example:
1373
- * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1374
- */
1375
- Components.Schemas.AutomationFlowId;
1376
- }
1377
- export interface PathParameters {
1378
- flow_id: Parameters.FlowId;
1379
- }
1380
- namespace Responses {
1381
- export type $200 = Components.Schemas.AutomationFlow;
1382
- }
1383
- }
1384
- namespace GetExecution {
1385
- namespace Parameters {
1386
- export type ExecutionId = /**
1387
- * example:
1388
- * 9baf184f-bc81-4128-bca3-d974c90a12c4
1389
- */
1390
- Components.Schemas.AutomationExecutionId;
1391
- }
1392
- export interface PathParameters {
1393
- execution_id: Parameters.ExecutionId;
1394
- }
1395
- namespace Responses {
1396
- export type $200 = Components.Schemas.AutomationExecution;
1397
- }
1398
- }
1399
- namespace GetExecutions {
1400
- namespace Parameters {
1401
- export type EntityId = /**
1402
- * example:
1403
- * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
1404
- */
1405
- Components.Schemas.EntityId;
1406
- export type From = number;
1407
- export type Size = number;
1408
- }
1409
- export interface QueryParameters {
1410
- entity_id?: Parameters.EntityId;
1411
- size?: Parameters.Size;
1412
- from?: Parameters.From;
1413
- }
1414
- namespace Responses {
1415
- export type $200 = Components.Schemas.GetExecutionsResp;
1416
- }
1417
- }
1418
- namespace GetFlow {
1419
- namespace Parameters {
1420
- export type FlowId = /**
1421
- * example:
1422
- * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1423
- */
1424
- Components.Schemas.AutomationFlowId;
1425
- }
1426
- export interface PathParameters {
1427
- flow_id: Parameters.FlowId;
1428
- }
1429
- namespace Responses {
1430
- export type $200 = Components.Schemas.AutomationFlow;
1431
- }
1432
- }
1433
- namespace PutFlow {
1434
- namespace Parameters {
1435
- export type FlowId = /**
1436
- * example:
1437
- * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1438
- */
1439
- Components.Schemas.AutomationFlowId;
1440
- }
1441
- export interface PathParameters {
1442
- flow_id: Parameters.FlowId;
1443
- }
1444
- export type RequestBody = Components.Schemas.AutomationFlow;
1445
- namespace Responses {
1446
- export type $200 = Components.Schemas.AutomationFlow;
1447
- }
1448
- }
1449
- namespace RetriggerAction {
1450
- namespace Parameters {
1451
- export type ActionId = /**
1452
- * example:
1453
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
1454
- */
1455
- Components.Schemas.AutomationActionId;
1456
- export type ExecutionId = /**
1457
- * example:
1458
- * 9baf184f-bc81-4128-bca3-d974c90a12c4
1459
- */
1460
- Components.Schemas.AutomationExecutionId;
1461
- }
1462
- export interface PathParameters {
1463
- execution_id: Parameters.ExecutionId;
1464
- action_id: Parameters.ActionId;
1465
- }
1466
- namespace Responses {
1467
- export interface $200 {
1468
- }
1469
- }
1470
- }
1471
- namespace SearchFlows {
1472
- namespace Parameters {
1473
- export type From = number;
1474
- /**
1475
- * example:
1476
- * submission
1477
- */
1478
- export type Schema = string;
1479
- export type Size = number;
1480
- /**
1481
- * example:
1482
- * 600945fe-212e-4b97-acf7-391d64648384
1483
- */
1484
- export type TriggerSourceId = string;
1485
- }
1486
- export interface QueryParameters {
1487
- schema?: /**
1488
- * example:
1489
- * submission
1490
- */
1491
- Parameters.Schema;
1492
- size?: Parameters.Size;
1493
- from?: Parameters.From;
1494
- trigger_source_id?: /**
1495
- * example:
1496
- * 600945fe-212e-4b97-acf7-391d64648384
1497
- */
1498
- Parameters.TriggerSourceId;
1499
- }
1500
- namespace Responses {
1501
- export type $200 = Components.Schemas.SearchAutomationsResp;
1502
- }
1503
- }
1504
- namespace StartExecution {
1505
- export type RequestBody = Components.Schemas.StartExecutionRequest;
1506
- namespace Responses {
1507
- export type $201 = Components.Schemas.AutomationExecution;
1508
- }
1509
- }
1510
- }
1511
-
1512
- export interface OperationMethods {
1513
- /**
1514
- * searchFlows - searchFlows
1515
- *
1516
- * Search available automation flows
1517
- */
1518
- 'searchFlows'(
1519
- parameters?: Parameters<Paths.SearchFlows.QueryParameters> | null,
1520
- data?: any,
1521
- config?: AxiosRequestConfig
1522
- ): OperationResponse<Paths.SearchFlows.Responses.$200>
1523
- /**
1524
- * createFlow - createFlow
1525
- *
1526
- * Create new automation flow
1527
- */
1528
- 'createFlow'(
1529
- parameters?: Parameters<UnknownParamsObject> | null,
1530
- data?: Paths.CreateFlow.RequestBody,
1531
- config?: AxiosRequestConfig
1532
- ): OperationResponse<Paths.CreateFlow.Responses.$201>
1533
- /**
1534
- * getFlow - getFlow
1535
- *
1536
- * List available automation flows
1537
- */
1538
- 'getFlow'(
1539
- parameters?: Parameters<Paths.GetFlow.PathParameters> | null,
1540
- data?: any,
1541
- config?: AxiosRequestConfig
1542
- ): OperationResponse<Paths.GetFlow.Responses.$200>
1543
- /**
1544
- * putFlow - putFlow
1545
- *
1546
- * Update automation flow by id
1547
- */
1548
- 'putFlow'(
1549
- parameters?: Parameters<Paths.PutFlow.PathParameters> | null,
1550
- data?: Paths.PutFlow.RequestBody,
1551
- config?: AxiosRequestConfig
1552
- ): OperationResponse<Paths.PutFlow.Responses.$200>
1553
- /**
1554
- * deleteFlow - deleteFlow
1555
- *
1556
- * Update automation flow by id
1557
- */
1558
- 'deleteFlow'(
1559
- parameters?: Parameters<Paths.DeleteFlow.PathParameters> | null,
1560
- data?: any,
1561
- config?: AxiosRequestConfig
1562
- ): OperationResponse<Paths.DeleteFlow.Responses.$200>
1563
- /**
1564
- * getExecutions - getExecutions
1565
- *
1566
- * List automation executions
1567
- */
1568
- 'getExecutions'(
1569
- parameters?: Parameters<Paths.GetExecutions.QueryParameters> | null,
1570
- data?: any,
1571
- config?: AxiosRequestConfig
1572
- ): OperationResponse<Paths.GetExecutions.Responses.$200>
1573
- /**
1574
- * startExecution - startExecution
1575
- *
1576
- * Start new automation execution
1577
- */
1578
- 'startExecution'(
1579
- parameters?: Parameters<UnknownParamsObject> | null,
1580
- data?: Paths.StartExecution.RequestBody,
1581
- config?: AxiosRequestConfig
1582
- ): OperationResponse<Paths.StartExecution.Responses.$201>
1583
- /**
1584
- * getExecution - getExecution
1585
- *
1586
- * Get automation execution
1587
- */
1588
- 'getExecution'(
1589
- parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
1590
- data?: any,
1591
- config?: AxiosRequestConfig
1592
- ): OperationResponse<Paths.GetExecution.Responses.$200>
1593
- /**
1594
- * cancelExecution - cancelExecution
1595
- *
1596
- * Cancel automation execution
1597
- */
1598
- 'cancelExecution'(
1599
- parameters?: Parameters<Paths.CancelExecution.PathParameters> | null,
1600
- data?: any,
1601
- config?: AxiosRequestConfig
1602
- ): OperationResponse<Paths.CancelExecution.Responses.$200>
1603
- /**
1604
- * retriggerAction - retriggerAction
1605
- *
1606
- * Retrigger a specific automation execution action
1607
- */
1608
- 'retriggerAction'(
1609
- parameters?: Parameters<Paths.RetriggerAction.PathParameters> | null,
1610
- data?: any,
1611
- config?: AxiosRequestConfig
1612
- ): OperationResponse<Paths.RetriggerAction.Responses.$200>
1613
- }
1614
-
1615
- export interface PathsDictionary {
1616
- ['/v1/automation/flows']: {
1617
- /**
1618
- * searchFlows - searchFlows
1619
- *
1620
- * Search available automation flows
1621
- */
1622
- 'get'(
1623
- parameters?: Parameters<Paths.SearchFlows.QueryParameters> | null,
1624
- data?: any,
1625
- config?: AxiosRequestConfig
1626
- ): OperationResponse<Paths.SearchFlows.Responses.$200>
1627
- /**
1628
- * createFlow - createFlow
1629
- *
1630
- * Create new automation flow
1631
- */
1632
- 'post'(
1633
- parameters?: Parameters<UnknownParamsObject> | null,
1634
- data?: Paths.CreateFlow.RequestBody,
1635
- config?: AxiosRequestConfig
1636
- ): OperationResponse<Paths.CreateFlow.Responses.$201>
1637
- }
1638
- ['/v1/automation/flows/{flow_id}']: {
1639
- /**
1640
- * getFlow - getFlow
1641
- *
1642
- * List available automation flows
1643
- */
1644
- 'get'(
1645
- parameters?: Parameters<Paths.GetFlow.PathParameters> | null,
1646
- data?: any,
1647
- config?: AxiosRequestConfig
1648
- ): OperationResponse<Paths.GetFlow.Responses.$200>
1649
- /**
1650
- * putFlow - putFlow
1651
- *
1652
- * Update automation flow by id
1653
- */
1654
- 'put'(
1655
- parameters?: Parameters<Paths.PutFlow.PathParameters> | null,
1656
- data?: Paths.PutFlow.RequestBody,
1657
- config?: AxiosRequestConfig
1658
- ): OperationResponse<Paths.PutFlow.Responses.$200>
1659
- /**
1660
- * deleteFlow - deleteFlow
1661
- *
1662
- * Update automation flow by id
1663
- */
1664
- 'delete'(
1665
- parameters?: Parameters<Paths.DeleteFlow.PathParameters> | null,
1666
- data?: any,
1667
- config?: AxiosRequestConfig
1668
- ): OperationResponse<Paths.DeleteFlow.Responses.$200>
1669
- }
1670
- ['/v1/automation/executions']: {
1671
- /**
1672
- * getExecutions - getExecutions
1673
- *
1674
- * List automation executions
1675
- */
1676
- 'get'(
1677
- parameters?: Parameters<Paths.GetExecutions.QueryParameters> | null,
1678
- data?: any,
1679
- config?: AxiosRequestConfig
1680
- ): OperationResponse<Paths.GetExecutions.Responses.$200>
1681
- /**
1682
- * startExecution - startExecution
1683
- *
1684
- * Start new automation execution
1685
- */
1686
- 'post'(
1687
- parameters?: Parameters<UnknownParamsObject> | null,
1688
- data?: Paths.StartExecution.RequestBody,
1689
- config?: AxiosRequestConfig
1690
- ): OperationResponse<Paths.StartExecution.Responses.$201>
1691
- }
1692
- ['/v1/automation/executions/{execution_id}']: {
1693
- /**
1694
- * getExecution - getExecution
1695
- *
1696
- * Get automation execution
1697
- */
1698
- 'get'(
1699
- parameters?: Parameters<Paths.GetExecution.PathParameters> | null,
1700
- data?: any,
1701
- config?: AxiosRequestConfig
1702
- ): OperationResponse<Paths.GetExecution.Responses.$200>
1703
- /**
1704
- * cancelExecution - cancelExecution
1705
- *
1706
- * Cancel automation execution
1707
- */
1708
- 'delete'(
1709
- parameters?: Parameters<Paths.CancelExecution.PathParameters> | null,
1710
- data?: any,
1711
- config?: AxiosRequestConfig
1712
- ): OperationResponse<Paths.CancelExecution.Responses.$200>
1713
- }
1714
- ['/v1/automation/executions/{execution_id}/{action_id}/retrigger']: {
1715
- /**
1716
- * retriggerAction - retriggerAction
1717
- *
1718
- * Retrigger a specific automation execution action
1719
- */
1720
- 'post'(
1721
- parameters?: Parameters<Paths.RetriggerAction.PathParameters> | null,
1722
- data?: any,
1723
- config?: AxiosRequestConfig
1724
- ): OperationResponse<Paths.RetriggerAction.Responses.$200>
1725
- }
1726
- }
1727
-
1728
- export type Client = OpenAPIClient<OperationMethods, PathsDictionary>