@emilgroup/notification-sdk 0.8.1-beta.37 → 0.8.1-beta.39

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 (34) hide show
  1. package/.openapi-generator/FILES +4 -3
  2. package/README.md +2 -2
  3. package/api/email-messages-api.ts +0 -223
  4. package/api/email-tracking-api.ts +231 -8
  5. package/dist/api/email-messages-api.d.ts +0 -122
  6. package/dist/api/email-messages-api.js +0 -191
  7. package/dist/api/email-tracking-api.d.ts +130 -8
  8. package/dist/api/email-tracking-api.js +197 -6
  9. package/dist/models/{assign-email-message-entity-body-dto.d.ts → assign-email-thread-entity-body-dto.d.ts} +9 -9
  10. package/dist/models/{assign-email-message-entity-body-dto.js → assign-email-thread-entity-body-dto.js} +2 -2
  11. package/dist/models/{assign-email-message-entity-response-class.d.ts → assign-email-thread-entity-response-class.d.ts} +7 -7
  12. package/dist/models/email-message-class.d.ts +4 -9
  13. package/dist/models/email-thread-class.d.ts +6 -5
  14. package/dist/models/entity-ref-class.d.ts +37 -0
  15. package/dist/models/entity-ref-class.js +22 -0
  16. package/dist/models/grpc-send-email-request-dto.d.ts +1 -1
  17. package/dist/models/index.d.ts +4 -3
  18. package/dist/models/index.js +4 -3
  19. package/dist/models/send-email-request-dto.d.ts +1 -1
  20. package/dist/models/send-notification-request-dto.d.ts +1 -1
  21. package/dist/models/{unassign-email-message-entity-response-class.d.ts → unassign-email-thread-entity-response-class.d.ts} +7 -7
  22. package/models/{assign-email-message-entity-body-dto.ts → assign-email-thread-entity-body-dto.ts} +9 -9
  23. package/models/{assign-email-message-entity-response-class.ts → assign-email-thread-entity-response-class.ts} +7 -7
  24. package/models/email-message-class.ts +4 -9
  25. package/models/email-thread-class.ts +6 -5
  26. package/models/entity-ref-class.ts +46 -0
  27. package/models/grpc-send-email-request-dto.ts +1 -1
  28. package/models/index.ts +4 -3
  29. package/models/send-email-request-dto.ts +1 -1
  30. package/models/send-notification-request-dto.ts +1 -1
  31. package/models/{unassign-email-message-entity-response-class.ts → unassign-email-thread-entity-response-class.ts} +7 -7
  32. package/package.json +1 -1
  33. /package/dist/models/{assign-email-message-entity-response-class.js → assign-email-thread-entity-response-class.js} +0 -0
  34. /package/dist/models/{unassign-email-message-entity-response-class.js → unassign-email-thread-entity-response-class.js} +0 -0
@@ -16,8 +16,8 @@ common.ts
16
16
  configuration.ts
17
17
  git_push.sh
18
18
  index.ts
19
- models/assign-email-message-entity-body-dto.ts
20
- models/assign-email-message-entity-response-class.ts
19
+ models/assign-email-thread-entity-body-dto.ts
20
+ models/assign-email-thread-entity-response-class.ts
21
21
  models/complete-email-verification-dto.ts
22
22
  models/complete-email-verification-response-class.ts
23
23
  models/create-layout-request-dto.ts
@@ -30,6 +30,7 @@ models/download-attachment-response-class.ts
30
30
  models/email-attachment-class.ts
31
31
  models/email-message-class.ts
32
32
  models/email-thread-class.ts
33
+ models/entity-ref-class.ts
33
34
  models/get-email-message-response-class.ts
34
35
  models/get-email-thread-response-class.ts
35
36
  models/get-layout-request-dto.ts
@@ -56,7 +57,7 @@ models/send-email-request-dto.ts
56
57
  models/send-email-response-class.ts
57
58
  models/send-notification-request-dto.ts
58
59
  models/send-notification-response-class.ts
59
- models/unassign-email-message-entity-response-class.ts
60
+ models/unassign-email-thread-entity-response-class.ts
60
61
  models/update-html-template-request-dto.ts
61
62
  models/update-layout-request-dto.ts
62
63
  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.37 --save
20
+ npm install @emilgroup/notification-sdk@0.8.1-beta.39 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/notification-sdk@0.8.1-beta.37
24
+ yarn add @emilgroup/notification-sdk@0.8.1-beta.39
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -21,10 +21,6 @@ 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 { AssignEmailMessageEntityBodyDto } from '../models';
25
- // @ts-ignore
26
- import { AssignEmailMessageEntityResponseClass } from '../models';
27
- // @ts-ignore
28
24
  import { DownloadAttachmentResponseClass } from '../models';
29
25
  // @ts-ignore
30
26
  import { GetEmailMessageResponseClass } from '../models';
@@ -32,65 +28,12 @@ import { GetEmailMessageResponseClass } from '../models';
32
28
  import { ListEmailAttachmentsResponseClass } from '../models';
33
29
  // @ts-ignore
34
30
  import { ListEmailMessagesResponseClass } from '../models';
35
- // @ts-ignore
36
- import { UnassignEmailMessageEntityResponseClass } from '../models';
37
31
  /**
38
32
  * EmailMessagesApi - axios parameter creator
39
33
  * @export
40
34
  */
41
35
  export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
42
36
  return {
43
- /**
44
- * 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\"
45
- * @summary Assign an email message to an entity
46
- * @param {string} code
47
- * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
48
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
49
- * @param {*} [options] Override http request option.
50
- * @throws {RequiredError}
51
- */
52
- assignEntity: async (code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
53
- // verify required parameter 'code' is not null or undefined
54
- assertParamExists('assignEntity', 'code', code)
55
- // verify required parameter 'assignEmailMessageEntityBodyDto' is not null or undefined
56
- assertParamExists('assignEntity', 'assignEmailMessageEntityBodyDto', assignEmailMessageEntityBodyDto)
57
- const localVarPath = `/notificationservice/v1/email-messages/{code}/entity`
58
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
59
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
60
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
61
- let baseOptions;
62
- let baseAccessToken;
63
- if (configuration) {
64
- baseOptions = configuration.baseOptions;
65
- baseAccessToken = configuration.accessToken;
66
- }
67
-
68
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
69
- const localVarHeaderParameter = {} as any;
70
- const localVarQueryParameter = {} as any;
71
-
72
- // authentication bearer required
73
- // http bearer authentication required
74
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
75
-
76
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
77
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
78
- }
79
-
80
-
81
-
82
- localVarHeaderParameter['Content-Type'] = 'application/json';
83
-
84
- setSearchParams(localVarUrlObj, localVarQueryParameter);
85
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
86
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
87
- localVarRequestOptions.data = serializeDataIfNeeded(assignEmailMessageEntityBodyDto, localVarRequestOptions, configuration)
88
-
89
- return {
90
- url: toPathString(localVarUrlObj),
91
- options: localVarRequestOptions,
92
- };
93
- },
94
37
  /**
95
38
  * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
96
39
  * @summary Download the email message attachment
@@ -297,51 +240,6 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
297
240
 
298
241
 
299
242
 
300
- setSearchParams(localVarUrlObj, localVarQueryParameter);
301
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
302
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
303
-
304
- return {
305
- url: toPathString(localVarUrlObj),
306
- options: localVarRequestOptions,
307
- };
308
- },
309
- /**
310
- * 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\"
311
- * @summary Unassign an email message from its entity
312
- * @param {string} code
313
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
314
- * @param {*} [options] Override http request option.
315
- * @throws {RequiredError}
316
- */
317
- unassignEntity: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
318
- // verify required parameter 'code' is not null or undefined
319
- assertParamExists('unassignEntity', 'code', code)
320
- const localVarPath = `/notificationservice/v1/email-messages/{code}/entity`
321
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
322
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
323
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
324
- let baseOptions;
325
- let baseAccessToken;
326
- if (configuration) {
327
- baseOptions = configuration.baseOptions;
328
- baseAccessToken = configuration.accessToken;
329
- }
330
-
331
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
332
- const localVarHeaderParameter = {} as any;
333
- const localVarQueryParameter = {} as any;
334
-
335
- // authentication bearer required
336
- // http bearer authentication required
337
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
338
-
339
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
340
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
341
- }
342
-
343
-
344
-
345
243
  setSearchParams(localVarUrlObj, localVarQueryParameter);
346
244
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
347
245
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -361,19 +259,6 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
361
259
  export const EmailMessagesApiFp = function(configuration?: Configuration) {
362
260
  const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
363
261
  return {
364
- /**
365
- * 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\"
366
- * @summary Assign an email message to an entity
367
- * @param {string} code
368
- * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
369
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
370
- * @param {*} [options] Override http request option.
371
- * @throws {RequiredError}
372
- */
373
- async assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignEmailMessageEntityResponseClass>> {
374
- const localVarAxiosArgs = await localVarAxiosParamCreator.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options);
375
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
- },
377
262
  /**
378
263
  * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
379
264
  * @summary Download the email message attachment
@@ -429,18 +314,6 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
429
314
  const localVarAxiosArgs = await localVarAxiosParamCreator.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
430
315
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
431
316
  },
432
- /**
433
- * 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\"
434
- * @summary Unassign an email message from its entity
435
- * @param {string} code
436
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
437
- * @param {*} [options] Override http request option.
438
- * @throws {RequiredError}
439
- */
440
- async unassignEntity(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnassignEmailMessageEntityResponseClass>> {
441
- const localVarAxiosArgs = await localVarAxiosParamCreator.unassignEntity(code, authorization, options);
442
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
443
- },
444
317
  }
445
318
  };
446
319
 
@@ -451,18 +324,6 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
451
324
  export const EmailMessagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
452
325
  const localVarFp = EmailMessagesApiFp(configuration)
453
326
  return {
454
- /**
455
- * 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\"
456
- * @summary Assign an email message to an entity
457
- * @param {string} code
458
- * @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
459
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
460
- * @param {*} [options] Override http request option.
461
- * @throws {RequiredError}
462
- */
463
- assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: any): AxiosPromise<AssignEmailMessageEntityResponseClass> {
464
- return localVarFp.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options).then((request) => request(axios, basePath));
465
- },
466
327
  /**
467
328
  * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
468
329
  * @summary Download the email message attachment
@@ -514,48 +375,9 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
514
375
  listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
515
376
  return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
516
377
  },
517
- /**
518
- * 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\"
519
- * @summary Unassign an email message from its entity
520
- * @param {string} code
521
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
522
- * @param {*} [options] Override http request option.
523
- * @throws {RequiredError}
524
- */
525
- unassignEntity(code: string, authorization?: string, options?: any): AxiosPromise<UnassignEmailMessageEntityResponseClass> {
526
- return localVarFp.unassignEntity(code, authorization, options).then((request) => request(axios, basePath));
527
- },
528
378
  };
529
379
  };
530
380
 
531
- /**
532
- * Request parameters for assignEntity operation in EmailMessagesApi.
533
- * @export
534
- * @interface EmailMessagesApiAssignEntityRequest
535
- */
536
- export interface EmailMessagesApiAssignEntityRequest {
537
- /**
538
- *
539
- * @type {string}
540
- * @memberof EmailMessagesApiAssignEntity
541
- */
542
- readonly code: string
543
-
544
- /**
545
- *
546
- * @type {AssignEmailMessageEntityBodyDto}
547
- * @memberof EmailMessagesApiAssignEntity
548
- */
549
- readonly assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto
550
-
551
- /**
552
- * Bearer Token: provided by the login endpoint under the name accessToken.
553
- * @type {string}
554
- * @memberof EmailMessagesApiAssignEntity
555
- */
556
- readonly authorization?: string
557
- }
558
-
559
381
  /**
560
382
  * Request parameters for downloadAttachment operation in EmailMessagesApi.
561
383
  * @export
@@ -689,27 +511,6 @@ export interface EmailMessagesApiListEmailMessagesRequest {
689
511
  readonly filters?: string
690
512
  }
691
513
 
692
- /**
693
- * Request parameters for unassignEntity operation in EmailMessagesApi.
694
- * @export
695
- * @interface EmailMessagesApiUnassignEntityRequest
696
- */
697
- export interface EmailMessagesApiUnassignEntityRequest {
698
- /**
699
- *
700
- * @type {string}
701
- * @memberof EmailMessagesApiUnassignEntity
702
- */
703
- readonly code: string
704
-
705
- /**
706
- * Bearer Token: provided by the login endpoint under the name accessToken.
707
- * @type {string}
708
- * @memberof EmailMessagesApiUnassignEntity
709
- */
710
- readonly authorization?: string
711
- }
712
-
713
514
  /**
714
515
  * EmailMessagesApi - object-oriented interface
715
516
  * @export
@@ -717,18 +518,6 @@ export interface EmailMessagesApiUnassignEntityRequest {
717
518
  * @extends {BaseAPI}
718
519
  */
719
520
  export class EmailMessagesApi extends BaseAPI {
720
- /**
721
- * 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\"
722
- * @summary Assign an email message to an entity
723
- * @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
724
- * @param {*} [options] Override http request option.
725
- * @throws {RequiredError}
726
- * @memberof EmailMessagesApi
727
- */
728
- public assignEntity(requestParameters: EmailMessagesApiAssignEntityRequest, options?: AxiosRequestConfig) {
729
- return EmailMessagesApiFp(this.configuration).assignEntity(requestParameters.code, requestParameters.assignEmailMessageEntityBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
730
- }
731
-
732
521
  /**
733
522
  * Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
734
523
  * @summary Download the email message attachment
@@ -776,16 +565,4 @@ export class EmailMessagesApi extends BaseAPI {
776
565
  public listEmailMessages(requestParameters: EmailMessagesApiListEmailMessagesRequest = {}, options?: AxiosRequestConfig) {
777
566
  return EmailMessagesApiFp(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
778
567
  }
779
-
780
- /**
781
- * 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\"
782
- * @summary Unassign an email message from its entity
783
- * @param {EmailMessagesApiUnassignEntityRequest} requestParameters Request parameters.
784
- * @param {*} [options] Override http request option.
785
- * @throws {RequiredError}
786
- * @memberof EmailMessagesApi
787
- */
788
- public unassignEntity(requestParameters: EmailMessagesApiUnassignEntityRequest, options?: AxiosRequestConfig) {
789
- return EmailMessagesApiFp(this.configuration).unassignEntity(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
790
- }
791
568
  }