@epilot/email-settings-client 0.0.2 → 0.0.5
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/LICENSE +21 -0
- package/README.md +14 -27
- package/dist/client.js +16 -1
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +3 -3
- package/package.json +35 -24
- package/src/openapi.d.ts +317 -0
- package/CHANGELOG.md +0 -5
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 epilot GmbH
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,43 +1,30 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @epilot/email-settings-client
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://github.com/epilot-dev/sdk-js/actions?query=workflow%3ACI)
|
|
4
|
+
[](https://www.npmjs.com/package/@epilot/email-settings-client)
|
|
5
|
+
[](https://bundlephobia.com/package/@epilot/email-settings-client)
|
|
6
|
+
[](https://github.com/epilot-dev/sdk-js/blob/main/LICENSE)
|
|
4
7
|
|
|
5
|
-
|
|
8
|
+
API Client for epilot [Email Settings API](https://docs.epilot.io/api/email-settings).
|
|
6
9
|
|
|
7
|
-
|
|
10
|
+
Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
|
|
8
11
|
|
|
9
|
-
|
|
12
|
+
## Installation
|
|
10
13
|
|
|
11
14
|
```bash
|
|
12
|
-
npm install --save
|
|
15
|
+
npm install --save @epilot/email-settings-client
|
|
13
16
|
```
|
|
14
17
|
|
|
15
|
-
|
|
18
|
+
## Usage
|
|
16
19
|
|
|
17
20
|
```typescript
|
|
18
21
|
import { getClient } from '@epilot/email-settings-client';
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
Use the client:
|
|
22
|
-
```typescript
|
|
23
|
-
// get typed client
|
|
24
|
-
const client = await getClient();
|
|
22
|
+
const emailSettingsClient = getClient();
|
|
25
23
|
|
|
26
|
-
|
|
27
|
-
const res = await client.testS3();
|
|
24
|
+
const getResponse = await emailSettingsClient.getSettings({ type: 'signature', id: 'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7' });
|
|
28
25
|
```
|
|
29
26
|
|
|
30
|
-
##
|
|
31
|
-
|
|
32
|
-
To pass an authorization header and set up the API url, you can use axios
|
|
33
|
-
defaults:
|
|
34
|
-
|
|
35
|
-
```typescript
|
|
36
|
-
const client = getClient();
|
|
37
|
-
client.defaults.baseURL = config.API_URL;
|
|
38
|
-
client.defaults.headers['authorization'] = `Bearer ${token}`;
|
|
39
|
-
```
|
|
27
|
+
## Documentation
|
|
40
28
|
|
|
41
|
-
|
|
29
|
+
https://docs.epilot.io/docs/messaging/email-settings
|
|
42
30
|
|
|
43
|
-
https://docs.api.epilot.io/
|
package/dist/client.js
CHANGED
|
@@ -1,14 +1,29 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __assign = (this && this.__assign) || function () {
|
|
3
|
+
__assign = Object.assign || function(t) {
|
|
4
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
5
|
+
s = arguments[i];
|
|
6
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
+
t[p] = s[p];
|
|
8
|
+
}
|
|
9
|
+
return t;
|
|
10
|
+
};
|
|
11
|
+
return __assign.apply(this, arguments);
|
|
12
|
+
};
|
|
2
13
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
14
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
15
|
};
|
|
5
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
17
|
exports.getClient = void 0;
|
|
18
|
+
var lambda_powertools_correlation_ids_1 = __importDefault(require("@dazn/lambda-powertools-correlation-ids"));
|
|
7
19
|
var openapi_client_axios_1 = __importDefault(require("openapi-client-axios"));
|
|
8
20
|
var definition_1 = __importDefault(require("./definition"));
|
|
9
21
|
var getClient = function () {
|
|
22
|
+
var _a;
|
|
10
23
|
var api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
|
|
11
|
-
|
|
24
|
+
var apiClient = api.initSync();
|
|
25
|
+
apiClient.defaults.headers.common = __assign(__assign({}, ((_a = apiClient.defaults.headers.common) !== null && _a !== void 0 ? _a : {})), (lambda_powertools_correlation_ids_1.default.get() || {}));
|
|
26
|
+
return apiClient;
|
|
12
27
|
};
|
|
13
28
|
exports.getClient = getClient;
|
|
14
29
|
//# sourceMappingURL=client.js.map
|
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
!function(e,t){for(var s in t)e[s]=t[s];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,s){var
|
|
1
|
+
!function(e,t){for(var s in t)e[s]=t[s];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,s){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=i(s(279));t.default=n.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Email settings API","version":"1.0.0"},"tags":[{"name":"Email settings","description":"Email settings service"}],"security":[{"EpilotAuth":[]},{"AsOrganization":[]},{"EpilotOrg":[]}],"paths":{"/v1/email-settings":{"get":{"operationId":"getSettings","summary":"getSettings","description":"Get all settings by type","tags":["Settings"],"parameters":[{"name":"type","description":"Setting types:\\n* signature\\n* email_domain\\n* email_address\\n","in":"query","required":true,"schema":{"type":"string","enum":["signature","email_domain","email_address","whitelist_email_address"]},"example":"signature"},{"name":"id","description":"ID of setting","in":"query","schema":{"type":"string"},"example":"a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}},"post":{"operationId":"addSetting","summary":"addSetting","description":"Add setting","tags":["Settings"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Setting"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}},"delete":{"operationId":"deleteSetting","summary":"deleteSetting","description":"delete setting by ID and type","tags":["Settings"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","type"],"properties":{"type":{"type":"string","example":"signature","enum":["signature","email_domain","email_address","whitelist_email_address"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Setting"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}}},"/v1/email-settings/{id}":{"post":{"operationId":"updateSetting","summary":"updateSetting","description":"Update setting by ID","tags":["Settings"],"parameters":[{"name":"id","description":"ID of setting","in":"path","required":true,"schema":{"type":"string"},"example":"a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Setting"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Setting"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}}},"/v1/email-settings/domain":{"post":{"operationId":"addDomain","summary":"addDomain","description":"Add domain","tags":["Domains"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}},"delete":{"operationId":"deleteDomain","summary":"deleteDomain","description":"Delete domain","tags":["Domains"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"responses":{"204":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}}},"/v1/email-settings/domain/name-servers:verify":{"post":{"operationId":"verifyNameServers","summary":"verifyNameServers","description":"Verify name servers","tags":["Domains"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}}},"/v1/email-settings/domain:verify":{"post":{"operationId":"verifyDomain","summary":"verifyDomain","description":"Verify domain","tags":["Domains"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id when using internal auth"},"EpilotOrg":{"description":"Overrides the target organization to allow shared tenant access","name":"x-epilot-org-id","in":"header","type":"apiKey"}},"schemas":{"SettingsResponse":{"type":"array","items":{"$ref":"#/components/schemas/Setting"}},"Setting":{"type":"object","required":["type"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"org_id":{"type":"string"},"type":{"type":"string","example":"signature","enum":["signature","email_domain","email_address","whitelist_email_address"]},"html":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"created_by":{"type":"string"},"updated_by":{"type":"string"}},"additionalProperties":true},"Domain":{"type":"object","properties":{"domain":{"type":"string","example":"subdomain.epilot.cloud"}}}}},"servers":[{"url":"https://email-settings.sls.epilot.io"},{"url":"https://email-settings.sls.epilot.io"}]}')}},t={};return function s(i){if(t[i])return t[i].exports;var n=t[i]={exports:{}};return e[i].call(n.exports,n,n.exports,s),n.exports}(914)})());
|
package/dist/openapi.d.ts
CHANGED
|
@@ -25,7 +25,7 @@ declare namespace Components {
|
|
|
25
25
|
* example:
|
|
26
26
|
* signature
|
|
27
27
|
*/
|
|
28
|
-
type: "signature" | "email_domain" | "email_address";
|
|
28
|
+
type: "signature" | "email_domain" | "email_address" | "whitelist_email_address";
|
|
29
29
|
html?: string;
|
|
30
30
|
created_at?: string;
|
|
31
31
|
updated_at?: string;
|
|
@@ -73,7 +73,7 @@ declare namespace Paths {
|
|
|
73
73
|
* example:
|
|
74
74
|
* signature
|
|
75
75
|
*/
|
|
76
|
-
type: "signature" | "email_domain" | "email_address";
|
|
76
|
+
type: "signature" | "email_domain" | "email_address" | "whitelist_email_address";
|
|
77
77
|
}
|
|
78
78
|
namespace Responses {
|
|
79
79
|
export type $200 = Components.Schemas.Setting;
|
|
@@ -86,7 +86,7 @@ declare namespace Paths {
|
|
|
86
86
|
namespace GetSettings {
|
|
87
87
|
namespace Parameters {
|
|
88
88
|
export type Id = string;
|
|
89
|
-
export type Type = "signature" | "email_domain" | "email_address";
|
|
89
|
+
export type Type = "signature" | "email_domain" | "email_address" | "whitelist_email_address";
|
|
90
90
|
}
|
|
91
91
|
export interface QueryParameters {
|
|
92
92
|
type: Parameters.Type;
|
package/package.json
CHANGED
|
@@ -1,18 +1,33 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/email-settings-client",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"description": "API Client for epilot
|
|
3
|
+
"version": "0.0.5",
|
|
4
|
+
"description": "API Client for epilot Email Settings API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+https://github.com/epilot-dev/sdk-js.git",
|
|
10
|
+
"directory": "clients/email-setting-client"
|
|
11
|
+
},
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/epilot-dev/sdk-js/issues"
|
|
14
|
+
},
|
|
15
|
+
"homepage": "https://github.com/epilot-dev/sdk-js/tree/main/clients/email-setting-client#readme",
|
|
16
|
+
"keywords": [
|
|
17
|
+
"epilot",
|
|
18
|
+
"sdk",
|
|
19
|
+
"email-settings"
|
|
20
|
+
],
|
|
7
21
|
"scripts": {
|
|
8
22
|
"test": "jest",
|
|
9
23
|
"typescript": "tsc",
|
|
10
24
|
"bundle-definition": "webpack",
|
|
11
|
-
"openapi": "
|
|
12
|
-
"typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen
|
|
13
|
-
"build": "
|
|
14
|
-
"
|
|
15
|
-
"prepublishOnly": "npm run build"
|
|
25
|
+
"openapi": "../../scripts/update-openapi.sh https://docs.api.epilot.io/email-settings.yaml",
|
|
26
|
+
"typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
|
|
27
|
+
"build": "tsc && npm run bundle-definition",
|
|
28
|
+
"build:watch": "npm run build && tsc -w",
|
|
29
|
+
"prepublishOnly": "npm run typegen && npm run build",
|
|
30
|
+
"lint": "../../node_modules/eslint/bin/eslint.js src"
|
|
16
31
|
},
|
|
17
32
|
"files": [
|
|
18
33
|
"*.js",
|
|
@@ -25,38 +40,34 @@
|
|
|
25
40
|
"!src",
|
|
26
41
|
"!*.config.js"
|
|
27
42
|
],
|
|
28
|
-
"repository": {
|
|
29
|
-
"type": "git",
|
|
30
|
-
"url": "https://github.com/epilot-dev/sdk-js",
|
|
31
|
-
"directory": "clients/email-settings-client"
|
|
32
|
-
},
|
|
33
|
-
"keywords": [],
|
|
34
43
|
"author": "epilot GmbH",
|
|
35
44
|
"license": "UNLICENSED",
|
|
36
45
|
"peerDependencies": {
|
|
37
|
-
"axios": "^0.
|
|
46
|
+
"axios": "^0.25.0"
|
|
38
47
|
},
|
|
39
48
|
"dependencies": {
|
|
49
|
+
"@dazn/lambda-powertools-correlation-ids": "^1.28.1",
|
|
40
50
|
"buffer": "^6.0.3",
|
|
41
51
|
"https-browserify": "^1.0.0",
|
|
42
|
-
"openapi-client-axios": "^
|
|
52
|
+
"openapi-client-axios": "^5.3.0",
|
|
43
53
|
"stream-http": "^3.1.1",
|
|
44
54
|
"url": "^0.11.0",
|
|
45
55
|
"util": "^0.12.3"
|
|
46
56
|
},
|
|
47
57
|
"devDependencies": {
|
|
48
58
|
"@types/jest": "^26.0.20",
|
|
49
|
-
"axios": "^0.
|
|
59
|
+
"axios": "^0.25.0",
|
|
50
60
|
"copy-webpack-plugin": "^7.0.0",
|
|
51
61
|
"jest": "^26.6.3",
|
|
52
62
|
"json-loader": "^0.5.7",
|
|
53
|
-
"openapi-client-axios-typegen": "^
|
|
54
|
-
"openapicmd": "^1.
|
|
55
|
-
"ts-jest": "^26.5.
|
|
56
|
-
"ts-loader": "^8.
|
|
57
|
-
"ts-node": "^9.1
|
|
58
|
-
"typescript": "^4.
|
|
59
|
-
"webpack": "
|
|
63
|
+
"openapi-client-axios-typegen": "^5.0.1",
|
|
64
|
+
"openapicmd": "^1.6.2",
|
|
65
|
+
"ts-jest": "^26.5.0",
|
|
66
|
+
"ts-loader": "^8.0.14",
|
|
67
|
+
"ts-node": "^10.9.1",
|
|
68
|
+
"typescript": "^4.1.3",
|
|
69
|
+
"webpack": "~5.18.0",
|
|
60
70
|
"webpack-cli": "^4.4.0"
|
|
61
|
-
}
|
|
71
|
+
},
|
|
72
|
+
"gitHead": "1cd202255ce447f3167d54b2589f6a90386850cb"
|
|
62
73
|
}
|
package/src/openapi.d.ts
ADDED
|
@@ -0,0 +1,317 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
import type {
|
|
3
|
+
OpenAPIClient,
|
|
4
|
+
Parameters,
|
|
5
|
+
UnknownParamsObject,
|
|
6
|
+
OperationResponse,
|
|
7
|
+
AxiosRequestConfig,
|
|
8
|
+
} from 'openapi-client-axios';
|
|
9
|
+
|
|
10
|
+
declare namespace Components {
|
|
11
|
+
namespace Schemas {
|
|
12
|
+
export interface Domain {
|
|
13
|
+
/**
|
|
14
|
+
* example:
|
|
15
|
+
* subdomain.epilot.cloud
|
|
16
|
+
*/
|
|
17
|
+
domain?: string;
|
|
18
|
+
}
|
|
19
|
+
export interface Setting {
|
|
20
|
+
[name: string]: any;
|
|
21
|
+
id?: string;
|
|
22
|
+
name?: string;
|
|
23
|
+
org_id?: string;
|
|
24
|
+
/**
|
|
25
|
+
* example:
|
|
26
|
+
* signature
|
|
27
|
+
*/
|
|
28
|
+
type: "signature" | "email_domain" | "email_address" | "whitelist_email_address";
|
|
29
|
+
html?: string;
|
|
30
|
+
created_at?: string;
|
|
31
|
+
updated_at?: string;
|
|
32
|
+
created_by?: string;
|
|
33
|
+
updated_by?: string;
|
|
34
|
+
}
|
|
35
|
+
export type SettingsResponse = Setting[];
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
declare namespace Paths {
|
|
39
|
+
namespace AddDomain {
|
|
40
|
+
export type RequestBody = Components.Schemas.Domain;
|
|
41
|
+
namespace Responses {
|
|
42
|
+
export type $200 = Components.Schemas.SettingsResponse;
|
|
43
|
+
export interface $403 {
|
|
44
|
+
}
|
|
45
|
+
export interface $404 {
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
namespace AddSetting {
|
|
50
|
+
export type RequestBody = Components.Schemas.Setting;
|
|
51
|
+
namespace Responses {
|
|
52
|
+
export type $200 = Components.Schemas.SettingsResponse;
|
|
53
|
+
export interface $403 {
|
|
54
|
+
}
|
|
55
|
+
export interface $404 {
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
namespace DeleteDomain {
|
|
60
|
+
export type RequestBody = Components.Schemas.Domain;
|
|
61
|
+
namespace Responses {
|
|
62
|
+
export interface $204 {
|
|
63
|
+
}
|
|
64
|
+
export interface $403 {
|
|
65
|
+
}
|
|
66
|
+
export interface $404 {
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
namespace DeleteSetting {
|
|
71
|
+
export interface RequestBody {
|
|
72
|
+
/**
|
|
73
|
+
* example:
|
|
74
|
+
* signature
|
|
75
|
+
*/
|
|
76
|
+
type: "signature" | "email_domain" | "email_address" | "whitelist_email_address";
|
|
77
|
+
}
|
|
78
|
+
namespace Responses {
|
|
79
|
+
export type $200 = Components.Schemas.Setting;
|
|
80
|
+
export interface $403 {
|
|
81
|
+
}
|
|
82
|
+
export interface $404 {
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
namespace GetSettings {
|
|
87
|
+
namespace Parameters {
|
|
88
|
+
export type Id = string;
|
|
89
|
+
export type Type = "signature" | "email_domain" | "email_address" | "whitelist_email_address";
|
|
90
|
+
}
|
|
91
|
+
export interface QueryParameters {
|
|
92
|
+
type: Parameters.Type;
|
|
93
|
+
id?: Parameters.Id;
|
|
94
|
+
}
|
|
95
|
+
namespace Responses {
|
|
96
|
+
export type $200 = Components.Schemas.SettingsResponse;
|
|
97
|
+
export interface $403 {
|
|
98
|
+
}
|
|
99
|
+
export interface $404 {
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
namespace UpdateSetting {
|
|
104
|
+
namespace Parameters {
|
|
105
|
+
export type Id = string;
|
|
106
|
+
}
|
|
107
|
+
export interface PathParameters {
|
|
108
|
+
id: Parameters.Id;
|
|
109
|
+
}
|
|
110
|
+
export type RequestBody = Components.Schemas.Setting;
|
|
111
|
+
namespace Responses {
|
|
112
|
+
export type $200 = Components.Schemas.Setting;
|
|
113
|
+
export interface $403 {
|
|
114
|
+
}
|
|
115
|
+
export interface $404 {
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
namespace VerifyDomain {
|
|
120
|
+
export type RequestBody = Components.Schemas.Domain;
|
|
121
|
+
namespace Responses {
|
|
122
|
+
export type $200 = Components.Schemas.SettingsResponse;
|
|
123
|
+
export interface $403 {
|
|
124
|
+
}
|
|
125
|
+
export interface $404 {
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
namespace VerifyNameServers {
|
|
130
|
+
export type RequestBody = Components.Schemas.Domain;
|
|
131
|
+
namespace Responses {
|
|
132
|
+
export type $200 = Components.Schemas.SettingsResponse;
|
|
133
|
+
export interface $403 {
|
|
134
|
+
}
|
|
135
|
+
export interface $404 {
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
export interface OperationMethods {
|
|
142
|
+
/**
|
|
143
|
+
* getSettings - getSettings
|
|
144
|
+
*
|
|
145
|
+
* Get all settings by type
|
|
146
|
+
*/
|
|
147
|
+
'getSettings'(
|
|
148
|
+
parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
|
|
149
|
+
data?: any,
|
|
150
|
+
config?: AxiosRequestConfig
|
|
151
|
+
): OperationResponse<Paths.GetSettings.Responses.$200>
|
|
152
|
+
/**
|
|
153
|
+
* addSetting - addSetting
|
|
154
|
+
*
|
|
155
|
+
* Add setting
|
|
156
|
+
*/
|
|
157
|
+
'addSetting'(
|
|
158
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
159
|
+
data?: Paths.AddSetting.RequestBody,
|
|
160
|
+
config?: AxiosRequestConfig
|
|
161
|
+
): OperationResponse<Paths.AddSetting.Responses.$200>
|
|
162
|
+
/**
|
|
163
|
+
* deleteSetting - deleteSetting
|
|
164
|
+
*
|
|
165
|
+
* delete setting by ID and type
|
|
166
|
+
*/
|
|
167
|
+
'deleteSetting'(
|
|
168
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
169
|
+
data?: Paths.DeleteSetting.RequestBody,
|
|
170
|
+
config?: AxiosRequestConfig
|
|
171
|
+
): OperationResponse<Paths.DeleteSetting.Responses.$200>
|
|
172
|
+
/**
|
|
173
|
+
* updateSetting - updateSetting
|
|
174
|
+
*
|
|
175
|
+
* Update setting by ID
|
|
176
|
+
*/
|
|
177
|
+
'updateSetting'(
|
|
178
|
+
parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
|
|
179
|
+
data?: Paths.UpdateSetting.RequestBody,
|
|
180
|
+
config?: AxiosRequestConfig
|
|
181
|
+
): OperationResponse<Paths.UpdateSetting.Responses.$200>
|
|
182
|
+
/**
|
|
183
|
+
* addDomain - addDomain
|
|
184
|
+
*
|
|
185
|
+
* Add domain
|
|
186
|
+
*/
|
|
187
|
+
'addDomain'(
|
|
188
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
189
|
+
data?: Paths.AddDomain.RequestBody,
|
|
190
|
+
config?: AxiosRequestConfig
|
|
191
|
+
): OperationResponse<Paths.AddDomain.Responses.$200>
|
|
192
|
+
/**
|
|
193
|
+
* deleteDomain - deleteDomain
|
|
194
|
+
*
|
|
195
|
+
* Delete domain
|
|
196
|
+
*/
|
|
197
|
+
'deleteDomain'(
|
|
198
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
199
|
+
data?: Paths.DeleteDomain.RequestBody,
|
|
200
|
+
config?: AxiosRequestConfig
|
|
201
|
+
): OperationResponse<Paths.DeleteDomain.Responses.$204>
|
|
202
|
+
/**
|
|
203
|
+
* verifyNameServers - verifyNameServers
|
|
204
|
+
*
|
|
205
|
+
* Verify name servers
|
|
206
|
+
*/
|
|
207
|
+
'verifyNameServers'(
|
|
208
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
209
|
+
data?: Paths.VerifyNameServers.RequestBody,
|
|
210
|
+
config?: AxiosRequestConfig
|
|
211
|
+
): OperationResponse<Paths.VerifyNameServers.Responses.$200>
|
|
212
|
+
/**
|
|
213
|
+
* verifyDomain - verifyDomain
|
|
214
|
+
*
|
|
215
|
+
* Verify domain
|
|
216
|
+
*/
|
|
217
|
+
'verifyDomain'(
|
|
218
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
219
|
+
data?: Paths.VerifyDomain.RequestBody,
|
|
220
|
+
config?: AxiosRequestConfig
|
|
221
|
+
): OperationResponse<Paths.VerifyDomain.Responses.$200>
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
export interface PathsDictionary {
|
|
225
|
+
['/v1/email-settings']: {
|
|
226
|
+
/**
|
|
227
|
+
* getSettings - getSettings
|
|
228
|
+
*
|
|
229
|
+
* Get all settings by type
|
|
230
|
+
*/
|
|
231
|
+
'get'(
|
|
232
|
+
parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
|
|
233
|
+
data?: any,
|
|
234
|
+
config?: AxiosRequestConfig
|
|
235
|
+
): OperationResponse<Paths.GetSettings.Responses.$200>
|
|
236
|
+
/**
|
|
237
|
+
* addSetting - addSetting
|
|
238
|
+
*
|
|
239
|
+
* Add setting
|
|
240
|
+
*/
|
|
241
|
+
'post'(
|
|
242
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
243
|
+
data?: Paths.AddSetting.RequestBody,
|
|
244
|
+
config?: AxiosRequestConfig
|
|
245
|
+
): OperationResponse<Paths.AddSetting.Responses.$200>
|
|
246
|
+
/**
|
|
247
|
+
* deleteSetting - deleteSetting
|
|
248
|
+
*
|
|
249
|
+
* delete setting by ID and type
|
|
250
|
+
*/
|
|
251
|
+
'delete'(
|
|
252
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
253
|
+
data?: Paths.DeleteSetting.RequestBody,
|
|
254
|
+
config?: AxiosRequestConfig
|
|
255
|
+
): OperationResponse<Paths.DeleteSetting.Responses.$200>
|
|
256
|
+
}
|
|
257
|
+
['/v1/email-settings/{id}']: {
|
|
258
|
+
/**
|
|
259
|
+
* updateSetting - updateSetting
|
|
260
|
+
*
|
|
261
|
+
* Update setting by ID
|
|
262
|
+
*/
|
|
263
|
+
'post'(
|
|
264
|
+
parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
|
|
265
|
+
data?: Paths.UpdateSetting.RequestBody,
|
|
266
|
+
config?: AxiosRequestConfig
|
|
267
|
+
): OperationResponse<Paths.UpdateSetting.Responses.$200>
|
|
268
|
+
}
|
|
269
|
+
['/v1/email-settings/domain']: {
|
|
270
|
+
/**
|
|
271
|
+
* addDomain - addDomain
|
|
272
|
+
*
|
|
273
|
+
* Add domain
|
|
274
|
+
*/
|
|
275
|
+
'post'(
|
|
276
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
277
|
+
data?: Paths.AddDomain.RequestBody,
|
|
278
|
+
config?: AxiosRequestConfig
|
|
279
|
+
): OperationResponse<Paths.AddDomain.Responses.$200>
|
|
280
|
+
/**
|
|
281
|
+
* deleteDomain - deleteDomain
|
|
282
|
+
*
|
|
283
|
+
* Delete domain
|
|
284
|
+
*/
|
|
285
|
+
'delete'(
|
|
286
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
287
|
+
data?: Paths.DeleteDomain.RequestBody,
|
|
288
|
+
config?: AxiosRequestConfig
|
|
289
|
+
): OperationResponse<Paths.DeleteDomain.Responses.$204>
|
|
290
|
+
}
|
|
291
|
+
['/v1/email-settings/domain/name-servers:verify']: {
|
|
292
|
+
/**
|
|
293
|
+
* verifyNameServers - verifyNameServers
|
|
294
|
+
*
|
|
295
|
+
* Verify name servers
|
|
296
|
+
*/
|
|
297
|
+
'post'(
|
|
298
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
299
|
+
data?: Paths.VerifyNameServers.RequestBody,
|
|
300
|
+
config?: AxiosRequestConfig
|
|
301
|
+
): OperationResponse<Paths.VerifyNameServers.Responses.$200>
|
|
302
|
+
}
|
|
303
|
+
['/v1/email-settings/domain:verify']: {
|
|
304
|
+
/**
|
|
305
|
+
* verifyDomain - verifyDomain
|
|
306
|
+
*
|
|
307
|
+
* Verify domain
|
|
308
|
+
*/
|
|
309
|
+
'post'(
|
|
310
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
311
|
+
data?: Paths.VerifyDomain.RequestBody,
|
|
312
|
+
config?: AxiosRequestConfig
|
|
313
|
+
): OperationResponse<Paths.VerifyDomain.Responses.$200>
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
package/CHANGELOG.md
DELETED
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
# Changelog
|
|
2
|
-
|
|
3
|
-
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
|
-
|
|
5
|
-
### [0.1.1](https://github.com/epilot-dev/sdk-js/compare/v1.0.0...v0.1.1) (2022-03-09)
|