@emilgroup/notification-sdk 0.8.1-beta.30 → 0.8.1-beta.31

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 (57) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +259 -24
  4. package/api/email-tracking-api.ts +32 -24
  5. package/api/email-verifications-api.ts +16 -8
  6. package/api/layouts-api.ts +56 -36
  7. package/api/msgraph-webhooks-api.ts +278 -0
  8. package/api/notification-templates-api.ts +56 -36
  9. package/api/notifications-api.ts +115 -4
  10. package/api.ts +2 -0
  11. package/dist/api/email-messages-api.d.ts +158 -24
  12. package/dist/api/email-messages-api.js +225 -22
  13. package/dist/api/email-tracking-api.d.ts +32 -24
  14. package/dist/api/email-tracking-api.js +30 -22
  15. package/dist/api/email-verifications-api.d.ts +16 -8
  16. package/dist/api/email-verifications-api.js +16 -8
  17. package/dist/api/layouts-api.d.ts +56 -36
  18. package/dist/api/layouts-api.js +52 -32
  19. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  20. package/dist/api/msgraph-webhooks-api.js +305 -0
  21. package/dist/api/notification-templates-api.d.ts +56 -36
  22. package/dist/api/notification-templates-api.js +52 -32
  23. package/dist/api/notifications-api.d.ts +65 -4
  24. package/dist/api/notifications-api.js +101 -4
  25. package/dist/api.d.ts +1 -0
  26. package/dist/api.js +1 -0
  27. package/dist/models/assign-email-message-entity-body-dto.d.ts +43 -0
  28. package/dist/models/assign-email-message-entity-body-dto.js +22 -0
  29. package/dist/models/assign-email-message-entity-response-class.d.ts +25 -0
  30. package/dist/models/assign-email-message-entity-response-class.js +15 -0
  31. package/dist/models/email-message-class.d.ts +49 -2
  32. package/dist/models/email-message-class.js +16 -2
  33. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  34. package/dist/models/grpc-send-email-request-dto.js +22 -0
  35. package/dist/models/index.d.ts +7 -0
  36. package/dist/models/index.js +7 -0
  37. package/dist/models/inline-attachment-dto.d.ts +36 -0
  38. package/dist/models/inline-attachment-dto.js +15 -0
  39. package/dist/models/send-email-request-dto.d.ts +131 -0
  40. package/dist/models/send-email-request-dto.js +22 -0
  41. package/dist/models/send-email-response-class.d.ts +24 -0
  42. package/dist/models/send-email-response-class.js +15 -0
  43. package/dist/models/send-notification-request-dto.d.ts +1 -0
  44. package/dist/models/send-notification-request-dto.js +2 -1
  45. package/dist/models/unassign-email-message-entity-response-class.d.ts +25 -0
  46. package/dist/models/unassign-email-message-entity-response-class.js +15 -0
  47. package/models/assign-email-message-entity-body-dto.ts +52 -0
  48. package/models/assign-email-message-entity-response-class.ts +31 -0
  49. package/models/email-message-class.ts +53 -3
  50. package/models/grpc-send-email-request-dto.ts +144 -0
  51. package/models/index.ts +7 -0
  52. package/models/inline-attachment-dto.ts +42 -0
  53. package/models/send-email-request-dto.ts +138 -0
  54. package/models/send-email-response-class.ts +30 -0
  55. package/models/send-notification-request-dto.ts +2 -1
  56. package/models/unassign-email-message-entity-response-class.ts +31 -0
  57. package/package.json +1 -1
@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { SendEmailRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { SendEmailResponseClass } from '../models';
27
+ // @ts-ignore
24
28
  import { SendNotificationRequestDto } from '../models';
25
29
  // @ts-ignore
26
30
  import { SendNotificationResponseClass } from '../models';
@@ -31,7 +35,55 @@ import { SendNotificationResponseClass } from '../models';
31
35
  export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) {
32
36
  return {
33
37
  /**
34
- * undefined **Required Permissions** none
38
+ * Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
39
+ * @summary Send an email without a template
40
+ * @param {SendEmailRequestDto} sendEmailRequestDto
41
+ * @param {string} [authorization] Bearer Token
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ sendEmail: async (sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
+ // verify required parameter 'sendEmailRequestDto' is not null or undefined
47
+ assertParamExists('sendEmail', 'sendEmailRequestDto', sendEmailRequestDto)
48
+ const localVarPath = `/notificationservice/v1/notifications/emails`;
49
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
50
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
51
+ let baseOptions;
52
+ let baseAccessToken;
53
+ if (configuration) {
54
+ baseOptions = configuration.baseOptions;
55
+ baseAccessToken = configuration.accessToken;
56
+ }
57
+
58
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
59
+ const localVarHeaderParameter = {} as any;
60
+ const localVarQueryParameter = {} as any;
61
+
62
+ // authentication bearer required
63
+ // http bearer authentication required
64
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
65
+
66
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
67
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
68
+ }
69
+
70
+
71
+
72
+ localVarHeaderParameter['Content-Type'] = 'application/json';
73
+
74
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
75
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
76
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77
+ localVarRequestOptions.data = serializeDataIfNeeded(sendEmailRequestDto, localVarRequestOptions, configuration)
78
+
79
+ return {
80
+ url: toPathString(localVarUrlObj),
81
+ options: localVarRequestOptions,
82
+ };
83
+ },
84
+ /**
85
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
86
+ * @summary Send a notification
35
87
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
36
88
  * @param {string} [authorization] Bearer Token
37
89
  * @param {*} [options] Override http request option.
@@ -87,7 +139,20 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
87
139
  const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
88
140
  return {
89
141
  /**
90
- * undefined **Required Permissions** none
142
+ * Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
143
+ * @summary Send an email without a template
144
+ * @param {SendEmailRequestDto} sendEmailRequestDto
145
+ * @param {string} [authorization] Bearer Token
146
+ * @param {*} [options] Override http request option.
147
+ * @throws {RequiredError}
148
+ */
149
+ async sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SendEmailResponseClass>> {
150
+ const localVarAxiosArgs = await localVarAxiosParamCreator.sendEmail(sendEmailRequestDto, authorization, options);
151
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
152
+ },
153
+ /**
154
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
155
+ * @summary Send a notification
91
156
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
92
157
  * @param {string} [authorization] Bearer Token
93
158
  * @param {*} [options] Override http request option.
@@ -108,7 +173,19 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
108
173
  const localVarFp = NotificationsApiFp(configuration)
109
174
  return {
110
175
  /**
111
- * undefined **Required Permissions** none
176
+ * Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
177
+ * @summary Send an email without a template
178
+ * @param {SendEmailRequestDto} sendEmailRequestDto
179
+ * @param {string} [authorization] Bearer Token
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ */
183
+ sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: any): AxiosPromise<SendEmailResponseClass> {
184
+ return localVarFp.sendEmail(sendEmailRequestDto, authorization, options).then((request) => request(axios, basePath));
185
+ },
186
+ /**
187
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
188
+ * @summary Send a notification
112
189
  * @param {SendNotificationRequestDto} sendNotificationRequestDto
113
190
  * @param {string} [authorization] Bearer Token
114
191
  * @param {*} [options] Override http request option.
@@ -120,6 +197,27 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
120
197
  };
121
198
  };
122
199
 
200
+ /**
201
+ * Request parameters for sendEmail operation in NotificationsApi.
202
+ * @export
203
+ * @interface NotificationsApiSendEmailRequest
204
+ */
205
+ export interface NotificationsApiSendEmailRequest {
206
+ /**
207
+ *
208
+ * @type {SendEmailRequestDto}
209
+ * @memberof NotificationsApiSendEmail
210
+ */
211
+ readonly sendEmailRequestDto: SendEmailRequestDto
212
+
213
+ /**
214
+ * Bearer Token
215
+ * @type {string}
216
+ * @memberof NotificationsApiSendEmail
217
+ */
218
+ readonly authorization?: string
219
+ }
220
+
123
221
  /**
124
222
  * Request parameters for sendNotification operation in NotificationsApi.
125
223
  * @export
@@ -149,7 +247,20 @@ export interface NotificationsApiSendNotificationRequest {
149
247
  */
150
248
  export class NotificationsApi extends BaseAPI {
151
249
  /**
152
- * undefined **Required Permissions** none
250
+ * Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
251
+ * @summary Send an email without a template
252
+ * @param {NotificationsApiSendEmailRequest} requestParameters Request parameters.
253
+ * @param {*} [options] Override http request option.
254
+ * @throws {RequiredError}
255
+ * @memberof NotificationsApi
256
+ */
257
+ public sendEmail(requestParameters: NotificationsApiSendEmailRequest, options?: AxiosRequestConfig) {
258
+ return NotificationsApiFp(this.configuration).sendEmail(requestParameters.sendEmailRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
259
+ }
260
+
261
+ /**
262
+ * Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
263
+ * @summary Send a notification
153
264
  * @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
154
265
  * @param {*} [options] Override http request option.
155
266
  * @throws {RequiredError}
package/api.ts CHANGED
@@ -25,6 +25,7 @@ import { EmailTrackingApi } from './api';
25
25
  import { EmailVerificationsApi } from './api';
26
26
  import { HealthApi } from './api';
27
27
  import { LayoutsApi } from './api';
28
+ import { MSGraphWebhooksApi } from './api';
28
29
  import { NotificationTemplatesApi } from './api';
29
30
  import { NotificationsApi } from './api';
30
31
 
@@ -34,6 +35,7 @@ export * from './api/email-tracking-api';
34
35
  export * from './api/email-verifications-api';
35
36
  export * from './api/health-api';
36
37
  export * from './api/layouts-api';
38
+ export * from './api/msgraph-webhooks-api';
37
39
  export * from './api/notification-templates-api';
38
40
  export * from './api/notifications-api';
39
41
 
@@ -12,17 +12,31 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { AssignEmailMessageEntityBodyDto } from '../models';
16
+ import { AssignEmailMessageEntityResponseClass } from '../models';
15
17
  import { DownloadAttachmentResponseClass } from '../models';
16
18
  import { GetEmailMessageResponseClass } from '../models';
17
19
  import { ListEmailAttachmentsResponseClass } from '../models';
18
20
  import { ListEmailMessagesResponseClass } from '../models';
21
+ import { UnassignEmailMessageEntityResponseClass } from '../models';
19
22
  /**
20
23
  * EmailMessagesApi - axios parameter creator
21
24
  * @export
22
25
  */
23
26
  export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
24
27
  /**
25
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
28
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
29
+ * @summary Assign an email message to an entity
30
+ * @param {string} code
31
+ * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
32
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ assignEntity: (code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
39
+ * @summary Download the email message attachment
26
40
  * @param {string} code
27
41
  * @param {number} attachmentId
28
42
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -31,7 +45,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
31
45
  */
32
46
  downloadAttachment: (code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
47
  /**
34
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
48
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
49
+ * @summary Retrieve the email message
35
50
  * @param {string} code
36
51
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
37
52
  * @param {*} [options] Override http request option.
@@ -39,7 +54,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
39
54
  */
40
55
  getMessage: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
56
  /**
42
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
57
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
58
+ * @summary List the email message attachments
43
59
  * @param {string} code
44
60
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
45
61
  * @param {*} [options] Override http request option.
@@ -47,20 +63,29 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
47
63
  */
48
64
  listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
65
  /**
50
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
66
+ * 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
67
  * @summary List email messages
52
68
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
53
69
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
54
70
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
71
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
56
72
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
57
73
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
58
74
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
59
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
75
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
60
76
  * @param {*} [options] Override http request option.
61
77
  * @throws {RequiredError}
62
78
  */
63
79
  listEmailMessages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
+ /**
81
+ * Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
82
+ * @summary Unassign an email message from its entity
83
+ * @param {string} code
84
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
+ * @param {*} [options] Override http request option.
86
+ * @throws {RequiredError}
87
+ */
88
+ unassignEntity: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
89
  };
65
90
  /**
66
91
  * EmailMessagesApi - functional programming interface
@@ -68,7 +93,18 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
68
93
  */
69
94
  export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
70
95
  /**
71
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
96
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
97
+ * @summary Assign an email message to an entity
98
+ * @param {string} code
99
+ * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
100
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignEmailMessageEntityResponseClass>>;
105
+ /**
106
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
107
+ * @summary Download the email message attachment
72
108
  * @param {string} code
73
109
  * @param {number} attachmentId
74
110
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -77,7 +113,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
77
113
  */
78
114
  downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>>;
79
115
  /**
80
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
116
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
117
+ * @summary Retrieve the email message
81
118
  * @param {string} code
82
119
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
83
120
  * @param {*} [options] Override http request option.
@@ -85,7 +122,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
85
122
  */
86
123
  getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>>;
87
124
  /**
88
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
125
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
126
+ * @summary List the email message attachments
89
127
  * @param {string} code
90
128
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
91
129
  * @param {*} [options] Override http request option.
@@ -93,20 +131,29 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
93
131
  */
94
132
  listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
95
133
  /**
96
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
134
+ * 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
135
  * @summary List email messages
98
136
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
137
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
100
138
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
139
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
102
140
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
103
141
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
104
142
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
105
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
143
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
106
144
  * @param {*} [options] Override http request option.
107
145
  * @throws {RequiredError}
108
146
  */
109
147
  listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
148
+ /**
149
+ * Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
150
+ * @summary Unassign an email message from its entity
151
+ * @param {string} code
152
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
+ * @param {*} [options] Override http request option.
154
+ * @throws {RequiredError}
155
+ */
156
+ unassignEntity(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnassignEmailMessageEntityResponseClass>>;
110
157
  };
111
158
  /**
112
159
  * EmailMessagesApi - factory interface
@@ -114,7 +161,18 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
114
161
  */
115
162
  export declare const EmailMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
116
163
  /**
117
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
164
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
165
+ * @summary Assign an email message to an entity
166
+ * @param {string} code
167
+ * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
168
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
169
+ * @param {*} [options] Override http request option.
170
+ * @throws {RequiredError}
171
+ */
172
+ assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: any): AxiosPromise<AssignEmailMessageEntityResponseClass>;
173
+ /**
174
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
175
+ * @summary Download the email message attachment
118
176
  * @param {string} code
119
177
  * @param {number} attachmentId
120
178
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -123,7 +181,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
123
181
  */
124
182
  downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass>;
125
183
  /**
126
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
184
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
185
+ * @summary Retrieve the email message
127
186
  * @param {string} code
128
187
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
129
188
  * @param {*} [options] Override http request option.
@@ -131,7 +190,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
131
190
  */
132
191
  getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass>;
133
192
  /**
134
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
193
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
194
+ * @summary List the email message attachments
135
195
  * @param {string} code
136
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
137
197
  * @param {*} [options] Override http request option.
@@ -139,21 +199,55 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
139
199
  */
140
200
  listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
141
201
  /**
142
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
202
+ * 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
203
  * @summary List email messages
144
204
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
145
205
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
146
206
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
207
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
148
208
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
149
209
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
150
210
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: attachments&lt;i&gt;
151
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
211
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
152
212
  * @param {*} [options] Override http request option.
153
213
  * @throws {RequiredError}
154
214
  */
155
215
  listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
216
+ /**
217
+ * Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
218
+ * @summary Unassign an email message from its entity
219
+ * @param {string} code
220
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
221
+ * @param {*} [options] Override http request option.
222
+ * @throws {RequiredError}
223
+ */
224
+ unassignEntity(code: string, authorization?: string, options?: any): AxiosPromise<UnassignEmailMessageEntityResponseClass>;
156
225
  };
226
+ /**
227
+ * Request parameters for assignEntity operation in EmailMessagesApi.
228
+ * @export
229
+ * @interface EmailMessagesApiAssignEntityRequest
230
+ */
231
+ export interface EmailMessagesApiAssignEntityRequest {
232
+ /**
233
+ *
234
+ * @type {string}
235
+ * @memberof EmailMessagesApiAssignEntity
236
+ */
237
+ readonly code: string;
238
+ /**
239
+ *
240
+ * @type {AssignEmailMessageEntityBodyDto}
241
+ * @memberof EmailMessagesApiAssignEntity
242
+ */
243
+ readonly assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto;
244
+ /**
245
+ * Bearer Token: provided by the login endpoint under the name accessToken.
246
+ * @type {string}
247
+ * @memberof EmailMessagesApiAssignEntity
248
+ */
249
+ readonly authorization?: string;
250
+ }
157
251
  /**
158
252
  * Request parameters for downloadAttachment operation in EmailMessagesApi.
159
253
  * @export
@@ -242,7 +336,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
242
336
  */
243
337
  readonly pageToken?: string;
244
338
  /**
245
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
339
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
246
340
  * @type {string}
247
341
  * @memberof EmailMessagesApiListEmailMessages
248
342
  */
@@ -266,12 +360,31 @@ export interface EmailMessagesApiListEmailMessagesRequest {
266
360
  */
267
361
  readonly expand?: string;
268
362
  /**
269
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
363
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
270
364
  * @type {string}
271
365
  * @memberof EmailMessagesApiListEmailMessages
272
366
  */
273
367
  readonly filters?: string;
274
368
  }
369
+ /**
370
+ * Request parameters for unassignEntity operation in EmailMessagesApi.
371
+ * @export
372
+ * @interface EmailMessagesApiUnassignEntityRequest
373
+ */
374
+ export interface EmailMessagesApiUnassignEntityRequest {
375
+ /**
376
+ *
377
+ * @type {string}
378
+ * @memberof EmailMessagesApiUnassignEntity
379
+ */
380
+ readonly code: string;
381
+ /**
382
+ * Bearer Token: provided by the login endpoint under the name accessToken.
383
+ * @type {string}
384
+ * @memberof EmailMessagesApiUnassignEntity
385
+ */
386
+ readonly authorization?: string;
387
+ }
275
388
  /**
276
389
  * EmailMessagesApi - object-oriented interface
277
390
  * @export
@@ -280,7 +393,17 @@ export interface EmailMessagesApiListEmailMessagesRequest {
280
393
  */
281
394
  export declare class EmailMessagesApi extends BaseAPI {
282
395
  /**
283
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
396
+ * Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
397
+ * @summary Assign an email message to an entity
398
+ * @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
399
+ * @param {*} [options] Override http request option.
400
+ * @throws {RequiredError}
401
+ * @memberof EmailMessagesApi
402
+ */
403
+ assignEntity(requestParameters: EmailMessagesApiAssignEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignEmailMessageEntityResponseClass, any, {}>>;
404
+ /**
405
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
406
+ * @summary Download the email message attachment
284
407
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
285
408
  * @param {*} [options] Override http request option.
286
409
  * @throws {RequiredError}
@@ -288,7 +411,8 @@ export declare class EmailMessagesApi extends BaseAPI {
288
411
  */
289
412
  downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}>>;
290
413
  /**
291
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
414
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
415
+ * @summary Retrieve the email message
292
416
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
293
417
  * @param {*} [options] Override http request option.
294
418
  * @throws {RequiredError}
@@ -296,7 +420,8 @@ export declare class EmailMessagesApi extends BaseAPI {
296
420
  */
297
421
  getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}>>;
298
422
  /**
299
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
423
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
424
+ * @summary List the email message attachments
300
425
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
301
426
  * @param {*} [options] Override http request option.
302
427
  * @throws {RequiredError}
@@ -304,7 +429,7 @@ export declare class EmailMessagesApi extends BaseAPI {
304
429
  */
305
430
  listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
306
431
  /**
307
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
432
+ * 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
433
  * @summary List email messages
309
434
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
310
435
  * @param {*} [options] Override http request option.
@@ -312,4 +437,13 @@ export declare class EmailMessagesApi extends BaseAPI {
312
437
  * @memberof EmailMessagesApi
313
438
  */
314
439
  listEmailMessages(requestParameters?: EmailMessagesApiListEmailMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
440
+ /**
441
+ * Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
442
+ * @summary Unassign an email message from its entity
443
+ * @param {EmailMessagesApiUnassignEntityRequest} requestParameters Request parameters.
444
+ * @param {*} [options] Override http request option.
445
+ * @throws {RequiredError}
446
+ * @memberof EmailMessagesApi
447
+ */
448
+ unassignEntity(requestParameters: EmailMessagesApiUnassignEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnassignEmailMessageEntityResponseClass, any, {}>>;
315
449
  }