tuix-email-service-client 0.0.21 → 0.0.23

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 (33) hide show
  1. package/apis/ClientApi.js +6 -158
  2. package/apis/ClientApi.js.map +1 -1
  3. package/apis/ClientApi.ts +6 -246
  4. package/docs/ApplicationDTO.md +2 -0
  5. package/docs/ApplicationWithApplicationCountDTO.md +2 -0
  6. package/docs/ClientApi.md +7 -302
  7. package/docs/CreateApplicationDTO.md +2 -0
  8. package/docs/CreateSESConfigurationDTO.md +0 -2
  9. package/docs/SESConfigurationDTO.md +0 -2
  10. package/docs/UpdateApplicationDTO.md +2 -0
  11. package/docs/UpdateSESConfigurationDTO.md +0 -2
  12. package/models/ApplicationDTO.js +3 -0
  13. package/models/ApplicationDTO.js.map +1 -1
  14. package/models/ApplicationDTO.ts +16 -0
  15. package/models/ApplicationWithApplicationCountDTO.js +3 -0
  16. package/models/ApplicationWithApplicationCountDTO.js.map +1 -1
  17. package/models/ApplicationWithApplicationCountDTO.ts +16 -0
  18. package/models/CreateApplicationDTO.js +3 -0
  19. package/models/CreateApplicationDTO.js.map +1 -1
  20. package/models/CreateApplicationDTO.ts +16 -0
  21. package/models/CreateSESConfigurationDTO.js +0 -4
  22. package/models/CreateSESConfigurationDTO.js.map +1 -1
  23. package/models/CreateSESConfigurationDTO.ts +0 -9
  24. package/models/SESConfigurationDTO.js +0 -2
  25. package/models/SESConfigurationDTO.js.map +1 -1
  26. package/models/SESConfigurationDTO.ts +0 -8
  27. package/models/UpdateApplicationDTO.js +3 -0
  28. package/models/UpdateApplicationDTO.js.map +1 -1
  29. package/models/UpdateApplicationDTO.ts +16 -0
  30. package/models/UpdateSESConfigurationDTO.js +0 -2
  31. package/models/UpdateSESConfigurationDTO.js.map +1 -1
  32. package/models/UpdateSESConfigurationDTO.ts +0 -8
  33. package/package.json +1 -1
package/apis/ClientApi.ts CHANGED
@@ -43,11 +43,6 @@ import {
43
43
  CreateApplicationDTOFromJSON,
44
44
  CreateApplicationDTOToJSON,
45
45
  } from '../models/CreateApplicationDTO';
46
- import {
47
- type CreateSESConfigurationDTO,
48
- CreateSESConfigurationDTOFromJSON,
49
- CreateSESConfigurationDTOToJSON,
50
- } from '../models/CreateSESConfigurationDTO';
51
46
  import {
52
47
  type EmailTemplateContentDTO,
53
48
  EmailTemplateContentDTOFromJSON,
@@ -78,11 +73,6 @@ import {
78
73
  PaginatedEmailTemplateDTOFromJSON,
79
74
  PaginatedEmailTemplateDTOToJSON,
80
75
  } from '../models/PaginatedEmailTemplateDTO';
81
- import {
82
- type SESConfigurationDTO,
83
- SESConfigurationDTOFromJSON,
84
- SESConfigurationDTOToJSON,
85
- } from '../models/SESConfigurationDTO';
86
76
  import {
87
77
  type UpdateApplicationDTO,
88
78
  UpdateApplicationDTOFromJSON,
@@ -93,11 +83,6 @@ import {
93
83
  UpdateEmailTemplateDTOFromJSON,
94
84
  UpdateEmailTemplateDTOToJSON,
95
85
  } from '../models/UpdateEmailTemplateDTO';
96
- import {
97
- type UpdateSESConfigurationDTO,
98
- UpdateSESConfigurationDTOFromJSON,
99
- UpdateSESConfigurationDTOToJSON,
100
- } from '../models/UpdateSESConfigurationDTO';
101
86
 
102
87
  export interface ApiKeysGetRequest {
103
88
  page?: number;
@@ -131,19 +116,10 @@ export interface CreateApplicationRequest {
131
116
  createApplicationDTO: CreateApplicationDTO;
132
117
  }
133
118
 
134
- export interface CreateSESConfigurationRequest {
135
- applicationId: string;
136
- createSESConfigurationDTO: CreateSESConfigurationDTO;
137
- }
138
-
139
119
  export interface DeleteApplicationRequest {
140
120
  applicationId: string;
141
121
  }
142
122
 
143
- export interface DeleteSESConfigurationRequest {
144
- applicationId: string;
145
- }
146
-
147
123
  export interface DeleteTemplateRequest {
148
124
  id: string;
149
125
  applicationId: string;
@@ -158,10 +134,6 @@ export interface GetApplicationsRequest {
158
134
  pageSize?: number;
159
135
  }
160
136
 
161
- export interface GetSESConfigurationRequest {
162
- applicationId: string;
163
- }
164
-
165
137
  export interface GetTemplateRequest {
166
138
  id: string;
167
139
  applicationId: string;
@@ -189,11 +161,6 @@ export interface UpdateApplicationRequest {
189
161
  updateApplicationDTO: UpdateApplicationDTO;
190
162
  }
191
163
 
192
- export interface UpdateSESConfigurationRequest {
193
- applicationId: string;
194
- updateSESConfigurationDTO: UpdateSESConfigurationDTO;
195
- }
196
-
197
164
  export interface UpdateTemplateRequest {
198
165
  applicationId: string;
199
166
  id: string;
@@ -554,7 +521,7 @@ export class ClientApi extends runtime.BaseAPI {
554
521
  }
555
522
 
556
523
  /**
557
- * Create a new application for the authenticated account
524
+ * Create a new application for the authenticated account. Optionally accepts a sesConfiguration object to create the SES configuration in the same request.
558
525
  * Create a new application
559
526
  */
560
527
  async createApplicationRaw(requestParameters: CreateApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationDTO>> {
@@ -565,7 +532,7 @@ export class ClientApi extends runtime.BaseAPI {
565
532
  }
566
533
 
567
534
  /**
568
- * Create a new application for the authenticated account
535
+ * Create a new application for the authenticated account. Optionally accepts a sesConfiguration object to create the SES configuration in the same request.
569
536
  * Create a new application
570
537
  */
571
538
  async createApplication(requestParameters: CreateApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationDTO> {
@@ -573,63 +540,6 @@ export class ClientApi extends runtime.BaseAPI {
573
540
  return await response.value();
574
541
  }
575
542
 
576
- /**
577
- * Creates request options for createSESConfiguration without sending the request
578
- */
579
- async createSESConfigurationRequestOpts(requestParameters: CreateSESConfigurationRequest): Promise<runtime.RequestOpts> {
580
- if (requestParameters['applicationId'] == null) {
581
- throw new runtime.RequiredError(
582
- 'applicationId',
583
- 'Required parameter "applicationId" was null or undefined when calling createSESConfiguration().'
584
- );
585
- }
586
-
587
- if (requestParameters['createSESConfigurationDTO'] == null) {
588
- throw new runtime.RequiredError(
589
- 'createSESConfigurationDTO',
590
- 'Required parameter "createSESConfigurationDTO" was null or undefined when calling createSESConfiguration().'
591
- );
592
- }
593
-
594
- const queryParameters: any = {};
595
-
596
- const headerParameters: runtime.HTTPHeaders = {};
597
-
598
- headerParameters['Content-Type'] = 'application/json';
599
-
600
-
601
- let urlPath = `/applications/{applicationId}/ses-configurations`;
602
- urlPath = urlPath.replace('{applicationId}', encodeURIComponent(String(requestParameters['applicationId'])));
603
-
604
- return {
605
- path: urlPath,
606
- method: 'POST',
607
- headers: headerParameters,
608
- query: queryParameters,
609
- body: CreateSESConfigurationDTOToJSON(requestParameters['createSESConfigurationDTO']),
610
- };
611
- }
612
-
613
- /**
614
- * Create the SES sending configuration for the given application. Each application can have only one configuration.
615
- * Create the SES configuration for the application
616
- */
617
- async createSESConfigurationRaw(requestParameters: CreateSESConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SESConfigurationDTO>> {
618
- const requestOptions = await this.createSESConfigurationRequestOpts(requestParameters);
619
- const response = await this.request(requestOptions, initOverrides);
620
-
621
- return new runtime.JSONApiResponse(response, (jsonValue) => SESConfigurationDTOFromJSON(jsonValue));
622
- }
623
-
624
- /**
625
- * Create the SES sending configuration for the given application. Each application can have only one configuration.
626
- * Create the SES configuration for the application
627
- */
628
- async createSESConfiguration(requestParameters: CreateSESConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SESConfigurationDTO> {
629
- const response = await this.createSESConfigurationRaw(requestParameters, initOverrides);
630
- return await response.value();
631
- }
632
-
633
543
  /**
634
544
  * Creates request options for deleteApplication without sending the request
635
545
  */
@@ -676,52 +586,6 @@ export class ClientApi extends runtime.BaseAPI {
676
586
  await this.deleteApplicationRaw(requestParameters, initOverrides);
677
587
  }
678
588
 
679
- /**
680
- * Creates request options for deleteSESConfiguration without sending the request
681
- */
682
- async deleteSESConfigurationRequestOpts(requestParameters: DeleteSESConfigurationRequest): Promise<runtime.RequestOpts> {
683
- if (requestParameters['applicationId'] == null) {
684
- throw new runtime.RequiredError(
685
- 'applicationId',
686
- 'Required parameter "applicationId" was null or undefined when calling deleteSESConfiguration().'
687
- );
688
- }
689
-
690
- const queryParameters: any = {};
691
-
692
- const headerParameters: runtime.HTTPHeaders = {};
693
-
694
-
695
- let urlPath = `/applications/{applicationId}/ses-configurations`;
696
- urlPath = urlPath.replace('{applicationId}', encodeURIComponent(String(requestParameters['applicationId'])));
697
-
698
- return {
699
- path: urlPath,
700
- method: 'DELETE',
701
- headers: headerParameters,
702
- query: queryParameters,
703
- };
704
- }
705
-
706
- /**
707
- * Delete the SES sending configuration of the given application. Emails can no longer be sent for the application until a new configuration is created.
708
- * Delete the SES configuration for the application
709
- */
710
- async deleteSESConfigurationRaw(requestParameters: DeleteSESConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
711
- const requestOptions = await this.deleteSESConfigurationRequestOpts(requestParameters);
712
- const response = await this.request(requestOptions, initOverrides);
713
-
714
- return new runtime.VoidApiResponse(response);
715
- }
716
-
717
- /**
718
- * Delete the SES sending configuration of the given application. Emails can no longer be sent for the application until a new configuration is created.
719
- * Delete the SES configuration for the application
720
- */
721
- async deleteSESConfiguration(requestParameters: DeleteSESConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
722
- await this.deleteSESConfigurationRaw(requestParameters, initOverrides);
723
- }
724
-
725
589
  /**
726
590
  * Creates request options for deleteTemplate without sending the request
727
591
  */
@@ -804,7 +668,7 @@ export class ClientApi extends runtime.BaseAPI {
804
668
  }
805
669
 
806
670
  /**
807
- * Get a specific application belonging to the authenticated account
671
+ * Get a specific application belonging to the authenticated account, including its SES configuration when one exists
808
672
  * Get an application by applicationId
809
673
  */
810
674
  async getApplicationByIDRaw(requestParameters: GetApplicationByIDRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationDTO>> {
@@ -815,7 +679,7 @@ export class ClientApi extends runtime.BaseAPI {
815
679
  }
816
680
 
817
681
  /**
818
- * Get a specific application belonging to the authenticated account
682
+ * Get a specific application belonging to the authenticated account, including its SES configuration when one exists
819
683
  * Get an application by applicationId
820
684
  */
821
685
  async getApplicationByID(requestParameters: GetApplicationByIDRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationDTO> {
@@ -870,53 +734,6 @@ export class ClientApi extends runtime.BaseAPI {
870
734
  return await response.value();
871
735
  }
872
736
 
873
- /**
874
- * Creates request options for getSESConfiguration without sending the request
875
- */
876
- async getSESConfigurationRequestOpts(requestParameters: GetSESConfigurationRequest): Promise<runtime.RequestOpts> {
877
- if (requestParameters['applicationId'] == null) {
878
- throw new runtime.RequiredError(
879
- 'applicationId',
880
- 'Required parameter "applicationId" was null or undefined when calling getSESConfiguration().'
881
- );
882
- }
883
-
884
- const queryParameters: any = {};
885
-
886
- const headerParameters: runtime.HTTPHeaders = {};
887
-
888
-
889
- let urlPath = `/applications/{applicationId}/ses-configurations`;
890
- urlPath = urlPath.replace('{applicationId}', encodeURIComponent(String(requestParameters['applicationId'])));
891
-
892
- return {
893
- path: urlPath,
894
- method: 'GET',
895
- headers: headerParameters,
896
- query: queryParameters,
897
- };
898
- }
899
-
900
- /**
901
- * Retrieve the SES sending configuration of the given application. The secret access key is never returned.
902
- * Get the SES configuration for the application
903
- */
904
- async getSESConfigurationRaw(requestParameters: GetSESConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SESConfigurationDTO>> {
905
- const requestOptions = await this.getSESConfigurationRequestOpts(requestParameters);
906
- const response = await this.request(requestOptions, initOverrides);
907
-
908
- return new runtime.JSONApiResponse(response, (jsonValue) => SESConfigurationDTOFromJSON(jsonValue));
909
- }
910
-
911
- /**
912
- * Retrieve the SES sending configuration of the given application. The secret access key is never returned.
913
- * Get the SES configuration for the application
914
- */
915
- async getSESConfiguration(requestParameters: GetSESConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SESConfigurationDTO> {
916
- const response = await this.getSESConfigurationRaw(requestParameters, initOverrides);
917
- return await response.value();
918
- }
919
-
920
737
  /**
921
738
  * Creates request options for getTemplate without sending the request
922
739
  */
@@ -1184,7 +1001,7 @@ export class ClientApi extends runtime.BaseAPI {
1184
1001
  }
1185
1002
 
1186
1003
  /**
1187
- * Update an application belonging to the authenticated account
1004
+ * Update an application belonging to the authenticated account. Optionally accepts a sesConfiguration object to create or update the SES configuration in the same request; when omitted or null the SES configuration is left untouched.
1188
1005
  * Update an application
1189
1006
  */
1190
1007
  async updateApplicationRaw(requestParameters: UpdateApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationDTO>> {
@@ -1195,7 +1012,7 @@ export class ClientApi extends runtime.BaseAPI {
1195
1012
  }
1196
1013
 
1197
1014
  /**
1198
- * Update an application belonging to the authenticated account
1015
+ * Update an application belonging to the authenticated account. Optionally accepts a sesConfiguration object to create or update the SES configuration in the same request; when omitted or null the SES configuration is left untouched.
1199
1016
  * Update an application
1200
1017
  */
1201
1018
  async updateApplication(requestParameters: UpdateApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationDTO> {
@@ -1203,63 +1020,6 @@ export class ClientApi extends runtime.BaseAPI {
1203
1020
  return await response.value();
1204
1021
  }
1205
1022
 
1206
- /**
1207
- * Creates request options for updateSESConfiguration without sending the request
1208
- */
1209
- async updateSESConfigurationRequestOpts(requestParameters: UpdateSESConfigurationRequest): Promise<runtime.RequestOpts> {
1210
- if (requestParameters['applicationId'] == null) {
1211
- throw new runtime.RequiredError(
1212
- 'applicationId',
1213
- 'Required parameter "applicationId" was null or undefined when calling updateSESConfiguration().'
1214
- );
1215
- }
1216
-
1217
- if (requestParameters['updateSESConfigurationDTO'] == null) {
1218
- throw new runtime.RequiredError(
1219
- 'updateSESConfigurationDTO',
1220
- 'Required parameter "updateSESConfigurationDTO" was null or undefined when calling updateSESConfiguration().'
1221
- );
1222
- }
1223
-
1224
- const queryParameters: any = {};
1225
-
1226
- const headerParameters: runtime.HTTPHeaders = {};
1227
-
1228
- headerParameters['Content-Type'] = 'application/json';
1229
-
1230
-
1231
- let urlPath = `/applications/{applicationId}/ses-configurations`;
1232
- urlPath = urlPath.replace('{applicationId}', encodeURIComponent(String(requestParameters['applicationId'])));
1233
-
1234
- return {
1235
- path: urlPath,
1236
- method: 'PUT',
1237
- headers: headerParameters,
1238
- query: queryParameters,
1239
- body: UpdateSESConfigurationDTOToJSON(requestParameters['updateSESConfigurationDTO']),
1240
- };
1241
- }
1242
-
1243
- /**
1244
- * Update the SES sending configuration of the given application. Omitted or empty fields keep their stored value.
1245
- * Update the SES configuration for the application
1246
- */
1247
- async updateSESConfigurationRaw(requestParameters: UpdateSESConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SESConfigurationDTO>> {
1248
- const requestOptions = await this.updateSESConfigurationRequestOpts(requestParameters);
1249
- const response = await this.request(requestOptions, initOverrides);
1250
-
1251
- return new runtime.JSONApiResponse(response, (jsonValue) => SESConfigurationDTOFromJSON(jsonValue));
1252
- }
1253
-
1254
- /**
1255
- * Update the SES sending configuration of the given application. Omitted or empty fields keep their stored value.
1256
- * Update the SES configuration for the application
1257
- */
1258
- async updateSESConfiguration(requestParameters: UpdateSESConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SESConfigurationDTO> {
1259
- const response = await this.updateSESConfigurationRaw(requestParameters, initOverrides);
1260
- return await response.value();
1261
- }
1262
-
1263
1023
  /**
1264
1024
  * Creates request options for updateTemplate without sending the request
1265
1025
  */
@@ -11,6 +11,7 @@ Name | Type
11
11
  `description` | string
12
12
  `id` | string
13
13
  `name` | string
14
+ `sesConfiguration` | [SESConfigurationDTO](SESConfigurationDTO.md)
14
15
 
15
16
  ## Example
16
17
 
@@ -24,6 +25,7 @@ const example = {
24
25
  "description": null,
25
26
  "id": null,
26
27
  "name": null,
28
+ "sesConfiguration": null,
27
29
  } satisfies ApplicationDTO
28
30
 
29
31
  console.log(example)
@@ -12,6 +12,7 @@ Name | Type
12
12
  `emailTemplatesCount` | number
13
13
  `id` | string
14
14
  `name` | string
15
+ `sesConfiguration` | [SESConfigurationDTO](SESConfigurationDTO.md)
15
16
 
16
17
  ## Example
17
18
 
@@ -26,6 +27,7 @@ const example = {
26
27
  "emailTemplatesCount": null,
27
28
  "id": null,
28
29
  "name": null,
30
+ "sesConfiguration": null,
29
31
  } satisfies ApplicationWithApplicationCountDTO
30
32
 
31
33
  console.log(example)