@epilot/automation-client 2.17.2 → 2.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/openapi.d.ts +61 -5
- package/dist/openapi.json +71 -5
- package/package.json +2 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -924,15 +924,17 @@ declare namespace Components {
|
|
|
924
924
|
/**
|
|
925
925
|
* Status of the bulk trigger automation job
|
|
926
926
|
* * approval: Waiting for user approval to start the bulk trigger automation
|
|
927
|
-
* *
|
|
928
|
-
* *
|
|
927
|
+
* * querying_entities: Loading entities in batches
|
|
928
|
+
* * entities_loaded: All entities have been loaded and stored
|
|
929
|
+
* * executing: Automation execution are currently running
|
|
930
|
+
* * monitoring: All executions have been started, now monitoring their completion
|
|
929
931
|
* * send_report: Automation executions finished running. Report is being created & sent to the user who initiated the bulk trigger automation
|
|
930
932
|
* * finished: Automation executions finished running. Some may have failed. Check the status of each entity.
|
|
931
933
|
* * failed: Bulk trigger automation execution failed. Some executions might have started. Check the status of each entity.
|
|
932
934
|
* * cancelled: Bulk trigger automation execution was cancelled
|
|
933
935
|
*
|
|
934
936
|
*/
|
|
935
|
-
status: "approval" | "
|
|
937
|
+
status: "approval" | "querying_entities" | "entities_loaded" | "executing" | "monitoring" | "send_report" | "finished" | "failed" | "cancelled";
|
|
936
938
|
/**
|
|
937
939
|
* User ID who created the bulk trigger automation job
|
|
938
940
|
* example:
|
|
@@ -955,10 +957,64 @@ declare namespace Components {
|
|
|
955
957
|
* Entity ID of the report file entity
|
|
956
958
|
*/
|
|
957
959
|
report_file_entity_id?: string;
|
|
960
|
+
/**
|
|
961
|
+
* Query configuration for loading entities
|
|
962
|
+
*/
|
|
963
|
+
entity_query?: {
|
|
964
|
+
type: "refs" | "query" | "filter";
|
|
965
|
+
data: EntityRef[] | string | /**
|
|
966
|
+
* 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.
|
|
967
|
+
* example:
|
|
968
|
+
* [
|
|
969
|
+
* {
|
|
970
|
+
* "term": {
|
|
971
|
+
* "_schema": "contact"
|
|
972
|
+
* }
|
|
973
|
+
* },
|
|
974
|
+
* {
|
|
975
|
+
* "terms": {
|
|
976
|
+
* "status": [
|
|
977
|
+
* "active"
|
|
978
|
+
* ]
|
|
979
|
+
* }
|
|
980
|
+
* }
|
|
981
|
+
* ]
|
|
982
|
+
*/
|
|
983
|
+
EntitySearchFilter;
|
|
984
|
+
};
|
|
985
|
+
/**
|
|
986
|
+
* Pagination state for entity loading
|
|
987
|
+
*/
|
|
988
|
+
pagination_state?: {
|
|
989
|
+
/**
|
|
990
|
+
* Number of entities per page
|
|
991
|
+
*/
|
|
992
|
+
page_size?: number;
|
|
993
|
+
/**
|
|
994
|
+
* Number of pages processed so far
|
|
995
|
+
*/
|
|
996
|
+
pages_processed?: number;
|
|
997
|
+
/**
|
|
998
|
+
* Total number of entities processed so far
|
|
999
|
+
*/
|
|
1000
|
+
total_processed?: number;
|
|
1001
|
+
/**
|
|
1002
|
+
* Stable query ID for pagination
|
|
1003
|
+
*/
|
|
1004
|
+
stable_query_id?: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* Last sort value used for pagination
|
|
1007
|
+
*/
|
|
1008
|
+
search_after?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* Whether there are more entities to load
|
|
1011
|
+
*/
|
|
1012
|
+
has_more?: boolean;
|
|
1013
|
+
};
|
|
958
1014
|
/**
|
|
959
1015
|
* List of entities & their automation execution id & status
|
|
960
1016
|
*/
|
|
961
|
-
execution_summary
|
|
1017
|
+
execution_summary?: /* Execution item for bulk trigger automation. It maps each entity to its automation execution id & status */ ExecItem[];
|
|
962
1018
|
}
|
|
963
1019
|
export type BulkTriggerRequest = {
|
|
964
1020
|
flow_id: /**
|
|
@@ -1888,7 +1944,7 @@ declare namespace Components {
|
|
|
1888
1944
|
*/
|
|
1889
1945
|
error?: string;
|
|
1890
1946
|
}
|
|
1891
|
-
export type ExecutionStatus = "pending" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot";
|
|
1947
|
+
export type ExecutionStatus = "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot";
|
|
1892
1948
|
export interface ExistsCondition {
|
|
1893
1949
|
exists?: boolean;
|
|
1894
1950
|
}
|
package/dist/openapi.json
CHANGED
|
@@ -2714,6 +2714,7 @@
|
|
|
2714
2714
|
"type": "string",
|
|
2715
2715
|
"enum": [
|
|
2716
2716
|
"pending",
|
|
2717
|
+
"starting",
|
|
2717
2718
|
"in_progress",
|
|
2718
2719
|
"paused",
|
|
2719
2720
|
"success",
|
|
@@ -2855,8 +2856,7 @@
|
|
|
2855
2856
|
"status",
|
|
2856
2857
|
"created_by",
|
|
2857
2858
|
"created_at",
|
|
2858
|
-
"updated_at"
|
|
2859
|
-
"execution_summary"
|
|
2859
|
+
"updated_at"
|
|
2860
2860
|
],
|
|
2861
2861
|
"properties": {
|
|
2862
2862
|
"job_id": {
|
|
@@ -2870,11 +2870,13 @@
|
|
|
2870
2870
|
},
|
|
2871
2871
|
"status": {
|
|
2872
2872
|
"type": "string",
|
|
2873
|
-
"description": "Status of the bulk trigger automation job\n* approval: Waiting for user approval to start the bulk trigger automation\n*
|
|
2873
|
+
"description": "Status of the bulk trigger automation job\n* approval: Waiting for user approval to start the bulk trigger automation\n* querying_entities: Loading entities in batches\n* entities_loaded: All entities have been loaded and stored\n* executing: Automation execution are currently running\n* monitoring: All executions have been started, now monitoring their completion\n* send_report: Automation executions finished running. Report is being created & sent to the user who initiated the bulk trigger automation\n* finished: Automation executions finished running. Some may have failed. Check the status of each entity.\n* failed: Bulk trigger automation execution failed. Some executions might have started. Check the status of each entity.\n* cancelled: Bulk trigger automation execution was cancelled\n",
|
|
2874
2874
|
"enum": [
|
|
2875
2875
|
"approval",
|
|
2876
|
-
"
|
|
2877
|
-
"
|
|
2876
|
+
"querying_entities",
|
|
2877
|
+
"entities_loaded",
|
|
2878
|
+
"executing",
|
|
2879
|
+
"monitoring",
|
|
2878
2880
|
"send_report",
|
|
2879
2881
|
"finished",
|
|
2880
2882
|
"failed",
|
|
@@ -2908,6 +2910,70 @@
|
|
|
2908
2910
|
"type": "string",
|
|
2909
2911
|
"description": "Entity ID of the report file entity"
|
|
2910
2912
|
},
|
|
2913
|
+
"entity_query": {
|
|
2914
|
+
"type": "object",
|
|
2915
|
+
"description": "Query configuration for loading entities",
|
|
2916
|
+
"properties": {
|
|
2917
|
+
"type": {
|
|
2918
|
+
"type": "string",
|
|
2919
|
+
"enum": [
|
|
2920
|
+
"refs",
|
|
2921
|
+
"query",
|
|
2922
|
+
"filter"
|
|
2923
|
+
]
|
|
2924
|
+
},
|
|
2925
|
+
"data": {
|
|
2926
|
+
"oneOf": [
|
|
2927
|
+
{
|
|
2928
|
+
"type": "array",
|
|
2929
|
+
"items": {
|
|
2930
|
+
"$ref": "#/components/schemas/EntityRef"
|
|
2931
|
+
}
|
|
2932
|
+
},
|
|
2933
|
+
{
|
|
2934
|
+
"type": "string"
|
|
2935
|
+
},
|
|
2936
|
+
{
|
|
2937
|
+
"$ref": "#/components/schemas/EntitySearchFilter"
|
|
2938
|
+
}
|
|
2939
|
+
]
|
|
2940
|
+
}
|
|
2941
|
+
},
|
|
2942
|
+
"required": [
|
|
2943
|
+
"type",
|
|
2944
|
+
"data"
|
|
2945
|
+
]
|
|
2946
|
+
},
|
|
2947
|
+
"pagination_state": {
|
|
2948
|
+
"type": "object",
|
|
2949
|
+
"description": "Pagination state for entity loading",
|
|
2950
|
+
"properties": {
|
|
2951
|
+
"page_size": {
|
|
2952
|
+
"type": "integer",
|
|
2953
|
+
"description": "Number of entities per page"
|
|
2954
|
+
},
|
|
2955
|
+
"pages_processed": {
|
|
2956
|
+
"type": "integer",
|
|
2957
|
+
"description": "Number of pages processed so far"
|
|
2958
|
+
},
|
|
2959
|
+
"total_processed": {
|
|
2960
|
+
"type": "integer",
|
|
2961
|
+
"description": "Total number of entities processed so far"
|
|
2962
|
+
},
|
|
2963
|
+
"stable_query_id": {
|
|
2964
|
+
"type": "string",
|
|
2965
|
+
"description": "Stable query ID for pagination"
|
|
2966
|
+
},
|
|
2967
|
+
"search_after": {
|
|
2968
|
+
"type": "string",
|
|
2969
|
+
"description": "Last sort value used for pagination"
|
|
2970
|
+
},
|
|
2971
|
+
"has_more": {
|
|
2972
|
+
"type": "boolean",
|
|
2973
|
+
"description": "Whether there are more entities to load"
|
|
2974
|
+
}
|
|
2975
|
+
}
|
|
2976
|
+
},
|
|
2911
2977
|
"execution_summary": {
|
|
2912
2978
|
"type": "array",
|
|
2913
2979
|
"description": "List of entities & their automation execution id & status",
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/automation-client",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.18.0",
|
|
4
4
|
"description": "Client library for epilot automation API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"author": "epilot GmbH",
|
|
8
8
|
"license": "MIT",
|
|
9
|
+
"private": false,
|
|
9
10
|
"repository": {
|
|
10
11
|
"type": "git",
|
|
11
12
|
"url": "git+https://github.com/epilot-dev/sdk-js.git",
|