@epilot/email-settings-client 0.0.1 → 0.0.2
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/CHANGELOG.md +5 -0
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +3 -3
- package/package.json +1 -1
- package/src/openapi.d.ts +0 -317
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
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)
|
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
!function(e,t){for(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 n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=n(s(279));t.default=i.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"]},"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"]}}}}}},"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"]},"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"}}}}}}')}},t={};return function s(n){if(t[n])return t[n].exports;var i=t[n]={exports:{}};return e[n].call(i.exports,i,i.exports,s),i.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";
|
|
28
|
+
type: "signature" | "email_domain" | "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";
|
|
76
|
+
type: "signature" | "email_domain" | "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";
|
|
89
|
+
export type Type = "signature" | "email_domain" | "email_address";
|
|
90
90
|
}
|
|
91
91
|
export interface QueryParameters {
|
|
92
92
|
type: Parameters.Type;
|
package/package.json
CHANGED
package/src/openapi.d.ts
DELETED
|
@@ -1,317 +0,0 @@
|
|
|
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";
|
|
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";
|
|
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";
|
|
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>
|