@datocms/cma-client 3.3.5 → 3.3.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/generated/Client.js +1 -1
- package/dist/cjs/generated/resources/Webhook.js +2 -0
- package/dist/cjs/generated/resources/Webhook.js.map +1 -1
- package/dist/cjs/generated/resources/WebhookCall.js +27 -0
- package/dist/cjs/generated/resources/WebhookCall.js.map +1 -1
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +125 -26
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +153 -35
- package/dist/esm/generated/resources/Webhook.js +2 -0
- package/dist/esm/generated/resources/Webhook.js.map +1 -1
- package/dist/esm/generated/resources/WebhookCall.d.ts +18 -0
- package/dist/esm/generated/resources/WebhookCall.js +27 -0
- package/dist/esm/generated/resources/WebhookCall.js.map +1 -1
- package/dist/types/generated/SchemaTypes.d.ts +125 -26
- package/dist/types/generated/SimpleSchemaTypes.d.ts +153 -35
- package/dist/types/generated/resources/WebhookCall.d.ts +18 -0
- package/package.json +12 -5
- package/resources.json +29 -2
- package/src/generated/Client.ts +1 -1
- package/src/generated/SchemaTypes.ts +255 -28
- package/src/generated/SimpleSchemaTypes.ts +328 -38
- package/src/generated/resources/Webhook.ts +2 -0
- package/src/generated/resources/WebhookCall.ts +33 -0
|
@@ -130,7 +130,7 @@ var Client = /** @class */ (function () {
|
|
|
130
130
|
});
|
|
131
131
|
Client.prototype.request = function (options) {
|
|
132
132
|
var _this = this;
|
|
133
|
-
return (0, rest_client_utils_1.request)(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.3.
|
|
133
|
+
return (0, rest_client_utils_1.request)(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.3.7', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
|
|
134
134
|
? { 'X-Environment': this.config.environment }
|
|
135
135
|
: {})), { 'X-API-Version': '3' }), fetchJobResult: function (jobId) {
|
|
136
136
|
return _this.jobResultsFetcher
|
|
@@ -70,6 +70,7 @@ var Webhook = /** @class */ (function (_super) {
|
|
|
70
70
|
'enabled',
|
|
71
71
|
'payload_api_version',
|
|
72
72
|
'nested_items_in_payload',
|
|
73
|
+
'auto_retry',
|
|
73
74
|
],
|
|
74
75
|
relationships: [],
|
|
75
76
|
})).then(function (body) {
|
|
@@ -114,6 +115,7 @@ var Webhook = /** @class */ (function (_super) {
|
|
|
114
115
|
'enabled',
|
|
115
116
|
'payload_api_version',
|
|
116
117
|
'nested_items_in_payload',
|
|
118
|
+
'auto_retry',
|
|
117
119
|
],
|
|
118
120
|
relationships: [],
|
|
119
121
|
})).then(function (body) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Webhook.js","sourceRoot":"","sources":["../../../../src/generated/resources/Webhook.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAAoD;AACpD,oEAA8C;AAI9C;IAAqC,2BAAY;IAAjD;;
|
|
1
|
+
{"version":3,"file":"Webhook.js","sourceRoot":"","sources":["../../../../src/generated/resources/Webhook.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAAoD;AACpD,oEAA8C;AAI9C;IAAqC,2BAAY;IAAjD;;IA+MA,CAAC;IA5MC;;;;;;;OAOG;IACH,wBAAM,GAAN,UAAO,IAA2C;QAChD,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAAkC,IAAI,EAAE;YAChE,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACV,MAAM;gBACN,KAAK;gBACL,gBAAgB;gBAChB,SAAS;gBACT,QAAQ;gBACR,iBAAiB;gBACjB,qBAAqB;gBACrB,SAAS;gBACT,qBAAqB;gBACrB,yBAAyB;gBACzB,YAAY;aACb;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,UAAC,IAAI;YACV,OAAA,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL;QAFD,CAEC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,2BAAS,GAAT,UACE,IAAqC;QAErC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,WAAW;YAChB,IAAI,MAAA;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,wBAAM,GAAN,UACE,SAAiD,EACjD,IAA2C;QAE3C,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EACrB,KAAK,CAAC,oBAAoB,CAAkC,IAAI,EAAE;YAChE,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACV,MAAM;gBACN,KAAK;gBACL,gBAAgB;gBAChB,SAAS;gBACT,QAAQ;gBACR,iBAAiB;gBACjB,qBAAqB;gBACrB,SAAS;gBACT,qBAAqB;gBACrB,yBAAyB;gBACzB,YAAY;aACb;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,UAAC,IAAI;YACV,OAAA,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL;QAFD,CAEC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,2BAAS,GAAT,UACE,SAAiB,EACjB,IAAqC;QAErC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,oBAAa,SAAS,CAAE;YAC7B,IAAI,MAAA;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,sBAAI,GAAJ;QACE,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,UAAC,IAAI;YAC9B,OAAA,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL;QAFD,CAEC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,yBAAO,GAAP;QACE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA2C;YACnE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,WAAW;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,sBAAI,GAAJ,UAAK,SAAiD;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI;YACnD,OAAA,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL;QAFD,CAEC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,yBAAO,GAAP,UAAQ,SAAiB;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAsC;YAC9D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,oBAAa,SAAS,CAAE;SAC9B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,yBAAO,GAAP,UAAQ,SAAiD;QACvD,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI;YACtD,OAAA,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL;QAFD,CAEC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,4BAAU,GAAV,UACE,SAAiB;QAEjB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAyC;YACjE,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,oBAAa,SAAS,CAAE;SAC9B,CAAC,CAAC;IACL,CAAC;IA7Me,YAAI,GAAG,SAAkB,CAAC;IA8M5C,cAAC;CAAA,AA/MD,CAAqC,sBAAY,GA+MhD;kBA/MoB,OAAO"}
|
|
@@ -209,6 +209,33 @@ var WebhookCall = /** @class */ (function (_super) {
|
|
|
209
209
|
return _this.rawList(__assign(__assign({}, queryParams), { page: page }));
|
|
210
210
|
}, iteratorOptions);
|
|
211
211
|
};
|
|
212
|
+
/**
|
|
213
|
+
* Retrieve a webhook call
|
|
214
|
+
*
|
|
215
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/self
|
|
216
|
+
*
|
|
217
|
+
* @throws {ApiError}
|
|
218
|
+
* @throws {TimeoutError}
|
|
219
|
+
*/
|
|
220
|
+
WebhookCall.prototype.find = function (webhookCallId) {
|
|
221
|
+
return this.rawFind(Utils.toId(webhookCallId)).then(function (body) {
|
|
222
|
+
return Utils.deserializeResponseBody(body);
|
|
223
|
+
});
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* Retrieve a webhook call
|
|
227
|
+
*
|
|
228
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/self
|
|
229
|
+
*
|
|
230
|
+
* @throws {ApiError}
|
|
231
|
+
* @throws {TimeoutError}
|
|
232
|
+
*/
|
|
233
|
+
WebhookCall.prototype.rawFind = function (webhookCallId) {
|
|
234
|
+
return this.client.request({
|
|
235
|
+
method: 'GET',
|
|
236
|
+
url: "/webhook_calls/".concat(webhookCallId),
|
|
237
|
+
});
|
|
238
|
+
};
|
|
212
239
|
/**
|
|
213
240
|
* Re-send the webhook call
|
|
214
241
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WebhookCall.js","sourceRoot":"","sources":["../../../../src/generated/resources/WebhookCall.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAAoD;AACpD,oEAA8C;AAI9C;IAAyC,+BAAY;IAArD;;
|
|
1
|
+
{"version":3,"file":"WebhookCall.js","sourceRoot":"","sources":["../../../../src/generated/resources/WebhookCall.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAAoD;AACpD,oEAA8C;AAI9C;IAAyC,+BAAY;IAArD;;IAuJA,CAAC;IApJC;;;;;;;OAOG;IACH,0BAAI,GAAJ,UAAK,WAA8D;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI;YACzC,OAAA,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL;QAFD,CAEC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,6BAAO,GAAP,UACE,WAAwD;QAExD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA+C;YACvE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,gBAAgB;YACrB,WAAW,aAAA;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,uCAAiB,GAAxB,UACE,WAGC,EACD,eAAuC;;;;;;;;mCAEX,KAAA,cAAA,IAAI,CAAC,oBAAoB,CACnD,WAAW,EACX,eAAe,CAChB,CAAA;;;;;wBAH2B,cAG3B;wBAH2B,WAG3B;;;;wBAHgB,OAAO,KAAA,CAAA;qDAIhB,KAAK,CAAC,qBAAqB,CAE/B,OAAO,CAAC;4BAFV,gCAEU;;wBAFV,SAEU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;KAEd;IAED;;;;;;;OAOG;IACH,0CAAoB,GAApB,UACE,WAGC,EACD,eAAuC;QALzC,iBAoBC;QAbC,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAExC,OAAO,KAAK,CAAC,eAAe,CAG1B;YACE,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,GAAG;SACd,EACD,UAAC,IAAwD;YACvD,OAAA,KAAI,CAAC,OAAO,uBAAM,WAAW,KAAE,IAAI,MAAA,IAAG;QAAtC,CAAsC,EACxC,eAAe,CAChB,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,0BAAI,GAAJ,UAAK,aAAyD;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI;YACvD,OAAA,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL;QAFD,CAEC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,6BAAO,GAAP,UACE,aAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA0C;YAClE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,yBAAkB,aAAa,CAAE;SACvC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,mCAAa,GAAb,UAAc,MAA2C;QACvD,OAAO,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACH,sCAAgB,GAAhB,UAAiB,MAAc;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO;YAC/B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,yBAAkB,MAAM,oBAAiB;SAC/C,CAAC,CAAC;IACL,CAAC;IArJe,gBAAI,GAAG,cAAuB,CAAC;IAsJjD,kBAAC;CAAA,AAvJD,CAAyC,sBAAY,GAuJpD;kBAvJoB,WAAW"}
|
|
@@ -104,7 +104,7 @@ var Client = /** @class */ (function () {
|
|
|
104
104
|
});
|
|
105
105
|
Client.prototype.request = function (options) {
|
|
106
106
|
var _this = this;
|
|
107
|
-
return request(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.3.
|
|
107
|
+
return request(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.3.7', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
|
|
108
108
|
? { 'X-Environment': this.config.environment }
|
|
109
109
|
: {})), { 'X-API-Version': '3' }), fetchJobResult: function (jobId) {
|
|
110
110
|
return _this.jobResultsFetcher
|
|
@@ -562,7 +562,6 @@ export type ItemInstancesHrefSchema = {
|
|
|
562
562
|
* The maximum number of entities to return (defaults to 30, maximum is 500)
|
|
563
563
|
*/
|
|
564
564
|
limit?: number;
|
|
565
|
-
[k: string]: unknown;
|
|
566
565
|
};
|
|
567
566
|
/**
|
|
568
567
|
* Fields used to order results. You **must** specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
|
|
@@ -685,7 +684,6 @@ export type ItemVersionInstancesHrefSchema = {
|
|
|
685
684
|
* The maximum number of entities to return (defaults to 15, maximum is 50)
|
|
686
685
|
*/
|
|
687
686
|
limit?: number;
|
|
688
|
-
[k: string]: unknown;
|
|
689
687
|
};
|
|
690
688
|
[k: string]: unknown;
|
|
691
689
|
};
|
|
@@ -838,7 +836,6 @@ export type UploadInstancesHrefSchema = {
|
|
|
838
836
|
* The maximum number of entities to return (defaults to 30, maximum is 500)
|
|
839
837
|
*/
|
|
840
838
|
limit?: number;
|
|
841
|
-
[k: string]: unknown;
|
|
842
839
|
};
|
|
843
840
|
[k: string]: unknown;
|
|
844
841
|
};
|
|
@@ -941,7 +938,6 @@ export type SearchResultInstancesHrefSchema = {
|
|
|
941
938
|
* The maximum number of entities to return (defaults to 20, maximum is 100)
|
|
942
939
|
*/
|
|
943
940
|
limit?: number;
|
|
944
|
-
[k: string]: unknown;
|
|
945
941
|
};
|
|
946
942
|
/**
|
|
947
943
|
* Attributes to filter search results
|
|
@@ -1064,8 +1060,55 @@ export type WebhookCallInstancesHrefSchema = {
|
|
|
1064
1060
|
* The maximum number of entities to return (defaults to 30, maximum is 500)
|
|
1065
1061
|
*/
|
|
1066
1062
|
limit?: number;
|
|
1067
|
-
[k: string]: unknown;
|
|
1068
1063
|
};
|
|
1064
|
+
/**
|
|
1065
|
+
* Attributes to filter
|
|
1066
|
+
*/
|
|
1067
|
+
filter?: {
|
|
1068
|
+
/**
|
|
1069
|
+
* IDs to fetch, comma separated
|
|
1070
|
+
*/
|
|
1071
|
+
ids?: string;
|
|
1072
|
+
fields?: {
|
|
1073
|
+
webhook_id?: {
|
|
1074
|
+
eq?: string;
|
|
1075
|
+
};
|
|
1076
|
+
entity_type?: {
|
|
1077
|
+
/**
|
|
1078
|
+
* The subject of webhook triggering
|
|
1079
|
+
*/
|
|
1080
|
+
eq?: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
|
|
1081
|
+
};
|
|
1082
|
+
event_type?: {
|
|
1083
|
+
/**
|
|
1084
|
+
* The event that triggers the webhook call
|
|
1085
|
+
*/
|
|
1086
|
+
eq?: 'create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate';
|
|
1087
|
+
};
|
|
1088
|
+
status?: {
|
|
1089
|
+
/**
|
|
1090
|
+
* The current status
|
|
1091
|
+
*/
|
|
1092
|
+
eq?: 'pending' | 'success' | 'failed' | 'rescheduled';
|
|
1093
|
+
};
|
|
1094
|
+
last_sent_at?: {
|
|
1095
|
+
gt?: string;
|
|
1096
|
+
lt?: string;
|
|
1097
|
+
};
|
|
1098
|
+
next_retry_at?: {
|
|
1099
|
+
gt?: string;
|
|
1100
|
+
lt?: string;
|
|
1101
|
+
};
|
|
1102
|
+
created_at?: {
|
|
1103
|
+
gt?: string;
|
|
1104
|
+
lt?: string;
|
|
1105
|
+
};
|
|
1106
|
+
};
|
|
1107
|
+
};
|
|
1108
|
+
/**
|
|
1109
|
+
* Fields used to order results
|
|
1110
|
+
*/
|
|
1111
|
+
order_by?: 'webhook_id_asc' | 'webhook_id_desc' | 'created_at_asc' | 'created_at_desc' | 'last_sent_at_asc' | 'last_sent_at_desc' | 'next_retry_at_asc' | 'next_retry_at_desc';
|
|
1069
1112
|
[k: string]: unknown;
|
|
1070
1113
|
};
|
|
1071
1114
|
/**
|
|
@@ -1281,7 +1324,6 @@ export type UploadTagInstancesHrefSchema = {
|
|
|
1281
1324
|
* The maximum number of entities to return (defaults to 50, maximum is 500)
|
|
1282
1325
|
*/
|
|
1283
1326
|
limit?: number;
|
|
1284
|
-
[k: string]: unknown;
|
|
1285
1327
|
};
|
|
1286
1328
|
[k: string]: unknown;
|
|
1287
1329
|
};
|
|
@@ -1327,7 +1369,6 @@ export type UploadSmartTagInstancesHrefSchema = {
|
|
|
1327
1369
|
* The maximum number of entities to return (defaults to 50, maximum is 500)
|
|
1328
1370
|
*/
|
|
1329
1371
|
limit?: number;
|
|
1330
|
-
[k: string]: unknown;
|
|
1331
1372
|
};
|
|
1332
1373
|
[k: string]: unknown;
|
|
1333
1374
|
};
|
|
@@ -8236,12 +8277,19 @@ export type WebhookAttributes = {
|
|
|
8236
8277
|
* Additional headers that will be sent
|
|
8237
8278
|
*/
|
|
8238
8279
|
headers: {
|
|
8239
|
-
[k: string]:
|
|
8280
|
+
[k: string]: string;
|
|
8240
8281
|
};
|
|
8241
|
-
|
|
8242
|
-
|
|
8243
|
-
|
|
8244
|
-
|
|
8282
|
+
events: {
|
|
8283
|
+
/**
|
|
8284
|
+
* The subject of webhook triggering
|
|
8285
|
+
*/
|
|
8286
|
+
entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
|
|
8287
|
+
event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
|
|
8288
|
+
filters?: {
|
|
8289
|
+
entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
|
|
8290
|
+
entity_ids: [string, ...string[]];
|
|
8291
|
+
}[] | null;
|
|
8292
|
+
}[];
|
|
8245
8293
|
/**
|
|
8246
8294
|
* Specifies which API version to use when serializing entities in the webhook payload
|
|
8247
8295
|
*/
|
|
@@ -8250,6 +8298,10 @@ export type WebhookAttributes = {
|
|
|
8250
8298
|
* Whether the you want records present in the payload to show blocks expanded or not
|
|
8251
8299
|
*/
|
|
8252
8300
|
nested_items_in_payload: boolean;
|
|
8301
|
+
/**
|
|
8302
|
+
* If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
|
|
8303
|
+
*/
|
|
8304
|
+
auto_retry: boolean;
|
|
8253
8305
|
};
|
|
8254
8306
|
/**
|
|
8255
8307
|
* JSON API data
|
|
@@ -8285,12 +8337,19 @@ export type WebhookCreateSchema = {
|
|
|
8285
8337
|
* Additional headers that will be sent
|
|
8286
8338
|
*/
|
|
8287
8339
|
headers: {
|
|
8288
|
-
[k: string]:
|
|
8340
|
+
[k: string]: string;
|
|
8289
8341
|
};
|
|
8290
|
-
|
|
8291
|
-
|
|
8292
|
-
|
|
8293
|
-
|
|
8342
|
+
events: {
|
|
8343
|
+
/**
|
|
8344
|
+
* The subject of webhook triggering
|
|
8345
|
+
*/
|
|
8346
|
+
entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
|
|
8347
|
+
event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
|
|
8348
|
+
filters?: {
|
|
8349
|
+
entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
|
|
8350
|
+
entity_ids: [string, ...string[]];
|
|
8351
|
+
}[] | null;
|
|
8352
|
+
}[];
|
|
8294
8353
|
/**
|
|
8295
8354
|
* HTTP Basic Authorization username
|
|
8296
8355
|
*/
|
|
@@ -8311,6 +8370,10 @@ export type WebhookCreateSchema = {
|
|
|
8311
8370
|
* Whether the you want records present in the payload to show blocks expanded or not
|
|
8312
8371
|
*/
|
|
8313
8372
|
nested_items_in_payload?: boolean;
|
|
8373
|
+
/**
|
|
8374
|
+
* If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
|
|
8375
|
+
*/
|
|
8376
|
+
auto_retry?: boolean;
|
|
8314
8377
|
};
|
|
8315
8378
|
};
|
|
8316
8379
|
};
|
|
@@ -8346,12 +8409,19 @@ export type WebhookUpdateSchema = {
|
|
|
8346
8409
|
* Additional headers that will be sent
|
|
8347
8410
|
*/
|
|
8348
8411
|
headers?: {
|
|
8349
|
-
[k: string]:
|
|
8412
|
+
[k: string]: string;
|
|
8350
8413
|
};
|
|
8351
|
-
|
|
8352
|
-
|
|
8353
|
-
|
|
8354
|
-
|
|
8414
|
+
events?: {
|
|
8415
|
+
/**
|
|
8416
|
+
* The subject of webhook triggering
|
|
8417
|
+
*/
|
|
8418
|
+
entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
|
|
8419
|
+
event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
|
|
8420
|
+
filters?: {
|
|
8421
|
+
entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
|
|
8422
|
+
entity_ids: [string, ...string[]];
|
|
8423
|
+
}[] | null;
|
|
8424
|
+
}[];
|
|
8355
8425
|
/**
|
|
8356
8426
|
* HTTP Basic Authorization username
|
|
8357
8427
|
*/
|
|
@@ -8372,6 +8442,10 @@ export type WebhookUpdateSchema = {
|
|
|
8372
8442
|
* Whether the you want records present in the payload to show blocks expanded or not
|
|
8373
8443
|
*/
|
|
8374
8444
|
nested_items_in_payload?: boolean;
|
|
8445
|
+
/**
|
|
8446
|
+
* If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
|
|
8447
|
+
*/
|
|
8448
|
+
auto_retry?: boolean;
|
|
8375
8449
|
};
|
|
8376
8450
|
};
|
|
8377
8451
|
};
|
|
@@ -8425,13 +8499,13 @@ export type WebhookCallAttributes = {
|
|
|
8425
8499
|
/**
|
|
8426
8500
|
* The subject of webhook triggering
|
|
8427
8501
|
*/
|
|
8428
|
-
entity_type: '
|
|
8502
|
+
entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
|
|
8429
8503
|
/**
|
|
8430
8504
|
* The event that triggers the webhook call
|
|
8431
8505
|
*/
|
|
8432
|
-
event_type: 'create' | 'update' | 'delete' | 'publish' | 'unpublish';
|
|
8506
|
+
event_type: 'create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate';
|
|
8433
8507
|
/**
|
|
8434
|
-
* The moment the
|
|
8508
|
+
* The moment the event was created
|
|
8435
8509
|
*/
|
|
8436
8510
|
created_at: string;
|
|
8437
8511
|
/**
|
|
@@ -8457,11 +8531,27 @@ export type WebhookCallAttributes = {
|
|
|
8457
8531
|
*/
|
|
8458
8532
|
response_headers: {
|
|
8459
8533
|
[k: string]: unknown;
|
|
8460
|
-
};
|
|
8534
|
+
} | null;
|
|
8461
8535
|
/**
|
|
8462
8536
|
* The body of the response
|
|
8463
8537
|
*/
|
|
8464
8538
|
response_payload: string | null;
|
|
8539
|
+
/**
|
|
8540
|
+
* The number of retries attempted so far
|
|
8541
|
+
*/
|
|
8542
|
+
attempted_auto_retries_count: number;
|
|
8543
|
+
/**
|
|
8544
|
+
* The last moment the call occurred
|
|
8545
|
+
*/
|
|
8546
|
+
last_sent_at: string;
|
|
8547
|
+
/**
|
|
8548
|
+
* The date when the next retry attempt is scheduled to run. If no retry attempt is scheduled, it is set to null
|
|
8549
|
+
*/
|
|
8550
|
+
next_retry_at: string | null;
|
|
8551
|
+
/**
|
|
8552
|
+
* The current status
|
|
8553
|
+
*/
|
|
8554
|
+
status: 'pending' | 'success' | 'failed' | 'rescheduled';
|
|
8465
8555
|
};
|
|
8466
8556
|
/**
|
|
8467
8557
|
* JSON API links
|
|
@@ -8496,6 +8586,15 @@ export type WebhookCallInstancesTargetSchema = {
|
|
|
8496
8586
|
meta: {
|
|
8497
8587
|
total_count: number;
|
|
8498
8588
|
};
|
|
8589
|
+
included: Webhook[];
|
|
8590
|
+
};
|
|
8591
|
+
/**
|
|
8592
|
+
* This interface was referenced by `WebhookCall`'s JSON-Schema
|
|
8593
|
+
* via the `self.targetSchema` link.
|
|
8594
|
+
*/
|
|
8595
|
+
export type WebhookCallSelfTargetSchema = {
|
|
8596
|
+
data: WebhookCall;
|
|
8597
|
+
included: Webhook[];
|
|
8499
8598
|
};
|
|
8500
8599
|
/**
|
|
8501
8600
|
* Configuration for different build triggers. You can have different staging and production environments in order to test your site before final deploy
|