tuix-email-service-client 0.0.19 → 0.0.21
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.
- package/.openapi-generator/FILES +6 -0
- package/apis/ClientApi.js +152 -0
- package/apis/ClientApi.js.map +1 -1
- package/apis/ClientApi.ts +240 -0
- package/docs/ClientApi.md +296 -1
- package/docs/CreateSESConfigurationDTO.md +40 -0
- package/docs/SESConfigurationDTO.md +46 -0
- package/docs/UpdateSESConfigurationDTO.md +40 -0
- package/models/CreateSESConfigurationDTO.js +63 -0
- package/models/CreateSESConfigurationDTO.js.map +1 -0
- package/models/CreateSESConfigurationDTO.ts +93 -0
- package/models/SESConfigurationDTO.js +61 -0
- package/models/SESConfigurationDTO.js.map +1 -0
- package/models/SESConfigurationDTO.ts +113 -0
- package/models/UpdateSESConfigurationDTO.js +55 -0
- package/models/UpdateSESConfigurationDTO.js.map +1 -0
- package/models/UpdateSESConfigurationDTO.ts +89 -0
- package/models/index.js +3 -0
- package/models/index.js.map +1 -1
- package/models/index.ts +3 -0
- package/package.json +1 -1
- package/runtime.js +1 -1
- package/runtime.js.map +1 -1
- package/runtime.ts +1 -1
- package/tsconfig.build.tsbuildinfo +1 -1
package/docs/ClientApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ClientApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *http://0.0.0.0:3000
|
|
3
|
+
All URIs are relative to *http://0.0.0.0:3000*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -10,14 +10,18 @@ All URIs are relative to *http://0.0.0.0:3000/local*
|
|
|
10
10
|
| [**apiSendEmail**](ClientApi.md#apisendemail) | **POST** /api/applications/{applicationId}/emails/send | Send an email |
|
|
11
11
|
| [**createAccount**](ClientApi.md#createaccount) | **POST** /accounts | Creates a new account |
|
|
12
12
|
| [**createApplication**](ClientApi.md#createapplication) | **POST** /applications | Create a new application |
|
|
13
|
+
| [**createSESConfiguration**](ClientApi.md#createsesconfiguration) | **POST** /applications/{applicationId}/ses-configurations | Create the SES configuration for the application |
|
|
13
14
|
| [**deleteApplication**](ClientApi.md#deleteapplication) | **DELETE** /applications/{applicationId} | Delete an application |
|
|
15
|
+
| [**deleteSESConfiguration**](ClientApi.md#deletesesconfiguration) | **DELETE** /applications/{applicationId}/ses-configurations | Delete the SES configuration for the application |
|
|
14
16
|
| [**deleteTemplate**](ClientApi.md#deletetemplate) | **DELETE** /applications/{applicationId}/templates/{id} | Delete an template |
|
|
15
17
|
| [**getApplicationByID**](ClientApi.md#getapplicationbyid) | **GET** /applications/{applicationId} | Get an application by applicationId |
|
|
16
18
|
| [**getApplications**](ClientApi.md#getapplications) | **GET** /applications | Get all applications for the account |
|
|
19
|
+
| [**getSESConfiguration**](ClientApi.md#getsesconfiguration) | **GET** /applications/{applicationId}/ses-configurations | Get the SES configuration for the application |
|
|
17
20
|
| [**getTemplate**](ClientApi.md#gettemplate) | **GET** /applications/{applicationId}/templates/{id} | Return a template |
|
|
18
21
|
| [**getTemplates**](ClientApi.md#gettemplates) | **GET** /applications/{applicationId}/templates | Return all templates |
|
|
19
22
|
| [**sendEmail**](ClientApi.md#sendemail) | **POST** /applications/{applicationId}/emails/send | Send an email |
|
|
20
23
|
| [**updateApplication**](ClientApi.md#updateapplication) | **PATCH** /applications/{applicationId} | Update an application |
|
|
24
|
+
| [**updateSESConfiguration**](ClientApi.md#updatesesconfiguration) | **PUT** /applications/{applicationId}/ses-configurations | Update the SES configuration for the application |
|
|
21
25
|
| [**updateTemplate**](ClientApi.md#updatetemplate) | **PATCH** /applications/{applicationId}/templates/{id} | Update a template |
|
|
22
26
|
| [**uploadTemplate**](ClientApi.md#uploadtemplate) | **POST** /applications/{applicationId}/templates | Upload a template |
|
|
23
27
|
|
|
@@ -470,6 +474,81 @@ No authorization required
|
|
|
470
474
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
471
475
|
|
|
472
476
|
|
|
477
|
+
## createSESConfiguration
|
|
478
|
+
|
|
479
|
+
> SESConfigurationDTO createSESConfiguration(applicationId, createSESConfigurationDTO)
|
|
480
|
+
|
|
481
|
+
Create the SES configuration for the application
|
|
482
|
+
|
|
483
|
+
Create the SES sending configuration for the given application. Each application can have only one configuration.
|
|
484
|
+
|
|
485
|
+
### Example
|
|
486
|
+
|
|
487
|
+
```ts
|
|
488
|
+
import {
|
|
489
|
+
Configuration,
|
|
490
|
+
ClientApi,
|
|
491
|
+
} from '';
|
|
492
|
+
import type { CreateSESConfigurationRequest } from '';
|
|
493
|
+
|
|
494
|
+
async function example() {
|
|
495
|
+
console.log("🚀 Testing SDK...");
|
|
496
|
+
const api = new ClientApi();
|
|
497
|
+
|
|
498
|
+
const body = {
|
|
499
|
+
// string | Application ID
|
|
500
|
+
applicationId: applicationId_example,
|
|
501
|
+
// CreateSESConfigurationDTO | SES configuration data
|
|
502
|
+
createSESConfigurationDTO: ...,
|
|
503
|
+
} satisfies CreateSESConfigurationRequest;
|
|
504
|
+
|
|
505
|
+
try {
|
|
506
|
+
const data = await api.createSESConfiguration(body);
|
|
507
|
+
console.log(data);
|
|
508
|
+
} catch (error) {
|
|
509
|
+
console.error(error);
|
|
510
|
+
}
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
// Run the test
|
|
514
|
+
example().catch(console.error);
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
### Parameters
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
| Name | Type | Description | Notes |
|
|
521
|
+
|------------- | ------------- | ------------- | -------------|
|
|
522
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
523
|
+
| **createSESConfigurationDTO** | [CreateSESConfigurationDTO](CreateSESConfigurationDTO.md) | SES configuration data | |
|
|
524
|
+
|
|
525
|
+
### Return type
|
|
526
|
+
|
|
527
|
+
[**SESConfigurationDTO**](SESConfigurationDTO.md)
|
|
528
|
+
|
|
529
|
+
### Authorization
|
|
530
|
+
|
|
531
|
+
No authorization required
|
|
532
|
+
|
|
533
|
+
### HTTP request headers
|
|
534
|
+
|
|
535
|
+
- **Content-Type**: `application/json`
|
|
536
|
+
- **Accept**: `application/json`
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
### HTTP response details
|
|
540
|
+
| Status code | Description | Response headers |
|
|
541
|
+
|-------------|-------------|------------------|
|
|
542
|
+
| **201** | Returns the created SES configuration | - |
|
|
543
|
+
| **400** | Return an error if there is a missing or invalid field | - |
|
|
544
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
545
|
+
| **404** | Return an error if the application does not belong to the account | - |
|
|
546
|
+
| **409** | Return an error if a configuration already exists for the application | - |
|
|
547
|
+
| **500** | Return an error if the server finds an error | - |
|
|
548
|
+
|
|
549
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
550
|
+
|
|
551
|
+
|
|
473
552
|
## deleteApplication
|
|
474
553
|
|
|
475
554
|
> deleteApplication(applicationId)
|
|
@@ -541,6 +620,77 @@ No authorization required
|
|
|
541
620
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
542
621
|
|
|
543
622
|
|
|
623
|
+
## deleteSESConfiguration
|
|
624
|
+
|
|
625
|
+
> deleteSESConfiguration(applicationId)
|
|
626
|
+
|
|
627
|
+
Delete the SES configuration for the application
|
|
628
|
+
|
|
629
|
+
Delete the SES sending configuration of the given application. Emails can no longer be sent for the application until a new configuration is created.
|
|
630
|
+
|
|
631
|
+
### Example
|
|
632
|
+
|
|
633
|
+
```ts
|
|
634
|
+
import {
|
|
635
|
+
Configuration,
|
|
636
|
+
ClientApi,
|
|
637
|
+
} from '';
|
|
638
|
+
import type { DeleteSESConfigurationRequest } from '';
|
|
639
|
+
|
|
640
|
+
async function example() {
|
|
641
|
+
console.log("🚀 Testing SDK...");
|
|
642
|
+
const api = new ClientApi();
|
|
643
|
+
|
|
644
|
+
const body = {
|
|
645
|
+
// string | Application ID
|
|
646
|
+
applicationId: applicationId_example,
|
|
647
|
+
} satisfies DeleteSESConfigurationRequest;
|
|
648
|
+
|
|
649
|
+
try {
|
|
650
|
+
const data = await api.deleteSESConfiguration(body);
|
|
651
|
+
console.log(data);
|
|
652
|
+
} catch (error) {
|
|
653
|
+
console.error(error);
|
|
654
|
+
}
|
|
655
|
+
}
|
|
656
|
+
|
|
657
|
+
// Run the test
|
|
658
|
+
example().catch(console.error);
|
|
659
|
+
```
|
|
660
|
+
|
|
661
|
+
### Parameters
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
| Name | Type | Description | Notes |
|
|
665
|
+
|------------- | ------------- | ------------- | -------------|
|
|
666
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
667
|
+
|
|
668
|
+
### Return type
|
|
669
|
+
|
|
670
|
+
`void` (Empty response body)
|
|
671
|
+
|
|
672
|
+
### Authorization
|
|
673
|
+
|
|
674
|
+
No authorization required
|
|
675
|
+
|
|
676
|
+
### HTTP request headers
|
|
677
|
+
|
|
678
|
+
- **Content-Type**: Not defined
|
|
679
|
+
- **Accept**: `application/json`
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
### HTTP response details
|
|
683
|
+
| Status code | Description | Response headers |
|
|
684
|
+
|-------------|-------------|------------------|
|
|
685
|
+
| **204** | SES configuration deleted successfully | - |
|
|
686
|
+
| **400** | Return an error if the applicationId is invalid | - |
|
|
687
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
688
|
+
| **404** | Return an error if the application has no SES configuration | - |
|
|
689
|
+
| **500** | Return an error if the server finds an error | - |
|
|
690
|
+
|
|
691
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
692
|
+
|
|
693
|
+
|
|
544
694
|
## deleteTemplate
|
|
545
695
|
|
|
546
696
|
> deleteTemplate(id, applicationId)
|
|
@@ -760,6 +910,77 @@ No authorization required
|
|
|
760
910
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
761
911
|
|
|
762
912
|
|
|
913
|
+
## getSESConfiguration
|
|
914
|
+
|
|
915
|
+
> SESConfigurationDTO getSESConfiguration(applicationId)
|
|
916
|
+
|
|
917
|
+
Get the SES configuration for the application
|
|
918
|
+
|
|
919
|
+
Retrieve the SES sending configuration of the given application. The secret access key is never returned.
|
|
920
|
+
|
|
921
|
+
### Example
|
|
922
|
+
|
|
923
|
+
```ts
|
|
924
|
+
import {
|
|
925
|
+
Configuration,
|
|
926
|
+
ClientApi,
|
|
927
|
+
} from '';
|
|
928
|
+
import type { GetSESConfigurationRequest } from '';
|
|
929
|
+
|
|
930
|
+
async function example() {
|
|
931
|
+
console.log("🚀 Testing SDK...");
|
|
932
|
+
const api = new ClientApi();
|
|
933
|
+
|
|
934
|
+
const body = {
|
|
935
|
+
// string | Application ID
|
|
936
|
+
applicationId: applicationId_example,
|
|
937
|
+
} satisfies GetSESConfigurationRequest;
|
|
938
|
+
|
|
939
|
+
try {
|
|
940
|
+
const data = await api.getSESConfiguration(body);
|
|
941
|
+
console.log(data);
|
|
942
|
+
} catch (error) {
|
|
943
|
+
console.error(error);
|
|
944
|
+
}
|
|
945
|
+
}
|
|
946
|
+
|
|
947
|
+
// Run the test
|
|
948
|
+
example().catch(console.error);
|
|
949
|
+
```
|
|
950
|
+
|
|
951
|
+
### Parameters
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
| Name | Type | Description | Notes |
|
|
955
|
+
|------------- | ------------- | ------------- | -------------|
|
|
956
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
957
|
+
|
|
958
|
+
### Return type
|
|
959
|
+
|
|
960
|
+
[**SESConfigurationDTO**](SESConfigurationDTO.md)
|
|
961
|
+
|
|
962
|
+
### Authorization
|
|
963
|
+
|
|
964
|
+
No authorization required
|
|
965
|
+
|
|
966
|
+
### HTTP request headers
|
|
967
|
+
|
|
968
|
+
- **Content-Type**: Not defined
|
|
969
|
+
- **Accept**: `application/json`
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
### HTTP response details
|
|
973
|
+
| Status code | Description | Response headers |
|
|
974
|
+
|-------------|-------------|------------------|
|
|
975
|
+
| **200** | Returns the SES configuration | - |
|
|
976
|
+
| **400** | Return an error if the applicationId is invalid | - |
|
|
977
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
978
|
+
| **404** | Return an error if the application has no SES configuration | - |
|
|
979
|
+
| **500** | Return an error if the server finds an error | - |
|
|
980
|
+
|
|
981
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
982
|
+
|
|
983
|
+
|
|
763
984
|
## getTemplate
|
|
764
985
|
|
|
765
986
|
> EmailTemplateContentDTO getTemplate(id, applicationId)
|
|
@@ -1077,6 +1298,80 @@ No authorization required
|
|
|
1077
1298
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1078
1299
|
|
|
1079
1300
|
|
|
1301
|
+
## updateSESConfiguration
|
|
1302
|
+
|
|
1303
|
+
> SESConfigurationDTO updateSESConfiguration(applicationId, updateSESConfigurationDTO)
|
|
1304
|
+
|
|
1305
|
+
Update the SES configuration for the application
|
|
1306
|
+
|
|
1307
|
+
Update the SES sending configuration of the given application. Omitted or empty fields keep their stored value.
|
|
1308
|
+
|
|
1309
|
+
### Example
|
|
1310
|
+
|
|
1311
|
+
```ts
|
|
1312
|
+
import {
|
|
1313
|
+
Configuration,
|
|
1314
|
+
ClientApi,
|
|
1315
|
+
} from '';
|
|
1316
|
+
import type { UpdateSESConfigurationRequest } from '';
|
|
1317
|
+
|
|
1318
|
+
async function example() {
|
|
1319
|
+
console.log("🚀 Testing SDK...");
|
|
1320
|
+
const api = new ClientApi();
|
|
1321
|
+
|
|
1322
|
+
const body = {
|
|
1323
|
+
// string | Application ID
|
|
1324
|
+
applicationId: applicationId_example,
|
|
1325
|
+
// UpdateSESConfigurationDTO | SES configuration data
|
|
1326
|
+
updateSESConfigurationDTO: ...,
|
|
1327
|
+
} satisfies UpdateSESConfigurationRequest;
|
|
1328
|
+
|
|
1329
|
+
try {
|
|
1330
|
+
const data = await api.updateSESConfiguration(body);
|
|
1331
|
+
console.log(data);
|
|
1332
|
+
} catch (error) {
|
|
1333
|
+
console.error(error);
|
|
1334
|
+
}
|
|
1335
|
+
}
|
|
1336
|
+
|
|
1337
|
+
// Run the test
|
|
1338
|
+
example().catch(console.error);
|
|
1339
|
+
```
|
|
1340
|
+
|
|
1341
|
+
### Parameters
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
| Name | Type | Description | Notes |
|
|
1345
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1346
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
1347
|
+
| **updateSESConfigurationDTO** | [UpdateSESConfigurationDTO](UpdateSESConfigurationDTO.md) | SES configuration data | |
|
|
1348
|
+
|
|
1349
|
+
### Return type
|
|
1350
|
+
|
|
1351
|
+
[**SESConfigurationDTO**](SESConfigurationDTO.md)
|
|
1352
|
+
|
|
1353
|
+
### Authorization
|
|
1354
|
+
|
|
1355
|
+
No authorization required
|
|
1356
|
+
|
|
1357
|
+
### HTTP request headers
|
|
1358
|
+
|
|
1359
|
+
- **Content-Type**: `application/json`
|
|
1360
|
+
- **Accept**: `application/json`
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
### HTTP response details
|
|
1364
|
+
| Status code | Description | Response headers |
|
|
1365
|
+
|-------------|-------------|------------------|
|
|
1366
|
+
| **200** | Returns the updated SES configuration (without the secret) | - |
|
|
1367
|
+
| **400** | Return an error if there is a missing or invalid field | - |
|
|
1368
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
1369
|
+
| **404** | Return an error if the application has no SES configuration | - |
|
|
1370
|
+
| **500** | Return an error if the server finds an error | - |
|
|
1371
|
+
|
|
1372
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1373
|
+
|
|
1374
|
+
|
|
1080
1375
|
## updateTemplate
|
|
1081
1376
|
|
|
1082
1377
|
> UpdateEmailTemplateDTO updateTemplate(applicationId, id, defaultEmail, file, name)
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateSESConfigurationDTO
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`accessKeyId` | string
|
|
10
|
+
`fromEmail` | string
|
|
11
|
+
`region` | string
|
|
12
|
+
`secretAccessKey` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { CreateSESConfigurationDTO } from ''
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"accessKeyId": AKIAIOSFODNN7EXAMPLE,
|
|
22
|
+
"fromEmail": no-reply@example.com,
|
|
23
|
+
"region": eu-central-1,
|
|
24
|
+
"secretAccessKey": wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY,
|
|
25
|
+
} satisfies CreateSESConfigurationDTO
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateSESConfigurationDTO
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
|
|
2
|
+
# SESConfigurationDTO
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`accessKeyId` | string
|
|
10
|
+
`applicationId` | string
|
|
11
|
+
`createdAt` | string
|
|
12
|
+
`fromEmail` | string
|
|
13
|
+
`id` | string
|
|
14
|
+
`region` | string
|
|
15
|
+
`updatedAt` | string
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { SESConfigurationDTO } from ''
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"accessKeyId": null,
|
|
25
|
+
"applicationId": null,
|
|
26
|
+
"createdAt": null,
|
|
27
|
+
"fromEmail": null,
|
|
28
|
+
"id": null,
|
|
29
|
+
"region": null,
|
|
30
|
+
"updatedAt": null,
|
|
31
|
+
} satisfies SESConfigurationDTO
|
|
32
|
+
|
|
33
|
+
console.log(example)
|
|
34
|
+
|
|
35
|
+
// Convert the instance to a JSON string
|
|
36
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
37
|
+
console.log(exampleJSON)
|
|
38
|
+
|
|
39
|
+
// Parse the JSON string back to an object
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as SESConfigurationDTO
|
|
41
|
+
console.log(exampleParsed)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
45
|
+
|
|
46
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateSESConfigurationDTO
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`accessKeyId` | string
|
|
10
|
+
`fromEmail` | string
|
|
11
|
+
`region` | string
|
|
12
|
+
`secretAccessKey` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { UpdateSESConfigurationDTO } from ''
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"accessKeyId": AKIAIOSFODNN7EXAMPLE,
|
|
22
|
+
"fromEmail": no-reply@example.com,
|
|
23
|
+
"region": eu-central-1,
|
|
24
|
+
"secretAccessKey": wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY,
|
|
25
|
+
} satisfies UpdateSESConfigurationDTO
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as UpdateSESConfigurationDTO
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Tuix Email Service
|
|
6
|
+
* Service to manage Tuix Email
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.0.1
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfCreateSESConfigurationDTO = instanceOfCreateSESConfigurationDTO;
|
|
17
|
+
exports.CreateSESConfigurationDTOFromJSON = CreateSESConfigurationDTOFromJSON;
|
|
18
|
+
exports.CreateSESConfigurationDTOFromJSONTyped = CreateSESConfigurationDTOFromJSONTyped;
|
|
19
|
+
exports.CreateSESConfigurationDTOToJSON = CreateSESConfigurationDTOToJSON;
|
|
20
|
+
exports.CreateSESConfigurationDTOToJSONTyped = CreateSESConfigurationDTOToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the CreateSESConfigurationDTO interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfCreateSESConfigurationDTO(value) {
|
|
25
|
+
if (!('accessKeyId' in value) || value['accessKeyId'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('fromEmail' in value) || value['fromEmail'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('region' in value) || value['region'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('secretAccessKey' in value) || value['secretAccessKey'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
function CreateSESConfigurationDTOFromJSON(json) {
|
|
36
|
+
return CreateSESConfigurationDTOFromJSONTyped(json, false);
|
|
37
|
+
}
|
|
38
|
+
function CreateSESConfigurationDTOFromJSONTyped(json, ignoreDiscriminator) {
|
|
39
|
+
if (json == null) {
|
|
40
|
+
return json;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
'accessKeyId': json['accessKeyId'],
|
|
44
|
+
'fromEmail': json['fromEmail'],
|
|
45
|
+
'region': json['region'],
|
|
46
|
+
'secretAccessKey': json['secretAccessKey'],
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
function CreateSESConfigurationDTOToJSON(json) {
|
|
50
|
+
return CreateSESConfigurationDTOToJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
function CreateSESConfigurationDTOToJSONTyped(value, ignoreDiscriminator = false) {
|
|
53
|
+
if (value == null) {
|
|
54
|
+
return value;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'accessKeyId': value['accessKeyId'],
|
|
58
|
+
'fromEmail': value['fromEmail'],
|
|
59
|
+
'region': value['region'],
|
|
60
|
+
'secretAccessKey': value['secretAccessKey'],
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
//# sourceMappingURL=CreateSESConfigurationDTO.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"CreateSESConfigurationDTO.js","sourceRoot":"","sources":["CreateSESConfigurationDTO.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;AAsCH,kFAMC;AAED,8EAEC;AAED,wFAWC;AAED,0EAEC;AAED,oFAYC;AA5CD;;GAEG;AACH,SAAgB,mCAAmC,CAAC,KAAa;IAC7D,IAAI,CAAC,CAAC,aAAa,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAClF,IAAI,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC9E,IAAI,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxE,IAAI,CAAC,CAAC,iBAAiB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC1F,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAgB,iCAAiC,CAAC,IAAS;IACvD,OAAO,sCAAsC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC/D,CAAC;AAED,SAAgB,sCAAsC,CAAC,IAAS,EAAE,mBAA4B;IAC1F,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAClC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;QAC9B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QACxB,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC;KAC7C,CAAC;AACN,CAAC;AAED,SAAgB,+BAA+B,CAAC,IAAS;IACrD,OAAO,oCAAoC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC7D,CAAC;AAED,SAAgB,oCAAoC,CAAC,KAAwC,EAAE,sBAA+B,KAAK;IAC/H,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;QAC/B,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC;KAC9C,CAAC;AACN,CAAC"}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Tuix Email Service
|
|
5
|
+
* Service to manage Tuix Email
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.0.1
|
|
8
|
+
*
|
|
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
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface CreateSESConfigurationDTO
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateSESConfigurationDTO {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof CreateSESConfigurationDTO
|
|
26
|
+
*/
|
|
27
|
+
accessKeyId: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof CreateSESConfigurationDTO
|
|
32
|
+
*/
|
|
33
|
+
fromEmail: string;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof CreateSESConfigurationDTO
|
|
38
|
+
*/
|
|
39
|
+
region: string;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof CreateSESConfigurationDTO
|
|
44
|
+
*/
|
|
45
|
+
secretAccessKey: string;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Check if a given object implements the CreateSESConfigurationDTO interface.
|
|
50
|
+
*/
|
|
51
|
+
export function instanceOfCreateSESConfigurationDTO(value: object): value is CreateSESConfigurationDTO {
|
|
52
|
+
if (!('accessKeyId' in value) || value['accessKeyId'] === undefined) return false;
|
|
53
|
+
if (!('fromEmail' in value) || value['fromEmail'] === undefined) return false;
|
|
54
|
+
if (!('region' in value) || value['region'] === undefined) return false;
|
|
55
|
+
if (!('secretAccessKey' in value) || value['secretAccessKey'] === undefined) return false;
|
|
56
|
+
return true;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function CreateSESConfigurationDTOFromJSON(json: any): CreateSESConfigurationDTO {
|
|
60
|
+
return CreateSESConfigurationDTOFromJSONTyped(json, false);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function CreateSESConfigurationDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSESConfigurationDTO {
|
|
64
|
+
if (json == null) {
|
|
65
|
+
return json;
|
|
66
|
+
}
|
|
67
|
+
return {
|
|
68
|
+
|
|
69
|
+
'accessKeyId': json['accessKeyId'],
|
|
70
|
+
'fromEmail': json['fromEmail'],
|
|
71
|
+
'region': json['region'],
|
|
72
|
+
'secretAccessKey': json['secretAccessKey'],
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export function CreateSESConfigurationDTOToJSON(json: any): CreateSESConfigurationDTO {
|
|
77
|
+
return CreateSESConfigurationDTOToJSONTyped(json, false);
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export function CreateSESConfigurationDTOToJSONTyped(value?: CreateSESConfigurationDTO | null, ignoreDiscriminator: boolean = false): any {
|
|
81
|
+
if (value == null) {
|
|
82
|
+
return value;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
return {
|
|
86
|
+
|
|
87
|
+
'accessKeyId': value['accessKeyId'],
|
|
88
|
+
'fromEmail': value['fromEmail'],
|
|
89
|
+
'region': value['region'],
|
|
90
|
+
'secretAccessKey': value['secretAccessKey'],
|
|
91
|
+
};
|
|
92
|
+
}
|
|
93
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Tuix Email Service
|
|
6
|
+
* Service to manage Tuix Email
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.0.1
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfSESConfigurationDTO = instanceOfSESConfigurationDTO;
|
|
17
|
+
exports.SESConfigurationDTOFromJSON = SESConfigurationDTOFromJSON;
|
|
18
|
+
exports.SESConfigurationDTOFromJSONTyped = SESConfigurationDTOFromJSONTyped;
|
|
19
|
+
exports.SESConfigurationDTOToJSON = SESConfigurationDTOToJSON;
|
|
20
|
+
exports.SESConfigurationDTOToJSONTyped = SESConfigurationDTOToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the SESConfigurationDTO interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfSESConfigurationDTO(value) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
function SESConfigurationDTOFromJSON(json) {
|
|
28
|
+
return SESConfigurationDTOFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
function SESConfigurationDTOFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'accessKeyId': json['accessKeyId'] == null ? undefined : json['accessKeyId'],
|
|
36
|
+
'applicationId': json['applicationId'] == null ? undefined : json['applicationId'],
|
|
37
|
+
'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
|
|
38
|
+
'fromEmail': json['fromEmail'] == null ? undefined : json['fromEmail'],
|
|
39
|
+
'id': json['id'] == null ? undefined : json['id'],
|
|
40
|
+
'region': json['region'] == null ? undefined : json['region'],
|
|
41
|
+
'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
function SESConfigurationDTOToJSON(json) {
|
|
45
|
+
return SESConfigurationDTOToJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
function SESConfigurationDTOToJSONTyped(value, ignoreDiscriminator = false) {
|
|
48
|
+
if (value == null) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'accessKeyId': value['accessKeyId'],
|
|
53
|
+
'applicationId': value['applicationId'],
|
|
54
|
+
'createdAt': value['createdAt'],
|
|
55
|
+
'fromEmail': value['fromEmail'],
|
|
56
|
+
'id': value['id'],
|
|
57
|
+
'region': value['region'],
|
|
58
|
+
'updatedAt': value['updatedAt'],
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
//# sourceMappingURL=SESConfigurationDTO.js.map
|