@randock/nameshift-api-client 0.0.535 → 0.0.537

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.
Files changed (81) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +3 -3
  3. package/dist/apis/AdminApi.d.ts +13 -0
  4. package/dist/apis/AdminApi.js +53 -0
  5. package/dist/apis/WebhooksApi.d.ts +186 -0
  6. package/dist/apis/WebhooksApi.js +797 -0
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/apis/index.js +1 -0
  9. package/dist/models/CreateWebhookEndpointInput.d.ts +69 -0
  10. package/dist/models/CreateWebhookEndpointInput.js +66 -0
  11. package/dist/models/FeatureFlagListItemDto.d.ts +1 -0
  12. package/dist/models/FeatureFlagListItemDto.js +2 -1
  13. package/dist/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.d.ts +1 -0
  14. package/dist/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.js +2 -1
  15. package/dist/models/PrivateAccountGetMeResponse.d.ts +1 -0
  16. package/dist/models/PrivateAccountGetMeResponse.js +2 -1
  17. package/dist/models/UpdateWebhookEndpointInput.d.ts +69 -0
  18. package/dist/models/UpdateWebhookEndpointInput.js +62 -0
  19. package/dist/models/WebhookAttemptTrigger.d.ts +25 -0
  20. package/dist/models/WebhookAttemptTrigger.js +51 -0
  21. package/dist/models/WebhookDeliveriesSummaryDto.d.ts +62 -0
  22. package/dist/models/WebhookDeliveriesSummaryDto.js +71 -0
  23. package/dist/models/WebhookDeliveryAttemptDto.d.ts +75 -0
  24. package/dist/models/WebhookDeliveryAttemptDto.js +80 -0
  25. package/dist/models/WebhookDeliveryDto.d.ts +100 -0
  26. package/dist/models/WebhookDeliveryDto.js +97 -0
  27. package/dist/models/WebhookDeliveryStatus.d.ts +28 -0
  28. package/dist/models/WebhookDeliveryStatus.js +54 -0
  29. package/dist/models/WebhookEndpointDto.d.ts +111 -0
  30. package/dist/models/WebhookEndpointDto.js +104 -0
  31. package/dist/models/WebhookEndpointHeaderDto.d.ts +38 -0
  32. package/dist/models/WebhookEndpointHeaderDto.js +55 -0
  33. package/dist/models/WebhookEndpointHeaderInput.d.ts +38 -0
  34. package/dist/models/WebhookEndpointHeaderInput.js +55 -0
  35. package/dist/models/WebhookEndpointHeadersDto.d.ts +33 -0
  36. package/dist/models/WebhookEndpointHeadersDto.js +52 -0
  37. package/dist/models/WebhookEndpointSecretDto.d.ts +32 -0
  38. package/dist/models/WebhookEndpointSecretDto.js +51 -0
  39. package/dist/models/WebhookEndpointStatus.d.ts +26 -0
  40. package/dist/models/WebhookEndpointStatus.js +52 -0
  41. package/dist/models/WebhookEventTypeDto.d.ts +52 -0
  42. package/dist/models/WebhookEventTypeDto.js +63 -0
  43. package/dist/models/WebhookMessageDetailDto.d.ts +79 -0
  44. package/dist/models/WebhookMessageDetailDto.js +82 -0
  45. package/dist/models/WebhookMessageDto.d.ts +64 -0
  46. package/dist/models/WebhookMessageDto.js +73 -0
  47. package/dist/models/WebhookMessagePageDto.d.ts +40 -0
  48. package/dist/models/WebhookMessagePageDto.js +57 -0
  49. package/dist/models/WebhookMessagePageMetaDto.d.ts +50 -0
  50. package/dist/models/WebhookMessagePageMetaDto.js +63 -0
  51. package/dist/models/WebhookMessageStatus.d.ts +27 -0
  52. package/dist/models/WebhookMessageStatus.js +53 -0
  53. package/dist/models/index.d.ts +19 -0
  54. package/dist/models/index.js +19 -0
  55. package/package.json +1 -1
  56. package/src/apis/AdminApi.ts +46 -0
  57. package/src/apis/WebhooksApi.ts +671 -0
  58. package/src/apis/index.ts +1 -0
  59. package/src/models/CreateWebhookEndpointInput.ts +123 -0
  60. package/src/models/FeatureFlagListItemDto.ts +2 -1
  61. package/src/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.ts +2 -1
  62. package/src/models/PrivateAccountGetMeResponse.ts +2 -1
  63. package/src/models/UpdateWebhookEndpointInput.ts +121 -0
  64. package/src/models/WebhookAttemptTrigger.ts +53 -0
  65. package/src/models/WebhookDeliveriesSummaryDto.ts +111 -0
  66. package/src/models/WebhookDeliveryAttemptDto.ts +139 -0
  67. package/src/models/WebhookDeliveryDto.ts +182 -0
  68. package/src/models/WebhookDeliveryStatus.ts +56 -0
  69. package/src/models/WebhookEndpointDto.ts +193 -0
  70. package/src/models/WebhookEndpointHeaderDto.ts +75 -0
  71. package/src/models/WebhookEndpointHeaderInput.ts +75 -0
  72. package/src/models/WebhookEndpointHeadersDto.ts +74 -0
  73. package/src/models/WebhookEndpointSecretDto.ts +66 -0
  74. package/src/models/WebhookEndpointStatus.ts +54 -0
  75. package/src/models/WebhookEventTypeDto.ts +93 -0
  76. package/src/models/WebhookMessageDetailDto.ts +153 -0
  77. package/src/models/WebhookMessageDto.ts +128 -0
  78. package/src/models/WebhookMessagePageDto.ts +90 -0
  79. package/src/models/WebhookMessagePageMetaDto.ts +93 -0
  80. package/src/models/WebhookMessageStatus.ts +55 -0
  81. package/src/models/index.ts +19 -0
@@ -0,0 +1,671 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Nameshift
5
+ * Nameshift domain marketplace and management API. ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access. ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import * as runtime from '../runtime';
17
+ import type {
18
+ CreateWebhookEndpointInput,
19
+ UpdateWebhookEndpointInput,
20
+ ValidationException,
21
+ WebhookDeliveryStatus,
22
+ WebhookEndpointDto,
23
+ WebhookEndpointHeadersDto,
24
+ WebhookEndpointSecretDto,
25
+ WebhookEventTypeDto,
26
+ WebhookMessageDetailDto,
27
+ WebhookMessagePageDto,
28
+ } from '../models/index';
29
+ import {
30
+ CreateWebhookEndpointInputFromJSON,
31
+ CreateWebhookEndpointInputToJSON,
32
+ UpdateWebhookEndpointInputFromJSON,
33
+ UpdateWebhookEndpointInputToJSON,
34
+ ValidationExceptionFromJSON,
35
+ ValidationExceptionToJSON,
36
+ WebhookDeliveryStatusFromJSON,
37
+ WebhookDeliveryStatusToJSON,
38
+ WebhookEndpointDtoFromJSON,
39
+ WebhookEndpointDtoToJSON,
40
+ WebhookEndpointHeadersDtoFromJSON,
41
+ WebhookEndpointHeadersDtoToJSON,
42
+ WebhookEndpointSecretDtoFromJSON,
43
+ WebhookEndpointSecretDtoToJSON,
44
+ WebhookEventTypeDtoFromJSON,
45
+ WebhookEventTypeDtoToJSON,
46
+ WebhookMessageDetailDtoFromJSON,
47
+ WebhookMessageDetailDtoToJSON,
48
+ WebhookMessagePageDtoFromJSON,
49
+ WebhookMessagePageDtoToJSON,
50
+ } from '../models/index';
51
+
52
+ export interface WebhooksApiCreateWebhookEndpointRequest {
53
+ createWebhookEndpointInput: CreateWebhookEndpointInput;
54
+ }
55
+
56
+ export interface WebhooksApiDeleteWebhookEndpointRequest {
57
+ endpointId: string;
58
+ }
59
+
60
+ export interface WebhooksApiGetWebhookEndpointRequest {
61
+ endpointId: string;
62
+ }
63
+
64
+ export interface WebhooksApiGetWebhookEndpointHeadersRequest {
65
+ endpointId: string;
66
+ }
67
+
68
+ export interface WebhooksApiGetWebhookEndpointSecretRequest {
69
+ endpointId: string;
70
+ }
71
+
72
+ export interface WebhooksApiGetWebhookMessageRequest {
73
+ messageId: string;
74
+ }
75
+
76
+ export interface WebhooksApiGetWebhookMessagesRequest {
77
+ page?: number;
78
+ limit?: number;
79
+ endpointId?: string;
80
+ eventType?: string;
81
+ deliveryStatus?: WebhookDeliveryStatus;
82
+ }
83
+
84
+ export interface WebhooksApiRetryWebhookDeliveryRequest {
85
+ deliveryId: string;
86
+ }
87
+
88
+ export interface WebhooksApiRotateWebhookEndpointSecretRequest {
89
+ endpointId: string;
90
+ }
91
+
92
+ export interface WebhooksApiSendWebhookEndpointTestRequest {
93
+ endpointId: string;
94
+ }
95
+
96
+ export interface WebhooksApiUpdateWebhookEndpointRequest {
97
+ endpointId: string;
98
+ updateWebhookEndpointInput: UpdateWebhookEndpointInput;
99
+ }
100
+
101
+ /**
102
+ *
103
+ */
104
+ export class WebhooksApi extends runtime.BaseAPI {
105
+
106
+ /**
107
+ * Adds a URL that starts receiving the chosen event types, signed with a secret of its own.
108
+ * Create a webhook endpoint
109
+ */
110
+ async createWebhookEndpointRaw(requestParameters: WebhooksApiCreateWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
111
+ if (requestParameters['createWebhookEndpointInput'] == null) {
112
+ throw new runtime.RequiredError(
113
+ 'createWebhookEndpointInput',
114
+ 'Required parameter "createWebhookEndpointInput" was null or undefined when calling createWebhookEndpoint().'
115
+ );
116
+ }
117
+
118
+ const queryParameters: any = {};
119
+
120
+ const headerParameters: runtime.HTTPHeaders = {};
121
+
122
+ headerParameters['Content-Type'] = 'application/json';
123
+
124
+ if (this.configuration && this.configuration.accessToken) {
125
+ const token = this.configuration.accessToken;
126
+ const tokenString = await token("bearer", []);
127
+
128
+ if (tokenString) {
129
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
130
+ }
131
+ }
132
+ const response = await this.request({
133
+ path: `/private/webhooks/endpoints`,
134
+ method: 'POST',
135
+ headers: headerParameters,
136
+ query: queryParameters,
137
+ body: CreateWebhookEndpointInputToJSON(requestParameters['createWebhookEndpointInput']),
138
+ }, initOverrides);
139
+
140
+ return new runtime.VoidApiResponse(response);
141
+ }
142
+
143
+ /**
144
+ * Adds a URL that starts receiving the chosen event types, signed with a secret of its own.
145
+ * Create a webhook endpoint
146
+ */
147
+ async createWebhookEndpoint(requestParameters: WebhooksApiCreateWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
148
+ await this.createWebhookEndpointRaw(requestParameters, initOverrides);
149
+ }
150
+
151
+ /**
152
+ * Removes an endpoint. Nothing is sent to it anymore, retries included.
153
+ * Delete a webhook endpoint
154
+ */
155
+ async deleteWebhookEndpointRaw(requestParameters: WebhooksApiDeleteWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
156
+ if (requestParameters['endpointId'] == null) {
157
+ throw new runtime.RequiredError(
158
+ 'endpointId',
159
+ 'Required parameter "endpointId" was null or undefined when calling deleteWebhookEndpoint().'
160
+ );
161
+ }
162
+
163
+ const queryParameters: any = {};
164
+
165
+ const headerParameters: runtime.HTTPHeaders = {};
166
+
167
+ if (this.configuration && this.configuration.accessToken) {
168
+ const token = this.configuration.accessToken;
169
+ const tokenString = await token("bearer", []);
170
+
171
+ if (tokenString) {
172
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
173
+ }
174
+ }
175
+ const response = await this.request({
176
+ path: `/private/webhooks/endpoints/{endpointId}`.replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
177
+ method: 'DELETE',
178
+ headers: headerParameters,
179
+ query: queryParameters,
180
+ }, initOverrides);
181
+
182
+ return new runtime.VoidApiResponse(response);
183
+ }
184
+
185
+ /**
186
+ * Removes an endpoint. Nothing is sent to it anymore, retries included.
187
+ * Delete a webhook endpoint
188
+ */
189
+ async deleteWebhookEndpoint(requestParameters: WebhooksApiDeleteWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
190
+ await this.deleteWebhookEndpointRaw(requestParameters, initOverrides);
191
+ }
192
+
193
+ /**
194
+ * Returns one of the URLs the events of the account are sent to.
195
+ * Get a webhook endpoint
196
+ */
197
+ async getWebhookEndpointRaw(requestParameters: WebhooksApiGetWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpointDto>> {
198
+ if (requestParameters['endpointId'] == null) {
199
+ throw new runtime.RequiredError(
200
+ 'endpointId',
201
+ 'Required parameter "endpointId" was null or undefined when calling getWebhookEndpoint().'
202
+ );
203
+ }
204
+
205
+ const queryParameters: any = {};
206
+
207
+ const headerParameters: runtime.HTTPHeaders = {};
208
+
209
+ if (this.configuration && this.configuration.accessToken) {
210
+ const token = this.configuration.accessToken;
211
+ const tokenString = await token("bearer", []);
212
+
213
+ if (tokenString) {
214
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
215
+ }
216
+ }
217
+ const response = await this.request({
218
+ path: `/private/webhooks/endpoints/{endpointId}`.replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
219
+ method: 'GET',
220
+ headers: headerParameters,
221
+ query: queryParameters,
222
+ }, initOverrides);
223
+
224
+ return new runtime.JSONApiResponse(response, (jsonValue) => WebhookEndpointDtoFromJSON(jsonValue));
225
+ }
226
+
227
+ /**
228
+ * Returns one of the URLs the events of the account are sent to.
229
+ * Get a webhook endpoint
230
+ */
231
+ async getWebhookEndpoint(requestParameters: WebhooksApiGetWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointDto> {
232
+ const response = await this.getWebhookEndpointRaw(requestParameters, initOverrides);
233
+ return await response.value();
234
+ }
235
+
236
+ /**
237
+ * Returns the custom headers sent with each event to the endpoint, values included, to edit them.
238
+ * Get the custom headers of a webhook endpoint
239
+ */
240
+ async getWebhookEndpointHeadersRaw(requestParameters: WebhooksApiGetWebhookEndpointHeadersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpointHeadersDto>> {
241
+ if (requestParameters['endpointId'] == null) {
242
+ throw new runtime.RequiredError(
243
+ 'endpointId',
244
+ 'Required parameter "endpointId" was null or undefined when calling getWebhookEndpointHeaders().'
245
+ );
246
+ }
247
+
248
+ const queryParameters: any = {};
249
+
250
+ const headerParameters: runtime.HTTPHeaders = {};
251
+
252
+ if (this.configuration && this.configuration.accessToken) {
253
+ const token = this.configuration.accessToken;
254
+ const tokenString = await token("bearer", []);
255
+
256
+ if (tokenString) {
257
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
258
+ }
259
+ }
260
+ const response = await this.request({
261
+ path: `/private/webhooks/endpoints/{endpointId}/headers`.replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
262
+ method: 'GET',
263
+ headers: headerParameters,
264
+ query: queryParameters,
265
+ }, initOverrides);
266
+
267
+ return new runtime.JSONApiResponse(response, (jsonValue) => WebhookEndpointHeadersDtoFromJSON(jsonValue));
268
+ }
269
+
270
+ /**
271
+ * Returns the custom headers sent with each event to the endpoint, values included, to edit them.
272
+ * Get the custom headers of a webhook endpoint
273
+ */
274
+ async getWebhookEndpointHeaders(requestParameters: WebhooksApiGetWebhookEndpointHeadersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointHeadersDto> {
275
+ const response = await this.getWebhookEndpointHeadersRaw(requestParameters, initOverrides);
276
+ return await response.value();
277
+ }
278
+
279
+ /**
280
+ * Returns the secret the events sent to the endpoint are signed with, to verify their signature.
281
+ * Get the signing secret of a webhook endpoint
282
+ */
283
+ async getWebhookEndpointSecretRaw(requestParameters: WebhooksApiGetWebhookEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpointSecretDto>> {
284
+ if (requestParameters['endpointId'] == null) {
285
+ throw new runtime.RequiredError(
286
+ 'endpointId',
287
+ 'Required parameter "endpointId" was null or undefined when calling getWebhookEndpointSecret().'
288
+ );
289
+ }
290
+
291
+ const queryParameters: any = {};
292
+
293
+ const headerParameters: runtime.HTTPHeaders = {};
294
+
295
+ if (this.configuration && this.configuration.accessToken) {
296
+ const token = this.configuration.accessToken;
297
+ const tokenString = await token("bearer", []);
298
+
299
+ if (tokenString) {
300
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
301
+ }
302
+ }
303
+ const response = await this.request({
304
+ path: `/private/webhooks/endpoints/{endpointId}/secret`.replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
305
+ method: 'GET',
306
+ headers: headerParameters,
307
+ query: queryParameters,
308
+ }, initOverrides);
309
+
310
+ return new runtime.JSONApiResponse(response, (jsonValue) => WebhookEndpointSecretDtoFromJSON(jsonValue));
311
+ }
312
+
313
+ /**
314
+ * Returns the secret the events sent to the endpoint are signed with, to verify their signature.
315
+ * Get the signing secret of a webhook endpoint
316
+ */
317
+ async getWebhookEndpointSecret(requestParameters: WebhooksApiGetWebhookEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointSecretDto> {
318
+ const response = await this.getWebhookEndpointSecretRaw(requestParameters, initOverrides);
319
+ return await response.value();
320
+ }
321
+
322
+ /**
323
+ * Lists the URLs the events of the account are sent to.
324
+ * List webhook endpoints
325
+ */
326
+ async getWebhookEndpointsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WebhookEndpointDto>>> {
327
+ const queryParameters: any = {};
328
+
329
+ const headerParameters: runtime.HTTPHeaders = {};
330
+
331
+ if (this.configuration && this.configuration.accessToken) {
332
+ const token = this.configuration.accessToken;
333
+ const tokenString = await token("bearer", []);
334
+
335
+ if (tokenString) {
336
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
337
+ }
338
+ }
339
+ const response = await this.request({
340
+ path: `/private/webhooks/endpoints`,
341
+ method: 'GET',
342
+ headers: headerParameters,
343
+ query: queryParameters,
344
+ }, initOverrides);
345
+
346
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(WebhookEndpointDtoFromJSON));
347
+ }
348
+
349
+ /**
350
+ * Lists the URLs the events of the account are sent to.
351
+ * List webhook endpoints
352
+ */
353
+ async getWebhookEndpoints(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WebhookEndpointDto>> {
354
+ const response = await this.getWebhookEndpointsRaw(initOverrides);
355
+ return await response.value();
356
+ }
357
+
358
+ /**
359
+ * Lists the event types an endpoint can receive, with an example of the data each one carries.
360
+ * List webhook event types
361
+ */
362
+ async getWebhookEventTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WebhookEventTypeDto>>> {
363
+ const queryParameters: any = {};
364
+
365
+ const headerParameters: runtime.HTTPHeaders = {};
366
+
367
+ if (this.configuration && this.configuration.accessToken) {
368
+ const token = this.configuration.accessToken;
369
+ const tokenString = await token("bearer", []);
370
+
371
+ if (tokenString) {
372
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
373
+ }
374
+ }
375
+ const response = await this.request({
376
+ path: `/private/webhooks/event-types`,
377
+ method: 'GET',
378
+ headers: headerParameters,
379
+ query: queryParameters,
380
+ }, initOverrides);
381
+
382
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(WebhookEventTypeDtoFromJSON));
383
+ }
384
+
385
+ /**
386
+ * Lists the event types an endpoint can receive, with an example of the data each one carries.
387
+ * List webhook event types
388
+ */
389
+ async getWebhookEventTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WebhookEventTypeDto>> {
390
+ const response = await this.getWebhookEventTypesRaw(initOverrides);
391
+ return await response.value();
392
+ }
393
+
394
+ /**
395
+ * Returns an event with the data it carried and each attempt to deliver it.
396
+ * Get a webhook event
397
+ */
398
+ async getWebhookMessageRaw(requestParameters: WebhooksApiGetWebhookMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookMessageDetailDto>> {
399
+ if (requestParameters['messageId'] == null) {
400
+ throw new runtime.RequiredError(
401
+ 'messageId',
402
+ 'Required parameter "messageId" was null or undefined when calling getWebhookMessage().'
403
+ );
404
+ }
405
+
406
+ const queryParameters: any = {};
407
+
408
+ const headerParameters: runtime.HTTPHeaders = {};
409
+
410
+ if (this.configuration && this.configuration.accessToken) {
411
+ const token = this.configuration.accessToken;
412
+ const tokenString = await token("bearer", []);
413
+
414
+ if (tokenString) {
415
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
416
+ }
417
+ }
418
+ const response = await this.request({
419
+ path: `/private/webhooks/messages/{messageId}`.replace(`{${"messageId"}}`, encodeURIComponent(String(requestParameters['messageId']))),
420
+ method: 'GET',
421
+ headers: headerParameters,
422
+ query: queryParameters,
423
+ }, initOverrides);
424
+
425
+ return new runtime.JSONApiResponse(response, (jsonValue) => WebhookMessageDetailDtoFromJSON(jsonValue));
426
+ }
427
+
428
+ /**
429
+ * Returns an event with the data it carried and each attempt to deliver it.
430
+ * Get a webhook event
431
+ */
432
+ async getWebhookMessage(requestParameters: WebhooksApiGetWebhookMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookMessageDetailDto> {
433
+ const response = await this.getWebhookMessageRaw(requestParameters, initOverrides);
434
+ return await response.value();
435
+ }
436
+
437
+ /**
438
+ * Lists the events sent to the endpoints of the account, the newest first.
439
+ * List webhook events
440
+ */
441
+ async getWebhookMessagesRaw(requestParameters: WebhooksApiGetWebhookMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookMessagePageDto>> {
442
+ const queryParameters: any = {};
443
+
444
+ if (requestParameters['page'] != null) {
445
+ queryParameters['page'] = requestParameters['page'];
446
+ }
447
+
448
+ if (requestParameters['limit'] != null) {
449
+ queryParameters['limit'] = requestParameters['limit'];
450
+ }
451
+
452
+ if (requestParameters['endpointId'] != null) {
453
+ queryParameters['endpointId'] = requestParameters['endpointId'];
454
+ }
455
+
456
+ if (requestParameters['eventType'] != null) {
457
+ queryParameters['eventType'] = requestParameters['eventType'];
458
+ }
459
+
460
+ if (requestParameters['deliveryStatus'] != null) {
461
+ queryParameters['deliveryStatus'] = requestParameters['deliveryStatus'];
462
+ }
463
+
464
+ const headerParameters: runtime.HTTPHeaders = {};
465
+
466
+ if (this.configuration && this.configuration.accessToken) {
467
+ const token = this.configuration.accessToken;
468
+ const tokenString = await token("bearer", []);
469
+
470
+ if (tokenString) {
471
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
472
+ }
473
+ }
474
+ const response = await this.request({
475
+ path: `/private/webhooks/messages`,
476
+ method: 'GET',
477
+ headers: headerParameters,
478
+ query: queryParameters,
479
+ }, initOverrides);
480
+
481
+ return new runtime.JSONApiResponse(response, (jsonValue) => WebhookMessagePageDtoFromJSON(jsonValue));
482
+ }
483
+
484
+ /**
485
+ * Lists the events sent to the endpoints of the account, the newest first.
486
+ * List webhook events
487
+ */
488
+ async getWebhookMessages(requestParameters: WebhooksApiGetWebhookMessagesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookMessagePageDto> {
489
+ const response = await this.getWebhookMessagesRaw(requestParameters, initOverrides);
490
+ return await response.value();
491
+ }
492
+
493
+ /**
494
+ * Tries once more to deliver an event to an endpoint.
495
+ * Retry a webhook delivery
496
+ */
497
+ async retryWebhookDeliveryRaw(requestParameters: WebhooksApiRetryWebhookDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
498
+ if (requestParameters['deliveryId'] == null) {
499
+ throw new runtime.RequiredError(
500
+ 'deliveryId',
501
+ 'Required parameter "deliveryId" was null or undefined when calling retryWebhookDelivery().'
502
+ );
503
+ }
504
+
505
+ const queryParameters: any = {};
506
+
507
+ const headerParameters: runtime.HTTPHeaders = {};
508
+
509
+ if (this.configuration && this.configuration.accessToken) {
510
+ const token = this.configuration.accessToken;
511
+ const tokenString = await token("bearer", []);
512
+
513
+ if (tokenString) {
514
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
515
+ }
516
+ }
517
+ const response = await this.request({
518
+ path: `/private/webhooks/deliveries/{deliveryId}/retry`.replace(`{${"deliveryId"}}`, encodeURIComponent(String(requestParameters['deliveryId']))),
519
+ method: 'POST',
520
+ headers: headerParameters,
521
+ query: queryParameters,
522
+ }, initOverrides);
523
+
524
+ return new runtime.VoidApiResponse(response);
525
+ }
526
+
527
+ /**
528
+ * Tries once more to deliver an event to an endpoint.
529
+ * Retry a webhook delivery
530
+ */
531
+ async retryWebhookDelivery(requestParameters: WebhooksApiRetryWebhookDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
532
+ await this.retryWebhookDeliveryRaw(requestParameters, initOverrides);
533
+ }
534
+
535
+ /**
536
+ * Gives the endpoint a new signing secret. Events are signed with the previous one too for 24 hours, to switch over without losing any.
537
+ * Rotate the signing secret of a webhook endpoint
538
+ */
539
+ async rotateWebhookEndpointSecretRaw(requestParameters: WebhooksApiRotateWebhookEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
540
+ if (requestParameters['endpointId'] == null) {
541
+ throw new runtime.RequiredError(
542
+ 'endpointId',
543
+ 'Required parameter "endpointId" was null or undefined when calling rotateWebhookEndpointSecret().'
544
+ );
545
+ }
546
+
547
+ const queryParameters: any = {};
548
+
549
+ const headerParameters: runtime.HTTPHeaders = {};
550
+
551
+ if (this.configuration && this.configuration.accessToken) {
552
+ const token = this.configuration.accessToken;
553
+ const tokenString = await token("bearer", []);
554
+
555
+ if (tokenString) {
556
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
557
+ }
558
+ }
559
+ const response = await this.request({
560
+ path: `/private/webhooks/endpoints/{endpointId}/rotate-secret`.replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
561
+ method: 'POST',
562
+ headers: headerParameters,
563
+ query: queryParameters,
564
+ }, initOverrides);
565
+
566
+ return new runtime.VoidApiResponse(response);
567
+ }
568
+
569
+ /**
570
+ * Gives the endpoint a new signing secret. Events are signed with the previous one too for 24 hours, to switch over without losing any.
571
+ * Rotate the signing secret of a webhook endpoint
572
+ */
573
+ async rotateWebhookEndpointSecret(requestParameters: WebhooksApiRotateWebhookEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
574
+ await this.rotateWebhookEndpointSecretRaw(requestParameters, initOverrides);
575
+ }
576
+
577
+ /**
578
+ * Sends a webhook.test event to the endpoint, even when it is disabled. It shows in the event log like any other.
579
+ * Send a test event to a webhook endpoint
580
+ */
581
+ async sendWebhookEndpointTestRaw(requestParameters: WebhooksApiSendWebhookEndpointTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
582
+ if (requestParameters['endpointId'] == null) {
583
+ throw new runtime.RequiredError(
584
+ 'endpointId',
585
+ 'Required parameter "endpointId" was null or undefined when calling sendWebhookEndpointTest().'
586
+ );
587
+ }
588
+
589
+ const queryParameters: any = {};
590
+
591
+ const headerParameters: runtime.HTTPHeaders = {};
592
+
593
+ if (this.configuration && this.configuration.accessToken) {
594
+ const token = this.configuration.accessToken;
595
+ const tokenString = await token("bearer", []);
596
+
597
+ if (tokenString) {
598
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
599
+ }
600
+ }
601
+ const response = await this.request({
602
+ path: `/private/webhooks/endpoints/{endpointId}/test`.replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
603
+ method: 'POST',
604
+ headers: headerParameters,
605
+ query: queryParameters,
606
+ }, initOverrides);
607
+
608
+ return new runtime.VoidApiResponse(response);
609
+ }
610
+
611
+ /**
612
+ * Sends a webhook.test event to the endpoint, even when it is disabled. It shows in the event log like any other.
613
+ * Send a test event to a webhook endpoint
614
+ */
615
+ async sendWebhookEndpointTest(requestParameters: WebhooksApiSendWebhookEndpointTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
616
+ await this.sendWebhookEndpointTestRaw(requestParameters, initOverrides);
617
+ }
618
+
619
+ /**
620
+ * Changes the URL, description, event types, custom headers, timeout, attempts or enabled state of an endpoint. What is left out stays as it is.
621
+ * Update a webhook endpoint
622
+ */
623
+ async updateWebhookEndpointRaw(requestParameters: WebhooksApiUpdateWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
624
+ if (requestParameters['endpointId'] == null) {
625
+ throw new runtime.RequiredError(
626
+ 'endpointId',
627
+ 'Required parameter "endpointId" was null or undefined when calling updateWebhookEndpoint().'
628
+ );
629
+ }
630
+
631
+ if (requestParameters['updateWebhookEndpointInput'] == null) {
632
+ throw new runtime.RequiredError(
633
+ 'updateWebhookEndpointInput',
634
+ 'Required parameter "updateWebhookEndpointInput" was null or undefined when calling updateWebhookEndpoint().'
635
+ );
636
+ }
637
+
638
+ const queryParameters: any = {};
639
+
640
+ const headerParameters: runtime.HTTPHeaders = {};
641
+
642
+ headerParameters['Content-Type'] = 'application/json';
643
+
644
+ if (this.configuration && this.configuration.accessToken) {
645
+ const token = this.configuration.accessToken;
646
+ const tokenString = await token("bearer", []);
647
+
648
+ if (tokenString) {
649
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
650
+ }
651
+ }
652
+ const response = await this.request({
653
+ path: `/private/webhooks/endpoints/{endpointId}`.replace(`{${"endpointId"}}`, encodeURIComponent(String(requestParameters['endpointId']))),
654
+ method: 'PATCH',
655
+ headers: headerParameters,
656
+ query: queryParameters,
657
+ body: UpdateWebhookEndpointInputToJSON(requestParameters['updateWebhookEndpointInput']),
658
+ }, initOverrides);
659
+
660
+ return new runtime.VoidApiResponse(response);
661
+ }
662
+
663
+ /**
664
+ * Changes the URL, description, event types, custom headers, timeout, attempts or enabled state of an endpoint. What is left out stays as it is.
665
+ * Update a webhook endpoint
666
+ */
667
+ async updateWebhookEndpoint(requestParameters: WebhooksApiUpdateWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
668
+ await this.updateWebhookEndpointRaw(requestParameters, initOverrides);
669
+ }
670
+
671
+ }
package/src/apis/index.ts CHANGED
@@ -37,3 +37,4 @@ export * from './TasksApi';
37
37
  export * from './TaxPublicApi';
38
38
  export * from './UsersApi';
39
39
  export * from './UsersPublicApi';
40
+ export * from './WebhooksApi';