@emilgroup/notification-sdk 0.8.1-beta.4 → 0.8.1-beta.41
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/.openapi-generator/FILES +16 -0
- package/README.md +2 -2
- package/api/email-messages-api.ts +36 -24
- package/api/email-subscriptions-api.ts +559 -0
- package/api/email-tracking-api.ts +263 -32
- package/api/email-verifications-api.ts +16 -8
- package/api/layouts-api.ts +56 -36
- package/api/msgraph-webhooks-api.ts +278 -0
- package/api/notification-templates-api.ts +56 -36
- package/api/notifications-api.ts +115 -4
- package/api.ts +4 -0
- package/dist/api/email-messages-api.d.ts +36 -24
- package/dist/api/email-messages-api.js +34 -22
- package/dist/api/email-subscriptions-api.d.ts +319 -0
- package/dist/api/email-subscriptions-api.js +537 -0
- package/dist/api/email-tracking-api.d.ts +162 -32
- package/dist/api/email-tracking-api.js +227 -28
- package/dist/api/email-verifications-api.d.ts +16 -8
- package/dist/api/email-verifications-api.js +16 -8
- package/dist/api/layouts-api.d.ts +56 -36
- package/dist/api/layouts-api.js +52 -32
- package/dist/api/msgraph-webhooks-api.d.ts +168 -0
- package/dist/api/msgraph-webhooks-api.js +305 -0
- package/dist/api/notification-templates-api.d.ts +56 -36
- package/dist/api/notification-templates-api.js +52 -32
- package/dist/api/notifications-api.d.ts +65 -4
- package/dist/api/notifications-api.js +101 -4
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
- package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
- package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
- package/dist/models/assign-email-thread-entity-response-class.js +15 -0
- package/dist/models/email-message-class.d.ts +55 -7
- package/dist/models/email-message-class.js +16 -2
- package/dist/models/email-subscription-class.d.ts +104 -0
- package/dist/models/email-subscription-class.js +23 -0
- package/dist/models/email-thread-class.d.ts +6 -5
- package/dist/models/entity-ref-class.d.ts +37 -0
- package/dist/models/entity-ref-class.js +22 -0
- package/dist/models/get-email-subscription-response-class.d.ts +25 -0
- package/dist/models/get-email-subscription-response-class.js +15 -0
- package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
- package/dist/models/grpc-send-email-request-dto.js +22 -0
- package/dist/models/index.d.ts +14 -0
- package/dist/models/index.js +14 -0
- package/dist/models/inline-attachment-dto.d.ts +36 -0
- package/dist/models/inline-attachment-dto.js +15 -0
- package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
- package/dist/models/list-email-subscriptions-response-class.js +15 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
- package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
- package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
- package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
- package/dist/models/renew-email-subscription-response-class.js +15 -0
- package/dist/models/send-email-request-dto.d.ts +131 -0
- package/dist/models/send-email-request-dto.js +22 -0
- package/dist/models/send-email-response-class.d.ts +24 -0
- package/dist/models/send-email-response-class.js +15 -0
- package/dist/models/send-notification-request-dto.d.ts +10 -1
- package/dist/models/send-notification-request-dto.js +2 -1
- package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
- package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
- package/models/assign-email-thread-entity-body-dto.ts +52 -0
- package/models/assign-email-thread-entity-response-class.ts +31 -0
- package/models/email-message-class.ts +59 -8
- package/models/email-subscription-class.ts +113 -0
- package/models/email-thread-class.ts +6 -5
- package/models/entity-ref-class.ts +46 -0
- package/models/get-email-subscription-response-class.ts +31 -0
- package/models/grpc-send-email-request-dto.ts +144 -0
- package/models/index.ts +14 -0
- package/models/inline-attachment-dto.ts +42 -0
- package/models/list-email-subscriptions-response-class.ts +49 -0
- package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
- package/models/reconcile-email-subscriptions-response-class.ts +54 -0
- package/models/renew-email-subscription-response-class.ts +31 -0
- package/models/send-email-request-dto.ts +138 -0
- package/models/send-email-response-class.ts +30 -0
- package/models/send-notification-request-dto.ts +9 -2
- package/models/unassign-email-thread-entity-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -22,7 +22,8 @@ import { ListEmailMessagesResponseClass } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
26
|
+
* @summary Download the email message attachment
|
|
26
27
|
* @param {string} code
|
|
27
28
|
* @param {number} attachmentId
|
|
28
29
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -31,7 +32,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
31
32
|
*/
|
|
32
33
|
downloadAttachment: (code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
34
|
/**
|
|
34
|
-
*
|
|
35
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
36
|
+
* @summary Retrieve the email message
|
|
35
37
|
* @param {string} code
|
|
36
38
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
39
|
* @param {*} [options] Override http request option.
|
|
@@ -39,7 +41,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
39
41
|
*/
|
|
40
42
|
getMessage: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
43
|
/**
|
|
42
|
-
*
|
|
44
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
45
|
+
* @summary List the email message attachments
|
|
43
46
|
* @param {string} code
|
|
44
47
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
45
48
|
* @param {*} [options] Override http request option.
|
|
@@ -47,16 +50,16 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
47
50
|
*/
|
|
48
51
|
listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
52
|
/**
|
|
50
|
-
*
|
|
53
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
51
54
|
* @summary List email messages
|
|
52
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
53
56
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
54
57
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
55
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
58
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
56
59
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
57
60
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
58
61
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
59
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
62
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
60
63
|
* @param {*} [options] Override http request option.
|
|
61
64
|
* @throws {RequiredError}
|
|
62
65
|
*/
|
|
@@ -68,7 +71,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
68
71
|
*/
|
|
69
72
|
export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
70
73
|
/**
|
|
71
|
-
*
|
|
74
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
75
|
+
* @summary Download the email message attachment
|
|
72
76
|
* @param {string} code
|
|
73
77
|
* @param {number} attachmentId
|
|
74
78
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -77,7 +81,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
77
81
|
*/
|
|
78
82
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>>;
|
|
79
83
|
/**
|
|
80
|
-
*
|
|
84
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
85
|
+
* @summary Retrieve the email message
|
|
81
86
|
* @param {string} code
|
|
82
87
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
88
|
* @param {*} [options] Override http request option.
|
|
@@ -85,7 +90,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
85
90
|
*/
|
|
86
91
|
getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>>;
|
|
87
92
|
/**
|
|
88
|
-
*
|
|
93
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
94
|
+
* @summary List the email message attachments
|
|
89
95
|
* @param {string} code
|
|
90
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
97
|
* @param {*} [options] Override http request option.
|
|
@@ -93,16 +99,16 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
93
99
|
*/
|
|
94
100
|
listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
|
|
95
101
|
/**
|
|
96
|
-
*
|
|
102
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
97
103
|
* @summary List email messages
|
|
98
104
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
105
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
100
106
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
101
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
107
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
102
108
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
103
109
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
104
110
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
105
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
111
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
106
112
|
* @param {*} [options] Override http request option.
|
|
107
113
|
* @throws {RequiredError}
|
|
108
114
|
*/
|
|
@@ -114,7 +120,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
114
120
|
*/
|
|
115
121
|
export declare const EmailMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
116
122
|
/**
|
|
117
|
-
*
|
|
123
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
124
|
+
* @summary Download the email message attachment
|
|
118
125
|
* @param {string} code
|
|
119
126
|
* @param {number} attachmentId
|
|
120
127
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -123,7 +130,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
123
130
|
*/
|
|
124
131
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass>;
|
|
125
132
|
/**
|
|
126
|
-
*
|
|
133
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
134
|
+
* @summary Retrieve the email message
|
|
127
135
|
* @param {string} code
|
|
128
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
137
|
* @param {*} [options] Override http request option.
|
|
@@ -131,7 +139,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
131
139
|
*/
|
|
132
140
|
getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass>;
|
|
133
141
|
/**
|
|
134
|
-
*
|
|
142
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
143
|
+
* @summary List the email message attachments
|
|
135
144
|
* @param {string} code
|
|
136
145
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
137
146
|
* @param {*} [options] Override http request option.
|
|
@@ -139,16 +148,16 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
139
148
|
*/
|
|
140
149
|
listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
|
|
141
150
|
/**
|
|
142
|
-
*
|
|
151
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
143
152
|
* @summary List email messages
|
|
144
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
145
154
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
146
155
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
147
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
156
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
148
157
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
149
158
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
150
159
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
151
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
160
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
152
161
|
* @param {*} [options] Override http request option.
|
|
153
162
|
* @throws {RequiredError}
|
|
154
163
|
*/
|
|
@@ -242,7 +251,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
242
251
|
*/
|
|
243
252
|
readonly pageToken?: string;
|
|
244
253
|
/**
|
|
245
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
254
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
246
255
|
* @type {string}
|
|
247
256
|
* @memberof EmailMessagesApiListEmailMessages
|
|
248
257
|
*/
|
|
@@ -266,7 +275,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
266
275
|
*/
|
|
267
276
|
readonly expand?: string;
|
|
268
277
|
/**
|
|
269
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
278
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
270
279
|
* @type {string}
|
|
271
280
|
* @memberof EmailMessagesApiListEmailMessages
|
|
272
281
|
*/
|
|
@@ -280,7 +289,8 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
280
289
|
*/
|
|
281
290
|
export declare class EmailMessagesApi extends BaseAPI {
|
|
282
291
|
/**
|
|
283
|
-
*
|
|
292
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
293
|
+
* @summary Download the email message attachment
|
|
284
294
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
285
295
|
* @param {*} [options] Override http request option.
|
|
286
296
|
* @throws {RequiredError}
|
|
@@ -288,7 +298,8 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
288
298
|
*/
|
|
289
299
|
downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}>>;
|
|
290
300
|
/**
|
|
291
|
-
*
|
|
301
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
302
|
+
* @summary Retrieve the email message
|
|
292
303
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
293
304
|
* @param {*} [options] Override http request option.
|
|
294
305
|
* @throws {RequiredError}
|
|
@@ -296,7 +307,8 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
296
307
|
*/
|
|
297
308
|
getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}>>;
|
|
298
309
|
/**
|
|
299
|
-
*
|
|
310
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
311
|
+
* @summary List the email message attachments
|
|
300
312
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
301
313
|
* @param {*} [options] Override http request option.
|
|
302
314
|
* @throws {RequiredError}
|
|
@@ -304,7 +316,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
304
316
|
*/
|
|
305
317
|
listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
|
|
306
318
|
/**
|
|
307
|
-
*
|
|
319
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
308
320
|
* @summary List email messages
|
|
309
321
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
310
322
|
* @param {*} [options] Override http request option.
|
|
@@ -93,7 +93,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
96
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
97
|
+
* @summary Download the email message attachment
|
|
97
98
|
* @param {string} code
|
|
98
99
|
* @param {number} attachmentId
|
|
99
100
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -144,7 +145,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
144
145
|
});
|
|
145
146
|
},
|
|
146
147
|
/**
|
|
147
|
-
*
|
|
148
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
149
|
+
* @summary Retrieve the email message
|
|
148
150
|
* @param {string} code
|
|
149
151
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
152
|
* @param {*} [options] Override http request option.
|
|
@@ -191,7 +193,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
191
193
|
});
|
|
192
194
|
},
|
|
193
195
|
/**
|
|
194
|
-
*
|
|
196
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
197
|
+
* @summary List the email message attachments
|
|
195
198
|
* @param {string} code
|
|
196
199
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
200
|
* @param {*} [options] Override http request option.
|
|
@@ -238,16 +241,16 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
238
241
|
});
|
|
239
242
|
},
|
|
240
243
|
/**
|
|
241
|
-
*
|
|
244
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
242
245
|
* @summary List email messages
|
|
243
246
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
247
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
248
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
246
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
249
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
247
250
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
248
251
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
249
252
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
250
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
253
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
251
254
|
* @param {*} [options] Override http request option.
|
|
252
255
|
* @throws {RequiredError}
|
|
253
256
|
*/
|
|
@@ -320,7 +323,8 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
320
323
|
var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
|
|
321
324
|
return {
|
|
322
325
|
/**
|
|
323
|
-
*
|
|
326
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
327
|
+
* @summary Download the email message attachment
|
|
324
328
|
* @param {string} code
|
|
325
329
|
* @param {number} attachmentId
|
|
326
330
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -341,7 +345,8 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
341
345
|
});
|
|
342
346
|
},
|
|
343
347
|
/**
|
|
344
|
-
*
|
|
348
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
349
|
+
* @summary Retrieve the email message
|
|
345
350
|
* @param {string} code
|
|
346
351
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
347
352
|
* @param {*} [options] Override http request option.
|
|
@@ -361,7 +366,8 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
361
366
|
});
|
|
362
367
|
},
|
|
363
368
|
/**
|
|
364
|
-
*
|
|
369
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
370
|
+
* @summary List the email message attachments
|
|
365
371
|
* @param {string} code
|
|
366
372
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
373
|
* @param {*} [options] Override http request option.
|
|
@@ -381,16 +387,16 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
381
387
|
});
|
|
382
388
|
},
|
|
383
389
|
/**
|
|
384
|
-
*
|
|
390
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
385
391
|
* @summary List email messages
|
|
386
392
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
387
393
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
388
394
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
389
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
395
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
390
396
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
391
397
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
392
398
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
393
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
399
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
394
400
|
* @param {*} [options] Override http request option.
|
|
395
401
|
* @throws {RequiredError}
|
|
396
402
|
*/
|
|
@@ -418,7 +424,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
418
424
|
var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
|
|
419
425
|
return {
|
|
420
426
|
/**
|
|
421
|
-
*
|
|
427
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
428
|
+
* @summary Download the email message attachment
|
|
422
429
|
* @param {string} code
|
|
423
430
|
* @param {number} attachmentId
|
|
424
431
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -429,7 +436,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
429
436
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
430
437
|
},
|
|
431
438
|
/**
|
|
432
|
-
*
|
|
439
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
440
|
+
* @summary Retrieve the email message
|
|
433
441
|
* @param {string} code
|
|
434
442
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
435
443
|
* @param {*} [options] Override http request option.
|
|
@@ -439,7 +447,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
439
447
|
return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
440
448
|
},
|
|
441
449
|
/**
|
|
442
|
-
*
|
|
450
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
451
|
+
* @summary List the email message attachments
|
|
443
452
|
* @param {string} code
|
|
444
453
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
445
454
|
* @param {*} [options] Override http request option.
|
|
@@ -449,16 +458,16 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
449
458
|
return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
450
459
|
},
|
|
451
460
|
/**
|
|
452
|
-
*
|
|
461
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
453
462
|
* @summary List email messages
|
|
454
463
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
455
464
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
456
465
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
457
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
466
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
458
467
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
459
468
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
460
469
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
461
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
470
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
462
471
|
* @param {*} [options] Override http request option.
|
|
463
472
|
* @throws {RequiredError}
|
|
464
473
|
*/
|
|
@@ -480,7 +489,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
480
489
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
481
490
|
}
|
|
482
491
|
/**
|
|
483
|
-
*
|
|
492
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
493
|
+
* @summary Download the email message attachment
|
|
484
494
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
485
495
|
* @param {*} [options] Override http request option.
|
|
486
496
|
* @throws {RequiredError}
|
|
@@ -491,7 +501,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
491
501
|
return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
492
502
|
};
|
|
493
503
|
/**
|
|
494
|
-
*
|
|
504
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
505
|
+
* @summary Retrieve the email message
|
|
495
506
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
496
507
|
* @param {*} [options] Override http request option.
|
|
497
508
|
* @throws {RequiredError}
|
|
@@ -502,7 +513,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
502
513
|
return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
503
514
|
};
|
|
504
515
|
/**
|
|
505
|
-
*
|
|
516
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
517
|
+
* @summary List the email message attachments
|
|
506
518
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
507
519
|
* @param {*} [options] Override http request option.
|
|
508
520
|
* @throws {RequiredError}
|
|
@@ -513,7 +525,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
513
525
|
return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
514
526
|
};
|
|
515
527
|
/**
|
|
516
|
-
*
|
|
528
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
517
529
|
* @summary List email messages
|
|
518
530
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
519
531
|
* @param {*} [options] Override http request option.
|