unione 2.2.4 → 2.3.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.
Files changed (37) hide show
  1. package/AGENTS.md +10 -10
  2. package/LICENSE +1 -1
  3. package/README.md +27 -7
  4. package/package.json +5 -2
  5. package/src/api/confirmed-email/ConfirmedEmailApi.d.ts +3 -3
  6. package/src/api/confirmed-email/models.d.ts +23 -2
  7. package/src/api/domain/DomainApi.d.ts +6 -6
  8. package/src/api/domain/models.d.ts +52 -3
  9. package/src/api/email/EmailApi.d.ts +3 -3
  10. package/src/api/email/models.d.ts +54 -8
  11. package/src/api/email-validation/EmailValidationApi.d.ts +2 -2
  12. package/src/api/email-validation/models.d.ts +6 -0
  13. package/src/api/event-dump/EventDumpApi.d.ts +4 -4
  14. package/src/api/event-dump/models.d.ts +51 -4
  15. package/src/api/obsolete/ObsoleteApi.d.ts +4 -4
  16. package/src/api/obsolete/models.d.ts +25 -1
  17. package/src/api/project/ProjectApi.d.ts +5 -5
  18. package/src/api/project/models.d.ts +42 -3
  19. package/src/api/suppression/SuppressionApi.d.ts +5 -5
  20. package/src/api/suppression/models.d.ts +34 -2
  21. package/src/api/system/models.d.ts +22 -2
  22. package/src/api/tag/TagApi.d.ts +2 -2
  23. package/src/api/tag/models.d.ts +13 -1
  24. package/src/api/template/TemplateApi.d.ts +5 -5
  25. package/src/api/template/models.d.ts +91 -13
  26. package/src/api/webhook/WebhookApi.d.ts +5 -5
  27. package/src/api/webhook/models.d.ts +102 -9
  28. package/src/client/ApiClient.js +47 -16
  29. package/src/client/ApiError.d.ts +34 -1
  30. package/src/client/ApiError.js +42 -3
  31. package/src/client/Configuration.js +1 -1
  32. package/src/client/errors.js +195 -0
  33. package/src/client/index.d.ts +1 -1
  34. package/src/client/index.js +1 -1
  35. package/src/common/models.d.ts +15 -0
  36. package/src/index.d.ts +1 -1
  37. package/src/index.js +1 -1
@@ -1,6 +1,6 @@
1
1
  // EmailValidationApi: API methods of the EmailValidation section.
2
2
  import type { ApiClient } from "../../client/ApiClient.js";
3
- import type { EmailValidationSingleRequest, EmailValidationSingleRequestJSON, EmailValidationSingleResponse } from "./models.js";
3
+ import type { EmailValidationSingleRequest, EmailValidationSingleRequestInput, EmailValidationSingleResponse } from "./models.js";
4
4
 
5
5
  /**
6
6
  * Email validation methods. As a result of the check, you’ll get detailed information on email
@@ -22,5 +22,5 @@ export declare class EmailValidationApi {
22
22
  * Documentation: https://docs.unione.io/en/web-api-ref#email-validation-single
23
23
  * @throws {ApiError}
24
24
  */
25
- single(request: EmailValidationSingleRequest | EmailValidationSingleRequestJSON): Promise<EmailValidationSingleResponse>;
25
+ single(request: EmailValidationSingleRequest | EmailValidationSingleRequestInput): Promise<EmailValidationSingleResponse>;
26
26
  }
@@ -5,6 +5,9 @@ export interface EmailValidationSingleRequestJSON {
5
5
  "email": string;
6
6
  }
7
7
 
8
+ /** EmailValidationSingleRequest in the API format as an argument: a nested model may also be given as a model. */
9
+ export type EmailValidationSingleRequestInput = EmailValidationSingleRequestJSON;
10
+
8
11
  /** Fields of new EmailValidationSingleRequest(): a nested model may be a plain object in the API format. */
9
12
  export interface EmailValidationSingleRequestInit {
10
13
  /** Email address to be checked. */
@@ -37,6 +40,9 @@ export interface EmailValidationSingleResponseJSON {
37
40
  "processed_at"?: string;
38
41
  }
39
42
 
43
+ /** EmailValidationSingleResponse in the API format as an argument: a nested model may also be given as a model. */
44
+ export type EmailValidationSingleResponseInput = EmailValidationSingleResponseJSON;
45
+
40
46
  /** Fields of new EmailValidationSingleResponse(): a nested model may be a plain object in the API format. */
41
47
  export interface EmailValidationSingleResponseInit {
42
48
  /**
@@ -1,7 +1,7 @@
1
1
  // EventDumpApi: API methods of the EventDump section.
2
2
  import type { ApiClient } from "../../client/ApiClient.js";
3
3
  import type { SuccessResponse } from "../../common/models.js";
4
- import type { EventDumpCreateRequest, EventDumpCreateRequestJSON, EventDumpCreateResponse, EventDumpDeleteRequest, EventDumpDeleteRequestJSON, EventDumpGetRequest, EventDumpGetRequestJSON, EventDumpGetResponse, EventDumpListResponse } from "./models.js";
4
+ import type { EventDumpCreateRequest, EventDumpCreateRequestInput, EventDumpCreateResponse, EventDumpDeleteRequest, EventDumpDeleteRequestInput, EventDumpGetRequest, EventDumpGetRequestInput, EventDumpGetResponse, EventDumpListResponse } from "./models.js";
5
5
 
6
6
  /**
7
7
  * These methods are used to obtain a list of events for a given period of time. The data is stored for
@@ -27,7 +27,7 @@ export declare class EventDumpApi {
27
27
  * Documentation: https://docs.unione.io/en/web-api-ref#event-dump-create
28
28
  * @throws {ApiError}
29
29
  */
30
- create(request: EventDumpCreateRequest | EventDumpCreateRequestJSON): Promise<EventDumpCreateResponse>;
30
+ create(request: EventDumpCreateRequest | EventDumpCreateRequestInput): Promise<EventDumpCreateResponse>;
31
31
 
32
32
  /**
33
33
  * Returns dump properties for a given identifier
@@ -35,7 +35,7 @@ export declare class EventDumpApi {
35
35
  * Documentation: https://docs.unione.io/en/web-api-ref#event-dump-get
36
36
  * @throws {ApiError}
37
37
  */
38
- get(request: EventDumpGetRequest | EventDumpGetRequestJSON): Promise<EventDumpGetResponse>;
38
+ get(request: EventDumpGetRequest | EventDumpGetRequestInput): Promise<EventDumpGetResponse>;
39
39
 
40
40
  /**
41
41
  * This method does not require any parameters; returns the full list of existing dumps.
@@ -51,5 +51,5 @@ export declare class EventDumpApi {
51
51
  * Documentation: https://docs.unione.io/en/web-api-ref#event-dump-delete
52
52
  * @throws {ApiError}
53
53
  */
54
- delete(request: EventDumpDeleteRequest | EventDumpDeleteRequestJSON): Promise<SuccessResponse>;
54
+ delete(request: EventDumpDeleteRequest | EventDumpDeleteRequestInput): Promise<SuccessResponse>;
55
55
  }
@@ -14,6 +14,19 @@ export interface EventDumpCreateRequestJSON {
14
14
  "format"?: string;
15
15
  }
16
16
 
17
+ /** EventDumpCreateRequest in the API format as an argument: a nested model may also be given as a model. */
18
+ export interface EventDumpCreateRequestInput {
19
+ "start_time": string;
20
+ "end_time"?: string;
21
+ "limit"?: number;
22
+ "all_projects"?: boolean;
23
+ "filter"?: FilterObject | FilterObjectInput;
24
+ "dump_fields"?: Array<string>;
25
+ "aggregate"?: string;
26
+ "delimiter"?: string;
27
+ "format"?: string;
28
+ }
29
+
17
30
  /** Fields of new EventDumpCreateRequest(): a nested model may be a plain object in the API format. */
18
31
  export interface EventDumpCreateRequestInit {
19
32
  /**
@@ -35,7 +48,7 @@ export interface EventDumpCreateRequestInit {
35
48
  */
36
49
  allProjects?: boolean;
37
50
  /** An object with the properties of the event dump filter. */
38
- filter?: FilterObject | FilterObjectJSON;
51
+ filter?: FilterObject | FilterObjectInput;
39
52
  /**
40
53
  * An array of strings containing the names of columns you need in your report, in your preferred
41
54
  * order. If the 'dump_fields' array is missing or empty, a default field list and order will be
@@ -124,6 +137,9 @@ export interface FilterObjectJSON {
124
137
  "campaign_id"?: string;
125
138
  }
126
139
 
140
+ /** FilterObject in the API format as an argument: a nested model may also be given as a model. */
141
+ export type FilterObjectInput = FilterObjectJSON;
142
+
127
143
  /** Fields of new FilterObject(): a nested model may be a plain object in the API format. */
128
144
  export interface FilterObjectInit {
129
145
  /**
@@ -285,6 +301,9 @@ export interface EventDumpCreateResponseJSON {
285
301
  "dump_id"?: string;
286
302
  }
287
303
 
304
+ /** EventDumpCreateResponse in the API format as an argument: a nested model may also be given as a model. */
305
+ export type EventDumpCreateResponseInput = EventDumpCreateResponseJSON;
306
+
288
307
  /** Fields of new EventDumpCreateResponse(): a nested model may be a plain object in the API format. */
289
308
  export interface EventDumpCreateResponseInit {
290
309
  /**
@@ -323,6 +342,9 @@ export interface EventDumpGetRequestJSON {
323
342
  "dump_id": string;
324
343
  }
325
344
 
345
+ /** EventDumpGetRequest in the API format as an argument: a nested model may also be given as a model. */
346
+ export type EventDumpGetRequestInput = EventDumpGetRequestJSON;
347
+
326
348
  /** Fields of new EventDumpGetRequest(): a nested model may be a plain object in the API format. */
327
349
  export interface EventDumpGetRequestInit {
328
350
  /**
@@ -352,6 +374,12 @@ export interface EventDumpGetResponseJSON {
352
374
  "event_dump"?: EventDumpObjectJSON;
353
375
  }
354
376
 
377
+ /** EventDumpGetResponse in the API format as an argument: a nested model may also be given as a model. */
378
+ export interface EventDumpGetResponseInput {
379
+ "status"?: string;
380
+ "event_dump"?: EventDumpObject | EventDumpObjectInput;
381
+ }
382
+
355
383
  /** Fields of new EventDumpGetResponse(): a nested model may be a plain object in the API format. */
356
384
  export interface EventDumpGetResponseInit {
357
385
  /**
@@ -360,7 +388,7 @@ export interface EventDumpGetResponseInit {
360
388
  */
361
389
  status?: string;
362
390
  /** An object with the properties of the event dump. */
363
- eventDump?: EventDumpObject | EventDumpObjectJSON;
391
+ eventDump?: EventDumpObject | EventDumpObjectInput;
364
392
  }
365
393
 
366
394
  /** EventDumpGetResponse */
@@ -386,6 +414,13 @@ export interface EventDumpObjectJSON {
386
414
  "files"?: Array<EventDumpFilesObjectJSON>;
387
415
  }
388
416
 
417
+ /** EventDumpObject in the API format as an argument: a nested model may also be given as a model. */
418
+ export interface EventDumpObjectInput {
419
+ "dump_id"?: string;
420
+ "dump_status"?: string;
421
+ "files"?: Array<EventDumpFilesObject | EventDumpFilesObjectInput>;
422
+ }
423
+
389
424
  /** Fields of new EventDumpObject(): a nested model may be a plain object in the API format. */
390
425
  export interface EventDumpObjectInit {
391
426
  /**
@@ -407,7 +442,7 @@ export interface EventDumpObjectInit {
407
442
  * everything listed in “files” even if "dump_status" is still "in_process". If there are no events,
408
443
  * according to the specified parameters, an empty array will be returned.
409
444
  */
410
- files?: Array<EventDumpFilesObject | EventDumpFilesObjectJSON>;
445
+ files?: Array<EventDumpFilesObject | EventDumpFilesObjectInput>;
411
446
  }
412
447
 
413
448
  /** An object with the properties of the event dump. */
@@ -445,6 +480,9 @@ export interface EventDumpFilesObjectJSON {
445
480
  "size"?: number;
446
481
  }
447
482
 
483
+ /** EventDumpFilesObject in the API format as an argument: a nested model may also be given as a model. */
484
+ export type EventDumpFilesObjectInput = EventDumpFilesObjectJSON;
485
+
448
486
  /** Fields of new EventDumpFilesObject(): a nested model may be a plain object in the API format. */
449
487
  export interface EventDumpFilesObjectInit {
450
488
  /**
@@ -478,6 +516,12 @@ export interface EventDumpListResponseJSON {
478
516
  "event_dumps"?: Array<EventDumpObjectJSON>;
479
517
  }
480
518
 
519
+ /** EventDumpListResponse in the API format as an argument: a nested model may also be given as a model. */
520
+ export interface EventDumpListResponseInput {
521
+ "status"?: string;
522
+ "event_dumps"?: Array<EventDumpObject | EventDumpObjectInput>;
523
+ }
524
+
481
525
  /** Fields of new EventDumpListResponse(): a nested model may be a plain object in the API format. */
482
526
  export interface EventDumpListResponseInit {
483
527
  /**
@@ -489,7 +533,7 @@ export interface EventDumpListResponseInit {
489
533
  * An array of objects describing event dumps. Each object is similar to 'event_dump' object returned
490
534
  * by the [event-dump/get](https://docs.unione.io/en/web-api-ref#event-dump-get) method.
491
535
  */
492
- eventDumps?: Array<EventDumpObject | EventDumpObjectJSON>;
536
+ eventDumps?: Array<EventDumpObject | EventDumpObjectInput>;
493
537
  }
494
538
 
495
539
  /** EventDumpListResponse */
@@ -516,6 +560,9 @@ export interface EventDumpDeleteRequestJSON {
516
560
  "dump_id": string;
517
561
  }
518
562
 
563
+ /** EventDumpDeleteRequest in the API format as an argument: a nested model may also be given as a model. */
564
+ export type EventDumpDeleteRequestInput = EventDumpDeleteRequestJSON;
565
+
519
566
  /** Fields of new EventDumpDeleteRequest(): a nested model may be a plain object in the API format. */
520
567
  export interface EventDumpDeleteRequestInit {
521
568
  /**
@@ -1,6 +1,6 @@
1
1
  // ObsoleteApi: API methods of the Obsolete section.
2
2
  import type { ApiClient } from "../../client/ApiClient.js";
3
- import type { ObsoleteUnsubscribedCheckRequest, ObsoleteUnsubscribedCheckRequestJSON, ObsoleteUnsubscribedCheckResponse, ObsoleteUnsubscribedListRequest, ObsoleteUnsubscribedListRequestJSON, ObsoleteUnsubscribedListResponse, ObsoleteUnsubscribedSetRequest, ObsoleteUnsubscribedSetRequestJSON, ObsoleteUnsubscribedSetResponse } from "./models.js";
3
+ import type { ObsoleteUnsubscribedCheckRequest, ObsoleteUnsubscribedCheckRequestInput, ObsoleteUnsubscribedCheckResponse, ObsoleteUnsubscribedListRequest, ObsoleteUnsubscribedListRequestInput, ObsoleteUnsubscribedListResponse, ObsoleteUnsubscribedSetRequest, ObsoleteUnsubscribedSetRequestInput, ObsoleteUnsubscribedSetResponse } from "./models.js";
4
4
 
5
5
  /**
6
6
  * Obsolete methods dealing with unsubscribes. We recommend using the more flexible
@@ -25,7 +25,7 @@ export declare class ObsoleteApi {
25
25
  * Documentation: https://docs.unione.io/en/web-api-ref#unsubscribed-set
26
26
  * @throws {ApiError}
27
27
  */
28
- unsubscribedSet(request: ObsoleteUnsubscribedSetRequest | ObsoleteUnsubscribedSetRequestJSON): Promise<ObsoleteUnsubscribedSetResponse>;
28
+ unsubscribedSet(request: ObsoleteUnsubscribedSetRequest | ObsoleteUnsubscribedSetRequestInput): Promise<ObsoleteUnsubscribedSetResponse>;
29
29
 
30
30
  /**
31
31
  * Checks if an email is unsubscribed.
@@ -33,7 +33,7 @@ export declare class ObsoleteApi {
33
33
  * Documentation: https://docs.unione.io/en/web-api-ref#unsubscribed-check
34
34
  * @throws {ApiError}
35
35
  */
36
- unsubscribedCheck(request: ObsoleteUnsubscribedCheckRequest | ObsoleteUnsubscribedCheckRequestJSON): Promise<ObsoleteUnsubscribedCheckResponse>;
36
+ unsubscribedCheck(request: ObsoleteUnsubscribedCheckRequest | ObsoleteUnsubscribedCheckRequestInput): Promise<ObsoleteUnsubscribedCheckResponse>;
37
37
 
38
38
  /**
39
39
  * Returns a list of all unsubscribed emails since provided date.
@@ -41,5 +41,5 @@ export declare class ObsoleteApi {
41
41
  * Documentation: https://docs.unione.io/en/web-api-ref#unsubscribed-list
42
42
  * @throws {ApiError}
43
43
  */
44
- unsubscribedList(request?: ObsoleteUnsubscribedListRequest | ObsoleteUnsubscribedListRequestJSON): Promise<ObsoleteUnsubscribedListResponse>;
44
+ unsubscribedList(request?: ObsoleteUnsubscribedListRequest | ObsoleteUnsubscribedListRequestInput): Promise<ObsoleteUnsubscribedListResponse>;
45
45
  }
@@ -29,6 +29,9 @@ export interface ObsoleteUnsubscribedSetRequestJSON {
29
29
  "address": string;
30
30
  }
31
31
 
32
+ /** ObsoleteUnsubscribedSetRequest in the API format as an argument: a nested model may also be given as a model. */
33
+ export type ObsoleteUnsubscribedSetRequestInput = ObsoleteUnsubscribedSetRequestJSON;
34
+
32
35
  /** Fields of new ObsoleteUnsubscribedSetRequest(): a nested model may be a plain object in the API format. */
33
36
  export interface ObsoleteUnsubscribedSetRequestInit {
34
37
  /** Email to be unsubscribed. */
@@ -53,6 +56,9 @@ export interface ObsoleteUnsubscribedSetResponseJSON {
53
56
  "message"?: ObsoleteUnsubscribedSetMessage;
54
57
  }
55
58
 
59
+ /** ObsoleteUnsubscribedSetResponse in the API format as an argument: a nested model may also be given as a model. */
60
+ export type ObsoleteUnsubscribedSetResponseInput = ObsoleteUnsubscribedSetResponseJSON;
61
+
56
62
  /** Fields of new ObsoleteUnsubscribedSetResponse(): a nested model may be a plain object in the API format. */
57
63
  export interface ObsoleteUnsubscribedSetResponseInit {
58
64
  /**
@@ -103,6 +109,9 @@ export interface ObsoleteUnsubscribedCheckRequestJSON {
103
109
  "address": string;
104
110
  }
105
111
 
112
+ /** ObsoleteUnsubscribedCheckRequest in the API format as an argument: a nested model may also be given as a model. */
113
+ export type ObsoleteUnsubscribedCheckRequestInput = ObsoleteUnsubscribedCheckRequestJSON;
114
+
106
115
  /** Fields of new ObsoleteUnsubscribedCheckRequest(): a nested model may be a plain object in the API format. */
107
116
  export interface ObsoleteUnsubscribedCheckRequestInit {
108
117
  /** Email to check. */
@@ -127,6 +136,9 @@ export interface ObsoleteUnsubscribedCheckResponseJSON {
127
136
  "is_unsubscribed"?: boolean;
128
137
  }
129
138
 
139
+ /** ObsoleteUnsubscribedCheckResponse in the API format as an argument: a nested model may also be given as a model. */
140
+ export type ObsoleteUnsubscribedCheckResponseInput = ObsoleteUnsubscribedCheckResponseJSON;
141
+
130
142
  /** Fields of new ObsoleteUnsubscribedCheckResponse(): a nested model may be a plain object in the API format. */
131
143
  export interface ObsoleteUnsubscribedCheckResponseInit {
132
144
  /**
@@ -163,6 +175,9 @@ export interface ObsoleteUnsubscribedListRequestJSON {
163
175
  "date_from"?: string;
164
176
  }
165
177
 
178
+ /** ObsoleteUnsubscribedListRequest in the API format as an argument: a nested model may also be given as a model. */
179
+ export type ObsoleteUnsubscribedListRequestInput = ObsoleteUnsubscribedListRequestJSON;
180
+
166
181
  /** Fields of new ObsoleteUnsubscribedListRequest(): a nested model may be a plain object in the API format. */
167
182
  export interface ObsoleteUnsubscribedListRequestInit {
168
183
  /**
@@ -192,6 +207,12 @@ export interface ObsoleteUnsubscribedListResponseJSON {
192
207
  "unsubscribed"?: Array<ObsoleteUnsubscribedListResponseUnsubscribedItemJSON>;
193
208
  }
194
209
 
210
+ /** ObsoleteUnsubscribedListResponse in the API format as an argument: a nested model may also be given as a model. */
211
+ export interface ObsoleteUnsubscribedListResponseInput {
212
+ "status"?: string;
213
+ "unsubscribed"?: Array<ObsoleteUnsubscribedListResponseUnsubscribedItem | ObsoleteUnsubscribedListResponseUnsubscribedItemInput>;
214
+ }
215
+
195
216
  /** Fields of new ObsoleteUnsubscribedListResponse(): a nested model may be a plain object in the API format. */
196
217
  export interface ObsoleteUnsubscribedListResponseInit {
197
218
  /**
@@ -200,7 +221,7 @@ export interface ObsoleteUnsubscribedListResponseInit {
200
221
  */
201
222
  status?: string;
202
223
  /** Array of object describing unsubscribed emails. */
203
- unsubscribed?: Array<ObsoleteUnsubscribedListResponseUnsubscribedItem | ObsoleteUnsubscribedListResponseUnsubscribedItemJSON>;
224
+ unsubscribed?: Array<ObsoleteUnsubscribedListResponseUnsubscribedItem | ObsoleteUnsubscribedListResponseUnsubscribedItemInput>;
204
225
  }
205
226
 
206
227
  /** ObsoleteUnsubscribedListResponse */
@@ -225,6 +246,9 @@ export interface ObsoleteUnsubscribedListResponseUnsubscribedItemJSON {
225
246
  "unsubscribed_on"?: string;
226
247
  }
227
248
 
249
+ /** ObsoleteUnsubscribedListResponseUnsubscribedItem in the API format as an argument: a nested model may also be given as a model. */
250
+ export type ObsoleteUnsubscribedListResponseUnsubscribedItemInput = ObsoleteUnsubscribedListResponseUnsubscribedItemJSON;
251
+
228
252
  /** Fields of new ObsoleteUnsubscribedListResponseUnsubscribedItem(): a nested model may be a plain object in the API format. */
229
253
  export interface ObsoleteUnsubscribedListResponseUnsubscribedItemInit {
230
254
  /** Unsubscribed email. */
@@ -1,7 +1,7 @@
1
1
  // ProjectApi: API methods of the Project section.
2
2
  import type { ApiClient } from "../../client/ApiClient.js";
3
3
  import type { SuccessResponse } from "../../common/models.js";
4
- import type { ProjectCreateRequest, ProjectCreateRequestJSON, ProjectCreateResponse, ProjectDeleteRequest, ProjectDeleteRequestJSON, ProjectListRequest, ProjectListRequestJSON, ProjectListResponse, ProjectUpdateRequest, ProjectUpdateRequestJSON, ProjectUpdateResponse } from "./models.js";
4
+ import type { ProjectCreateRequest, ProjectCreateRequestInput, ProjectCreateResponse, ProjectDeleteRequest, ProjectDeleteRequestInput, ProjectListRequest, ProjectListRequestInput, ProjectListResponse, ProjectUpdateRequest, ProjectUpdateRequestInput, ProjectUpdateResponse } from "./models.js";
5
5
 
6
6
  /**
7
7
  * Projects allow you to group several independent domains, webhooks, templates, and unsubscription
@@ -27,7 +27,7 @@ export declare class ProjectApi {
27
27
  * Documentation: https://docs.unione.io/en/web-api-ref#project-create
28
28
  * @throws {ApiError}
29
29
  */
30
- create(request: ProjectCreateRequest | ProjectCreateRequestJSON): Promise<ProjectCreateResponse>;
30
+ create(request: ProjectCreateRequest | ProjectCreateRequestInput): Promise<ProjectCreateResponse>;
31
31
 
32
32
  /**
33
33
  * Updates a project.
@@ -35,7 +35,7 @@ export declare class ProjectApi {
35
35
  * Documentation: https://docs.unione.io/en/web-api-ref#project-update
36
36
  * @throws {ApiError}
37
37
  */
38
- update(request: ProjectUpdateRequest | ProjectUpdateRequestJSON): Promise<ProjectUpdateResponse>;
38
+ update(request: ProjectUpdateRequest | ProjectUpdateRequestInput): Promise<ProjectUpdateResponse>;
39
39
 
40
40
  /**
41
41
  * Lists projects.
@@ -43,7 +43,7 @@ export declare class ProjectApi {
43
43
  * Documentation: https://docs.unione.io/en/web-api-ref#project-list
44
44
  * @throws {ApiError}
45
45
  */
46
- list(request?: ProjectListRequest | ProjectListRequestJSON): Promise<ProjectListResponse>;
46
+ list(request?: ProjectListRequest | ProjectListRequestInput): Promise<ProjectListResponse>;
47
47
 
48
48
  /**
49
49
  * Deletes a project.
@@ -54,5 +54,5 @@ export declare class ProjectApi {
54
54
  * Documentation: https://docs.unione.io/en/web-api-ref#project-delete
55
55
  * @throws {ApiError}
56
56
  */
57
- delete(request?: ProjectDeleteRequest | ProjectDeleteRequestJSON): Promise<SuccessResponse>;
57
+ delete(request?: ProjectDeleteRequest | ProjectDeleteRequestInput): Promise<SuccessResponse>;
58
58
  }
@@ -6,10 +6,15 @@ export interface ProjectCreateRequestJSON {
6
6
  "project": ProjectObjectJSON;
7
7
  }
8
8
 
9
+ /** ProjectCreateRequest in the API format as an argument: a nested model may also be given as a model. */
10
+ export interface ProjectCreateRequestInput {
11
+ "project": ProjectObject | ProjectObjectInput;
12
+ }
13
+
9
14
  /** Fields of new ProjectCreateRequest(): a nested model may be a plain object in the API format. */
10
15
  export interface ProjectCreateRequestInit {
11
16
  /** Object with project properties. */
12
- project: ProjectObject | ProjectObjectJSON;
17
+ project: ProjectObject | ProjectObjectInput;
13
18
  }
14
19
 
15
20
  /** ProjectCreateRequest */
@@ -33,6 +38,9 @@ export interface ProjectObjectJSON {
33
38
  "unsubscribe_page_id"?: number;
34
39
  }
35
40
 
41
+ /** ProjectObject in the API format as an argument: a nested model may also be given as a model. */
42
+ export type ProjectObjectInput = ProjectObjectJSON;
43
+
36
44
  /** Fields of new ProjectObject(): a nested model may be a plain object in the API format. */
37
45
  export interface ProjectObjectInit {
38
46
  /** Project name, unique for user account. */
@@ -121,6 +129,9 @@ export interface ProjectCreateResponseJSON {
121
129
  "project_api_key"?: string;
122
130
  }
123
131
 
132
+ /** ProjectCreateResponse in the API format as an argument: a nested model may also be given as a model. */
133
+ export type ProjectCreateResponseInput = ProjectCreateResponseJSON;
134
+
124
135
  /** Fields of new ProjectCreateResponse(): a nested model may be a plain object in the API format. */
125
136
  export interface ProjectCreateResponseInit {
126
137
  /**
@@ -165,6 +176,13 @@ export interface ProjectUpdateRequestJSON {
165
176
  "project": ProjectUpdateObjectJSON;
166
177
  }
167
178
 
179
+ /** ProjectUpdateRequest in the API format as an argument: a nested model may also be given as a model. */
180
+ export interface ProjectUpdateRequestInput {
181
+ "project_id"?: string;
182
+ "project_api_key"?: string;
183
+ "project": ProjectUpdateObject | ProjectUpdateObjectInput;
184
+ }
185
+
168
186
  /** Fields of new ProjectUpdateRequest(): a nested model may be a plain object in the API format. */
169
187
  export interface ProjectUpdateRequestInit {
170
188
  /**
@@ -178,7 +196,7 @@ export interface ProjectUpdateRequestInit {
178
196
  */
179
197
  projectApiKey?: string;
180
198
  /** Object with project properties. */
181
- project: ProjectUpdateObject | ProjectUpdateObjectJSON;
199
+ project: ProjectUpdateObject | ProjectUpdateObjectInput;
182
200
  }
183
201
 
184
202
  /** ProjectUpdateRequest */
@@ -215,6 +233,9 @@ export interface ProjectUpdateObjectJSON {
215
233
  "email_counter_mode"?: EmailCounterMode;
216
234
  }
217
235
 
236
+ /** ProjectUpdateObject in the API format as an argument: a nested model may also be given as a model. */
237
+ export type ProjectUpdateObjectInput = ProjectUpdateObjectJSON;
238
+
218
239
  /** Fields of new ProjectUpdateObject(): a nested model may be a plain object in the API format. */
219
240
  export interface ProjectUpdateObjectInit {
220
241
  /** Project name, unique for user account. */
@@ -350,6 +371,9 @@ export interface ProjectUpdateResponseJSON {
350
371
  "project_api_key"?: string;
351
372
  }
352
373
 
374
+ /** ProjectUpdateResponse in the API format as an argument: a nested model may also be given as a model. */
375
+ export type ProjectUpdateResponseInput = ProjectUpdateResponseJSON;
376
+
353
377
  /** Fields of new ProjectUpdateResponse(): a nested model may be a plain object in the API format. */
354
378
  export interface ProjectUpdateResponseInit {
355
379
  /**
@@ -389,6 +413,9 @@ export interface ProjectListRequestJSON {
389
413
  "project_api_key"?: string;
390
414
  }
391
415
 
416
+ /** ProjectListRequest in the API format as an argument: a nested model may also be given as a model. */
417
+ export type ProjectListRequestInput = ProjectListRequestJSON;
418
+
392
419
  /** Fields of new ProjectListRequest(): a nested model may be a plain object in the API format. */
393
420
  export interface ProjectListRequestInit {
394
421
  /** Optional possibility to specify project_id to include only this project to list. */
@@ -416,6 +443,12 @@ export interface ProjectListResponseJSON {
416
443
  "projects"?: Array<ProjectListObjectJSON>;
417
444
  }
418
445
 
446
+ /** ProjectListResponse in the API format as an argument: a nested model may also be given as a model. */
447
+ export interface ProjectListResponseInput {
448
+ "status"?: string;
449
+ "projects"?: Array<ProjectListObject | ProjectListObjectInput>;
450
+ }
451
+
419
452
  /** Fields of new ProjectListResponse(): a nested model may be a plain object in the API format. */
420
453
  export interface ProjectListResponseInit {
421
454
  /**
@@ -424,7 +457,7 @@ export interface ProjectListResponseInit {
424
457
  */
425
458
  status?: string;
426
459
  /** Array of objects where each object represents one project. */
427
- projects?: Array<ProjectListObject | ProjectListObjectJSON>;
460
+ projects?: Array<ProjectListObject | ProjectListObjectInput>;
428
461
  }
429
462
 
430
463
  /** ProjectListResponse */
@@ -459,6 +492,9 @@ export interface ProjectListObjectJSON {
459
492
  "unsubscribe_page_id"?: number;
460
493
  }
461
494
 
495
+ /** ProjectListObject in the API format as an argument: a nested model may also be given as a model. */
496
+ export type ProjectListObjectInput = ProjectListObjectJSON;
497
+
462
498
  /** Fields of new ProjectListObject(): a nested model may be a plain object in the API format. */
463
499
  export interface ProjectListObjectInit {
464
500
  /** Unqiue project identifier, ASCII string up to 36 characters long. */
@@ -590,6 +626,9 @@ export interface ProjectDeleteRequestJSON {
590
626
  "project_api_key"?: string;
591
627
  }
592
628
 
629
+ /** ProjectDeleteRequest in the API format as an argument: a nested model may also be given as a model. */
630
+ export type ProjectDeleteRequestInput = ProjectDeleteRequestJSON;
631
+
593
632
  /** Fields of new ProjectDeleteRequest(): a nested model may be a plain object in the API format. */
594
633
  export interface ProjectDeleteRequestInit {
595
634
  /**
@@ -1,7 +1,7 @@
1
1
  // SuppressionApi: API methods of the Suppression section.
2
2
  import type { ApiClient } from "../../client/ApiClient.js";
3
3
  import type { SuccessResponse } from "../../common/models.js";
4
- import type { SuppressionDeleteRequest, SuppressionDeleteRequestJSON, SuppressionGetRequest, SuppressionGetRequestJSON, SuppressionGetResponse, SuppressionListRequest, SuppressionListRequestJSON, SuppressionListResponse, SuppressionSetRequest, SuppressionSetRequestJSON } from "./models.js";
4
+ import type { SuppressionDeleteRequest, SuppressionDeleteRequestInput, SuppressionGetRequest, SuppressionGetRequestInput, SuppressionGetResponse, SuppressionListRequest, SuppressionListRequestInput, SuppressionListResponse, SuppressionSetRequest, SuppressionSetRequestInput } from "./models.js";
5
5
 
6
6
  /**
7
7
  * Methods for managing suppression lists. An email can be added to suppression list because of
@@ -19,7 +19,7 @@ export declare class SuppressionApi {
19
19
  * Documentation: https://docs.unione.io/en/web-api-ref#suppression-set
20
20
  * @throws {ApiError}
21
21
  */
22
- set(request: SuppressionSetRequest | SuppressionSetRequestJSON): Promise<SuccessResponse>;
22
+ set(request: SuppressionSetRequest | SuppressionSetRequestInput): Promise<SuccessResponse>;
23
23
 
24
24
  /**
25
25
  * Gets a reason and date of email suppression.
@@ -27,7 +27,7 @@ export declare class SuppressionApi {
27
27
  * Documentation: https://docs.unione.io/en/web-api-ref#suppression-get
28
28
  * @throws {ApiError}
29
29
  */
30
- get(request: SuppressionGetRequest | SuppressionGetRequestJSON): Promise<SuppressionGetResponse>;
30
+ get(request: SuppressionGetRequest | SuppressionGetRequestInput): Promise<SuppressionGetResponse>;
31
31
 
32
32
  /**
33
33
  * Returns a suppression list since provided date.
@@ -35,7 +35,7 @@ export declare class SuppressionApi {
35
35
  * Documentation: https://docs.unione.io/en/web-api-ref#suppression-list
36
36
  * @throws {ApiError}
37
37
  */
38
- list(request?: SuppressionListRequest | SuppressionListRequestJSON): Promise<SuppressionListResponse>;
38
+ list(request?: SuppressionListRequest | SuppressionListRequestInput): Promise<SuppressionListResponse>;
39
39
 
40
40
  /**
41
41
  * Deletes an email from suppression list (only records with is_deletable=true). If there are no
@@ -46,5 +46,5 @@ export declare class SuppressionApi {
46
46
  * Documentation: https://docs.unione.io/en/web-api-ref#suppression-delete
47
47
  * @throws {ApiError}
48
48
  */
49
- delete(request: SuppressionDeleteRequest | SuppressionDeleteRequestJSON): Promise<SuccessResponse>;
49
+ delete(request: SuppressionDeleteRequest | SuppressionDeleteRequestInput): Promise<SuccessResponse>;
50
50
  }
@@ -7,6 +7,9 @@ export interface SuppressionSetRequestJSON {
7
7
  "created"?: string;
8
8
  }
9
9
 
10
+ /** SuppressionSetRequest in the API format as an argument: a nested model may also be given as a model. */
11
+ export type SuppressionSetRequestInput = SuppressionSetRequestJSON;
12
+
10
13
  /** Fields of new SuppressionSetRequest(): a nested model may be a plain object in the API format. */
11
14
  export interface SuppressionSetRequestInit {
12
15
  /** Email to add in suppression list. */
@@ -64,6 +67,9 @@ export interface SuppressionGetRequestJSON {
64
67
  "all_projects"?: boolean;
65
68
  }
66
69
 
70
+ /** SuppressionGetRequest in the API format as an argument: a nested model may also be given as a model. */
71
+ export type SuppressionGetRequestInput = SuppressionGetRequestJSON;
72
+
67
73
  /** Fields of new SuppressionGetRequest(): a nested model may be a plain object in the API format. */
68
74
  export interface SuppressionGetRequestInit {
69
75
  /** Email to get suppression details for. */
@@ -100,6 +106,13 @@ export interface SuppressionGetResponseJSON {
100
106
  "suppressions"?: Array<SuppressionGetObjectJSON>;
101
107
  }
102
108
 
109
+ /** SuppressionGetResponse in the API format as an argument: a nested model may also be given as a model. */
110
+ export interface SuppressionGetResponseInput {
111
+ "status"?: string;
112
+ "email"?: string;
113
+ "suppressions"?: Array<SuppressionGetObject | SuppressionGetObjectInput>;
114
+ }
115
+
103
116
  /** Fields of new SuppressionGetResponse(): a nested model may be a plain object in the API format. */
104
117
  export interface SuppressionGetResponseInit {
105
118
  /**
@@ -110,7 +123,7 @@ export interface SuppressionGetResponseInit {
110
123
  /** The email for which suppression details were requested. */
111
124
  email?: string;
112
125
  /** Array of suppression objects. */
113
- suppressions?: Array<SuppressionGetObject | SuppressionGetObjectJSON>;
126
+ suppressions?: Array<SuppressionGetObject | SuppressionGetObjectInput>;
114
127
  }
115
128
 
116
129
  /** SuppressionGetResponse */
@@ -140,6 +153,9 @@ export interface SuppressionGetObjectJSON {
140
153
  "created"?: string;
141
154
  }
142
155
 
156
+ /** SuppressionGetObject in the API format as an argument: a nested model may also be given as a model. */
157
+ export type SuppressionGetObjectInput = SuppressionGetObjectJSON;
158
+
143
159
  /** Fields of new SuppressionGetObject(): a nested model may be a plain object in the API format. */
144
160
  export interface SuppressionGetObjectInit {
145
161
  /** Unqiue project identifier, ASCII string up to 36 characters long. */
@@ -224,6 +240,9 @@ export interface SuppressionListRequestJSON {
224
240
  "limit"?: number;
225
241
  }
226
242
 
243
+ /** SuppressionListRequest in the API format as an argument: a nested model may also be given as a model. */
244
+ export type SuppressionListRequestInput = SuppressionListRequestJSON;
245
+
227
246
  /** Fields of new SuppressionListRequest(): a nested model may be a plain object in the API format. */
228
247
  export interface SuppressionListRequestInit {
229
248
  /**
@@ -320,6 +339,13 @@ export interface SuppressionListResponseJSON {
320
339
  "cursor"?: string;
321
340
  }
322
341
 
342
+ /** SuppressionListResponse in the API format as an argument: a nested model may also be given as a model. */
343
+ export interface SuppressionListResponseInput {
344
+ "status"?: string;
345
+ "suppressions"?: Array<SuppressionListObject | SuppressionListObjectInput>;
346
+ "cursor"?: string;
347
+ }
348
+
323
349
  /** Fields of new SuppressionListResponse(): a nested model may be a plain object in the API format. */
324
350
  export interface SuppressionListResponseInit {
325
351
  /**
@@ -328,7 +354,7 @@ export interface SuppressionListResponseInit {
328
354
  */
329
355
  status?: string;
330
356
  /** Array of suppression objects. */
331
- suppressions?: Array<SuppressionListObject | SuppressionListObjectJSON>;
357
+ suppressions?: Array<SuppressionListObject | SuppressionListObjectInput>;
332
358
  /**
333
359
  * The parameter indicates from which position the selection is to be started. Must be empty or omitted
334
360
  * for the first data chunk. In order to get subsequent chunks, you must set the "cursor" parameter in
@@ -368,6 +394,9 @@ export interface SuppressionListObjectJSON {
368
394
  "created"?: string;
369
395
  }
370
396
 
397
+ /** SuppressionListObject in the API format as an argument: a nested model may also be given as a model. */
398
+ export type SuppressionListObjectInput = SuppressionListObjectJSON;
399
+
371
400
  /** Fields of new SuppressionListObject(): a nested model may be a plain object in the API format. */
372
401
  export interface SuppressionListObjectInit {
373
402
  /** Email to get suppression details for. */
@@ -448,6 +477,9 @@ export interface SuppressionDeleteRequestJSON {
448
477
  "email": string;
449
478
  }
450
479
 
480
+ /** SuppressionDeleteRequest in the API format as an argument: a nested model may also be given as a model. */
481
+ export type SuppressionDeleteRequestInput = SuppressionDeleteRequestJSON;
482
+
451
483
  /** Fields of new SuppressionDeleteRequest(): a nested model may be a plain object in the API format. */
452
484
  export interface SuppressionDeleteRequestInit {
453
485
  /** An email to delete from suppression list. */