@emilgroup/notification-sdk 0.8.1-beta.6 → 0.8.1-beta.60

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 (114) hide show
  1. package/.openapi-generator/FILES +23 -0
  2. package/README.md +2 -2
  3. package/api/email-mailboxes-api.ts +150 -0
  4. package/api/email-messages-api.ts +56 -36
  5. package/api/email-subscriptions-api.ts +781 -0
  6. package/api/email-tracking-api.ts +291 -48
  7. package/api/email-verifications-api.ts +24 -12
  8. package/api/layouts-api.ts +76 -46
  9. package/api/msgraph-webhooks-api.ts +278 -0
  10. package/api/notification-templates-api.ts +76 -46
  11. package/api/notifications-api.ts +121 -6
  12. package/api.ts +6 -0
  13. package/base.ts +174 -41
  14. package/common.ts +3 -2
  15. package/configuration.ts +20 -0
  16. package/dist/api/email-mailboxes-api.d.ts +87 -0
  17. package/dist/api/email-mailboxes-api.js +221 -0
  18. package/dist/api/email-messages-api.d.ts +44 -32
  19. package/dist/api/email-messages-api.js +62 -40
  20. package/dist/api/email-subscriptions-api.d.ts +432 -0
  21. package/dist/api/email-subscriptions-api.js +738 -0
  22. package/dist/api/email-tracking-api.d.ts +174 -44
  23. package/dist/api/email-tracking-api.js +261 -48
  24. package/dist/api/email-verifications-api.d.ts +18 -10
  25. package/dist/api/email-verifications-api.js +30 -16
  26. package/dist/api/health-api.d.ts +1 -1
  27. package/dist/api/layouts-api.d.ts +61 -41
  28. package/dist/api/layouts-api.js +81 -50
  29. package/dist/api/msgraph-webhooks-api.d.ts +168 -0
  30. package/dist/api/msgraph-webhooks-api.js +305 -0
  31. package/dist/api/notification-templates-api.d.ts +61 -41
  32. package/dist/api/notification-templates-api.js +81 -50
  33. package/dist/api/notifications-api.d.ts +66 -5
  34. package/dist/api/notifications-api.js +111 -8
  35. package/dist/api.d.ts +3 -0
  36. package/dist/api.js +3 -0
  37. package/dist/base.d.ts +24 -0
  38. package/dist/base.js +178 -59
  39. package/dist/common.d.ts +1 -1
  40. package/dist/common.js +1 -0
  41. package/dist/configuration.d.ts +17 -0
  42. package/dist/configuration.js +2 -0
  43. package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
  44. package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
  45. package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
  46. package/dist/models/assign-email-thread-entity-response-class.js +15 -0
  47. package/dist/models/catch-up-email-subscription-response-class.d.ts +24 -0
  48. package/dist/models/catch-up-email-subscription-response-class.js +15 -0
  49. package/dist/models/catch-up-email-subscriptions-request-dto.d.ts +24 -0
  50. package/dist/models/catch-up-email-subscriptions-request-dto.js +15 -0
  51. package/dist/models/catch-up-email-subscriptions-response-class.d.ts +30 -0
  52. package/dist/models/catch-up-email-subscriptions-response-class.js +15 -0
  53. package/dist/models/email-mailbox-class.d.ts +47 -0
  54. package/dist/models/email-mailbox-class.js +20 -0
  55. package/dist/models/email-message-class.d.ts +73 -7
  56. package/dist/models/email-message-class.js +22 -3
  57. package/dist/models/email-message-summary-class.d.ts +98 -0
  58. package/dist/models/email-message-summary-class.js +33 -0
  59. package/dist/models/email-subscription-class.d.ts +110 -0
  60. package/dist/models/email-subscription-class.js +23 -0
  61. package/dist/models/email-thread-class.d.ts +37 -5
  62. package/dist/models/entity-ref-class.d.ts +37 -0
  63. package/dist/models/entity-ref-class.js +22 -0
  64. package/dist/models/get-email-subscription-response-class.d.ts +25 -0
  65. package/dist/models/get-email-subscription-response-class.js +15 -0
  66. package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
  67. package/dist/models/grpc-send-email-request-dto.js +22 -0
  68. package/dist/models/index.d.ts +20 -0
  69. package/dist/models/index.js +20 -0
  70. package/dist/models/inline-attachment-dto.d.ts +36 -0
  71. package/dist/models/inline-attachment-dto.js +15 -0
  72. package/dist/models/list-email-mailboxes-response-class.d.ts +43 -0
  73. package/dist/models/list-email-mailboxes-response-class.js +15 -0
  74. package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
  75. package/dist/models/list-email-subscriptions-response-class.js +15 -0
  76. package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
  77. package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
  78. package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
  79. package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
  80. package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
  81. package/dist/models/renew-email-subscription-response-class.js +15 -0
  82. package/dist/models/send-email-request-dto.d.ts +131 -0
  83. package/dist/models/send-email-request-dto.js +22 -0
  84. package/dist/models/send-email-response-class.d.ts +24 -0
  85. package/dist/models/send-email-response-class.js +15 -0
  86. package/dist/models/send-notification-request-dto.d.ts +10 -1
  87. package/dist/models/send-notification-request-dto.js +2 -1
  88. package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
  89. package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
  90. package/models/assign-email-thread-entity-body-dto.ts +52 -0
  91. package/models/assign-email-thread-entity-response-class.ts +31 -0
  92. package/models/catch-up-email-subscription-response-class.ts +30 -0
  93. package/models/catch-up-email-subscriptions-request-dto.ts +30 -0
  94. package/models/catch-up-email-subscriptions-response-class.ts +36 -0
  95. package/models/email-mailbox-class.ts +56 -0
  96. package/models/email-message-class.ts +78 -8
  97. package/models/email-message-summary-class.ts +109 -0
  98. package/models/email-subscription-class.ts +119 -0
  99. package/models/email-thread-class.ts +37 -5
  100. package/models/entity-ref-class.ts +46 -0
  101. package/models/get-email-subscription-response-class.ts +31 -0
  102. package/models/grpc-send-email-request-dto.ts +144 -0
  103. package/models/index.ts +20 -0
  104. package/models/inline-attachment-dto.ts +42 -0
  105. package/models/list-email-mailboxes-response-class.ts +49 -0
  106. package/models/list-email-subscriptions-response-class.ts +49 -0
  107. package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
  108. package/models/reconcile-email-subscriptions-response-class.ts +54 -0
  109. package/models/renew-email-subscription-response-class.ts +31 -0
  110. package/models/send-email-request-dto.ts +138 -0
  111. package/models/send-email-response-class.ts +30 -0
  112. package/models/send-notification-request-dto.ts +9 -2
  113. package/models/unassign-email-thread-entity-response-class.ts +31 -0
  114. package/package.json +2 -2
@@ -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,11 @@ 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
23
+ models/catch-up-email-subscription-response-class.ts
24
+ models/catch-up-email-subscriptions-request-dto.ts
25
+ models/catch-up-email-subscriptions-response-class.ts
18
26
  models/complete-email-verification-dto.ts
19
27
  models/complete-email-verification-response-class.ts
20
28
  models/create-layout-request-dto.ts
@@ -25,30 +33,45 @@ models/delete-layout-request-dto.ts
25
33
  models/delete-notification-template-request-dto.ts
26
34
  models/download-attachment-response-class.ts
27
35
  models/email-attachment-class.ts
36
+ models/email-mailbox-class.ts
28
37
  models/email-message-class.ts
38
+ models/email-message-summary-class.ts
39
+ models/email-subscription-class.ts
29
40
  models/email-thread-class.ts
41
+ models/entity-ref-class.ts
30
42
  models/get-email-message-response-class.ts
43
+ models/get-email-subscription-response-class.ts
31
44
  models/get-email-thread-response-class.ts
32
45
  models/get-layout-request-dto.ts
33
46
  models/get-layout-response-class.ts
34
47
  models/get-notification-template-request-dto.ts
35
48
  models/get-notification-template-response-class.ts
49
+ models/grpc-send-email-request-dto.ts
36
50
  models/html-template-class.ts
37
51
  models/index.ts
38
52
  models/initiate-email-verification-dto.ts
39
53
  models/initiate-email-verification-response-class.ts
54
+ models/inline-attachment-dto.ts
40
55
  models/inline-response200.ts
41
56
  models/inline-response503.ts
42
57
  models/layout-class.ts
43
58
  models/list-email-attachments-response-class.ts
59
+ models/list-email-mailboxes-response-class.ts
44
60
  models/list-email-messages-response-class.ts
61
+ models/list-email-subscriptions-response-class.ts
45
62
  models/list-email-threads-response-class.ts
46
63
  models/list-layouts-response-class.ts
47
64
  models/list-notification-templates-response-class.ts
48
65
  models/notification-template-class.ts
66
+ models/reconcile-email-subscriptions-request-dto.ts
67
+ models/reconcile-email-subscriptions-response-class.ts
68
+ models/renew-email-subscription-response-class.ts
49
69
  models/s3-document-dto.ts
70
+ models/send-email-request-dto.ts
71
+ models/send-email-response-class.ts
50
72
  models/send-notification-request-dto.ts
51
73
  models/send-notification-response-class.ts
74
+ models/unassign-email-thread-entity-response-class.ts
52
75
  models/update-html-template-request-dto.ts
53
76
  models/update-layout-request-dto.ts
54
77
  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.6 --save
20
+ npm install @emilgroup/notification-sdk@0.8.1-beta.60 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk@0.8.1-beta.6
24
+ yarn add @emilgroup/notification-sdk@0.8.1-beta.60
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -0,0 +1,150 @@
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
+ // Only Authorization falls back to the configured token; an empty value is never sent.
58
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
59
+ if (authorizationValue) {
60
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
61
+ }
62
+
63
+
64
+
65
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
66
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
67
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
68
+
69
+ return {
70
+ url: toPathString(localVarUrlObj),
71
+ options: localVarRequestOptions,
72
+ };
73
+ },
74
+ }
75
+ };
76
+
77
+ /**
78
+ * EmailMailboxesApi - functional programming interface
79
+ * @export
80
+ */
81
+ export const EmailMailboxesApiFp = function(configuration?: Configuration) {
82
+ const localVarAxiosParamCreator = EmailMailboxesApiAxiosParamCreator(configuration)
83
+ return {
84
+ /**
85
+ * 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\"
86
+ * @summary List the email mailboxes
87
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ async listEmailMailboxes(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMailboxesResponseClass>> {
92
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listEmailMailboxes(authorization, options);
93
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
94
+ },
95
+ }
96
+ };
97
+
98
+ /**
99
+ * EmailMailboxesApi - factory interface
100
+ * @export
101
+ */
102
+ export const EmailMailboxesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
103
+ const localVarFp = EmailMailboxesApiFp(configuration)
104
+ return {
105
+ /**
106
+ * 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\"
107
+ * @summary List the email mailboxes
108
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
109
+ * @param {*} [options] Override http request option.
110
+ * @throws {RequiredError}
111
+ */
112
+ listEmailMailboxes(authorization?: string, options?: any): AxiosPromise<ListEmailMailboxesResponseClass> {
113
+ return localVarFp.listEmailMailboxes(authorization, options).then((request) => request(axios, basePath));
114
+ },
115
+ };
116
+ };
117
+
118
+ /**
119
+ * Request parameters for listEmailMailboxes operation in EmailMailboxesApi.
120
+ * @export
121
+ * @interface EmailMailboxesApiListEmailMailboxesRequest
122
+ */
123
+ export interface EmailMailboxesApiListEmailMailboxesRequest {
124
+ /**
125
+ * Bearer Token: provided by the login endpoint under the name accessToken.
126
+ * @type {string}
127
+ * @memberof EmailMailboxesApiListEmailMailboxes
128
+ */
129
+ readonly authorization?: string
130
+ }
131
+
132
+ /**
133
+ * EmailMailboxesApi - object-oriented interface
134
+ * @export
135
+ * @class EmailMailboxesApi
136
+ * @extends {BaseAPI}
137
+ */
138
+ export class EmailMailboxesApi extends BaseAPI {
139
+ /**
140
+ * 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\"
141
+ * @summary List the email mailboxes
142
+ * @param {EmailMailboxesApiListEmailMailboxesRequest} requestParameters Request parameters.
143
+ * @param {*} [options] Override http request option.
144
+ * @throws {RequiredError}
145
+ * @memberof EmailMailboxesApi
146
+ */
147
+ public listEmailMailboxes(requestParameters: EmailMailboxesApiListEmailMailboxesRequest = {}, options?: AxiosRequestConfig) {
148
+ return EmailMailboxesApiFp(this.configuration).listEmailMailboxes(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
149
+ }
150
+ }
@@ -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.
@@ -67,8 +68,10 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
67
68
  // http bearer authentication required
68
69
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
69
70
 
70
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
71
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
71
+ // Only Authorization falls back to the configured token; an empty value is never sent.
72
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
73
+ if (authorizationValue) {
74
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
72
75
  }
73
76
 
74
77
 
@@ -83,7 +86,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
83
86
  };
84
87
  },
85
88
  /**
86
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
89
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
90
+ * @summary Retrieve the email message
87
91
  * @param {string} code
88
92
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
93
  * @param {*} [options] Override http request option.
@@ -111,8 +115,10 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
111
115
  // http bearer authentication required
112
116
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
113
117
 
114
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
115
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
118
+ // Only Authorization falls back to the configured token; an empty value is never sent.
119
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
120
+ if (authorizationValue) {
121
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
116
122
  }
117
123
 
118
124
 
@@ -127,7 +133,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
127
133
  };
128
134
  },
129
135
  /**
130
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
136
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
137
+ * @summary List the email message attachments
131
138
  * @param {string} code
132
139
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
140
  * @param {*} [options] Override http request option.
@@ -155,8 +162,10 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
155
162
  // http bearer authentication required
156
163
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
157
164
 
158
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
159
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
165
+ // Only Authorization falls back to the configured token; an empty value is never sent.
166
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
167
+ if (authorizationValue) {
168
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
160
169
  }
161
170
 
162
171
 
@@ -171,16 +180,16 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
171
180
  };
172
181
  },
173
182
  /**
174
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
183
+ * 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
184
  * @summary List email messages
176
185
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
177
186
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
178
187
  * @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;
188
+ * @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
189
  * @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;
190
+ * @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
191
  * @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;
192
+ * @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
193
  * @param {*} [options] Override http request option.
185
194
  * @throws {RequiredError}
186
195
  */
@@ -231,8 +240,10 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
231
240
  localVarQueryParameter['filters'] = filters;
232
241
  }
233
242
 
234
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
235
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
243
+ // Only Authorization falls back to the configured token; an empty value is never sent.
244
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
245
+ if (authorizationValue) {
246
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
236
247
  }
237
248
 
238
249
 
@@ -257,7 +268,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
257
268
  const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
258
269
  return {
259
270
  /**
260
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
271
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
272
+ * @summary Download the email message attachment
261
273
  * @param {string} code
262
274
  * @param {number} attachmentId
263
275
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -269,7 +281,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
269
281
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
270
282
  },
271
283
  /**
272
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
284
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
285
+ * @summary Retrieve the email message
273
286
  * @param {string} code
274
287
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
275
288
  * @param {*} [options] Override http request option.
@@ -280,7 +293,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
280
293
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
281
294
  },
282
295
  /**
283
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
296
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
297
+ * @summary List the email message attachments
284
298
  * @param {string} code
285
299
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
286
300
  * @param {*} [options] Override http request option.
@@ -291,16 +305,16 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
291
305
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
292
306
  },
293
307
  /**
294
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
308
+ * 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
309
  * @summary List email messages
296
310
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
311
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
298
312
  * @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;
313
+ * @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
314
  * @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;
315
+ * @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
316
  * @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;
317
+ * @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
318
  * @param {*} [options] Override http request option.
305
319
  * @throws {RequiredError}
306
320
  */
@@ -319,7 +333,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
319
333
  const localVarFp = EmailMessagesApiFp(configuration)
320
334
  return {
321
335
  /**
322
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
336
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
337
+ * @summary Download the email message attachment
323
338
  * @param {string} code
324
339
  * @param {number} attachmentId
325
340
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -330,7 +345,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
330
345
  return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
331
346
  },
332
347
  /**
333
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
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
334
350
  * @param {string} code
335
351
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
336
352
  * @param {*} [options] Override http request option.
@@ -340,7 +356,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
340
356
  return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
341
357
  },
342
358
  /**
343
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
359
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
360
+ * @summary List the email message attachments
344
361
  * @param {string} code
345
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
346
363
  * @param {*} [options] Override http request option.
@@ -350,16 +367,16 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
350
367
  return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
351
368
  },
352
369
  /**
353
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
370
+ * 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
371
  * @summary List email messages
355
372
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
356
373
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
357
374
  * @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;
375
+ * @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
376
  * @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;
377
+ * @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
378
  * @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;
379
+ * @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
380
  * @param {*} [options] Override http request option.
364
381
  * @throws {RequiredError}
365
382
  */
@@ -467,7 +484,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
467
484
  readonly pageToken?: string
468
485
 
469
486
  /**
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;
487
+ * 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
488
  * @type {string}
472
489
  * @memberof EmailMessagesApiListEmailMessages
473
490
  */
@@ -481,7 +498,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
481
498
  readonly search?: string
482
499
 
483
500
  /**
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;
501
+ * 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
502
  * @type {string}
486
503
  * @memberof EmailMessagesApiListEmailMessages
487
504
  */
@@ -495,7 +512,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
495
512
  readonly expand?: string
496
513
 
497
514
  /**
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;
515
+ * 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
516
  * @type {string}
500
517
  * @memberof EmailMessagesApiListEmailMessages
501
518
  */
@@ -510,7 +527,8 @@ export interface EmailMessagesApiListEmailMessagesRequest {
510
527
  */
511
528
  export class EmailMessagesApi extends BaseAPI {
512
529
  /**
513
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
530
+ * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
531
+ * @summary Download the email message attachment
514
532
  * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
515
533
  * @param {*} [options] Override http request option.
516
534
  * @throws {RequiredError}
@@ -521,7 +539,8 @@ export class EmailMessagesApi extends BaseAPI {
521
539
  }
522
540
 
523
541
  /**
524
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
542
+ * Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
543
+ * @summary Retrieve the email message
525
544
  * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
526
545
  * @param {*} [options] Override http request option.
527
546
  * @throws {RequiredError}
@@ -532,7 +551,8 @@ export class EmailMessagesApi extends BaseAPI {
532
551
  }
533
552
 
534
553
  /**
535
- * undefined **Required Permissions** \"notification-management.email-messages.view\"
554
+ * Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
555
+ * @summary List the email message attachments
536
556
  * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
537
557
  * @param {*} [options] Override http request option.
538
558
  * @throws {RequiredError}
@@ -543,7 +563,7 @@ export class EmailMessagesApi extends BaseAPI {
543
563
  }
544
564
 
545
565
  /**
546
- * Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
566
+ * 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
567
  * @summary List email messages
548
568
  * @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
549
569
  * @param {*} [options] Override http request option.