@epilot/automation-client 2.16.2 → 2.16.5-rc.1

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.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,t,o){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var r=n(o(240));t.default=r.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/automation/flows":{"get":{"operationId":"searchFlows","parameters":[{"name":"schema","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"},{"name":"trigger_source_id","in":"query"}],"responses":{}},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/flows/{flow_id}":{"get":{"operationId":"getFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions":{"get":{"operationId":"getExecutions","parameters":[{"name":"entity_id","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"}],"responses":{}},"post":{"operationId":"startExecution","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs":{"post":{"operationId":"bulkTriggerExecutions","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs/{job_id}":{"get":{"operationId":"getBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/{execution_id}":{"get":{"operationId":"getExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}},"delete":{"operationId":"cancelExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions/{execution_id}/{action_id}/retrigger":{"post":{"operationId":"retriggerAction","parameters":[{"name":"execution_id","in":"path","required":true},{"name":"action_id","in":"path","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/automation/public/executions:resume":{"post":{"operationId":"resumeExecutionWithToken","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"NotFoundError":{"content":{"application/json":{}}},"ForbiddenError":{"content":{"application/json":{}}}}},"servers":[{"url":"https://automation.sls.epilot.io"}]}')}},t={},o=function o(n){var r=t[n];if(void 0!==r)return r.exports;var i=t[n]={exports:{}};return e[n].call(i.exports,i,i.exports,o),i.exports}(914),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={187:function(e,t,o){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var r=n(o(466));t.default=r.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/automation/flows":{"get":{"operationId":"searchFlows","parameters":[{"name":"schema","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"},{"name":"trigger_source_id","in":"query"}],"responses":{}},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/flows/{flow_id}":{"get":{"operationId":"getFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions":{"get":{"operationId":"getExecutions","parameters":[{"name":"entity_id","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"}],"responses":{}},"post":{"operationId":"startExecution","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs":{"post":{"operationId":"bulkTriggerExecutions","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs/{job_id}":{"get":{"operationId":"getBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/{execution_id}":{"get":{"operationId":"getExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}},"delete":{"operationId":"cancelExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions/{execution_id}/{action_id}/retrigger":{"post":{"operationId":"retriggerAction","parameters":[{"name":"execution_id","in":"path","required":true},{"name":"action_id","in":"path","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/automation/public/executions:resume":{"post":{"operationId":"resumeExecutionWithToken","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"NotFoundError":{"content":{"application/json":{}}},"ForbiddenError":{"content":{"application/json":{}}}}},"servers":[{"url":"https://automation.sls.epilot.io"}]}')}},t={},o=function o(n){var r=t[n];if(void 0!==r)return r.exports;var i=t[n]={exports:{}};return e[n].call(i.exports,i,i.exports,o),i.exports}(187),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
package/dist/openapi.d.ts CHANGED
@@ -126,33 +126,7 @@ declare namespace Components {
126
126
  types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal") | string)[];
127
127
  };
128
128
  }
129
- export interface AdvancedCustomActionConfig {
130
- /**
131
- * Name of the custom action
132
- */
133
- name?: string;
134
- /**
135
- * Description of the custom action
136
- */
137
- description?: string;
138
- /**
139
- * The ID of the app to fetch configuration from the app API
140
- * example:
141
- * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
142
- */
143
- app_id?: string;
144
- /**
145
- * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
146
- * example:
147
- * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
148
- */
149
- component_id?: string;
150
- type: "advanced";
151
- advanced_settings?: {
152
- [name: string]: any;
153
- };
154
- }
155
- export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction;
129
+ export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | InformERPAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction;
156
130
  export type AnyActionConfig = /**
157
131
  * example:
158
132
  * {
@@ -323,6 +297,21 @@ declare namespace Components {
323
297
  * }
324
298
  */
325
299
  TriggerWebhookActionConfig | /**
300
+ * example:
301
+ * {
302
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
303
+ * "name": "Inform ERP",
304
+ * "type": "inform-erp",
305
+ * "config": {
306
+ * "entity_sources": [
307
+ * "contact",
308
+ * "account"
309
+ * ],
310
+ * "target_webhook_id": "25jg9ag2ga"
311
+ * }
312
+ * }
313
+ */
314
+ InformERPActionConfig | /**
326
315
  * example:
327
316
  * {
328
317
  * "id": "08g988-ojt2jtaga-292h-8978gsaga",
@@ -352,7 +341,7 @@ declare namespace Components {
352
341
  * }
353
342
  * }
354
343
  */
355
- SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | CustomActionConfig | AutomationActionConfig;
344
+ SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | CustomAction | AutomationActionConfig;
356
345
  export type AnyTrigger = FrontendSubmitTrigger | JourneySubmitTrigger | ApiSubmissionTrigger | /**
357
346
  * - If provides filter_config, executes an automation based on the filtered configuration when an entity event occurs.
358
347
  * - The conditions on a filter follows the event bridge patterns - `https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html`
@@ -819,6 +808,10 @@ declare namespace Components {
819
808
  * Who disabled the flow (system or user)
820
809
  */
821
810
  disabled_by: "system" | "user";
811
+ /**
812
+ * The 360 user email that disabled the flow
813
+ */
814
+ blame?: string;
822
815
  };
823
816
  triggers: AnyTrigger[];
824
817
  trigger_conditions?: /**
@@ -911,64 +904,6 @@ declare namespace Components {
911
904
  */
912
905
  id?: string; // uuid
913
906
  }
914
- export interface BaseCustomActionConfig {
915
- /**
916
- * Name of the custom action
917
- */
918
- name?: string;
919
- /**
920
- * Description of the custom action
921
- */
922
- description?: string;
923
- /**
924
- * The ID of the app to fetch configuration from the app API
925
- * example:
926
- * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
927
- */
928
- app_id?: string;
929
- /**
930
- * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
931
- * example:
932
- * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
933
- */
934
- component_id?: string;
935
- }
936
- export interface BasicCustomActionConfig {
937
- /**
938
- * Name of the custom action
939
- */
940
- name?: string;
941
- /**
942
- * Description of the custom action
943
- */
944
- description?: string;
945
- /**
946
- * The ID of the app to fetch configuration from the app API
947
- * example:
948
- * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
949
- */
950
- app_id?: string;
951
- /**
952
- * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
953
- * example:
954
- * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
955
- */
956
- component_id?: string;
957
- type: "basic";
958
- basic_settings?: {
959
- /**
960
- * URL to call
961
- */
962
- url?: string;
963
- headers?: {
964
- [name: string]: any;
965
- };
966
- /**
967
- * SSM Reference to the auth token to use for the request
968
- */
969
- auth_token_ref?: string;
970
- };
971
- }
972
907
  export interface BulkTriggerJob {
973
908
  job_id: /**
974
909
  * Job ID for tracking the status of bulk trigger automation executions
@@ -1025,15 +960,46 @@ declare namespace Components {
1025
960
  */
1026
961
  execution_summary: /* Execution item for bulk trigger automation. It maps each entity to its automation execution id & status */ ExecItem[];
1027
962
  }
1028
- export interface BulkTriggerRequest {
963
+ export type BulkTriggerRequest = {
1029
964
  flow_id: /**
1030
965
  * example:
1031
966
  * 7791b04a-16d2-44a2-9af9-2d59c25c512f
1032
967
  */
1033
968
  AutomationFlowId;
1034
- entities_refs?: EntityRef[];
1035
- entities_query?: string;
1036
- }
969
+ entities_refs: EntityRef[];
970
+ } | {
971
+ flow_id: /**
972
+ * example:
973
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
974
+ */
975
+ AutomationFlowId;
976
+ entities_query: string;
977
+ } | {
978
+ flow_id: /**
979
+ * example:
980
+ * 7791b04a-16d2-44a2-9af9-2d59c25c512f
981
+ */
982
+ AutomationFlowId;
983
+ entities_filter: /**
984
+ * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
985
+ * example:
986
+ * [
987
+ * {
988
+ * "term": {
989
+ * "_schema": "contact"
990
+ * }
991
+ * },
992
+ * {
993
+ * "terms": {
994
+ * "status": [
995
+ * "active"
996
+ * ]
997
+ * }
998
+ * }
999
+ * ]
1000
+ */
1001
+ EntitySearchFilter;
1002
+ };
1037
1003
  /**
1038
1004
  * Creates an order entity with prices from journey
1039
1005
  */
@@ -1386,7 +1352,33 @@ declare namespace Components {
1386
1352
  AutomationActionId;
1387
1353
  name?: string;
1388
1354
  type?: "custom-action";
1389
- config?: BasicCustomActionConfig | AdvancedCustomActionConfig;
1355
+ config?: {
1356
+ [name: string]: any;
1357
+ /**
1358
+ * The name of the custom action
1359
+ * example:
1360
+ * Credit Check
1361
+ */
1362
+ name?: string;
1363
+ /**
1364
+ * The description of the custom action
1365
+ * example:
1366
+ * Check if the customer has a credit limit
1367
+ */
1368
+ description?: string;
1369
+ /**
1370
+ * The ID of the app to fetch configuration from the app API
1371
+ * example:
1372
+ * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
1373
+ */
1374
+ app_id?: string;
1375
+ /**
1376
+ * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
1377
+ * example:
1378
+ * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
1379
+ */
1380
+ component_id?: string;
1381
+ };
1390
1382
  /**
1391
1383
  * Whether to stop execution in a failed state if this action fails
1392
1384
  */
@@ -1434,55 +1426,6 @@ declare namespace Components {
1434
1426
  error_output?: ErrorOutput;
1435
1427
  retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
1436
1428
  }
1437
- export interface CustomActionConfig {
1438
- id?: /**
1439
- * example:
1440
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
1441
- */
1442
- AutomationActionId;
1443
- flow_action_id?: /**
1444
- * example:
1445
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
1446
- */
1447
- AutomationActionId;
1448
- name?: string;
1449
- type?: "custom-action";
1450
- config?: BasicCustomActionConfig | AdvancedCustomActionConfig;
1451
- /**
1452
- * Whether to stop execution in a failed state if this action fails
1453
- */
1454
- allow_failure?: boolean;
1455
- /**
1456
- * Flag indicating whether the action was created automatically or manually
1457
- */
1458
- created_automatically?: boolean;
1459
- /**
1460
- * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1461
- */
1462
- is_bulk_action?: boolean;
1463
- reason?: {
1464
- /**
1465
- * Why the action has to be skipped/failed
1466
- * example:
1467
- * There are no registered portal users for the given emails, hence skipping the action
1468
- */
1469
- message?: string;
1470
- /**
1471
- * Extra metadata about the skipping reason - such as a certain condition not met, etc.
1472
- */
1473
- payload?: {
1474
- [name: string]: any;
1475
- };
1476
- };
1477
- /**
1478
- * Condition Id to be checked before executing the action
1479
- */
1480
- condition_id?: string;
1481
- /**
1482
- * Schedule Id which indicates the schedule of the action
1483
- */
1484
- schedule_id?: string;
1485
- }
1486
1429
  export type DiffAdded = FilterConditionOnEvent;
1487
1430
  export type DiffDeleted = FilterConditionOnEvent;
1488
1431
  export type DiffUpdated = FilterConditionOnEvent;
@@ -1521,7 +1464,7 @@ declare namespace Components {
1521
1464
  schema?: string;
1522
1465
  };
1523
1466
  }
1524
- export type EntityOperation = "createEntity" | "updateEntity" | "deleteEntity";
1467
+ export type EntityOperation = "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity";
1525
1468
  /**
1526
1469
  * - If provides filter_config, executes an automation based on the filtered configuration when an entity event occurs.
1527
1470
  * - The conditions on a filter follows the event bridge patterns - `https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html`
@@ -1735,6 +1678,166 @@ declare namespace Components {
1735
1678
  EntityId;
1736
1679
  entity_schema: string;
1737
1680
  }
1681
+ /**
1682
+ * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
1683
+ * example:
1684
+ * [
1685
+ * {
1686
+ * "term": {
1687
+ * "_schema": "contact"
1688
+ * }
1689
+ * },
1690
+ * {
1691
+ * "terms": {
1692
+ * "status": [
1693
+ * "active"
1694
+ * ]
1695
+ * }
1696
+ * }
1697
+ * ]
1698
+ */
1699
+ export type EntitySearchFilter = {
1700
+ /**
1701
+ * Returns documents that contain an exact term in a provided field.
1702
+ *
1703
+ * To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
1704
+ *
1705
+ * You likely DO NOT want to use this filter on text fields and want to target its .keyword instead.
1706
+ *
1707
+ * example:
1708
+ * {
1709
+ * "_schema": "contact"
1710
+ * }
1711
+ */
1712
+ term?: {
1713
+ [name: string]: /* A filter field value. */ EntitySearchFilterValue;
1714
+ };
1715
+ /**
1716
+ * Returns documents that contain one of the exact terms in a provided field. See term filter for more info.
1717
+ * example:
1718
+ * {
1719
+ * "status": [
1720
+ * "active"
1721
+ * ]
1722
+ * }
1723
+ */
1724
+ terms?: {
1725
+ [name: string]: /* A filter field value. */ EntitySearchFilterValue[];
1726
+ };
1727
+ /**
1728
+ * Returns documents based on their IDs.
1729
+ * example:
1730
+ * {
1731
+ * "values": [
1732
+ * "550e8400-e29b-41d4-a716-446655440000"
1733
+ * ]
1734
+ * }
1735
+ */
1736
+ ids?: {
1737
+ values?: string[];
1738
+ };
1739
+ /**
1740
+ * Returns documents with fields that have terms within a certain range.
1741
+ * example:
1742
+ * {
1743
+ * "_created_at": {
1744
+ * "gte": "2021-01-01T00:00:00.000Z",
1745
+ * "lte": "2021-01-31T23:59:59.999Z"
1746
+ * }
1747
+ * }
1748
+ */
1749
+ range?: {
1750
+ [name: string]: {
1751
+ gt?: /* A filter field value. */ EntitySearchFilterValue;
1752
+ gte?: /* A filter field value. */ EntitySearchFilterValue;
1753
+ lt?: /* A filter field value. */ EntitySearchFilterValue;
1754
+ lte?: /* A filter field value. */ EntitySearchFilterValue;
1755
+ /**
1756
+ * The date format used to parse date values.
1757
+ */
1758
+ format?: string;
1759
+ /**
1760
+ * Indicates how the range query matches values for range fields.
1761
+ */
1762
+ relation?: "INTERSECTS" | "CONTAINS" | "WITHIN";
1763
+ /**
1764
+ * Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC.
1765
+ */
1766
+ time_zone?: string;
1767
+ };
1768
+ };
1769
+ /**
1770
+ * Returns documents that have a value in the specified field.
1771
+ * example:
1772
+ * {
1773
+ * "field": "_tags"
1774
+ * }
1775
+ */
1776
+ exists?: {
1777
+ field: string;
1778
+ };
1779
+ $and?: /**
1780
+ * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
1781
+ * example:
1782
+ * [
1783
+ * {
1784
+ * "term": {
1785
+ * "_schema": "contact"
1786
+ * }
1787
+ * },
1788
+ * {
1789
+ * "terms": {
1790
+ * "status": [
1791
+ * "active"
1792
+ * ]
1793
+ * }
1794
+ * }
1795
+ * ]
1796
+ */
1797
+ EntitySearchFilter;
1798
+ $or?: /**
1799
+ * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
1800
+ * example:
1801
+ * [
1802
+ * {
1803
+ * "term": {
1804
+ * "_schema": "contact"
1805
+ * }
1806
+ * },
1807
+ * {
1808
+ * "terms": {
1809
+ * "status": [
1810
+ * "active"
1811
+ * ]
1812
+ * }
1813
+ * }
1814
+ * ]
1815
+ */
1816
+ EntitySearchFilter;
1817
+ $not?: /**
1818
+ * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
1819
+ * example:
1820
+ * [
1821
+ * {
1822
+ * "term": {
1823
+ * "_schema": "contact"
1824
+ * }
1825
+ * },
1826
+ * {
1827
+ * "terms": {
1828
+ * "status": [
1829
+ * "active"
1830
+ * ]
1831
+ * }
1832
+ * }
1833
+ * ]
1834
+ */
1835
+ EntitySearchFilter;
1836
+ }[];
1837
+ /**
1838
+ * A filter field value.
1839
+ */
1840
+ export type EntitySearchFilterValue = /* A filter field value. */ (string | null) | number | boolean;
1738
1841
  export interface EqualsIgnoreCaseCondition {
1739
1842
  "equals-ignore-case"?: string;
1740
1843
  }
@@ -1822,6 +1925,139 @@ declare namespace Components {
1822
1925
  total: number;
1823
1926
  results: AutomationExecution[];
1824
1927
  }
1928
+ export interface InformERPAction {
1929
+ id?: /**
1930
+ * example:
1931
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1932
+ */
1933
+ AutomationActionId;
1934
+ flow_action_id?: /**
1935
+ * example:
1936
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
1937
+ */
1938
+ AutomationActionId;
1939
+ name?: string;
1940
+ type?: "trigger-webhook";
1941
+ config?: InformERPConfig;
1942
+ /**
1943
+ * Whether to stop execution in a failed state if this action fails
1944
+ */
1945
+ allow_failure?: boolean;
1946
+ /**
1947
+ * Flag indicating whether the action was created automatically or manually
1948
+ */
1949
+ created_automatically?: boolean;
1950
+ /**
1951
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1952
+ */
1953
+ is_bulk_action?: boolean;
1954
+ reason?: {
1955
+ /**
1956
+ * Why the action has to be skipped/failed
1957
+ * example:
1958
+ * There are no registered portal users for the given emails, hence skipping the action
1959
+ */
1960
+ message?: string;
1961
+ /**
1962
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
1963
+ */
1964
+ payload?: {
1965
+ [name: string]: any;
1966
+ };
1967
+ };
1968
+ /**
1969
+ * Condition Id to be checked before executing the action
1970
+ */
1971
+ condition_id?: string;
1972
+ /**
1973
+ * Schedule Id which indicates the schedule of the action
1974
+ */
1975
+ schedule_id?: string;
1976
+ execution_status?: ExecutionStatus;
1977
+ started_at?: string;
1978
+ updated_at?: string;
1979
+ /**
1980
+ * example:
1981
+ * {}
1982
+ */
1983
+ outputs?: {
1984
+ [name: string]: any;
1985
+ };
1986
+ error_output?: ErrorOutput;
1987
+ retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
1988
+ }
1989
+ /**
1990
+ * example:
1991
+ * {
1992
+ * "id": "2520gja-2sgmsaga-0asg-822jgal",
1993
+ * "name": "Inform ERP",
1994
+ * "type": "inform-erp",
1995
+ * "config": {
1996
+ * "entity_sources": [
1997
+ * "contact",
1998
+ * "account"
1999
+ * ],
2000
+ * "target_webhook_id": "25jg9ag2ga"
2001
+ * }
2002
+ * }
2003
+ */
2004
+ export interface InformERPActionConfig {
2005
+ id?: /**
2006
+ * example:
2007
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2008
+ */
2009
+ AutomationActionId;
2010
+ flow_action_id?: /**
2011
+ * example:
2012
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
2013
+ */
2014
+ AutomationActionId;
2015
+ name?: string;
2016
+ type?: "trigger-webhook";
2017
+ config?: InformERPConfig;
2018
+ /**
2019
+ * Whether to stop execution in a failed state if this action fails
2020
+ */
2021
+ allow_failure?: boolean;
2022
+ /**
2023
+ * Flag indicating whether the action was created automatically or manually
2024
+ */
2025
+ created_automatically?: boolean;
2026
+ /**
2027
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2028
+ */
2029
+ is_bulk_action?: boolean;
2030
+ reason?: {
2031
+ /**
2032
+ * Why the action has to be skipped/failed
2033
+ * example:
2034
+ * There are no registered portal users for the given emails, hence skipping the action
2035
+ */
2036
+ message?: string;
2037
+ /**
2038
+ * Extra metadata about the skipping reason - such as a certain condition not met, etc.
2039
+ */
2040
+ payload?: {
2041
+ [name: string]: any;
2042
+ };
2043
+ };
2044
+ /**
2045
+ * Condition Id to be checked before executing the action
2046
+ */
2047
+ condition_id?: string;
2048
+ /**
2049
+ * Schedule Id which indicates the schedule of the action
2050
+ */
2051
+ schedule_id?: string;
2052
+ }
2053
+ export interface InformERPConfig {
2054
+ entity_sources?: string[];
2055
+ target_webhook_id?: string;
2056
+ /**
2057
+ * Whether to wait for the request to finish before continuing automation execution
2058
+ */
2059
+ sync?: boolean;
2060
+ }
1825
2061
  /**
1826
2062
  * Job ID for tracking the status of bulk trigger automation executions
1827
2063
  * example:
@@ -3294,6 +3530,7 @@ declare namespace Paths {
3294
3530
  }
3295
3531
  }
3296
3532
 
3533
+
3297
3534
  export interface OperationMethods {
3298
3535
  /**
3299
3536
  * searchFlows - searchFlows
@@ -3608,12 +3845,12 @@ export interface PathsDictionary {
3608
3845
 
3609
3846
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
3610
3847
 
3848
+
3611
3849
  export type ActionCondition = Components.Schemas.ActionCondition;
3612
3850
  export type ActionSchedule = Components.Schemas.ActionSchedule;
3613
3851
  export type ActionScheduleSource = Components.Schemas.ActionScheduleSource;
3614
3852
  export type ActivityId = Components.Schemas.ActivityId;
3615
3853
  export type ActivityTrigger = Components.Schemas.ActivityTrigger;
3616
- export type AdvancedCustomActionConfig = Components.Schemas.AdvancedCustomActionConfig;
3617
3854
  export type AnyAction = Components.Schemas.AnyAction;
3618
3855
  export type AnyActionConfig = Components.Schemas.AnyActionConfig;
3619
3856
  export type AnyTrigger = Components.Schemas.AnyTrigger;
@@ -3631,8 +3868,6 @@ export type AutomationExecutionId = Components.Schemas.AutomationExecutionId;
3631
3868
  export type AutomationFlow = Components.Schemas.AutomationFlow;
3632
3869
  export type AutomationFlowId = Components.Schemas.AutomationFlowId;
3633
3870
  export type AutomationTrigger = Components.Schemas.AutomationTrigger;
3634
- export type BaseCustomActionConfig = Components.Schemas.BaseCustomActionConfig;
3635
- export type BasicCustomActionConfig = Components.Schemas.BasicCustomActionConfig;
3636
3871
  export type BulkTriggerJob = Components.Schemas.BulkTriggerJob;
3637
3872
  export type BulkTriggerRequest = Components.Schemas.BulkTriggerRequest;
3638
3873
  export type CartCheckoutAction = Components.Schemas.CartCheckoutAction;
@@ -3645,7 +3880,6 @@ export type CreateDocumentAction = Components.Schemas.CreateDocumentAction;
3645
3880
  export type CreateDocumentActionConfig = Components.Schemas.CreateDocumentActionConfig;
3646
3881
  export type CreateDocumentConfig = Components.Schemas.CreateDocumentConfig;
3647
3882
  export type CustomAction = Components.Schemas.CustomAction;
3648
- export type CustomActionConfig = Components.Schemas.CustomActionConfig;
3649
3883
  export type DiffAdded = Components.Schemas.DiffAdded;
3650
3884
  export type DiffDeleted = Components.Schemas.DiffDeleted;
3651
3885
  export type DiffUpdated = Components.Schemas.DiffUpdated;
@@ -3655,6 +3889,8 @@ export type EntityManualTrigger = Components.Schemas.EntityManualTrigger;
3655
3889
  export type EntityOperation = Components.Schemas.EntityOperation;
3656
3890
  export type EntityOperationTrigger = Components.Schemas.EntityOperationTrigger;
3657
3891
  export type EntityRef = Components.Schemas.EntityRef;
3892
+ export type EntitySearchFilter = Components.Schemas.EntitySearchFilter;
3893
+ export type EntitySearchFilterValue = Components.Schemas.EntitySearchFilterValue;
3658
3894
  export type EqualsIgnoreCaseCondition = Components.Schemas.EqualsIgnoreCaseCondition;
3659
3895
  export type ErrorCode = Components.Schemas.ErrorCode;
3660
3896
  export type ErrorDetail = Components.Schemas.ErrorDetail;
@@ -3667,6 +3903,9 @@ export type FilterConditionOnEvent = Components.Schemas.FilterConditionOnEvent;
3667
3903
  export type FlowsTrigger = Components.Schemas.FlowsTrigger;
3668
3904
  export type FrontendSubmitTrigger = Components.Schemas.FrontendSubmitTrigger;
3669
3905
  export type GetExecutionsResp = Components.Schemas.GetExecutionsResp;
3906
+ export type InformERPAction = Components.Schemas.InformERPAction;
3907
+ export type InformERPActionConfig = Components.Schemas.InformERPActionConfig;
3908
+ export type InformERPConfig = Components.Schemas.InformERPConfig;
3670
3909
  export type JobId = Components.Schemas.JobId;
3671
3910
  export type JourneySubmitTrigger = Components.Schemas.JourneySubmitTrigger;
3672
3911
  export type MapEntityAction = Components.Schemas.MapEntityAction;
package/dist/openapi.json CHANGED
@@ -330,9 +330,15 @@
330
330
  },
331
331
  "example": {
332
332
  "flow_id": "8e2e067e-3c63-4b1a-8e02-6150a3d1fd89",
333
- "entity_ids": [
334
- "7791b04a-16d2-44a2-9af9-2d59c25c512f",
335
- "b35a6c51-2a15-4ef1-9623-20db37b0744f"
333
+ "entities_refs": [
334
+ {
335
+ "entity_schema": "opportunity",
336
+ "entity_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f"
337
+ },
338
+ {
339
+ "entity_schema": "opportunity",
340
+ "entity_id": "b35a6c51-2a15-4ef1-9623-20db37b0744f"
341
+ }
336
342
  ]
337
343
  }
338
344
  }
@@ -662,6 +668,10 @@
662
668
  "user"
663
669
  ],
664
670
  "description": "Who disabled the flow (system or user)"
671
+ },
672
+ "blame": {
673
+ "type": "string",
674
+ "description": "The 360 user email that disabled the flow"
665
675
  }
666
676
  },
667
677
  "required": [
@@ -839,6 +849,9 @@
839
849
  {
840
850
  "$ref": "#/components/schemas/TriggerWebhookAction"
841
851
  },
852
+ {
853
+ "$ref": "#/components/schemas/InformERPAction"
854
+ },
842
855
  {
843
856
  "$ref": "#/components/schemas/CreateDocumentAction"
844
857
  },
@@ -867,6 +880,9 @@
867
880
  {
868
881
  "$ref": "#/components/schemas/TriggerWebhookActionConfig"
869
882
  },
883
+ {
884
+ "$ref": "#/components/schemas/InformERPActionConfig"
885
+ },
870
886
  {
871
887
  "$ref": "#/components/schemas/CreateDocumentActionConfig"
872
888
  },
@@ -877,7 +893,7 @@
877
893
  "$ref": "#/components/schemas/CartCheckoutActionConfig"
878
894
  },
879
895
  {
880
- "$ref": "#/components/schemas/CustomActionConfig"
896
+ "$ref": "#/components/schemas/CustomAction"
881
897
  },
882
898
  {
883
899
  "$ref": "#/components/schemas/AutomationActionConfig"
@@ -2008,33 +2024,10 @@
2008
2024
  }
2009
2025
  ]
2010
2026
  },
2011
- "BaseCustomActionConfig": {
2012
- "type": "object",
2013
- "properties": {
2014
- "name": {
2015
- "type": "string",
2016
- "description": "Name of the custom action"
2017
- },
2018
- "description": {
2019
- "type": "string",
2020
- "description": "Description of the custom action"
2021
- },
2022
- "app_id": {
2023
- "type": "string",
2024
- "description": "The ID of the app to fetch configuration from the app API",
2025
- "example": "c451c26a-cc7a-4c1c-92bf-1c6246cbfe88"
2026
- },
2027
- "component_id": {
2028
- "type": "string",
2029
- "description": "The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component",
2030
- "example": "2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88"
2031
- }
2032
- }
2033
- },
2034
- "BasicCustomActionConfig": {
2027
+ "CustomAction": {
2035
2028
  "allOf": [
2036
2029
  {
2037
- "$ref": "#/components/schemas/BaseCustomActionConfig"
2030
+ "$ref": "#/components/schemas/AutomationAction"
2038
2031
  },
2039
2032
  {
2040
2033
  "type": "object",
@@ -2042,59 +2035,39 @@
2042
2035
  "type": {
2043
2036
  "type": "string",
2044
2037
  "enum": [
2045
- "basic"
2038
+ "custom-action"
2046
2039
  ]
2047
2040
  },
2048
- "basic_settings": {
2041
+ "config": {
2049
2042
  "type": "object",
2050
2043
  "properties": {
2051
- "url": {
2044
+ "name": {
2052
2045
  "type": "string",
2053
- "description": "URL to call"
2046
+ "description": "The name of the custom action",
2047
+ "example": "Credit Check"
2054
2048
  },
2055
- "headers": {
2056
- "type": "object",
2057
- "additionalProperties": true
2049
+ "description": {
2050
+ "type": "string",
2051
+ "description": "The description of the custom action",
2052
+ "example": "Check if the customer has a credit limit"
2053
+ },
2054
+ "app_id": {
2055
+ "type": "string",
2056
+ "description": "The ID of the app to fetch configuration from the app API",
2057
+ "example": "c451c26a-cc7a-4c1c-92bf-1c6246cbfe88"
2058
2058
  },
2059
- "auth_token_ref": {
2059
+ "component_id": {
2060
2060
  "type": "string",
2061
- "description": "SSM Reference to the auth token to use for the request"
2061
+ "description": "The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component",
2062
+ "example": "2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88"
2062
2063
  }
2063
2064
  }
2064
2065
  }
2065
- },
2066
- "required": [
2067
- "type"
2068
- ]
2069
- }
2070
- ]
2071
- },
2072
- "AdvancedCustomActionConfig": {
2073
- "allOf": [
2074
- {
2075
- "$ref": "#/components/schemas/BaseCustomActionConfig"
2076
- },
2077
- {
2078
- "type": "object",
2079
- "properties": {
2080
- "type": {
2081
- "type": "string",
2082
- "enum": [
2083
- "advanced"
2084
- ]
2085
- },
2086
- "advanced_settings": {
2087
- "type": "object",
2088
- "additionalProperties": true
2089
- }
2090
- },
2091
- "required": [
2092
- "type"
2093
- ]
2066
+ }
2094
2067
  }
2095
2068
  ]
2096
2069
  },
2097
- "CustomActionConfig": {
2070
+ "TriggerWebhookActionConfig": {
2098
2071
  "allOf": [
2099
2072
  {
2100
2073
  "$ref": "#/components/schemas/AutomationActionConfig"
@@ -2103,33 +2076,30 @@
2103
2076
  "type": "object",
2104
2077
  "properties": {
2105
2078
  "type": {
2106
- "type": "string",
2107
2079
  "enum": [
2108
- "custom-action"
2080
+ "trigger-webhook"
2109
2081
  ]
2110
2082
  },
2111
2083
  "config": {
2112
- "oneOf": [
2113
- {
2114
- "$ref": "#/components/schemas/BasicCustomActionConfig"
2115
- },
2116
- {
2117
- "$ref": "#/components/schemas/AdvancedCustomActionConfig"
2118
- }
2119
- ],
2120
- "discriminator": {
2121
- "propertyName": "type",
2122
- "mapping": {
2123
- "basic": "#/components/schemas/BasicCustomActionConfig",
2124
- "advanced": "#/components/schemas/AdvancedCustomActionConfig"
2125
- }
2126
- }
2084
+ "$ref": "#/components/schemas/TriggerWebhookConfig"
2127
2085
  }
2128
2086
  }
2129
2087
  }
2130
- ]
2088
+ ],
2089
+ "example": {
2090
+ "id": "2520gja-2sgmsaga-0asg-822jgal",
2091
+ "name": "Trigger Webhook",
2092
+ "type": "trigger-webhook",
2093
+ "config": {
2094
+ "entity_sources": [
2095
+ "contact",
2096
+ "account"
2097
+ ],
2098
+ "target_webhook_id": "25jg9ag2ga"
2099
+ }
2100
+ }
2131
2101
  },
2132
- "CustomAction": {
2102
+ "TriggerWebhookAction": {
2133
2103
  "allOf": [
2134
2104
  {
2135
2105
  "$ref": "#/components/schemas/AutomationAction"
@@ -2138,33 +2108,37 @@
2138
2108
  "type": "object",
2139
2109
  "properties": {
2140
2110
  "type": {
2141
- "type": "string",
2142
2111
  "enum": [
2143
- "custom-action"
2112
+ "trigger-webhook"
2144
2113
  ]
2145
2114
  },
2146
2115
  "config": {
2147
- "oneOf": [
2148
- {
2149
- "$ref": "#/components/schemas/BasicCustomActionConfig"
2150
- },
2151
- {
2152
- "$ref": "#/components/schemas/AdvancedCustomActionConfig"
2153
- }
2154
- ],
2155
- "discriminator": {
2156
- "propertyName": "type",
2157
- "mapping": {
2158
- "basic": "#/components/schemas/BasicCustomActionConfig",
2159
- "advanced": "#/components/schemas/AdvancedCustomActionConfig"
2160
- }
2161
- }
2116
+ "$ref": "#/components/schemas/TriggerWebhookConfig"
2162
2117
  }
2163
2118
  }
2164
2119
  }
2165
2120
  ]
2166
2121
  },
2167
- "TriggerWebhookActionConfig": {
2122
+ "TriggerWebhookConfig": {
2123
+ "type": "object",
2124
+ "properties": {
2125
+ "entity_sources": {
2126
+ "type": "array",
2127
+ "items": {
2128
+ "type": "string"
2129
+ }
2130
+ },
2131
+ "target_webhook_id": {
2132
+ "type": "string"
2133
+ },
2134
+ "sync": {
2135
+ "type": "boolean",
2136
+ "description": "Whether to wait for the request to finish before continuing automation execution",
2137
+ "default": false
2138
+ }
2139
+ }
2140
+ },
2141
+ "InformERPActionConfig": {
2168
2142
  "allOf": [
2169
2143
  {
2170
2144
  "$ref": "#/components/schemas/AutomationActionConfig"
@@ -2178,15 +2152,15 @@
2178
2152
  ]
2179
2153
  },
2180
2154
  "config": {
2181
- "$ref": "#/components/schemas/TriggerWebhookConfig"
2155
+ "$ref": "#/components/schemas/InformERPConfig"
2182
2156
  }
2183
2157
  }
2184
2158
  }
2185
2159
  ],
2186
2160
  "example": {
2187
2161
  "id": "2520gja-2sgmsaga-0asg-822jgal",
2188
- "name": "Trigger Webhook",
2189
- "type": "trigger-webhook",
2162
+ "name": "Inform ERP",
2163
+ "type": "inform-erp",
2190
2164
  "config": {
2191
2165
  "entity_sources": [
2192
2166
  "contact",
@@ -2196,7 +2170,7 @@
2196
2170
  }
2197
2171
  }
2198
2172
  },
2199
- "TriggerWebhookAction": {
2173
+ "InformERPAction": {
2200
2174
  "allOf": [
2201
2175
  {
2202
2176
  "$ref": "#/components/schemas/AutomationAction"
@@ -2210,13 +2184,13 @@
2210
2184
  ]
2211
2185
  },
2212
2186
  "config": {
2213
- "$ref": "#/components/schemas/TriggerWebhookConfig"
2187
+ "$ref": "#/components/schemas/InformERPConfig"
2214
2188
  }
2215
2189
  }
2216
2190
  }
2217
2191
  ]
2218
2192
  },
2219
- "TriggerWebhookConfig": {
2193
+ "InformERPConfig": {
2220
2194
  "type": "object",
2221
2195
  "properties": {
2222
2196
  "entity_sources": {
@@ -2746,23 +2720,58 @@
2746
2720
  ]
2747
2721
  },
2748
2722
  "BulkTriggerRequest": {
2749
- "type": "object",
2750
- "properties": {
2751
- "flow_id": {
2752
- "$ref": "#/components/schemas/AutomationFlowId"
2723
+ "oneOf": [
2724
+ {
2725
+ "type": "object",
2726
+ "properties": {
2727
+ "flow_id": {
2728
+ "$ref": "#/components/schemas/AutomationFlowId"
2729
+ },
2730
+ "entities_refs": {
2731
+ "type": "array",
2732
+ "items": {
2733
+ "$ref": "#/components/schemas/EntityRef"
2734
+ }
2735
+ }
2736
+ },
2737
+ "required": [
2738
+ "flow_id",
2739
+ "entities_refs"
2740
+ ],
2741
+ "additionalProperties": false
2753
2742
  },
2754
- "entities_refs": {
2755
- "type": "array",
2756
- "items": {
2757
- "$ref": "#/components/schemas/EntityRef"
2758
- }
2743
+ {
2744
+ "type": "object",
2745
+ "properties": {
2746
+ "flow_id": {
2747
+ "$ref": "#/components/schemas/AutomationFlowId"
2748
+ },
2749
+ "entities_query": {
2750
+ "type": "string"
2751
+ }
2752
+ },
2753
+ "required": [
2754
+ "flow_id",
2755
+ "entities_query"
2756
+ ],
2757
+ "additionalProperties": false
2759
2758
  },
2760
- "entities_query": {
2761
- "type": "string"
2759
+ {
2760
+ "type": "object",
2761
+ "properties": {
2762
+ "flow_id": {
2763
+ "$ref": "#/components/schemas/AutomationFlowId"
2764
+ },
2765
+ "entities_filter": {
2766
+ "$ref": "#/components/schemas/EntitySearchFilter"
2767
+ }
2768
+ },
2769
+ "required": [
2770
+ "flow_id",
2771
+ "entities_filter"
2772
+ ],
2773
+ "additionalProperties": false
2762
2774
  }
2763
- },
2764
- "required": [
2765
- "flow_id"
2766
2775
  ]
2767
2776
  },
2768
2777
  "EntityRef": {
@@ -3279,7 +3288,180 @@
3279
3288
  "enum": [
3280
3289
  "createEntity",
3281
3290
  "updateEntity",
3282
- "deleteEntity"
3291
+ "deleteEntity",
3292
+ "softDeleteEntity",
3293
+ "restoreEntity"
3294
+ ]
3295
+ },
3296
+ "EntitySearchFilter": {
3297
+ "type": "array",
3298
+ "description": "A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.",
3299
+ "items": {
3300
+ "type": "object",
3301
+ "minProperties": 1,
3302
+ "maxProperties": 1,
3303
+ "properties": {
3304
+ "term": {
3305
+ "description": "Returns documents that contain an exact term in a provided field.\n\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.\n\nYou likely DO NOT want to use this filter on text fields and want to target its .keyword instead.\n",
3306
+ "externalDocs": {
3307
+ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html"
3308
+ },
3309
+ "type": "object",
3310
+ "minProperties": 1,
3311
+ "maxProperties": 1,
3312
+ "additionalProperties": {
3313
+ "$ref": "#/components/schemas/EntitySearchFilterValue"
3314
+ },
3315
+ "example": {
3316
+ "_schema": "contact"
3317
+ }
3318
+ },
3319
+ "terms": {
3320
+ "description": "Returns documents that contain one of the exact terms in a provided field. See term filter for more info.",
3321
+ "externalDocs": {
3322
+ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html"
3323
+ },
3324
+ "type": "object",
3325
+ "minProperties": 1,
3326
+ "maxProperties": 1,
3327
+ "additionalProperties": {
3328
+ "type": "array",
3329
+ "items": {
3330
+ "$ref": "#/components/schemas/EntitySearchFilterValue"
3331
+ }
3332
+ },
3333
+ "example": {
3334
+ "status": [
3335
+ "active"
3336
+ ]
3337
+ }
3338
+ },
3339
+ "ids": {
3340
+ "description": "Returns documents based on their IDs.",
3341
+ "externalDocs": {
3342
+ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html"
3343
+ },
3344
+ "type": "object",
3345
+ "properties": {
3346
+ "values": {
3347
+ "type": "array",
3348
+ "items": {
3349
+ "type": "string"
3350
+ }
3351
+ }
3352
+ },
3353
+ "example": {
3354
+ "values": [
3355
+ "550e8400-e29b-41d4-a716-446655440000"
3356
+ ]
3357
+ }
3358
+ },
3359
+ "range": {
3360
+ "description": "Returns documents with fields that have terms within a certain range.",
3361
+ "externalDocs": {
3362
+ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html"
3363
+ },
3364
+ "type": "object",
3365
+ "minProperties": 1,
3366
+ "maxProperties": 1,
3367
+ "additionalProperties": {
3368
+ "type": "object",
3369
+ "properties": {
3370
+ "gt": {
3371
+ "$ref": "#/components/schemas/EntitySearchFilterValue"
3372
+ },
3373
+ "gte": {
3374
+ "$ref": "#/components/schemas/EntitySearchFilterValue"
3375
+ },
3376
+ "lt": {
3377
+ "$ref": "#/components/schemas/EntitySearchFilterValue"
3378
+ },
3379
+ "lte": {
3380
+ "$ref": "#/components/schemas/EntitySearchFilterValue"
3381
+ },
3382
+ "format": {
3383
+ "type": "string",
3384
+ "description": "The date format used to parse date values."
3385
+ },
3386
+ "relation": {
3387
+ "type": "string",
3388
+ "enum": [
3389
+ "INTERSECTS",
3390
+ "CONTAINS",
3391
+ "WITHIN"
3392
+ ],
3393
+ "description": "Indicates how the range query matches values for range fields."
3394
+ },
3395
+ "time_zone": {
3396
+ "type": "string",
3397
+ "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC."
3398
+ }
3399
+ }
3400
+ },
3401
+ "example": {
3402
+ "_created_at": {
3403
+ "gte": "2021-01-01T00:00:00.000Z",
3404
+ "lte": "2021-01-31T23:59:59.999Z"
3405
+ }
3406
+ }
3407
+ },
3408
+ "exists": {
3409
+ "description": "Returns documents that have a value in the specified field.",
3410
+ "externalDocs": {
3411
+ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html"
3412
+ },
3413
+ "type": "object",
3414
+ "properties": {
3415
+ "field": {
3416
+ "type": "string"
3417
+ }
3418
+ },
3419
+ "required": [
3420
+ "field"
3421
+ ],
3422
+ "example": {
3423
+ "field": "_tags"
3424
+ }
3425
+ },
3426
+ "$and": {
3427
+ "$ref": "#/components/schemas/EntitySearchFilter"
3428
+ },
3429
+ "$or": {
3430
+ "$ref": "#/components/schemas/EntitySearchFilter"
3431
+ },
3432
+ "$not": {
3433
+ "$ref": "#/components/schemas/EntitySearchFilter"
3434
+ }
3435
+ }
3436
+ },
3437
+ "example": [
3438
+ {
3439
+ "term": {
3440
+ "_schema": "contact"
3441
+ }
3442
+ },
3443
+ {
3444
+ "terms": {
3445
+ "status": [
3446
+ "active"
3447
+ ]
3448
+ }
3449
+ }
3450
+ ]
3451
+ },
3452
+ "EntitySearchFilterValue": {
3453
+ "description": "A filter field value.",
3454
+ "oneOf": [
3455
+ {
3456
+ "type": "string",
3457
+ "nullable": true
3458
+ },
3459
+ {
3460
+ "type": "number"
3461
+ },
3462
+ {
3463
+ "type": "boolean"
3464
+ }
3283
3465
  ]
3284
3466
  },
3285
3467
  "EntityManualTrigger": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/automation-client",
3
- "version": "2.16.2",
3
+ "version": "2.16.5-rc.1",
4
4
  "description": "Client library for epilot automation API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -66,7 +66,7 @@
66
66
  "json-loader": "^0.5.7",
67
67
  "node-fetch": "^3.2.10",
68
68
  "openapi-client-axios": "^7.5.1",
69
- "openapicmd": "^2.6.0",
69
+ "openapicmd": "^2.6.2",
70
70
  "ts-jest": "^26.5.0",
71
71
  "ts-loader": "^8.0.14",
72
72
  "ts-node": "^10.9.1",