@emilgroup/notification-sdk 0.8.1-beta.5 → 0.8.1-beta.50

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 (101) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +2 -2
  3. package/api/email-mailboxes-api.ts +148 -0
  4. package/api/email-messages-api.ts +40 -28
  5. package/api/email-subscriptions-api.ts +559 -0
  6. package/api/email-tracking-api.ts +271 -40
  7. package/api/email-verifications-api.ts +16 -8
  8. package/api/layouts-api.ts +56 -36
  9. package/api/msgraph-webhooks-api.ts +278 -0
  10. package/api/notification-templates-api.ts +56 -36
  11. package/api/notifications-api.ts +115 -4
  12. package/api.ts +6 -0
  13. package/base.ts +36 -15
  14. package/configuration.ts +11 -0
  15. package/dist/api/email-mailboxes-api.d.ts +87 -0
  16. package/dist/api/email-mailboxes-api.js +218 -0
  17. package/dist/api/email-messages-api.d.ts +40 -28
  18. package/dist/api/email-messages-api.js +37 -25
  19. package/dist/api/email-subscriptions-api.d.ts +319 -0
  20. package/dist/api/email-subscriptions-api.js +537 -0
  21. package/dist/api/email-tracking-api.d.ts +170 -40
  22. package/dist/api/email-tracking-api.js +233 -34
  23. package/dist/api/email-verifications-api.d.ts +16 -8
  24. package/dist/api/email-verifications-api.js +16 -8
  25. package/dist/api/layouts-api.d.ts +56 -36
  26. package/dist/api/layouts-api.js +52 -32
  27. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  28. package/dist/api/msgraph-webhooks-api.js +305 -0
  29. package/dist/api/notification-templates-api.d.ts +56 -36
  30. package/dist/api/notification-templates-api.js +52 -32
  31. package/dist/api/notifications-api.d.ts +65 -4
  32. package/dist/api/notifications-api.js +101 -4
  33. package/dist/api.d.ts +3 -0
  34. package/dist/api.js +3 -0
  35. package/dist/base.d.ts +1 -0
  36. package/dist/base.js +36 -16
  37. package/dist/configuration.d.ts +9 -0
  38. package/dist/configuration.js +1 -0
  39. package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
  40. package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
  41. package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
  42. package/dist/models/assign-email-thread-entity-response-class.js +15 -0
  43. package/dist/models/email-mailbox-class.d.ts +47 -0
  44. package/dist/models/email-mailbox-class.js +20 -0
  45. package/dist/models/email-message-class.d.ts +73 -7
  46. package/dist/models/email-message-class.js +22 -3
  47. package/dist/models/email-message-summary-class.d.ts +98 -0
  48. package/dist/models/email-message-summary-class.js +33 -0
  49. package/dist/models/email-subscription-class.d.ts +104 -0
  50. package/dist/models/email-subscription-class.js +23 -0
  51. package/dist/models/email-thread-class.d.ts +37 -5
  52. package/dist/models/entity-ref-class.d.ts +37 -0
  53. package/dist/models/entity-ref-class.js +22 -0
  54. package/dist/models/get-email-subscription-response-class.d.ts +25 -0
  55. package/dist/models/get-email-subscription-response-class.js +15 -0
  56. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  57. package/dist/models/grpc-send-email-request-dto.js +22 -0
  58. package/dist/models/index.d.ts +17 -0
  59. package/dist/models/index.js +17 -0
  60. package/dist/models/inline-attachment-dto.d.ts +36 -0
  61. package/dist/models/inline-attachment-dto.js +15 -0
  62. package/dist/models/list-email-mailboxes-response-class.d.ts +43 -0
  63. package/dist/models/list-email-mailboxes-response-class.js +15 -0
  64. package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
  65. package/dist/models/list-email-subscriptions-response-class.js +15 -0
  66. package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
  67. package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
  68. package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
  69. package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
  70. package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
  71. package/dist/models/renew-email-subscription-response-class.js +15 -0
  72. package/dist/models/send-email-request-dto.d.ts +131 -0
  73. package/dist/models/send-email-request-dto.js +22 -0
  74. package/dist/models/send-email-response-class.d.ts +24 -0
  75. package/dist/models/send-email-response-class.js +15 -0
  76. package/dist/models/send-notification-request-dto.d.ts +10 -1
  77. package/dist/models/send-notification-request-dto.js +2 -1
  78. package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
  79. package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
  80. package/models/assign-email-thread-entity-body-dto.ts +52 -0
  81. package/models/assign-email-thread-entity-response-class.ts +31 -0
  82. package/models/email-mailbox-class.ts +56 -0
  83. package/models/email-message-class.ts +78 -8
  84. package/models/email-message-summary-class.ts +109 -0
  85. package/models/email-subscription-class.ts +113 -0
  86. package/models/email-thread-class.ts +37 -5
  87. package/models/entity-ref-class.ts +46 -0
  88. package/models/get-email-subscription-response-class.ts +31 -0
  89. package/models/grpc-send-email-request-dto.ts +144 -0
  90. package/models/index.ts +17 -0
  91. package/models/inline-attachment-dto.ts +42 -0
  92. package/models/list-email-mailboxes-response-class.ts +49 -0
  93. package/models/list-email-subscriptions-response-class.ts +49 -0
  94. package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
  95. package/models/reconcile-email-subscriptions-response-class.ts +54 -0
  96. package/models/renew-email-subscription-response-class.ts +31 -0
  97. package/models/send-email-request-dto.ts +138 -0
  98. package/models/send-email-response-class.ts +30 -0
  99. package/models/send-notification-request-dto.ts +9 -2
  100. package/models/unassign-email-thread-entity-response-class.ts +31 -0
  101. package/package.json +1 -1
@@ -3,11 +3,14 @@
3
3
  .openapi-generator-ignore
4
4
  README.md
5
5
  api.ts
6
+ api/email-mailboxes-api.ts
6
7
  api/email-messages-api.ts
8
+ api/email-subscriptions-api.ts
7
9
  api/email-tracking-api.ts
8
10
  api/email-verifications-api.ts
9
11
  api/health-api.ts
10
12
  api/layouts-api.ts
13
+ api/msgraph-webhooks-api.ts
11
14
  api/notification-templates-api.ts
12
15
  api/notifications-api.ts
13
16
  base.ts
@@ -15,6 +18,8 @@ common.ts
15
18
  configuration.ts
16
19
  git_push.sh
17
20
  index.ts
21
+ models/assign-email-thread-entity-body-dto.ts
22
+ models/assign-email-thread-entity-response-class.ts
18
23
  models/complete-email-verification-dto.ts
19
24
  models/complete-email-verification-response-class.ts
20
25
  models/create-layout-request-dto.ts
@@ -25,30 +30,45 @@ models/delete-layout-request-dto.ts
25
30
  models/delete-notification-template-request-dto.ts
26
31
  models/download-attachment-response-class.ts
27
32
  models/email-attachment-class.ts
33
+ models/email-mailbox-class.ts
28
34
  models/email-message-class.ts
35
+ models/email-message-summary-class.ts
36
+ models/email-subscription-class.ts
29
37
  models/email-thread-class.ts
38
+ models/entity-ref-class.ts
30
39
  models/get-email-message-response-class.ts
40
+ models/get-email-subscription-response-class.ts
31
41
  models/get-email-thread-response-class.ts
32
42
  models/get-layout-request-dto.ts
33
43
  models/get-layout-response-class.ts
34
44
  models/get-notification-template-request-dto.ts
35
45
  models/get-notification-template-response-class.ts
46
+ models/grpc-send-email-request-dto.ts
36
47
  models/html-template-class.ts
37
48
  models/index.ts
38
49
  models/initiate-email-verification-dto.ts
39
50
  models/initiate-email-verification-response-class.ts
51
+ models/inline-attachment-dto.ts
40
52
  models/inline-response200.ts
41
53
  models/inline-response503.ts
42
54
  models/layout-class.ts
43
55
  models/list-email-attachments-response-class.ts
56
+ models/list-email-mailboxes-response-class.ts
44
57
  models/list-email-messages-response-class.ts
58
+ models/list-email-subscriptions-response-class.ts
45
59
  models/list-email-threads-response-class.ts
46
60
  models/list-layouts-response-class.ts
47
61
  models/list-notification-templates-response-class.ts
48
62
  models/notification-template-class.ts
63
+ models/reconcile-email-subscriptions-request-dto.ts
64
+ models/reconcile-email-subscriptions-response-class.ts
65
+ models/renew-email-subscription-response-class.ts
49
66
  models/s3-document-dto.ts
67
+ models/send-email-request-dto.ts
68
+ models/send-email-response-class.ts
50
69
  models/send-notification-request-dto.ts
51
70
  models/send-notification-response-class.ts
71
+ models/unassign-email-thread-entity-response-class.ts
52
72
  models/update-html-template-request-dto.ts
53
73
  models/update-layout-request-dto.ts
54
74
  models/update-layout-response-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/notification-sdk@0.8.1-beta.5 --save
20
+ npm install @emilgroup/notification-sdk@0.8.1-beta.50 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk@0.8.1-beta.5
24
+ yarn add @emilgroup/notification-sdk@0.8.1-beta.50
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -0,0 +1,148 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL NotificationService
5
+ * The EMIL NotificationService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { ListEmailMailboxesResponseClass } from '../models';
25
+ /**
26
+ * EmailMailboxesApi - axios parameter creator
27
+ * @export
28
+ */
29
+ export const EmailMailboxesApiAxiosParamCreator = function (configuration?: Configuration) {
30
+ return {
31
+ /**
32
+ * Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
33
+ * @summary List the email mailboxes
34
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ listEmailMailboxes: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
39
+ const localVarPath = `/notificationservice/v1/email-mailboxes`;
40
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
41
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
42
+ let baseOptions;
43
+ let baseAccessToken;
44
+ if (configuration) {
45
+ baseOptions = configuration.baseOptions;
46
+ baseAccessToken = configuration.accessToken;
47
+ }
48
+
49
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
50
+ const localVarHeaderParameter = {} as any;
51
+ const localVarQueryParameter = {} as any;
52
+
53
+ // authentication bearer required
54
+ // http bearer authentication required
55
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
56
+
57
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
58
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
59
+ }
60
+
61
+
62
+
63
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
64
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
65
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
66
+
67
+ return {
68
+ url: toPathString(localVarUrlObj),
69
+ options: localVarRequestOptions,
70
+ };
71
+ },
72
+ }
73
+ };
74
+
75
+ /**
76
+ * EmailMailboxesApi - functional programming interface
77
+ * @export
78
+ */
79
+ export const EmailMailboxesApiFp = function(configuration?: Configuration) {
80
+ const localVarAxiosParamCreator = EmailMailboxesApiAxiosParamCreator(configuration)
81
+ return {
82
+ /**
83
+ * Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
84
+ * @summary List the email mailboxes
85
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ async listEmailMailboxes(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMailboxesResponseClass>> {
90
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listEmailMailboxes(authorization, options);
91
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
92
+ },
93
+ }
94
+ };
95
+
96
+ /**
97
+ * EmailMailboxesApi - factory interface
98
+ * @export
99
+ */
100
+ export const EmailMailboxesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
101
+ const localVarFp = EmailMailboxesApiFp(configuration)
102
+ return {
103
+ /**
104
+ * Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
105
+ * @summary List the email mailboxes
106
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ */
110
+ listEmailMailboxes(authorization?: string, options?: any): AxiosPromise<ListEmailMailboxesResponseClass> {
111
+ return localVarFp.listEmailMailboxes(authorization, options).then((request) => request(axios, basePath));
112
+ },
113
+ };
114
+ };
115
+
116
+ /**
117
+ * Request parameters for listEmailMailboxes operation in EmailMailboxesApi.
118
+ * @export
119
+ * @interface EmailMailboxesApiListEmailMailboxesRequest
120
+ */
121
+ export interface EmailMailboxesApiListEmailMailboxesRequest {
122
+ /**
123
+ * Bearer Token: provided by the login endpoint under the name accessToken.
124
+ * @type {string}
125
+ * @memberof EmailMailboxesApiListEmailMailboxes
126
+ */
127
+ readonly authorization?: string
128
+ }
129
+
130
+ /**
131
+ * EmailMailboxesApi - object-oriented interface
132
+ * @export
133
+ * @class EmailMailboxesApi
134
+ * @extends {BaseAPI}
135
+ */
136
+ export class EmailMailboxesApi extends BaseAPI {
137
+ /**
138
+ * Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
139
+ * @summary List the email mailboxes
140
+ * @param {EmailMailboxesApiListEmailMailboxesRequest} requestParameters Request parameters.
141
+ * @param {*} [options] Override http request option.
142
+ * @throws {RequiredError}
143
+ * @memberof EmailMailboxesApi
144
+ */
145
+ public listEmailMailboxes(requestParameters: EmailMailboxesApiListEmailMailboxesRequest = {}, options?: AxiosRequestConfig) {
146
+ return EmailMailboxesApiFp(this.configuration).listEmailMailboxes(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
147
+ }
148
+ }
@@ -35,7 +35,8 @@ import { ListEmailMessagesResponseClass } from '../models';
35
35
  export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
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
39
40
  * @param {string} code
40
41
  * @param {number} attachmentId
41
42
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -83,7 +84,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
83
84
  };
84
85
  },
85
86
  /**
86
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
87
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
88
+ * @summary Retrieve the email message
87
89
  * @param {string} code
88
90
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
91
  * @param {*} [options] Override http request option.
@@ -127,7 +129,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
127
129
  };
128
130
  },
129
131
  /**
130
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
132
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
133
+ * @summary List the email message attachments
131
134
  * @param {string} code
132
135
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
136
  * @param {*} [options] Override http request option.
@@ -171,16 +174,16 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
171
174
  };
172
175
  },
173
176
  /**
174
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
177
+ * 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\"
175
178
  * @summary List email messages
176
179
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
177
180
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
178
181
  * @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.
179
- * @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;
182
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
180
183
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
181
- * @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;
184
+ * @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
182
185
  * @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;
183
- * @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;
186
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
184
187
  * @param {*} [options] Override http request option.
185
188
  * @throws {RequiredError}
186
189
  */
@@ -257,7 +260,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
257
260
  const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
258
261
  return {
259
262
  /**
260
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
263
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
264
+ * @summary Download the email message attachment
261
265
  * @param {string} code
262
266
  * @param {number} attachmentId
263
267
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -269,7 +273,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
269
273
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
270
274
  },
271
275
  /**
272
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
276
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
277
+ * @summary Retrieve the email message
273
278
  * @param {string} code
274
279
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
275
280
  * @param {*} [options] Override http request option.
@@ -280,7 +285,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
280
285
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
281
286
  },
282
287
  /**
283
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
288
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
289
+ * @summary List the email message attachments
284
290
  * @param {string} code
285
291
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
286
292
  * @param {*} [options] Override http request option.
@@ -291,16 +297,16 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
291
297
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
292
298
  },
293
299
  /**
294
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
300
+ * 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\"
295
301
  * @summary List email messages
296
302
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
303
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
298
304
  * @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.
299
- * @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;
305
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
300
306
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
301
- * @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;
307
+ * @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
302
308
  * @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;
303
- * @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;
309
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
304
310
  * @param {*} [options] Override http request option.
305
311
  * @throws {RequiredError}
306
312
  */
@@ -319,7 +325,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
319
325
  const localVarFp = EmailMessagesApiFp(configuration)
320
326
  return {
321
327
  /**
322
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
328
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
329
+ * @summary Download the email message attachment
323
330
  * @param {string} code
324
331
  * @param {number} attachmentId
325
332
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -330,7 +337,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
330
337
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
331
338
  },
332
339
  /**
333
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
340
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
341
+ * @summary Retrieve the email message
334
342
  * @param {string} code
335
343
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
336
344
  * @param {*} [options] Override http request option.
@@ -340,7 +348,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
340
348
  return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
341
349
  },
342
350
  /**
343
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
351
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
352
+ * @summary List the email message attachments
344
353
  * @param {string} code
345
354
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
346
355
  * @param {*} [options] Override http request option.
@@ -350,16 +359,16 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
350
359
  return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
351
360
  },
352
361
  /**
353
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
362
+ * 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\"
354
363
  * @summary List email messages
355
364
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
356
365
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
357
366
  * @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.
358
- * @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;
367
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
359
368
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
360
- * @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;
369
+ * @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
361
370
  * @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;
362
- * @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;
371
+ * @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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
363
372
  * @param {*} [options] Override http request option.
364
373
  * @throws {RequiredError}
365
374
  */
@@ -467,7 +476,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
467
476
  readonly pageToken?: string
468
477
 
469
478
  /**
470
- * 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;
479
+ * 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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
471
480
  * @type {string}
472
481
  * @memberof EmailMessagesApiListEmailMessages
473
482
  */
@@ -481,7 +490,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
481
490
  readonly search?: string
482
491
 
483
492
  /**
484
- * 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;
493
+ * 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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt&lt;/i&gt;
485
494
  * @type {string}
486
495
  * @memberof EmailMessagesApiListEmailMessages
487
496
  */
@@ -495,7 +504,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
495
504
  readonly expand?: string
496
505
 
497
506
  /**
498
- * 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;
507
+ * 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, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
499
508
  * @type {string}
500
509
  * @memberof EmailMessagesApiListEmailMessages
501
510
  */
@@ -510,7 +519,8 @@ export interface EmailMessagesApiListEmailMessagesRequest {
510
519
  */
511
520
  export class EmailMessagesApi extends BaseAPI {
512
521
  /**
513
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
522
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
523
+ * @summary Download the email message attachment
514
524
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
515
525
  * @param {*} [options] Override http request option.
516
526
  * @throws {RequiredError}
@@ -521,7 +531,8 @@ export class EmailMessagesApi extends BaseAPI {
521
531
  }
522
532
 
523
533
  /**
524
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
534
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
535
+ * @summary Retrieve the email message
525
536
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
526
537
  * @param {*} [options] Override http request option.
527
538
  * @throws {RequiredError}
@@ -532,7 +543,8 @@ export class EmailMessagesApi extends BaseAPI {
532
543
  }
533
544
 
534
545
  /**
535
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
546
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
547
+ * @summary List the email message attachments
536
548
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
537
549
  * @param {*} [options] Override http request option.
538
550
  * @throws {RequiredError}
@@ -543,7 +555,7 @@ export class EmailMessagesApi extends BaseAPI {
543
555
  }
544
556
 
545
557
  /**
546
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
558
+ * 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\"
547
559
  * @summary List email messages
548
560
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
549
561
  * @param {*} [options] Override http request option.