unione 2.2.3 → 2.3.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/AGENTS.md +53 -64
- package/LICENSE +1 -1
- package/README.md +27 -7
- package/package.json +5 -2
- package/src/api/confirmed-email/ConfirmedEmailApi.d.ts +3 -3
- package/src/api/confirmed-email/models.d.ts +23 -2
- package/src/api/domain/DomainApi.d.ts +6 -6
- package/src/api/domain/models.d.ts +52 -3
- package/src/api/email/EmailApi.d.ts +3 -3
- package/src/api/email/models.d.ts +54 -8
- package/src/api/email-validation/EmailValidationApi.d.ts +2 -2
- package/src/api/email-validation/models.d.ts +6 -0
- package/src/api/event-dump/EventDumpApi.d.ts +4 -4
- package/src/api/event-dump/models.d.ts +51 -4
- package/src/api/obsolete/ObsoleteApi.d.ts +4 -4
- package/src/api/obsolete/models.d.ts +25 -1
- package/src/api/project/ProjectApi.d.ts +5 -5
- package/src/api/project/models.d.ts +42 -3
- package/src/api/suppression/SuppressionApi.d.ts +5 -5
- package/src/api/suppression/models.d.ts +34 -2
- package/src/api/system/models.d.ts +22 -2
- package/src/api/tag/TagApi.d.ts +2 -2
- package/src/api/tag/models.d.ts +13 -1
- package/src/api/template/TemplateApi.d.ts +5 -5
- package/src/api/template/models.d.ts +91 -13
- package/src/api/webhook/WebhookApi.d.ts +5 -5
- package/src/api/webhook/models.d.ts +102 -9
- package/src/client/ApiClient.js +47 -16
- package/src/client/ApiError.d.ts +34 -1
- package/src/client/ApiError.js +42 -3
- package/src/client/Configuration.js +1 -1
- package/src/client/errors.js +195 -0
- package/src/client/index.d.ts +1 -1
- package/src/client/index.js +1 -1
- package/src/common/models.d.ts +15 -0
- package/src/index.d.ts +1 -1
- package/src/index.js +1 -1
|
@@ -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,
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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. */
|
|
@@ -7,6 +7,9 @@ export interface SystemPingResponseJSON {
|
|
|
7
7
|
"user_id"?: number;
|
|
8
8
|
}
|
|
9
9
|
|
|
10
|
+
/** SystemPingResponse in the API format as an argument: a nested model may also be given as a model. */
|
|
11
|
+
export type SystemPingResponseInput = SystemPingResponseJSON;
|
|
12
|
+
|
|
10
13
|
/** Fields of new SystemPingResponse(): a nested model may be a plain object in the API format. */
|
|
11
14
|
export interface SystemPingResponseInit {
|
|
12
15
|
/**
|
|
@@ -45,6 +48,17 @@ export interface SystemInfoResponseJSON {
|
|
|
45
48
|
"accounting"?: SystemInfoResponseAccountingJSON;
|
|
46
49
|
}
|
|
47
50
|
|
|
51
|
+
/** SystemInfoResponse in the API format as an argument: a nested model may also be given as a model. */
|
|
52
|
+
export interface SystemInfoResponseInput {
|
|
53
|
+
"status"?: string;
|
|
54
|
+
"user_id"?: number;
|
|
55
|
+
"email"?: string;
|
|
56
|
+
"project_id"?: string;
|
|
57
|
+
"project_name"?: string;
|
|
58
|
+
"project_accounting"?: ProjectAccountingObject | ProjectAccountingObjectInput;
|
|
59
|
+
"accounting"?: SystemInfoResponseAccounting | SystemInfoResponseAccountingInput;
|
|
60
|
+
}
|
|
61
|
+
|
|
48
62
|
/** Fields of new SystemInfoResponse(): a nested model may be a plain object in the API format. */
|
|
49
63
|
export interface SystemInfoResponseInit {
|
|
50
64
|
/**
|
|
@@ -70,12 +84,12 @@ export interface SystemInfoResponseInit {
|
|
|
70
84
|
* Object with email counter properties. Present only if the API key used for request is the user API
|
|
71
85
|
* key.
|
|
72
86
|
*/
|
|
73
|
-
projectAccounting?: ProjectAccountingObject |
|
|
87
|
+
projectAccounting?: ProjectAccountingObject | ProjectAccountingObjectInput;
|
|
74
88
|
/**
|
|
75
89
|
* Object with accounting period properties. Present only if the API key used for request is the user
|
|
76
90
|
* API key.
|
|
77
91
|
*/
|
|
78
|
-
accounting?: SystemInfoResponseAccounting |
|
|
92
|
+
accounting?: SystemInfoResponseAccounting | SystemInfoResponseAccountingInput;
|
|
79
93
|
}
|
|
80
94
|
|
|
81
95
|
/** SystemInfoResponse */
|
|
@@ -123,6 +137,9 @@ export interface ProjectAccountingObjectJSON {
|
|
|
123
137
|
"email_counter_mode"?: EmailCounterMode;
|
|
124
138
|
}
|
|
125
139
|
|
|
140
|
+
/** ProjectAccountingObject in the API format as an argument: a nested model may also be given as a model. */
|
|
141
|
+
export type ProjectAccountingObjectInput = ProjectAccountingObjectJSON;
|
|
142
|
+
|
|
126
143
|
/** Fields of new ProjectAccountingObject(): a nested model may be a plain object in the API format. */
|
|
127
144
|
export interface ProjectAccountingObjectInit {
|
|
128
145
|
/** Project's email counter value. It increases on every email sent. */
|
|
@@ -173,6 +190,9 @@ export interface SystemInfoResponseAccountingJSON {
|
|
|
173
190
|
"emails_sent"?: number;
|
|
174
191
|
}
|
|
175
192
|
|
|
193
|
+
/** SystemInfoResponseAccounting in the API format as an argument: a nested model may also be given as a model. */
|
|
194
|
+
export type SystemInfoResponseAccountingInput = SystemInfoResponseAccountingJSON;
|
|
195
|
+
|
|
176
196
|
/** Fields of new SystemInfoResponseAccounting(): a nested model may be a plain object in the API format. */
|
|
177
197
|
export interface SystemInfoResponseAccountingInit {
|
|
178
198
|
/** Date and time of accounting period start in UTC in "YYYY-MM-DD hh:mm:ss" format. */
|
package/src/api/tag/TagApi.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// TagApi: API methods of the Tag section.
|
|
2
2
|
import type { ApiClient } from "../../client/ApiClient.js";
|
|
3
3
|
import type { SuccessResponse } from "../../common/models.js";
|
|
4
|
-
import type { TagDeleteRequest,
|
|
4
|
+
import type { TagDeleteRequest, TagDeleteRequestInput, TagListResponse } from "./models.js";
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
7
|
* This family of methods is used to manage user-defined tags. Tags are used to categorize letters
|
|
@@ -28,5 +28,5 @@ export declare class TagApi {
|
|
|
28
28
|
* Documentation: https://docs.unione.io/en/web-api-ref#tag-delete
|
|
29
29
|
* @throws {ApiError}
|
|
30
30
|
*/
|
|
31
|
-
delete(request: TagDeleteRequest |
|
|
31
|
+
delete(request: TagDeleteRequest | TagDeleteRequestInput): Promise<SuccessResponse>;
|
|
32
32
|
}
|
package/src/api/tag/models.d.ts
CHANGED
|
@@ -6,6 +6,12 @@ export interface TagListResponseJSON {
|
|
|
6
6
|
"tags"?: Array<TagsResponseObjectJSON>;
|
|
7
7
|
}
|
|
8
8
|
|
|
9
|
+
/** TagListResponse in the API format as an argument: a nested model may also be given as a model. */
|
|
10
|
+
export interface TagListResponseInput {
|
|
11
|
+
"status"?: string;
|
|
12
|
+
"tags"?: Array<TagsResponseObject | TagsResponseObjectInput>;
|
|
13
|
+
}
|
|
14
|
+
|
|
9
15
|
/** Fields of new TagListResponse(): a nested model may be a plain object in the API format. */
|
|
10
16
|
export interface TagListResponseInit {
|
|
11
17
|
/**
|
|
@@ -14,7 +20,7 @@ export interface TagListResponseInit {
|
|
|
14
20
|
*/
|
|
15
21
|
status?: string;
|
|
16
22
|
/** An array of objects containing data for user-defined tags. */
|
|
17
|
-
tags?: Array<TagsResponseObject |
|
|
23
|
+
tags?: Array<TagsResponseObject | TagsResponseObjectInput>;
|
|
18
24
|
}
|
|
19
25
|
|
|
20
26
|
/** TagListResponse */
|
|
@@ -39,6 +45,9 @@ export interface TagsResponseObjectJSON {
|
|
|
39
45
|
"tag"?: string;
|
|
40
46
|
}
|
|
41
47
|
|
|
48
|
+
/** TagsResponseObject in the API format as an argument: a nested model may also be given as a model. */
|
|
49
|
+
export type TagsResponseObjectInput = TagsResponseObjectJSON;
|
|
50
|
+
|
|
42
51
|
/** Fields of new TagsResponseObject(): a nested model may be a plain object in the API format. */
|
|
43
52
|
export interface TagsResponseObjectInit {
|
|
44
53
|
/** Unique tag id. */
|
|
@@ -65,6 +74,9 @@ export interface TagDeleteRequestJSON {
|
|
|
65
74
|
"tag_id": number;
|
|
66
75
|
}
|
|
67
76
|
|
|
77
|
+
/** TagDeleteRequest in the API format as an argument: a nested model may also be given as a model. */
|
|
78
|
+
export type TagDeleteRequestInput = TagDeleteRequestJSON;
|
|
79
|
+
|
|
68
80
|
/** Fields of new TagDeleteRequest(): a nested model may be a plain object in the API format. */
|
|
69
81
|
export interface TagDeleteRequestInit {
|
|
70
82
|
/** Unique tag id. */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// TemplateApi: API methods of the Template section.
|
|
2
2
|
import type { ApiClient } from "../../client/ApiClient.js";
|
|
3
3
|
import type { SuccessResponse } from "../../common/models.js";
|
|
4
|
-
import type { TemplateDeleteRequest,
|
|
4
|
+
import type { TemplateDeleteRequest, TemplateDeleteRequestInput, TemplateGetRequest, TemplateGetRequestInput, TemplateGetResponse, TemplateListRequest, TemplateListRequestInput, TemplateListResponse, TemplateSetRequest, TemplateSetRequestInput, TemplateSetResponse } from "./models.js";
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
7
|
* You have the option of storing a template on the UniOne side and then using it by id, which is
|
|
@@ -22,7 +22,7 @@ export declare class TemplateApi {
|
|
|
22
22
|
* Documentation: https://docs.unione.io/en/web-api-ref#template-set
|
|
23
23
|
* @throws {ApiError}
|
|
24
24
|
*/
|
|
25
|
-
set(request: TemplateSetRequest |
|
|
25
|
+
set(request: TemplateSetRequest | TemplateSetRequestInput): Promise<TemplateSetResponse>;
|
|
26
26
|
|
|
27
27
|
/**
|
|
28
28
|
* Gets template properties by it's id.
|
|
@@ -30,7 +30,7 @@ export declare class TemplateApi {
|
|
|
30
30
|
* Documentation: https://docs.unione.io/en/web-api-ref#template-get
|
|
31
31
|
* @throws {ApiError}
|
|
32
32
|
*/
|
|
33
|
-
get(request: TemplateGetRequest |
|
|
33
|
+
get(request: TemplateGetRequest | TemplateGetRequestInput): Promise<TemplateGetResponse>;
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
36
|
* Returns the list of all or some templates of the account.
|
|
@@ -41,7 +41,7 @@ export declare class TemplateApi {
|
|
|
41
41
|
* Documentation: https://docs.unione.io/en/web-api-ref#template-list
|
|
42
42
|
* @throws {ApiError}
|
|
43
43
|
*/
|
|
44
|
-
list(request?: TemplateListRequest |
|
|
44
|
+
list(request?: TemplateListRequest | TemplateListRequestInput): Promise<TemplateListResponse>;
|
|
45
45
|
|
|
46
46
|
/**
|
|
47
47
|
* Deletes a template by id.
|
|
@@ -49,5 +49,5 @@ export declare class TemplateApi {
|
|
|
49
49
|
* Documentation: https://docs.unione.io/en/web-api-ref#template-delete
|
|
50
50
|
* @throws {ApiError}
|
|
51
51
|
*/
|
|
52
|
-
delete(request: TemplateDeleteRequest |
|
|
52
|
+
delete(request: TemplateDeleteRequest | TemplateDeleteRequestInput): Promise<SuccessResponse>;
|
|
53
53
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// Types of the models of the Template section.
|
|
2
|
-
import type { AttachmentsArrayItem, AttachmentsArrayItemJSON, BodyObject, BodyObjectJSON, HeadersObject, HeadersObjectJSON, InlineAttachmentsArrayItem, InlineAttachmentsArrayItemJSON, TemplateEngine } from "../../common/models.js";
|
|
2
|
+
import type { AttachmentsArrayItem, AttachmentsArrayItemInput, AttachmentsArrayItemJSON, BodyObject, BodyObjectInput, BodyObjectJSON, HeadersObject, HeadersObjectInput, HeadersObjectJSON, InlineAttachmentsArrayItem, InlineAttachmentsArrayItemInput, InlineAttachmentsArrayItemJSON, TemplateEngine } from "../../common/models.js";
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Editor type, "html" or "visual". Default is "html". You can create a template with "visual" editor
|
|
@@ -20,10 +20,15 @@ export interface TemplateSetRequestJSON {
|
|
|
20
20
|
"template": TemplateObjectJSON;
|
|
21
21
|
}
|
|
22
22
|
|
|
23
|
+
/** TemplateSetRequest in the API format as an argument: a nested model may also be given as a model. */
|
|
24
|
+
export interface TemplateSetRequestInput {
|
|
25
|
+
"template": TemplateObject | TemplateObjectInput;
|
|
26
|
+
}
|
|
27
|
+
|
|
23
28
|
/** Fields of new TemplateSetRequest(): a nested model may be a plain object in the API format. */
|
|
24
29
|
export interface TemplateSetRequestInit {
|
|
25
30
|
/** Object with all the template properties. */
|
|
26
|
-
template: TemplateObject |
|
|
31
|
+
template: TemplateObject | TemplateObjectInput;
|
|
27
32
|
}
|
|
28
33
|
|
|
29
34
|
/** Object with all the properties of the template. */
|
|
@@ -58,6 +63,27 @@ export interface TemplateObjectJSON {
|
|
|
58
63
|
"inline_attachments"?: Array<InlineAttachmentsArrayItemJSON>;
|
|
59
64
|
}
|
|
60
65
|
|
|
66
|
+
/** TemplateObject in the API format as an argument: a nested model may also be given as a model. */
|
|
67
|
+
export interface TemplateObjectInput {
|
|
68
|
+
"id"?: string;
|
|
69
|
+
"name": string;
|
|
70
|
+
"editor_type"?: EditorType;
|
|
71
|
+
"template_engine"?: TemplateEngine;
|
|
72
|
+
"global_substitutions"?: Record<string, string>;
|
|
73
|
+
"global_metadata"?: Record<string, string>;
|
|
74
|
+
"body"?: BodyObject | BodyObjectInput;
|
|
75
|
+
"subject"?: string;
|
|
76
|
+
"from_email": string;
|
|
77
|
+
"from_name"?: string;
|
|
78
|
+
"reply_to"?: string;
|
|
79
|
+
"reply_to_name"?: string;
|
|
80
|
+
"track_links"?: number;
|
|
81
|
+
"track_read"?: number;
|
|
82
|
+
"headers"?: HeadersObject | HeadersObjectInput;
|
|
83
|
+
"attachments"?: Array<AttachmentsArrayItem | AttachmentsArrayItemInput>;
|
|
84
|
+
"inline_attachments"?: Array<InlineAttachmentsArrayItem | InlineAttachmentsArrayItemInput>;
|
|
85
|
+
}
|
|
86
|
+
|
|
61
87
|
/** Fields of new TemplateObject(): a nested model may be a plain object in the API format. */
|
|
62
88
|
export interface TemplateObjectInit {
|
|
63
89
|
/**
|
|
@@ -102,7 +128,7 @@ export interface TemplateObjectInit {
|
|
|
102
128
|
*/
|
|
103
129
|
globalMetadata?: Record<string, string>;
|
|
104
130
|
/** Contains HTML/plaintext/AMP parts of the email. Either html or plaintext part is required. */
|
|
105
|
-
body?: BodyObject |
|
|
131
|
+
body?: BodyObject | BodyObjectInput;
|
|
106
132
|
/** Email subject. */
|
|
107
133
|
subject?: string;
|
|
108
134
|
/** Sender's email. */
|
|
@@ -137,14 +163,14 @@ export interface TemplateObjectInit {
|
|
|
137
163
|
* List-Unsubscribe, List-Subscribe, List-Help, List-Owner, List-Archive, In-Reply-To and References
|
|
138
164
|
* headers.
|
|
139
165
|
*/
|
|
140
|
-
headers?: HeadersObject |
|
|
166
|
+
headers?: HeadersObject | HeadersObjectInput;
|
|
141
167
|
/** Optional array of attachments */
|
|
142
|
-
attachments?: Array<AttachmentsArrayItem |
|
|
168
|
+
attachments?: Array<AttachmentsArrayItem | AttachmentsArrayItemInput>;
|
|
143
169
|
/**
|
|
144
170
|
* Optional array of inline attachments, e.g. for including images in email instead of loading them
|
|
145
171
|
* from external URL.
|
|
146
172
|
*/
|
|
147
|
-
inlineAttachments?: Array<InlineAttachmentsArrayItem |
|
|
173
|
+
inlineAttachments?: Array<InlineAttachmentsArrayItem | InlineAttachmentsArrayItemInput>;
|
|
148
174
|
}
|
|
149
175
|
|
|
150
176
|
/** Object with all the template properties. */
|
|
@@ -247,6 +273,12 @@ export interface TemplateSetResponseJSON {
|
|
|
247
273
|
"template"?: TemplateObjectJSON;
|
|
248
274
|
}
|
|
249
275
|
|
|
276
|
+
/** TemplateSetResponse in the API format as an argument: a nested model may also be given as a model. */
|
|
277
|
+
export interface TemplateSetResponseInput {
|
|
278
|
+
"status"?: string;
|
|
279
|
+
"template"?: TemplateObject | TemplateObjectInput;
|
|
280
|
+
}
|
|
281
|
+
|
|
250
282
|
/** Fields of new TemplateSetResponse(): a nested model may be a plain object in the API format. */
|
|
251
283
|
export interface TemplateSetResponseInit {
|
|
252
284
|
/**
|
|
@@ -255,7 +287,7 @@ export interface TemplateSetResponseInit {
|
|
|
255
287
|
*/
|
|
256
288
|
status?: string;
|
|
257
289
|
/** Object with all the template properties. */
|
|
258
|
-
template?: TemplateObject |
|
|
290
|
+
template?: TemplateObject | TemplateObjectInput;
|
|
259
291
|
}
|
|
260
292
|
|
|
261
293
|
/** TemplateSetResponse */
|
|
@@ -279,6 +311,9 @@ export interface TemplateGetRequestJSON {
|
|
|
279
311
|
"id": string;
|
|
280
312
|
}
|
|
281
313
|
|
|
314
|
+
/** TemplateGetRequest in the API format as an argument: a nested model may also be given as a model. */
|
|
315
|
+
export type TemplateGetRequestInput = TemplateGetRequestJSON;
|
|
316
|
+
|
|
282
317
|
/** Fields of new TemplateGetRequest(): a nested model may be a plain object in the API format. */
|
|
283
318
|
export interface TemplateGetRequestInit {
|
|
284
319
|
/** Template id. */
|
|
@@ -302,6 +337,12 @@ export interface TemplateGetResponseJSON {
|
|
|
302
337
|
"template"?: TemplateObjectJSON;
|
|
303
338
|
}
|
|
304
339
|
|
|
340
|
+
/** TemplateGetResponse in the API format as an argument: a nested model may also be given as a model. */
|
|
341
|
+
export interface TemplateGetResponseInput {
|
|
342
|
+
"status"?: string;
|
|
343
|
+
"template"?: TemplateObject | TemplateObjectInput;
|
|
344
|
+
}
|
|
345
|
+
|
|
305
346
|
/** Fields of new TemplateGetResponse(): a nested model may be a plain object in the API format. */
|
|
306
347
|
export interface TemplateGetResponseInit {
|
|
307
348
|
/**
|
|
@@ -310,7 +351,7 @@ export interface TemplateGetResponseInit {
|
|
|
310
351
|
*/
|
|
311
352
|
status?: string;
|
|
312
353
|
/** Object with all the template properties. */
|
|
313
|
-
template?: TemplateObject |
|
|
354
|
+
template?: TemplateObject | TemplateObjectInput;
|
|
314
355
|
}
|
|
315
356
|
|
|
316
357
|
/** TemplateGetResponse */
|
|
@@ -335,6 +376,9 @@ export interface TemplateListRequestJSON {
|
|
|
335
376
|
"offset"?: number;
|
|
336
377
|
}
|
|
337
378
|
|
|
379
|
+
/** TemplateListRequest in the API format as an argument: a nested model may also be given as a model. */
|
|
380
|
+
export type TemplateListRequestInput = TemplateListRequestJSON;
|
|
381
|
+
|
|
338
382
|
/** Fields of new TemplateListRequest(): a nested model may be a plain object in the API format. */
|
|
339
383
|
export interface TemplateListRequestInit {
|
|
340
384
|
/**
|
|
@@ -374,6 +418,12 @@ export interface TemplateListResponseJSON {
|
|
|
374
418
|
"templates"?: Array<TemplateListObjectJSON>;
|
|
375
419
|
}
|
|
376
420
|
|
|
421
|
+
/** TemplateListResponse in the API format as an argument: a nested model may also be given as a model. */
|
|
422
|
+
export interface TemplateListResponseInput {
|
|
423
|
+
"status"?: string;
|
|
424
|
+
"templates"?: Array<TemplateListObject | TemplateListObjectInput>;
|
|
425
|
+
}
|
|
426
|
+
|
|
377
427
|
/** Fields of new TemplateListResponse(): a nested model may be a plain object in the API format. */
|
|
378
428
|
export interface TemplateListResponseInit {
|
|
379
429
|
/**
|
|
@@ -382,7 +432,7 @@ export interface TemplateListResponseInit {
|
|
|
382
432
|
*/
|
|
383
433
|
status?: string;
|
|
384
434
|
/** Array of template objects. */
|
|
385
|
-
templates?: Array<TemplateListObject |
|
|
435
|
+
templates?: Array<TemplateListObject | TemplateListObjectInput>;
|
|
386
436
|
}
|
|
387
437
|
|
|
388
438
|
/** TemplateListResponse */
|
|
@@ -426,6 +476,31 @@ export interface TemplateListObjectJSON {
|
|
|
426
476
|
"project_name"?: string;
|
|
427
477
|
}
|
|
428
478
|
|
|
479
|
+
/** TemplateListObject in the API format as an argument: a nested model may also be given as a model. */
|
|
480
|
+
export interface TemplateListObjectInput {
|
|
481
|
+
"id"?: string;
|
|
482
|
+
"name"?: string;
|
|
483
|
+
"editor_type"?: EditorType;
|
|
484
|
+
"template_engine"?: TemplateEngine;
|
|
485
|
+
"global_substitutions"?: Record<string, string>;
|
|
486
|
+
"global_metadata"?: Record<string, string>;
|
|
487
|
+
"body"?: BodyObject | BodyObjectInput;
|
|
488
|
+
"subject"?: string;
|
|
489
|
+
"from_email"?: string;
|
|
490
|
+
"from_name"?: string;
|
|
491
|
+
"reply_to"?: string;
|
|
492
|
+
"reply_to_name"?: string;
|
|
493
|
+
"track_links"?: number;
|
|
494
|
+
"track_read"?: number;
|
|
495
|
+
"headers"?: HeadersObject | HeadersObjectInput;
|
|
496
|
+
"attachments"?: Array<AttachmentsArrayItem | AttachmentsArrayItemInput>;
|
|
497
|
+
"inline_attachments"?: Array<InlineAttachmentsArrayItem | InlineAttachmentsArrayItemInput>;
|
|
498
|
+
"created"?: string;
|
|
499
|
+
"user_id"?: number;
|
|
500
|
+
"project_id"?: string;
|
|
501
|
+
"project_name"?: string;
|
|
502
|
+
}
|
|
503
|
+
|
|
429
504
|
/** Fields of new TemplateListObject(): a nested model may be a plain object in the API format. */
|
|
430
505
|
export interface TemplateListObjectInit {
|
|
431
506
|
/** Template unique identifier. */
|
|
@@ -467,7 +542,7 @@ export interface TemplateListObjectInit {
|
|
|
467
542
|
*/
|
|
468
543
|
globalMetadata?: Record<string, string>;
|
|
469
544
|
/** Contains HTML/plaintext/AMP parts of the email. Either html or plaintext part is required. */
|
|
470
|
-
body?: BodyObject |
|
|
545
|
+
body?: BodyObject | BodyObjectInput;
|
|
471
546
|
/** Email subject. */
|
|
472
547
|
subject?: string;
|
|
473
548
|
/** Sender's email. */
|
|
@@ -502,14 +577,14 @@ export interface TemplateListObjectInit {
|
|
|
502
577
|
* List-Unsubscribe, List-Subscribe, List-Help, List-Owner, List-Archive, In-Reply-To and References
|
|
503
578
|
* headers.
|
|
504
579
|
*/
|
|
505
|
-
headers?: HeadersObject |
|
|
580
|
+
headers?: HeadersObject | HeadersObjectInput;
|
|
506
581
|
/** Optional array of attachments */
|
|
507
|
-
attachments?: Array<AttachmentsArrayItem |
|
|
582
|
+
attachments?: Array<AttachmentsArrayItem | AttachmentsArrayItemInput>;
|
|
508
583
|
/**
|
|
509
584
|
* Optional array of inline attachments, e.g. for including images in email instead of loading them
|
|
510
585
|
* from external URL.
|
|
511
586
|
*/
|
|
512
|
-
inlineAttachments?: Array<InlineAttachmentsArrayItem |
|
|
587
|
+
inlineAttachments?: Array<InlineAttachmentsArrayItem | InlineAttachmentsArrayItemInput>;
|
|
513
588
|
/** Template creation date and time in UTC timezone in format "YYYY-MM-DD hh:mm:ss" */
|
|
514
589
|
created?: string;
|
|
515
590
|
/** Unique user identifier. */
|
|
@@ -624,6 +699,9 @@ export interface TemplateDeleteRequestJSON {
|
|
|
624
699
|
"id": string;
|
|
625
700
|
}
|
|
626
701
|
|
|
702
|
+
/** TemplateDeleteRequest in the API format as an argument: a nested model may also be given as a model. */
|
|
703
|
+
export type TemplateDeleteRequestInput = TemplateDeleteRequestJSON;
|
|
704
|
+
|
|
627
705
|
/** Fields of new TemplateDeleteRequest(): a nested model may be a plain object in the API format. */
|
|
628
706
|
export interface TemplateDeleteRequestInit {
|
|
629
707
|
/** Template id. */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// WebhookApi: API methods of the Webhook section.
|
|
2
2
|
import type { ApiClient } from "../../client/ApiClient.js";
|
|
3
3
|
import type { SuccessResponse } from "../../common/models.js";
|
|
4
|
-
import type { WebhookCallback, WebhookDeleteRequest,
|
|
4
|
+
import type { WebhookCallback, WebhookDeleteRequest, WebhookDeleteRequestInput, WebhookGetRequest, WebhookGetRequestInput, WebhookGetResponse, WebhookListRequest, WebhookListRequestInput, WebhookListResponse, WebhookSetRequest, WebhookSetRequestInput, WebhookSetResponse } from "./models.js";
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
7
|
* UniOne lets you recieve notifications about email status changes or spam blocks. You provide an URL
|
|
@@ -37,7 +37,7 @@ export declare class WebhookApi {
|
|
|
37
37
|
* Documentation: https://docs.unione.io/en/web-api-ref#webhook-set
|
|
38
38
|
* @throws {ApiError}
|
|
39
39
|
*/
|
|
40
|
-
set(request: WebhookSetRequest |
|
|
40
|
+
set(request: WebhookSetRequest | WebhookSetRequestInput): Promise<WebhookSetResponse>;
|
|
41
41
|
|
|
42
42
|
/**
|
|
43
43
|
* Gets properties of a [webhook](https://docs.unione.io/en/web-api-ref#webhook).
|
|
@@ -45,7 +45,7 @@ export declare class WebhookApi {
|
|
|
45
45
|
* Documentation: https://docs.unione.io/en/web-api-ref#webhook-get
|
|
46
46
|
* @throws {ApiError}
|
|
47
47
|
*/
|
|
48
|
-
get(request: WebhookGetRequest |
|
|
48
|
+
get(request: WebhookGetRequest | WebhookGetRequestInput): Promise<WebhookGetResponse>;
|
|
49
49
|
|
|
50
50
|
/**
|
|
51
51
|
* List all or some [webhooks](https://docs.unione.io/en/web-api-ref#webhook) (event notification
|
|
@@ -54,7 +54,7 @@ export declare class WebhookApi {
|
|
|
54
54
|
* Documentation: https://docs.unione.io/en/web-api-ref#webhook-list
|
|
55
55
|
* @throws {ApiError}
|
|
56
56
|
*/
|
|
57
|
-
list(request?: WebhookListRequest |
|
|
57
|
+
list(request?: WebhookListRequest | WebhookListRequestInput): Promise<WebhookListResponse>;
|
|
58
58
|
|
|
59
59
|
/**
|
|
60
60
|
* Deletes an event notification handler
|
|
@@ -65,7 +65,7 @@ export declare class WebhookApi {
|
|
|
65
65
|
* Documentation: https://docs.unione.io/en/web-api-ref#webhook-delete
|
|
66
66
|
* @throws {ApiError}
|
|
67
67
|
*/
|
|
68
|
-
delete(request: WebhookDeleteRequest |
|
|
68
|
+
delete(request: WebhookDeleteRequest | WebhookDeleteRequestInput): Promise<SuccessResponse>;
|
|
69
69
|
|
|
70
70
|
/**
|
|
71
71
|
* Webhook callback format description.
|