@pidginhost/sdk 0.5.0 → 0.7.0
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 +39 -0
- package/CHANGELOG.md +13 -0
- package/README.md +115 -2
- package/api.ts +9092 -3385
- package/dist/api.d.ts +2573 -62
- package/dist/api.js +8148 -3042
- package/dist/esm/api.d.ts +2573 -62
- package/dist/esm/api.js +8138 -3036
- package/docs/ApiCredential.md +32 -0
- package/docs/Bucket.md +40 -0
- package/docs/CloudApi.md +1312 -134
- package/docs/ClusterAdd.md +2 -0
- package/docs/ClusterDetail.md +4 -0
- package/docs/DnsSourceEnum.md +13 -0
- package/docs/DomainAdd.md +28 -0
- package/docs/EmailApi.md +2828 -0
- package/docs/EmailService.md +44 -0
- package/docs/FloatingIPAuthorization.md +27 -0
- package/docs/FloatingIPAuthorizeRequest.md +20 -0
- package/docs/FloatingIPv4.md +32 -0
- package/docs/FloatingIPv4AuthorizeResponse.md +20 -0
- package/docs/FloatingIPv4Create.md +20 -0
- package/docs/FloatingIPv4UnauthorizeResponse.md +20 -0
- package/docs/FloatingIPv6.md +32 -0
- package/docs/FloatingIPv6AuthorizeResponse.md +20 -0
- package/docs/FloatingIPv6Create.md +20 -0
- package/docs/FloatingIPv6UnauthorizeResponse.md +20 -0
- package/docs/InboundRoute.md +34 -0
- package/docs/KubeVersionEnum.md +4 -4
- package/docs/ModeEnum.md +11 -0
- package/docs/PaginatedApiCredentialList.md +26 -0
- package/docs/PaginatedEmailServiceList.md +26 -0
- package/docs/PaginatedFloatingIPAuthorizationList.md +26 -0
- package/docs/PaginatedFloatingIPv4List.md +26 -0
- package/docs/PaginatedFloatingIPv6List.md +26 -0
- package/docs/PaginatedInboundRouteList.md +26 -0
- package/docs/PaginatedSandboxAddressList.md +26 -0
- package/docs/PaginatedSendingDomainList.md +26 -0
- package/docs/PaginatedSmtpCredentialList.md +26 -0
- package/docs/PaginatedSuppressionEntryList.md +26 -0
- package/docs/PatchedClusterDetail.md +4 -0
- package/docs/PatchedEmailService.md +44 -0
- package/docs/PatchedInboundRoute.md +34 -0
- package/docs/PatchedSubscribe.md +20 -0
- package/docs/ReasonEnum.md +15 -0
- package/docs/SandboxAddress.md +26 -0
- package/docs/SendingDomain.md +42 -0
- package/docs/SendingDomainStatusEnum.md +17 -0
- package/docs/ServerAdd.md +2 -0
- package/docs/SmtpCredential.md +30 -0
- package/docs/Subscribe.md +20 -0
- package/docs/SuppressionEntry.md +28 -0
- package/docs/TierEnum.md +13 -0
- package/package.json +1 -1
package/docs/EmailApi.md
ADDED
|
@@ -0,0 +1,2828 @@
|
|
|
1
|
+
# EmailApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://www.pidginhost.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**emailApiCredentialsCreate**](#emailapicredentialscreate) | **POST** /api/email/api_credentials/ | |
|
|
8
|
+
|[**emailApiCredentialsDestroy**](#emailapicredentialsdestroy) | **DELETE** /api/email/api_credentials/{id}/ | |
|
|
9
|
+
|[**emailApiCredentialsList**](#emailapicredentialslist) | **GET** /api/email/api_credentials/ | |
|
|
10
|
+
|[**emailApiCredentialsRetrieve**](#emailapicredentialsretrieve) | **GET** /api/email/api_credentials/{id}/ | |
|
|
11
|
+
|[**emailDomainsCreate**](#emaildomainscreate) | **POST** /api/email/domains/ | |
|
|
12
|
+
|[**emailDomainsInboundRoutesCreate**](#emaildomainsinboundroutescreate) | **POST** /api/email/domains/{domain_pk}/inbound_routes/ | |
|
|
13
|
+
|[**emailDomainsInboundRoutesList**](#emaildomainsinboundrouteslist) | **GET** /api/email/domains/{domain_pk}/inbound_routes/ | |
|
|
14
|
+
|[**emailDomainsList**](#emaildomainslist) | **GET** /api/email/domains/ | |
|
|
15
|
+
|[**emailDomainsRetrieve**](#emaildomainsretrieve) | **GET** /api/email/domains/{id}/ | |
|
|
16
|
+
|[**emailDomainsRotateDkimCreate**](#emaildomainsrotatedkimcreate) | **POST** /api/email/domains/{id}/rotate_dkim/ | |
|
|
17
|
+
|[**emailDomainsToggleInboundCreate**](#emaildomainstoggleinboundcreate) | **POST** /api/email/domains/{id}/toggle_inbound/ | |
|
|
18
|
+
|[**emailDomainsVerifyCreate**](#emaildomainsverifycreate) | **POST** /api/email/domains/{id}/verify/ | |
|
|
19
|
+
|[**emailInboundRoutesCreate**](#emailinboundroutescreate) | **POST** /api/email/inbound_routes/ | |
|
|
20
|
+
|[**emailInboundRoutesDestroy**](#emailinboundroutesdestroy) | **DELETE** /api/email/inbound_routes/{id}/ | |
|
|
21
|
+
|[**emailInboundRoutesList**](#emailinboundrouteslist) | **GET** /api/email/inbound_routes/ | |
|
|
22
|
+
|[**emailInboundRoutesPartialUpdate**](#emailinboundroutespartialupdate) | **PATCH** /api/email/inbound_routes/{id}/ | |
|
|
23
|
+
|[**emailInboundRoutesRetrieve**](#emailinboundroutesretrieve) | **GET** /api/email/inbound_routes/{id}/ | |
|
|
24
|
+
|[**emailMessagesRetrieve**](#emailmessagesretrieve) | **GET** /api/email/messages/{message_id}/ | |
|
|
25
|
+
|[**emailSandboxAddressesCreate**](#emailsandboxaddressescreate) | **POST** /api/email/sandbox_addresses/ | |
|
|
26
|
+
|[**emailSandboxAddressesDestroy**](#emailsandboxaddressesdestroy) | **DELETE** /api/email/sandbox_addresses/{id}/ | |
|
|
27
|
+
|[**emailSandboxAddressesList**](#emailsandboxaddresseslist) | **GET** /api/email/sandbox_addresses/ | |
|
|
28
|
+
|[**emailSandboxAddressesRetrieve**](#emailsandboxaddressesretrieve) | **GET** /api/email/sandbox_addresses/{id}/ | |
|
|
29
|
+
|[**emailSendCreate**](#emailsendcreate) | **POST** /api/email/send/ | |
|
|
30
|
+
|[**emailServicesApiCredentialsCreate**](#emailservicesapicredentialscreate) | **POST** /api/email/services/{service_pk}/api_credentials/ | |
|
|
31
|
+
|[**emailServicesApiCredentialsList**](#emailservicesapicredentialslist) | **GET** /api/email/services/{service_pk}/api_credentials/ | |
|
|
32
|
+
|[**emailServicesCancelCreate**](#emailservicescancelcreate) | **POST** /api/email/services/{id}/cancel/ | |
|
|
33
|
+
|[**emailServicesChangeTierPartialUpdate**](#emailserviceschangetierpartialupdate) | **PATCH** /api/email/services/{id}/change_tier/ | |
|
|
34
|
+
|[**emailServicesCreate**](#emailservicescreate) | **POST** /api/email/services/ | |
|
|
35
|
+
|[**emailServicesDedicatedIpCreate**](#emailservicesdedicatedipcreate) | **POST** /api/email/services/{id}/dedicated_ip/ | |
|
|
36
|
+
|[**emailServicesDedicatedIpDestroy**](#emailservicesdedicatedipdestroy) | **DELETE** /api/email/services/{id}/dedicated_ip/ | |
|
|
37
|
+
|[**emailServicesDestroy**](#emailservicesdestroy) | **DELETE** /api/email/services/{id}/ | |
|
|
38
|
+
|[**emailServicesDomainsCreate**](#emailservicesdomainscreate) | **POST** /api/email/services/{service_pk}/domains/ | |
|
|
39
|
+
|[**emailServicesDomainsList**](#emailservicesdomainslist) | **GET** /api/email/services/{service_pk}/domains/ | |
|
|
40
|
+
|[**emailServicesList**](#emailserviceslist) | **GET** /api/email/services/ | |
|
|
41
|
+
|[**emailServicesMessagesRetrieve**](#emailservicesmessagesretrieve) | **GET** /api/email/services/{service_pk}/messages/ | |
|
|
42
|
+
|[**emailServicesPartialUpdate**](#emailservicespartialupdate) | **PATCH** /api/email/services/{id}/ | |
|
|
43
|
+
|[**emailServicesRestoreCreate**](#emailservicesrestorecreate) | **POST** /api/email/services/{id}/restore/ | |
|
|
44
|
+
|[**emailServicesRetrieve**](#emailservicesretrieve) | **GET** /api/email/services/{id}/ | |
|
|
45
|
+
|[**emailServicesSandboxAddressesCreate**](#emailservicessandboxaddressescreate) | **POST** /api/email/services/{service_pk}/sandbox_addresses/ | |
|
|
46
|
+
|[**emailServicesSandboxAddressesList**](#emailservicessandboxaddresseslist) | **GET** /api/email/services/{service_pk}/sandbox_addresses/ | |
|
|
47
|
+
|[**emailServicesSmtpCredentialsCreate**](#emailservicessmtpcredentialscreate) | **POST** /api/email/services/{service_pk}/smtp_credentials/ | |
|
|
48
|
+
|[**emailServicesSmtpCredentialsList**](#emailservicessmtpcredentialslist) | **GET** /api/email/services/{service_pk}/smtp_credentials/ | |
|
|
49
|
+
|[**emailServicesStatsRetrieve**](#emailservicesstatsretrieve) | **GET** /api/email/services/{service_pk}/stats/ | |
|
|
50
|
+
|[**emailServicesSuppressionsCreate**](#emailservicessuppressionscreate) | **POST** /api/email/services/{service_pk}/suppressions/ | |
|
|
51
|
+
|[**emailServicesSuppressionsList**](#emailservicessuppressionslist) | **GET** /api/email/services/{service_pk}/suppressions/ | |
|
|
52
|
+
|[**emailSmtpCredentialsCreate**](#emailsmtpcredentialscreate) | **POST** /api/email/smtp_credentials/ | |
|
|
53
|
+
|[**emailSmtpCredentialsDestroy**](#emailsmtpcredentialsdestroy) | **DELETE** /api/email/smtp_credentials/{id}/ | |
|
|
54
|
+
|[**emailSmtpCredentialsList**](#emailsmtpcredentialslist) | **GET** /api/email/smtp_credentials/ | |
|
|
55
|
+
|[**emailSmtpCredentialsRetrieve**](#emailsmtpcredentialsretrieve) | **GET** /api/email/smtp_credentials/{id}/ | |
|
|
56
|
+
|[**emailSuppressionsCreate**](#emailsuppressionscreate) | **POST** /api/email/suppressions/ | |
|
|
57
|
+
|[**emailSuppressionsDestroy**](#emailsuppressionsdestroy) | **DELETE** /api/email/suppressions/{id}/ | |
|
|
58
|
+
|[**emailSuppressionsList**](#emailsuppressionslist) | **GET** /api/email/suppressions/ | |
|
|
59
|
+
|[**emailSuppressionsRetrieve**](#emailsuppressionsretrieve) | **GET** /api/email/suppressions/{id}/ | |
|
|
60
|
+
|
|
61
|
+
# **emailApiCredentialsCreate**
|
|
62
|
+
> ApiCredential emailApiCredentialsCreate()
|
|
63
|
+
|
|
64
|
+
Require complete user profile for provisioning (create) API actions.
|
|
65
|
+
|
|
66
|
+
### Example
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
import {
|
|
70
|
+
EmailApi,
|
|
71
|
+
Configuration,
|
|
72
|
+
ApiCredential
|
|
73
|
+
} from '@pidginhost/sdk';
|
|
74
|
+
|
|
75
|
+
const configuration = new Configuration();
|
|
76
|
+
const apiInstance = new EmailApi(configuration);
|
|
77
|
+
|
|
78
|
+
let apiCredential: ApiCredential; // (optional)
|
|
79
|
+
|
|
80
|
+
const { status, data } = await apiInstance.emailApiCredentialsCreate(
|
|
81
|
+
apiCredential
|
|
82
|
+
);
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Parameters
|
|
86
|
+
|
|
87
|
+
|Name | Type | Description | Notes|
|
|
88
|
+
|------------- | ------------- | ------------- | -------------|
|
|
89
|
+
| **apiCredential** | **ApiCredential**| | |
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
### Return type
|
|
93
|
+
|
|
94
|
+
**ApiCredential**
|
|
95
|
+
|
|
96
|
+
### Authorization
|
|
97
|
+
|
|
98
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
99
|
+
|
|
100
|
+
### HTTP request headers
|
|
101
|
+
|
|
102
|
+
- **Content-Type**: application/json
|
|
103
|
+
- **Accept**: application/json
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### HTTP response details
|
|
107
|
+
| Status code | Description | Response headers |
|
|
108
|
+
|-------------|-------------|------------------|
|
|
109
|
+
|**201** | | - |
|
|
110
|
+
|
|
111
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
112
|
+
|
|
113
|
+
# **emailApiCredentialsDestroy**
|
|
114
|
+
> emailApiCredentialsDestroy()
|
|
115
|
+
|
|
116
|
+
Require complete user profile for provisioning (create) API actions.
|
|
117
|
+
|
|
118
|
+
### Example
|
|
119
|
+
|
|
120
|
+
```typescript
|
|
121
|
+
import {
|
|
122
|
+
EmailApi,
|
|
123
|
+
Configuration
|
|
124
|
+
} from '@pidginhost/sdk';
|
|
125
|
+
|
|
126
|
+
const configuration = new Configuration();
|
|
127
|
+
const apiInstance = new EmailApi(configuration);
|
|
128
|
+
|
|
129
|
+
let id: number; //A unique integer value identifying this api credential. (default to undefined)
|
|
130
|
+
|
|
131
|
+
const { status, data } = await apiInstance.emailApiCredentialsDestroy(
|
|
132
|
+
id
|
|
133
|
+
);
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
|Name | Type | Description | Notes|
|
|
139
|
+
|------------- | ------------- | ------------- | -------------|
|
|
140
|
+
| **id** | [**number**] | A unique integer value identifying this api credential. | defaults to undefined|
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
### Return type
|
|
144
|
+
|
|
145
|
+
void (empty response body)
|
|
146
|
+
|
|
147
|
+
### Authorization
|
|
148
|
+
|
|
149
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
150
|
+
|
|
151
|
+
### HTTP request headers
|
|
152
|
+
|
|
153
|
+
- **Content-Type**: Not defined
|
|
154
|
+
- **Accept**: Not defined
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
### HTTP response details
|
|
158
|
+
| Status code | Description | Response headers |
|
|
159
|
+
|-------------|-------------|------------------|
|
|
160
|
+
|**204** | No response body | - |
|
|
161
|
+
|
|
162
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
163
|
+
|
|
164
|
+
# **emailApiCredentialsList**
|
|
165
|
+
> PaginatedApiCredentialList emailApiCredentialsList()
|
|
166
|
+
|
|
167
|
+
Require complete user profile for provisioning (create) API actions.
|
|
168
|
+
|
|
169
|
+
### Example
|
|
170
|
+
|
|
171
|
+
```typescript
|
|
172
|
+
import {
|
|
173
|
+
EmailApi,
|
|
174
|
+
Configuration
|
|
175
|
+
} from '@pidginhost/sdk';
|
|
176
|
+
|
|
177
|
+
const configuration = new Configuration();
|
|
178
|
+
const apiInstance = new EmailApi(configuration);
|
|
179
|
+
|
|
180
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
181
|
+
|
|
182
|
+
const { status, data } = await apiInstance.emailApiCredentialsList(
|
|
183
|
+
page
|
|
184
|
+
);
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### Parameters
|
|
188
|
+
|
|
189
|
+
|Name | Type | Description | Notes|
|
|
190
|
+
|------------- | ------------- | ------------- | -------------|
|
|
191
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
### Return type
|
|
195
|
+
|
|
196
|
+
**PaginatedApiCredentialList**
|
|
197
|
+
|
|
198
|
+
### Authorization
|
|
199
|
+
|
|
200
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
201
|
+
|
|
202
|
+
### HTTP request headers
|
|
203
|
+
|
|
204
|
+
- **Content-Type**: Not defined
|
|
205
|
+
- **Accept**: application/json
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
### HTTP response details
|
|
209
|
+
| Status code | Description | Response headers |
|
|
210
|
+
|-------------|-------------|------------------|
|
|
211
|
+
|**200** | | - |
|
|
212
|
+
|
|
213
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
214
|
+
|
|
215
|
+
# **emailApiCredentialsRetrieve**
|
|
216
|
+
> ApiCredential emailApiCredentialsRetrieve()
|
|
217
|
+
|
|
218
|
+
Require complete user profile for provisioning (create) API actions.
|
|
219
|
+
|
|
220
|
+
### Example
|
|
221
|
+
|
|
222
|
+
```typescript
|
|
223
|
+
import {
|
|
224
|
+
EmailApi,
|
|
225
|
+
Configuration
|
|
226
|
+
} from '@pidginhost/sdk';
|
|
227
|
+
|
|
228
|
+
const configuration = new Configuration();
|
|
229
|
+
const apiInstance = new EmailApi(configuration);
|
|
230
|
+
|
|
231
|
+
let id: number; //A unique integer value identifying this api credential. (default to undefined)
|
|
232
|
+
|
|
233
|
+
const { status, data } = await apiInstance.emailApiCredentialsRetrieve(
|
|
234
|
+
id
|
|
235
|
+
);
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
### Parameters
|
|
239
|
+
|
|
240
|
+
|Name | Type | Description | Notes|
|
|
241
|
+
|------------- | ------------- | ------------- | -------------|
|
|
242
|
+
| **id** | [**number**] | A unique integer value identifying this api credential. | defaults to undefined|
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
### Return type
|
|
246
|
+
|
|
247
|
+
**ApiCredential**
|
|
248
|
+
|
|
249
|
+
### Authorization
|
|
250
|
+
|
|
251
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
252
|
+
|
|
253
|
+
### HTTP request headers
|
|
254
|
+
|
|
255
|
+
- **Content-Type**: Not defined
|
|
256
|
+
- **Accept**: application/json
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
### HTTP response details
|
|
260
|
+
| Status code | Description | Response headers |
|
|
261
|
+
|-------------|-------------|------------------|
|
|
262
|
+
|**200** | | - |
|
|
263
|
+
|
|
264
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
265
|
+
|
|
266
|
+
# **emailDomainsCreate**
|
|
267
|
+
> SendingDomain emailDomainsCreate(domainAdd)
|
|
268
|
+
|
|
269
|
+
Require complete user profile for provisioning (create) API actions.
|
|
270
|
+
|
|
271
|
+
### Example
|
|
272
|
+
|
|
273
|
+
```typescript
|
|
274
|
+
import {
|
|
275
|
+
EmailApi,
|
|
276
|
+
Configuration,
|
|
277
|
+
DomainAdd
|
|
278
|
+
} from '@pidginhost/sdk';
|
|
279
|
+
|
|
280
|
+
const configuration = new Configuration();
|
|
281
|
+
const apiInstance = new EmailApi(configuration);
|
|
282
|
+
|
|
283
|
+
let domainAdd: DomainAdd; //
|
|
284
|
+
|
|
285
|
+
const { status, data } = await apiInstance.emailDomainsCreate(
|
|
286
|
+
domainAdd
|
|
287
|
+
);
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Parameters
|
|
291
|
+
|
|
292
|
+
|Name | Type | Description | Notes|
|
|
293
|
+
|------------- | ------------- | ------------- | -------------|
|
|
294
|
+
| **domainAdd** | **DomainAdd**| | |
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
### Return type
|
|
298
|
+
|
|
299
|
+
**SendingDomain**
|
|
300
|
+
|
|
301
|
+
### Authorization
|
|
302
|
+
|
|
303
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
304
|
+
|
|
305
|
+
### HTTP request headers
|
|
306
|
+
|
|
307
|
+
- **Content-Type**: application/json
|
|
308
|
+
- **Accept**: application/json
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
### HTTP response details
|
|
312
|
+
| Status code | Description | Response headers |
|
|
313
|
+
|-------------|-------------|------------------|
|
|
314
|
+
|**201** | | - |
|
|
315
|
+
|
|
316
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
317
|
+
|
|
318
|
+
# **emailDomainsInboundRoutesCreate**
|
|
319
|
+
> InboundRoute emailDomainsInboundRoutesCreate(inboundRoute)
|
|
320
|
+
|
|
321
|
+
Require complete user profile for provisioning (create) API actions.
|
|
322
|
+
|
|
323
|
+
### Example
|
|
324
|
+
|
|
325
|
+
```typescript
|
|
326
|
+
import {
|
|
327
|
+
EmailApi,
|
|
328
|
+
Configuration,
|
|
329
|
+
InboundRoute
|
|
330
|
+
} from '@pidginhost/sdk';
|
|
331
|
+
|
|
332
|
+
const configuration = new Configuration();
|
|
333
|
+
const apiInstance = new EmailApi(configuration);
|
|
334
|
+
|
|
335
|
+
let domainPk: number; // (default to undefined)
|
|
336
|
+
let inboundRoute: InboundRoute; //
|
|
337
|
+
|
|
338
|
+
const { status, data } = await apiInstance.emailDomainsInboundRoutesCreate(
|
|
339
|
+
domainPk,
|
|
340
|
+
inboundRoute
|
|
341
|
+
);
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### Parameters
|
|
345
|
+
|
|
346
|
+
|Name | Type | Description | Notes|
|
|
347
|
+
|------------- | ------------- | ------------- | -------------|
|
|
348
|
+
| **inboundRoute** | **InboundRoute**| | |
|
|
349
|
+
| **domainPk** | [**number**] | | defaults to undefined|
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
### Return type
|
|
353
|
+
|
|
354
|
+
**InboundRoute**
|
|
355
|
+
|
|
356
|
+
### Authorization
|
|
357
|
+
|
|
358
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
359
|
+
|
|
360
|
+
### HTTP request headers
|
|
361
|
+
|
|
362
|
+
- **Content-Type**: application/json
|
|
363
|
+
- **Accept**: application/json
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
### HTTP response details
|
|
367
|
+
| Status code | Description | Response headers |
|
|
368
|
+
|-------------|-------------|------------------|
|
|
369
|
+
|**201** | | - |
|
|
370
|
+
|
|
371
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
372
|
+
|
|
373
|
+
# **emailDomainsInboundRoutesList**
|
|
374
|
+
> PaginatedInboundRouteList emailDomainsInboundRoutesList()
|
|
375
|
+
|
|
376
|
+
Require complete user profile for provisioning (create) API actions.
|
|
377
|
+
|
|
378
|
+
### Example
|
|
379
|
+
|
|
380
|
+
```typescript
|
|
381
|
+
import {
|
|
382
|
+
EmailApi,
|
|
383
|
+
Configuration
|
|
384
|
+
} from '@pidginhost/sdk';
|
|
385
|
+
|
|
386
|
+
const configuration = new Configuration();
|
|
387
|
+
const apiInstance = new EmailApi(configuration);
|
|
388
|
+
|
|
389
|
+
let domainPk: number; // (default to undefined)
|
|
390
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
391
|
+
|
|
392
|
+
const { status, data } = await apiInstance.emailDomainsInboundRoutesList(
|
|
393
|
+
domainPk,
|
|
394
|
+
page
|
|
395
|
+
);
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
### Parameters
|
|
399
|
+
|
|
400
|
+
|Name | Type | Description | Notes|
|
|
401
|
+
|------------- | ------------- | ------------- | -------------|
|
|
402
|
+
| **domainPk** | [**number**] | | defaults to undefined|
|
|
403
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
### Return type
|
|
407
|
+
|
|
408
|
+
**PaginatedInboundRouteList**
|
|
409
|
+
|
|
410
|
+
### Authorization
|
|
411
|
+
|
|
412
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
413
|
+
|
|
414
|
+
### HTTP request headers
|
|
415
|
+
|
|
416
|
+
- **Content-Type**: Not defined
|
|
417
|
+
- **Accept**: application/json
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
### HTTP response details
|
|
421
|
+
| Status code | Description | Response headers |
|
|
422
|
+
|-------------|-------------|------------------|
|
|
423
|
+
|**200** | | - |
|
|
424
|
+
|
|
425
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
426
|
+
|
|
427
|
+
# **emailDomainsList**
|
|
428
|
+
> PaginatedSendingDomainList emailDomainsList()
|
|
429
|
+
|
|
430
|
+
Require complete user profile for provisioning (create) API actions.
|
|
431
|
+
|
|
432
|
+
### Example
|
|
433
|
+
|
|
434
|
+
```typescript
|
|
435
|
+
import {
|
|
436
|
+
EmailApi,
|
|
437
|
+
Configuration
|
|
438
|
+
} from '@pidginhost/sdk';
|
|
439
|
+
|
|
440
|
+
const configuration = new Configuration();
|
|
441
|
+
const apiInstance = new EmailApi(configuration);
|
|
442
|
+
|
|
443
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
444
|
+
|
|
445
|
+
const { status, data } = await apiInstance.emailDomainsList(
|
|
446
|
+
page
|
|
447
|
+
);
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
### Parameters
|
|
451
|
+
|
|
452
|
+
|Name | Type | Description | Notes|
|
|
453
|
+
|------------- | ------------- | ------------- | -------------|
|
|
454
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
### Return type
|
|
458
|
+
|
|
459
|
+
**PaginatedSendingDomainList**
|
|
460
|
+
|
|
461
|
+
### Authorization
|
|
462
|
+
|
|
463
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
464
|
+
|
|
465
|
+
### HTTP request headers
|
|
466
|
+
|
|
467
|
+
- **Content-Type**: Not defined
|
|
468
|
+
- **Accept**: application/json
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
### HTTP response details
|
|
472
|
+
| Status code | Description | Response headers |
|
|
473
|
+
|-------------|-------------|------------------|
|
|
474
|
+
|**200** | | - |
|
|
475
|
+
|
|
476
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
477
|
+
|
|
478
|
+
# **emailDomainsRetrieve**
|
|
479
|
+
> SendingDomain emailDomainsRetrieve()
|
|
480
|
+
|
|
481
|
+
Require complete user profile for provisioning (create) API actions.
|
|
482
|
+
|
|
483
|
+
### Example
|
|
484
|
+
|
|
485
|
+
```typescript
|
|
486
|
+
import {
|
|
487
|
+
EmailApi,
|
|
488
|
+
Configuration
|
|
489
|
+
} from '@pidginhost/sdk';
|
|
490
|
+
|
|
491
|
+
const configuration = new Configuration();
|
|
492
|
+
const apiInstance = new EmailApi(configuration);
|
|
493
|
+
|
|
494
|
+
let id: number; //A unique integer value identifying this sending domain. (default to undefined)
|
|
495
|
+
|
|
496
|
+
const { status, data } = await apiInstance.emailDomainsRetrieve(
|
|
497
|
+
id
|
|
498
|
+
);
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
### Parameters
|
|
502
|
+
|
|
503
|
+
|Name | Type | Description | Notes|
|
|
504
|
+
|------------- | ------------- | ------------- | -------------|
|
|
505
|
+
| **id** | [**number**] | A unique integer value identifying this sending domain. | defaults to undefined|
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
### Return type
|
|
509
|
+
|
|
510
|
+
**SendingDomain**
|
|
511
|
+
|
|
512
|
+
### Authorization
|
|
513
|
+
|
|
514
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
515
|
+
|
|
516
|
+
### HTTP request headers
|
|
517
|
+
|
|
518
|
+
- **Content-Type**: Not defined
|
|
519
|
+
- **Accept**: application/json
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
### HTTP response details
|
|
523
|
+
| Status code | Description | Response headers |
|
|
524
|
+
|-------------|-------------|------------------|
|
|
525
|
+
|**200** | | - |
|
|
526
|
+
|
|
527
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
528
|
+
|
|
529
|
+
# **emailDomainsRotateDkimCreate**
|
|
530
|
+
> SendingDomain emailDomainsRotateDkimCreate()
|
|
531
|
+
|
|
532
|
+
Require complete user profile for provisioning (create) API actions.
|
|
533
|
+
|
|
534
|
+
### Example
|
|
535
|
+
|
|
536
|
+
```typescript
|
|
537
|
+
import {
|
|
538
|
+
EmailApi,
|
|
539
|
+
Configuration,
|
|
540
|
+
SendingDomain
|
|
541
|
+
} from '@pidginhost/sdk';
|
|
542
|
+
|
|
543
|
+
const configuration = new Configuration();
|
|
544
|
+
const apiInstance = new EmailApi(configuration);
|
|
545
|
+
|
|
546
|
+
let id: number; //A unique integer value identifying this sending domain. (default to undefined)
|
|
547
|
+
let sendingDomain: SendingDomain; // (optional)
|
|
548
|
+
|
|
549
|
+
const { status, data } = await apiInstance.emailDomainsRotateDkimCreate(
|
|
550
|
+
id,
|
|
551
|
+
sendingDomain
|
|
552
|
+
);
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
### Parameters
|
|
556
|
+
|
|
557
|
+
|Name | Type | Description | Notes|
|
|
558
|
+
|------------- | ------------- | ------------- | -------------|
|
|
559
|
+
| **sendingDomain** | **SendingDomain**| | |
|
|
560
|
+
| **id** | [**number**] | A unique integer value identifying this sending domain. | defaults to undefined|
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
### Return type
|
|
564
|
+
|
|
565
|
+
**SendingDomain**
|
|
566
|
+
|
|
567
|
+
### Authorization
|
|
568
|
+
|
|
569
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
570
|
+
|
|
571
|
+
### HTTP request headers
|
|
572
|
+
|
|
573
|
+
- **Content-Type**: application/json
|
|
574
|
+
- **Accept**: application/json
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
### HTTP response details
|
|
578
|
+
| Status code | Description | Response headers |
|
|
579
|
+
|-------------|-------------|------------------|
|
|
580
|
+
|**200** | | - |
|
|
581
|
+
|
|
582
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
583
|
+
|
|
584
|
+
# **emailDomainsToggleInboundCreate**
|
|
585
|
+
> SendingDomain emailDomainsToggleInboundCreate()
|
|
586
|
+
|
|
587
|
+
Require complete user profile for provisioning (create) API actions.
|
|
588
|
+
|
|
589
|
+
### Example
|
|
590
|
+
|
|
591
|
+
```typescript
|
|
592
|
+
import {
|
|
593
|
+
EmailApi,
|
|
594
|
+
Configuration,
|
|
595
|
+
SendingDomain
|
|
596
|
+
} from '@pidginhost/sdk';
|
|
597
|
+
|
|
598
|
+
const configuration = new Configuration();
|
|
599
|
+
const apiInstance = new EmailApi(configuration);
|
|
600
|
+
|
|
601
|
+
let id: number; //A unique integer value identifying this sending domain. (default to undefined)
|
|
602
|
+
let sendingDomain: SendingDomain; // (optional)
|
|
603
|
+
|
|
604
|
+
const { status, data } = await apiInstance.emailDomainsToggleInboundCreate(
|
|
605
|
+
id,
|
|
606
|
+
sendingDomain
|
|
607
|
+
);
|
|
608
|
+
```
|
|
609
|
+
|
|
610
|
+
### Parameters
|
|
611
|
+
|
|
612
|
+
|Name | Type | Description | Notes|
|
|
613
|
+
|------------- | ------------- | ------------- | -------------|
|
|
614
|
+
| **sendingDomain** | **SendingDomain**| | |
|
|
615
|
+
| **id** | [**number**] | A unique integer value identifying this sending domain. | defaults to undefined|
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
### Return type
|
|
619
|
+
|
|
620
|
+
**SendingDomain**
|
|
621
|
+
|
|
622
|
+
### Authorization
|
|
623
|
+
|
|
624
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
625
|
+
|
|
626
|
+
### HTTP request headers
|
|
627
|
+
|
|
628
|
+
- **Content-Type**: application/json
|
|
629
|
+
- **Accept**: application/json
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
### HTTP response details
|
|
633
|
+
| Status code | Description | Response headers |
|
|
634
|
+
|-------------|-------------|------------------|
|
|
635
|
+
|**200** | | - |
|
|
636
|
+
|
|
637
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
638
|
+
|
|
639
|
+
# **emailDomainsVerifyCreate**
|
|
640
|
+
> SendingDomain emailDomainsVerifyCreate()
|
|
641
|
+
|
|
642
|
+
Require complete user profile for provisioning (create) API actions.
|
|
643
|
+
|
|
644
|
+
### Example
|
|
645
|
+
|
|
646
|
+
```typescript
|
|
647
|
+
import {
|
|
648
|
+
EmailApi,
|
|
649
|
+
Configuration,
|
|
650
|
+
SendingDomain
|
|
651
|
+
} from '@pidginhost/sdk';
|
|
652
|
+
|
|
653
|
+
const configuration = new Configuration();
|
|
654
|
+
const apiInstance = new EmailApi(configuration);
|
|
655
|
+
|
|
656
|
+
let id: number; //A unique integer value identifying this sending domain. (default to undefined)
|
|
657
|
+
let sendingDomain: SendingDomain; // (optional)
|
|
658
|
+
|
|
659
|
+
const { status, data } = await apiInstance.emailDomainsVerifyCreate(
|
|
660
|
+
id,
|
|
661
|
+
sendingDomain
|
|
662
|
+
);
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
### Parameters
|
|
666
|
+
|
|
667
|
+
|Name | Type | Description | Notes|
|
|
668
|
+
|------------- | ------------- | ------------- | -------------|
|
|
669
|
+
| **sendingDomain** | **SendingDomain**| | |
|
|
670
|
+
| **id** | [**number**] | A unique integer value identifying this sending domain. | defaults to undefined|
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
### Return type
|
|
674
|
+
|
|
675
|
+
**SendingDomain**
|
|
676
|
+
|
|
677
|
+
### Authorization
|
|
678
|
+
|
|
679
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
680
|
+
|
|
681
|
+
### HTTP request headers
|
|
682
|
+
|
|
683
|
+
- **Content-Type**: application/json
|
|
684
|
+
- **Accept**: application/json
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
### HTTP response details
|
|
688
|
+
| Status code | Description | Response headers |
|
|
689
|
+
|-------------|-------------|------------------|
|
|
690
|
+
|**200** | | - |
|
|
691
|
+
|
|
692
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
693
|
+
|
|
694
|
+
# **emailInboundRoutesCreate**
|
|
695
|
+
> InboundRoute emailInboundRoutesCreate(inboundRoute)
|
|
696
|
+
|
|
697
|
+
Require complete user profile for provisioning (create) API actions.
|
|
698
|
+
|
|
699
|
+
### Example
|
|
700
|
+
|
|
701
|
+
```typescript
|
|
702
|
+
import {
|
|
703
|
+
EmailApi,
|
|
704
|
+
Configuration,
|
|
705
|
+
InboundRoute
|
|
706
|
+
} from '@pidginhost/sdk';
|
|
707
|
+
|
|
708
|
+
const configuration = new Configuration();
|
|
709
|
+
const apiInstance = new EmailApi(configuration);
|
|
710
|
+
|
|
711
|
+
let inboundRoute: InboundRoute; //
|
|
712
|
+
|
|
713
|
+
const { status, data } = await apiInstance.emailInboundRoutesCreate(
|
|
714
|
+
inboundRoute
|
|
715
|
+
);
|
|
716
|
+
```
|
|
717
|
+
|
|
718
|
+
### Parameters
|
|
719
|
+
|
|
720
|
+
|Name | Type | Description | Notes|
|
|
721
|
+
|------------- | ------------- | ------------- | -------------|
|
|
722
|
+
| **inboundRoute** | **InboundRoute**| | |
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
### Return type
|
|
726
|
+
|
|
727
|
+
**InboundRoute**
|
|
728
|
+
|
|
729
|
+
### Authorization
|
|
730
|
+
|
|
731
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
732
|
+
|
|
733
|
+
### HTTP request headers
|
|
734
|
+
|
|
735
|
+
- **Content-Type**: application/json
|
|
736
|
+
- **Accept**: application/json
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
### HTTP response details
|
|
740
|
+
| Status code | Description | Response headers |
|
|
741
|
+
|-------------|-------------|------------------|
|
|
742
|
+
|**201** | | - |
|
|
743
|
+
|
|
744
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
745
|
+
|
|
746
|
+
# **emailInboundRoutesDestroy**
|
|
747
|
+
> emailInboundRoutesDestroy()
|
|
748
|
+
|
|
749
|
+
Require complete user profile for provisioning (create) API actions.
|
|
750
|
+
|
|
751
|
+
### Example
|
|
752
|
+
|
|
753
|
+
```typescript
|
|
754
|
+
import {
|
|
755
|
+
EmailApi,
|
|
756
|
+
Configuration
|
|
757
|
+
} from '@pidginhost/sdk';
|
|
758
|
+
|
|
759
|
+
const configuration = new Configuration();
|
|
760
|
+
const apiInstance = new EmailApi(configuration);
|
|
761
|
+
|
|
762
|
+
let id: number; //A unique integer value identifying this inbound route. (default to undefined)
|
|
763
|
+
|
|
764
|
+
const { status, data } = await apiInstance.emailInboundRoutesDestroy(
|
|
765
|
+
id
|
|
766
|
+
);
|
|
767
|
+
```
|
|
768
|
+
|
|
769
|
+
### Parameters
|
|
770
|
+
|
|
771
|
+
|Name | Type | Description | Notes|
|
|
772
|
+
|------------- | ------------- | ------------- | -------------|
|
|
773
|
+
| **id** | [**number**] | A unique integer value identifying this inbound route. | defaults to undefined|
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
### Return type
|
|
777
|
+
|
|
778
|
+
void (empty response body)
|
|
779
|
+
|
|
780
|
+
### Authorization
|
|
781
|
+
|
|
782
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
783
|
+
|
|
784
|
+
### HTTP request headers
|
|
785
|
+
|
|
786
|
+
- **Content-Type**: Not defined
|
|
787
|
+
- **Accept**: Not defined
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
### HTTP response details
|
|
791
|
+
| Status code | Description | Response headers |
|
|
792
|
+
|-------------|-------------|------------------|
|
|
793
|
+
|**204** | No response body | - |
|
|
794
|
+
|
|
795
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
796
|
+
|
|
797
|
+
# **emailInboundRoutesList**
|
|
798
|
+
> PaginatedInboundRouteList emailInboundRoutesList()
|
|
799
|
+
|
|
800
|
+
Require complete user profile for provisioning (create) API actions.
|
|
801
|
+
|
|
802
|
+
### Example
|
|
803
|
+
|
|
804
|
+
```typescript
|
|
805
|
+
import {
|
|
806
|
+
EmailApi,
|
|
807
|
+
Configuration
|
|
808
|
+
} from '@pidginhost/sdk';
|
|
809
|
+
|
|
810
|
+
const configuration = new Configuration();
|
|
811
|
+
const apiInstance = new EmailApi(configuration);
|
|
812
|
+
|
|
813
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
814
|
+
|
|
815
|
+
const { status, data } = await apiInstance.emailInboundRoutesList(
|
|
816
|
+
page
|
|
817
|
+
);
|
|
818
|
+
```
|
|
819
|
+
|
|
820
|
+
### Parameters
|
|
821
|
+
|
|
822
|
+
|Name | Type | Description | Notes|
|
|
823
|
+
|------------- | ------------- | ------------- | -------------|
|
|
824
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
### Return type
|
|
828
|
+
|
|
829
|
+
**PaginatedInboundRouteList**
|
|
830
|
+
|
|
831
|
+
### Authorization
|
|
832
|
+
|
|
833
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
834
|
+
|
|
835
|
+
### HTTP request headers
|
|
836
|
+
|
|
837
|
+
- **Content-Type**: Not defined
|
|
838
|
+
- **Accept**: application/json
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
### HTTP response details
|
|
842
|
+
| Status code | Description | Response headers |
|
|
843
|
+
|-------------|-------------|------------------|
|
|
844
|
+
|**200** | | - |
|
|
845
|
+
|
|
846
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
847
|
+
|
|
848
|
+
# **emailInboundRoutesPartialUpdate**
|
|
849
|
+
> InboundRoute emailInboundRoutesPartialUpdate()
|
|
850
|
+
|
|
851
|
+
Require complete user profile for provisioning (create) API actions.
|
|
852
|
+
|
|
853
|
+
### Example
|
|
854
|
+
|
|
855
|
+
```typescript
|
|
856
|
+
import {
|
|
857
|
+
EmailApi,
|
|
858
|
+
Configuration,
|
|
859
|
+
PatchedInboundRoute
|
|
860
|
+
} from '@pidginhost/sdk';
|
|
861
|
+
|
|
862
|
+
const configuration = new Configuration();
|
|
863
|
+
const apiInstance = new EmailApi(configuration);
|
|
864
|
+
|
|
865
|
+
let id: number; //A unique integer value identifying this inbound route. (default to undefined)
|
|
866
|
+
let patchedInboundRoute: PatchedInboundRoute; // (optional)
|
|
867
|
+
|
|
868
|
+
const { status, data } = await apiInstance.emailInboundRoutesPartialUpdate(
|
|
869
|
+
id,
|
|
870
|
+
patchedInboundRoute
|
|
871
|
+
);
|
|
872
|
+
```
|
|
873
|
+
|
|
874
|
+
### Parameters
|
|
875
|
+
|
|
876
|
+
|Name | Type | Description | Notes|
|
|
877
|
+
|------------- | ------------- | ------------- | -------------|
|
|
878
|
+
| **patchedInboundRoute** | **PatchedInboundRoute**| | |
|
|
879
|
+
| **id** | [**number**] | A unique integer value identifying this inbound route. | defaults to undefined|
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
### Return type
|
|
883
|
+
|
|
884
|
+
**InboundRoute**
|
|
885
|
+
|
|
886
|
+
### Authorization
|
|
887
|
+
|
|
888
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
889
|
+
|
|
890
|
+
### HTTP request headers
|
|
891
|
+
|
|
892
|
+
- **Content-Type**: application/json
|
|
893
|
+
- **Accept**: application/json
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
### HTTP response details
|
|
897
|
+
| Status code | Description | Response headers |
|
|
898
|
+
|-------------|-------------|------------------|
|
|
899
|
+
|**200** | | - |
|
|
900
|
+
|
|
901
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
902
|
+
|
|
903
|
+
# **emailInboundRoutesRetrieve**
|
|
904
|
+
> InboundRoute emailInboundRoutesRetrieve()
|
|
905
|
+
|
|
906
|
+
Require complete user profile for provisioning (create) API actions.
|
|
907
|
+
|
|
908
|
+
### Example
|
|
909
|
+
|
|
910
|
+
```typescript
|
|
911
|
+
import {
|
|
912
|
+
EmailApi,
|
|
913
|
+
Configuration
|
|
914
|
+
} from '@pidginhost/sdk';
|
|
915
|
+
|
|
916
|
+
const configuration = new Configuration();
|
|
917
|
+
const apiInstance = new EmailApi(configuration);
|
|
918
|
+
|
|
919
|
+
let id: number; //A unique integer value identifying this inbound route. (default to undefined)
|
|
920
|
+
|
|
921
|
+
const { status, data } = await apiInstance.emailInboundRoutesRetrieve(
|
|
922
|
+
id
|
|
923
|
+
);
|
|
924
|
+
```
|
|
925
|
+
|
|
926
|
+
### Parameters
|
|
927
|
+
|
|
928
|
+
|Name | Type | Description | Notes|
|
|
929
|
+
|------------- | ------------- | ------------- | -------------|
|
|
930
|
+
| **id** | [**number**] | A unique integer value identifying this inbound route. | defaults to undefined|
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
### Return type
|
|
934
|
+
|
|
935
|
+
**InboundRoute**
|
|
936
|
+
|
|
937
|
+
### Authorization
|
|
938
|
+
|
|
939
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
940
|
+
|
|
941
|
+
### HTTP request headers
|
|
942
|
+
|
|
943
|
+
- **Content-Type**: Not defined
|
|
944
|
+
- **Accept**: application/json
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
### HTTP response details
|
|
948
|
+
| Status code | Description | Response headers |
|
|
949
|
+
|-------------|-------------|------------------|
|
|
950
|
+
|**200** | | - |
|
|
951
|
+
|
|
952
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
953
|
+
|
|
954
|
+
# **emailMessagesRetrieve**
|
|
955
|
+
> emailMessagesRetrieve()
|
|
956
|
+
|
|
957
|
+
Require complete user profile for provisioning (create) API actions.
|
|
958
|
+
|
|
959
|
+
### Example
|
|
960
|
+
|
|
961
|
+
```typescript
|
|
962
|
+
import {
|
|
963
|
+
EmailApi,
|
|
964
|
+
Configuration
|
|
965
|
+
} from '@pidginhost/sdk';
|
|
966
|
+
|
|
967
|
+
const configuration = new Configuration();
|
|
968
|
+
const apiInstance = new EmailApi(configuration);
|
|
969
|
+
|
|
970
|
+
let messageId: string; // (default to undefined)
|
|
971
|
+
|
|
972
|
+
const { status, data } = await apiInstance.emailMessagesRetrieve(
|
|
973
|
+
messageId
|
|
974
|
+
);
|
|
975
|
+
```
|
|
976
|
+
|
|
977
|
+
### Parameters
|
|
978
|
+
|
|
979
|
+
|Name | Type | Description | Notes|
|
|
980
|
+
|------------- | ------------- | ------------- | -------------|
|
|
981
|
+
| **messageId** | [**string**] | | defaults to undefined|
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
### Return type
|
|
985
|
+
|
|
986
|
+
void (empty response body)
|
|
987
|
+
|
|
988
|
+
### Authorization
|
|
989
|
+
|
|
990
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
991
|
+
|
|
992
|
+
### HTTP request headers
|
|
993
|
+
|
|
994
|
+
- **Content-Type**: Not defined
|
|
995
|
+
- **Accept**: Not defined
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
### HTTP response details
|
|
999
|
+
| Status code | Description | Response headers |
|
|
1000
|
+
|-------------|-------------|------------------|
|
|
1001
|
+
|**200** | No response body | - |
|
|
1002
|
+
|
|
1003
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1004
|
+
|
|
1005
|
+
# **emailSandboxAddressesCreate**
|
|
1006
|
+
> SandboxAddress emailSandboxAddressesCreate(sandboxAddress)
|
|
1007
|
+
|
|
1008
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1009
|
+
|
|
1010
|
+
### Example
|
|
1011
|
+
|
|
1012
|
+
```typescript
|
|
1013
|
+
import {
|
|
1014
|
+
EmailApi,
|
|
1015
|
+
Configuration,
|
|
1016
|
+
SandboxAddress
|
|
1017
|
+
} from '@pidginhost/sdk';
|
|
1018
|
+
|
|
1019
|
+
const configuration = new Configuration();
|
|
1020
|
+
const apiInstance = new EmailApi(configuration);
|
|
1021
|
+
|
|
1022
|
+
let sandboxAddress: SandboxAddress; //
|
|
1023
|
+
|
|
1024
|
+
const { status, data } = await apiInstance.emailSandboxAddressesCreate(
|
|
1025
|
+
sandboxAddress
|
|
1026
|
+
);
|
|
1027
|
+
```
|
|
1028
|
+
|
|
1029
|
+
### Parameters
|
|
1030
|
+
|
|
1031
|
+
|Name | Type | Description | Notes|
|
|
1032
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1033
|
+
| **sandboxAddress** | **SandboxAddress**| | |
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
### Return type
|
|
1037
|
+
|
|
1038
|
+
**SandboxAddress**
|
|
1039
|
+
|
|
1040
|
+
### Authorization
|
|
1041
|
+
|
|
1042
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1043
|
+
|
|
1044
|
+
### HTTP request headers
|
|
1045
|
+
|
|
1046
|
+
- **Content-Type**: application/json
|
|
1047
|
+
- **Accept**: application/json
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
### HTTP response details
|
|
1051
|
+
| Status code | Description | Response headers |
|
|
1052
|
+
|-------------|-------------|------------------|
|
|
1053
|
+
|**201** | | - |
|
|
1054
|
+
|
|
1055
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1056
|
+
|
|
1057
|
+
# **emailSandboxAddressesDestroy**
|
|
1058
|
+
> emailSandboxAddressesDestroy()
|
|
1059
|
+
|
|
1060
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1061
|
+
|
|
1062
|
+
### Example
|
|
1063
|
+
|
|
1064
|
+
```typescript
|
|
1065
|
+
import {
|
|
1066
|
+
EmailApi,
|
|
1067
|
+
Configuration
|
|
1068
|
+
} from '@pidginhost/sdk';
|
|
1069
|
+
|
|
1070
|
+
const configuration = new Configuration();
|
|
1071
|
+
const apiInstance = new EmailApi(configuration);
|
|
1072
|
+
|
|
1073
|
+
let id: number; //A unique integer value identifying this sandbox verified address. (default to undefined)
|
|
1074
|
+
|
|
1075
|
+
const { status, data } = await apiInstance.emailSandboxAddressesDestroy(
|
|
1076
|
+
id
|
|
1077
|
+
);
|
|
1078
|
+
```
|
|
1079
|
+
|
|
1080
|
+
### Parameters
|
|
1081
|
+
|
|
1082
|
+
|Name | Type | Description | Notes|
|
|
1083
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1084
|
+
| **id** | [**number**] | A unique integer value identifying this sandbox verified address. | defaults to undefined|
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
### Return type
|
|
1088
|
+
|
|
1089
|
+
void (empty response body)
|
|
1090
|
+
|
|
1091
|
+
### Authorization
|
|
1092
|
+
|
|
1093
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1094
|
+
|
|
1095
|
+
### HTTP request headers
|
|
1096
|
+
|
|
1097
|
+
- **Content-Type**: Not defined
|
|
1098
|
+
- **Accept**: Not defined
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
### HTTP response details
|
|
1102
|
+
| Status code | Description | Response headers |
|
|
1103
|
+
|-------------|-------------|------------------|
|
|
1104
|
+
|**204** | No response body | - |
|
|
1105
|
+
|
|
1106
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1107
|
+
|
|
1108
|
+
# **emailSandboxAddressesList**
|
|
1109
|
+
> PaginatedSandboxAddressList emailSandboxAddressesList()
|
|
1110
|
+
|
|
1111
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1112
|
+
|
|
1113
|
+
### Example
|
|
1114
|
+
|
|
1115
|
+
```typescript
|
|
1116
|
+
import {
|
|
1117
|
+
EmailApi,
|
|
1118
|
+
Configuration
|
|
1119
|
+
} from '@pidginhost/sdk';
|
|
1120
|
+
|
|
1121
|
+
const configuration = new Configuration();
|
|
1122
|
+
const apiInstance = new EmailApi(configuration);
|
|
1123
|
+
|
|
1124
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1125
|
+
|
|
1126
|
+
const { status, data } = await apiInstance.emailSandboxAddressesList(
|
|
1127
|
+
page
|
|
1128
|
+
);
|
|
1129
|
+
```
|
|
1130
|
+
|
|
1131
|
+
### Parameters
|
|
1132
|
+
|
|
1133
|
+
|Name | Type | Description | Notes|
|
|
1134
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1135
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
### Return type
|
|
1139
|
+
|
|
1140
|
+
**PaginatedSandboxAddressList**
|
|
1141
|
+
|
|
1142
|
+
### Authorization
|
|
1143
|
+
|
|
1144
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1145
|
+
|
|
1146
|
+
### HTTP request headers
|
|
1147
|
+
|
|
1148
|
+
- **Content-Type**: Not defined
|
|
1149
|
+
- **Accept**: application/json
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
### HTTP response details
|
|
1153
|
+
| Status code | Description | Response headers |
|
|
1154
|
+
|-------------|-------------|------------------|
|
|
1155
|
+
|**200** | | - |
|
|
1156
|
+
|
|
1157
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1158
|
+
|
|
1159
|
+
# **emailSandboxAddressesRetrieve**
|
|
1160
|
+
> SandboxAddress emailSandboxAddressesRetrieve()
|
|
1161
|
+
|
|
1162
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1163
|
+
|
|
1164
|
+
### Example
|
|
1165
|
+
|
|
1166
|
+
```typescript
|
|
1167
|
+
import {
|
|
1168
|
+
EmailApi,
|
|
1169
|
+
Configuration
|
|
1170
|
+
} from '@pidginhost/sdk';
|
|
1171
|
+
|
|
1172
|
+
const configuration = new Configuration();
|
|
1173
|
+
const apiInstance = new EmailApi(configuration);
|
|
1174
|
+
|
|
1175
|
+
let id: number; //A unique integer value identifying this sandbox verified address. (default to undefined)
|
|
1176
|
+
|
|
1177
|
+
const { status, data } = await apiInstance.emailSandboxAddressesRetrieve(
|
|
1178
|
+
id
|
|
1179
|
+
);
|
|
1180
|
+
```
|
|
1181
|
+
|
|
1182
|
+
### Parameters
|
|
1183
|
+
|
|
1184
|
+
|Name | Type | Description | Notes|
|
|
1185
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1186
|
+
| **id** | [**number**] | A unique integer value identifying this sandbox verified address. | defaults to undefined|
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
### Return type
|
|
1190
|
+
|
|
1191
|
+
**SandboxAddress**
|
|
1192
|
+
|
|
1193
|
+
### Authorization
|
|
1194
|
+
|
|
1195
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1196
|
+
|
|
1197
|
+
### HTTP request headers
|
|
1198
|
+
|
|
1199
|
+
- **Content-Type**: Not defined
|
|
1200
|
+
- **Accept**: application/json
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
### HTTP response details
|
|
1204
|
+
| Status code | Description | Response headers |
|
|
1205
|
+
|-------------|-------------|------------------|
|
|
1206
|
+
|**200** | | - |
|
|
1207
|
+
|
|
1208
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1209
|
+
|
|
1210
|
+
# **emailSendCreate**
|
|
1211
|
+
> emailSendCreate()
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
### Example
|
|
1215
|
+
|
|
1216
|
+
```typescript
|
|
1217
|
+
import {
|
|
1218
|
+
EmailApi,
|
|
1219
|
+
Configuration
|
|
1220
|
+
} from '@pidginhost/sdk';
|
|
1221
|
+
|
|
1222
|
+
const configuration = new Configuration();
|
|
1223
|
+
const apiInstance = new EmailApi(configuration);
|
|
1224
|
+
|
|
1225
|
+
const { status, data } = await apiInstance.emailSendCreate();
|
|
1226
|
+
```
|
|
1227
|
+
|
|
1228
|
+
### Parameters
|
|
1229
|
+
This endpoint does not have any parameters.
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
### Return type
|
|
1233
|
+
|
|
1234
|
+
void (empty response body)
|
|
1235
|
+
|
|
1236
|
+
### Authorization
|
|
1237
|
+
|
|
1238
|
+
No authorization required
|
|
1239
|
+
|
|
1240
|
+
### HTTP request headers
|
|
1241
|
+
|
|
1242
|
+
- **Content-Type**: Not defined
|
|
1243
|
+
- **Accept**: Not defined
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
### HTTP response details
|
|
1247
|
+
| Status code | Description | Response headers |
|
|
1248
|
+
|-------------|-------------|------------------|
|
|
1249
|
+
|**200** | No response body | - |
|
|
1250
|
+
|
|
1251
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1252
|
+
|
|
1253
|
+
# **emailServicesApiCredentialsCreate**
|
|
1254
|
+
> ApiCredential emailServicesApiCredentialsCreate()
|
|
1255
|
+
|
|
1256
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1257
|
+
|
|
1258
|
+
### Example
|
|
1259
|
+
|
|
1260
|
+
```typescript
|
|
1261
|
+
import {
|
|
1262
|
+
EmailApi,
|
|
1263
|
+
Configuration,
|
|
1264
|
+
ApiCredential
|
|
1265
|
+
} from '@pidginhost/sdk';
|
|
1266
|
+
|
|
1267
|
+
const configuration = new Configuration();
|
|
1268
|
+
const apiInstance = new EmailApi(configuration);
|
|
1269
|
+
|
|
1270
|
+
let servicePk: number; // (default to undefined)
|
|
1271
|
+
let apiCredential: ApiCredential; // (optional)
|
|
1272
|
+
|
|
1273
|
+
const { status, data } = await apiInstance.emailServicesApiCredentialsCreate(
|
|
1274
|
+
servicePk,
|
|
1275
|
+
apiCredential
|
|
1276
|
+
);
|
|
1277
|
+
```
|
|
1278
|
+
|
|
1279
|
+
### Parameters
|
|
1280
|
+
|
|
1281
|
+
|Name | Type | Description | Notes|
|
|
1282
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1283
|
+
| **apiCredential** | **ApiCredential**| | |
|
|
1284
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
### Return type
|
|
1288
|
+
|
|
1289
|
+
**ApiCredential**
|
|
1290
|
+
|
|
1291
|
+
### Authorization
|
|
1292
|
+
|
|
1293
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1294
|
+
|
|
1295
|
+
### HTTP request headers
|
|
1296
|
+
|
|
1297
|
+
- **Content-Type**: application/json
|
|
1298
|
+
- **Accept**: application/json
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
### HTTP response details
|
|
1302
|
+
| Status code | Description | Response headers |
|
|
1303
|
+
|-------------|-------------|------------------|
|
|
1304
|
+
|**201** | | - |
|
|
1305
|
+
|
|
1306
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1307
|
+
|
|
1308
|
+
# **emailServicesApiCredentialsList**
|
|
1309
|
+
> PaginatedApiCredentialList emailServicesApiCredentialsList()
|
|
1310
|
+
|
|
1311
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1312
|
+
|
|
1313
|
+
### Example
|
|
1314
|
+
|
|
1315
|
+
```typescript
|
|
1316
|
+
import {
|
|
1317
|
+
EmailApi,
|
|
1318
|
+
Configuration
|
|
1319
|
+
} from '@pidginhost/sdk';
|
|
1320
|
+
|
|
1321
|
+
const configuration = new Configuration();
|
|
1322
|
+
const apiInstance = new EmailApi(configuration);
|
|
1323
|
+
|
|
1324
|
+
let servicePk: number; // (default to undefined)
|
|
1325
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1326
|
+
|
|
1327
|
+
const { status, data } = await apiInstance.emailServicesApiCredentialsList(
|
|
1328
|
+
servicePk,
|
|
1329
|
+
page
|
|
1330
|
+
);
|
|
1331
|
+
```
|
|
1332
|
+
|
|
1333
|
+
### Parameters
|
|
1334
|
+
|
|
1335
|
+
|Name | Type | Description | Notes|
|
|
1336
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1337
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
1338
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
### Return type
|
|
1342
|
+
|
|
1343
|
+
**PaginatedApiCredentialList**
|
|
1344
|
+
|
|
1345
|
+
### Authorization
|
|
1346
|
+
|
|
1347
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1348
|
+
|
|
1349
|
+
### HTTP request headers
|
|
1350
|
+
|
|
1351
|
+
- **Content-Type**: Not defined
|
|
1352
|
+
- **Accept**: application/json
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
### HTTP response details
|
|
1356
|
+
| Status code | Description | Response headers |
|
|
1357
|
+
|-------------|-------------|------------------|
|
|
1358
|
+
|**200** | | - |
|
|
1359
|
+
|
|
1360
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1361
|
+
|
|
1362
|
+
# **emailServicesCancelCreate**
|
|
1363
|
+
> EmailService emailServicesCancelCreate()
|
|
1364
|
+
|
|
1365
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1366
|
+
|
|
1367
|
+
### Example
|
|
1368
|
+
|
|
1369
|
+
```typescript
|
|
1370
|
+
import {
|
|
1371
|
+
EmailApi,
|
|
1372
|
+
Configuration
|
|
1373
|
+
} from '@pidginhost/sdk';
|
|
1374
|
+
|
|
1375
|
+
const configuration = new Configuration();
|
|
1376
|
+
const apiInstance = new EmailApi(configuration);
|
|
1377
|
+
|
|
1378
|
+
let id: number; //A unique integer value identifying this email service. (default to undefined)
|
|
1379
|
+
|
|
1380
|
+
const { status, data } = await apiInstance.emailServicesCancelCreate(
|
|
1381
|
+
id
|
|
1382
|
+
);
|
|
1383
|
+
```
|
|
1384
|
+
|
|
1385
|
+
### Parameters
|
|
1386
|
+
|
|
1387
|
+
|Name | Type | Description | Notes|
|
|
1388
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1389
|
+
| **id** | [**number**] | A unique integer value identifying this email service. | defaults to undefined|
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
### Return type
|
|
1393
|
+
|
|
1394
|
+
**EmailService**
|
|
1395
|
+
|
|
1396
|
+
### Authorization
|
|
1397
|
+
|
|
1398
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1399
|
+
|
|
1400
|
+
### HTTP request headers
|
|
1401
|
+
|
|
1402
|
+
- **Content-Type**: Not defined
|
|
1403
|
+
- **Accept**: application/json
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
### HTTP response details
|
|
1407
|
+
| Status code | Description | Response headers |
|
|
1408
|
+
|-------------|-------------|------------------|
|
|
1409
|
+
|**200** | | - |
|
|
1410
|
+
|
|
1411
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1412
|
+
|
|
1413
|
+
# **emailServicesChangeTierPartialUpdate**
|
|
1414
|
+
> EmailService emailServicesChangeTierPartialUpdate()
|
|
1415
|
+
|
|
1416
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1417
|
+
|
|
1418
|
+
### Example
|
|
1419
|
+
|
|
1420
|
+
```typescript
|
|
1421
|
+
import {
|
|
1422
|
+
EmailApi,
|
|
1423
|
+
Configuration,
|
|
1424
|
+
PatchedSubscribe
|
|
1425
|
+
} from '@pidginhost/sdk';
|
|
1426
|
+
|
|
1427
|
+
const configuration = new Configuration();
|
|
1428
|
+
const apiInstance = new EmailApi(configuration);
|
|
1429
|
+
|
|
1430
|
+
let id: number; //A unique integer value identifying this email service. (default to undefined)
|
|
1431
|
+
let patchedSubscribe: PatchedSubscribe; // (optional)
|
|
1432
|
+
|
|
1433
|
+
const { status, data } = await apiInstance.emailServicesChangeTierPartialUpdate(
|
|
1434
|
+
id,
|
|
1435
|
+
patchedSubscribe
|
|
1436
|
+
);
|
|
1437
|
+
```
|
|
1438
|
+
|
|
1439
|
+
### Parameters
|
|
1440
|
+
|
|
1441
|
+
|Name | Type | Description | Notes|
|
|
1442
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1443
|
+
| **patchedSubscribe** | **PatchedSubscribe**| | |
|
|
1444
|
+
| **id** | [**number**] | A unique integer value identifying this email service. | defaults to undefined|
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
### Return type
|
|
1448
|
+
|
|
1449
|
+
**EmailService**
|
|
1450
|
+
|
|
1451
|
+
### Authorization
|
|
1452
|
+
|
|
1453
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1454
|
+
|
|
1455
|
+
### HTTP request headers
|
|
1456
|
+
|
|
1457
|
+
- **Content-Type**: application/json
|
|
1458
|
+
- **Accept**: application/json
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
### HTTP response details
|
|
1462
|
+
| Status code | Description | Response headers |
|
|
1463
|
+
|-------------|-------------|------------------|
|
|
1464
|
+
|**200** | | - |
|
|
1465
|
+
|
|
1466
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1467
|
+
|
|
1468
|
+
# **emailServicesCreate**
|
|
1469
|
+
> EmailService emailServicesCreate(subscribe)
|
|
1470
|
+
|
|
1471
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1472
|
+
|
|
1473
|
+
### Example
|
|
1474
|
+
|
|
1475
|
+
```typescript
|
|
1476
|
+
import {
|
|
1477
|
+
EmailApi,
|
|
1478
|
+
Configuration,
|
|
1479
|
+
Subscribe
|
|
1480
|
+
} from '@pidginhost/sdk';
|
|
1481
|
+
|
|
1482
|
+
const configuration = new Configuration();
|
|
1483
|
+
const apiInstance = new EmailApi(configuration);
|
|
1484
|
+
|
|
1485
|
+
let subscribe: Subscribe; //
|
|
1486
|
+
|
|
1487
|
+
const { status, data } = await apiInstance.emailServicesCreate(
|
|
1488
|
+
subscribe
|
|
1489
|
+
);
|
|
1490
|
+
```
|
|
1491
|
+
|
|
1492
|
+
### Parameters
|
|
1493
|
+
|
|
1494
|
+
|Name | Type | Description | Notes|
|
|
1495
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1496
|
+
| **subscribe** | **Subscribe**| | |
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
### Return type
|
|
1500
|
+
|
|
1501
|
+
**EmailService**
|
|
1502
|
+
|
|
1503
|
+
### Authorization
|
|
1504
|
+
|
|
1505
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1506
|
+
|
|
1507
|
+
### HTTP request headers
|
|
1508
|
+
|
|
1509
|
+
- **Content-Type**: application/json
|
|
1510
|
+
- **Accept**: application/json
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
### HTTP response details
|
|
1514
|
+
| Status code | Description | Response headers |
|
|
1515
|
+
|-------------|-------------|------------------|
|
|
1516
|
+
|**201** | | - |
|
|
1517
|
+
|
|
1518
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1519
|
+
|
|
1520
|
+
# **emailServicesDedicatedIpCreate**
|
|
1521
|
+
> EmailService emailServicesDedicatedIpCreate()
|
|
1522
|
+
|
|
1523
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1524
|
+
|
|
1525
|
+
### Example
|
|
1526
|
+
|
|
1527
|
+
```typescript
|
|
1528
|
+
import {
|
|
1529
|
+
EmailApi,
|
|
1530
|
+
Configuration
|
|
1531
|
+
} from '@pidginhost/sdk';
|
|
1532
|
+
|
|
1533
|
+
const configuration = new Configuration();
|
|
1534
|
+
const apiInstance = new EmailApi(configuration);
|
|
1535
|
+
|
|
1536
|
+
let id: number; //A unique integer value identifying this email service. (default to undefined)
|
|
1537
|
+
|
|
1538
|
+
const { status, data } = await apiInstance.emailServicesDedicatedIpCreate(
|
|
1539
|
+
id
|
|
1540
|
+
);
|
|
1541
|
+
```
|
|
1542
|
+
|
|
1543
|
+
### Parameters
|
|
1544
|
+
|
|
1545
|
+
|Name | Type | Description | Notes|
|
|
1546
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1547
|
+
| **id** | [**number**] | A unique integer value identifying this email service. | defaults to undefined|
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
### Return type
|
|
1551
|
+
|
|
1552
|
+
**EmailService**
|
|
1553
|
+
|
|
1554
|
+
### Authorization
|
|
1555
|
+
|
|
1556
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1557
|
+
|
|
1558
|
+
### HTTP request headers
|
|
1559
|
+
|
|
1560
|
+
- **Content-Type**: Not defined
|
|
1561
|
+
- **Accept**: application/json
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
### HTTP response details
|
|
1565
|
+
| Status code | Description | Response headers |
|
|
1566
|
+
|-------------|-------------|------------------|
|
|
1567
|
+
|**200** | | - |
|
|
1568
|
+
|
|
1569
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1570
|
+
|
|
1571
|
+
# **emailServicesDedicatedIpDestroy**
|
|
1572
|
+
> emailServicesDedicatedIpDestroy()
|
|
1573
|
+
|
|
1574
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1575
|
+
|
|
1576
|
+
### Example
|
|
1577
|
+
|
|
1578
|
+
```typescript
|
|
1579
|
+
import {
|
|
1580
|
+
EmailApi,
|
|
1581
|
+
Configuration
|
|
1582
|
+
} from '@pidginhost/sdk';
|
|
1583
|
+
|
|
1584
|
+
const configuration = new Configuration();
|
|
1585
|
+
const apiInstance = new EmailApi(configuration);
|
|
1586
|
+
|
|
1587
|
+
let id: number; //A unique integer value identifying this email service. (default to undefined)
|
|
1588
|
+
|
|
1589
|
+
const { status, data } = await apiInstance.emailServicesDedicatedIpDestroy(
|
|
1590
|
+
id
|
|
1591
|
+
);
|
|
1592
|
+
```
|
|
1593
|
+
|
|
1594
|
+
### Parameters
|
|
1595
|
+
|
|
1596
|
+
|Name | Type | Description | Notes|
|
|
1597
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1598
|
+
| **id** | [**number**] | A unique integer value identifying this email service. | defaults to undefined|
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
### Return type
|
|
1602
|
+
|
|
1603
|
+
void (empty response body)
|
|
1604
|
+
|
|
1605
|
+
### Authorization
|
|
1606
|
+
|
|
1607
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1608
|
+
|
|
1609
|
+
### HTTP request headers
|
|
1610
|
+
|
|
1611
|
+
- **Content-Type**: Not defined
|
|
1612
|
+
- **Accept**: Not defined
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
### HTTP response details
|
|
1616
|
+
| Status code | Description | Response headers |
|
|
1617
|
+
|-------------|-------------|------------------|
|
|
1618
|
+
|**204** | No response body | - |
|
|
1619
|
+
|
|
1620
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1621
|
+
|
|
1622
|
+
# **emailServicesDestroy**
|
|
1623
|
+
> emailServicesDestroy()
|
|
1624
|
+
|
|
1625
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1626
|
+
|
|
1627
|
+
### Example
|
|
1628
|
+
|
|
1629
|
+
```typescript
|
|
1630
|
+
import {
|
|
1631
|
+
EmailApi,
|
|
1632
|
+
Configuration
|
|
1633
|
+
} from '@pidginhost/sdk';
|
|
1634
|
+
|
|
1635
|
+
const configuration = new Configuration();
|
|
1636
|
+
const apiInstance = new EmailApi(configuration);
|
|
1637
|
+
|
|
1638
|
+
let id: number; //A unique integer value identifying this email service. (default to undefined)
|
|
1639
|
+
|
|
1640
|
+
const { status, data } = await apiInstance.emailServicesDestroy(
|
|
1641
|
+
id
|
|
1642
|
+
);
|
|
1643
|
+
```
|
|
1644
|
+
|
|
1645
|
+
### Parameters
|
|
1646
|
+
|
|
1647
|
+
|Name | Type | Description | Notes|
|
|
1648
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1649
|
+
| **id** | [**number**] | A unique integer value identifying this email service. | defaults to undefined|
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
### Return type
|
|
1653
|
+
|
|
1654
|
+
void (empty response body)
|
|
1655
|
+
|
|
1656
|
+
### Authorization
|
|
1657
|
+
|
|
1658
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1659
|
+
|
|
1660
|
+
### HTTP request headers
|
|
1661
|
+
|
|
1662
|
+
- **Content-Type**: Not defined
|
|
1663
|
+
- **Accept**: Not defined
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
### HTTP response details
|
|
1667
|
+
| Status code | Description | Response headers |
|
|
1668
|
+
|-------------|-------------|------------------|
|
|
1669
|
+
|**204** | No response body | - |
|
|
1670
|
+
|
|
1671
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1672
|
+
|
|
1673
|
+
# **emailServicesDomainsCreate**
|
|
1674
|
+
> SendingDomain emailServicesDomainsCreate(domainAdd)
|
|
1675
|
+
|
|
1676
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1677
|
+
|
|
1678
|
+
### Example
|
|
1679
|
+
|
|
1680
|
+
```typescript
|
|
1681
|
+
import {
|
|
1682
|
+
EmailApi,
|
|
1683
|
+
Configuration,
|
|
1684
|
+
DomainAdd
|
|
1685
|
+
} from '@pidginhost/sdk';
|
|
1686
|
+
|
|
1687
|
+
const configuration = new Configuration();
|
|
1688
|
+
const apiInstance = new EmailApi(configuration);
|
|
1689
|
+
|
|
1690
|
+
let servicePk: number; // (default to undefined)
|
|
1691
|
+
let domainAdd: DomainAdd; //
|
|
1692
|
+
|
|
1693
|
+
const { status, data } = await apiInstance.emailServicesDomainsCreate(
|
|
1694
|
+
servicePk,
|
|
1695
|
+
domainAdd
|
|
1696
|
+
);
|
|
1697
|
+
```
|
|
1698
|
+
|
|
1699
|
+
### Parameters
|
|
1700
|
+
|
|
1701
|
+
|Name | Type | Description | Notes|
|
|
1702
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1703
|
+
| **domainAdd** | **DomainAdd**| | |
|
|
1704
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
### Return type
|
|
1708
|
+
|
|
1709
|
+
**SendingDomain**
|
|
1710
|
+
|
|
1711
|
+
### Authorization
|
|
1712
|
+
|
|
1713
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1714
|
+
|
|
1715
|
+
### HTTP request headers
|
|
1716
|
+
|
|
1717
|
+
- **Content-Type**: application/json
|
|
1718
|
+
- **Accept**: application/json
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
### HTTP response details
|
|
1722
|
+
| Status code | Description | Response headers |
|
|
1723
|
+
|-------------|-------------|------------------|
|
|
1724
|
+
|**201** | | - |
|
|
1725
|
+
|
|
1726
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1727
|
+
|
|
1728
|
+
# **emailServicesDomainsList**
|
|
1729
|
+
> PaginatedSendingDomainList emailServicesDomainsList()
|
|
1730
|
+
|
|
1731
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1732
|
+
|
|
1733
|
+
### Example
|
|
1734
|
+
|
|
1735
|
+
```typescript
|
|
1736
|
+
import {
|
|
1737
|
+
EmailApi,
|
|
1738
|
+
Configuration
|
|
1739
|
+
} from '@pidginhost/sdk';
|
|
1740
|
+
|
|
1741
|
+
const configuration = new Configuration();
|
|
1742
|
+
const apiInstance = new EmailApi(configuration);
|
|
1743
|
+
|
|
1744
|
+
let servicePk: number; // (default to undefined)
|
|
1745
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1746
|
+
|
|
1747
|
+
const { status, data } = await apiInstance.emailServicesDomainsList(
|
|
1748
|
+
servicePk,
|
|
1749
|
+
page
|
|
1750
|
+
);
|
|
1751
|
+
```
|
|
1752
|
+
|
|
1753
|
+
### Parameters
|
|
1754
|
+
|
|
1755
|
+
|Name | Type | Description | Notes|
|
|
1756
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1757
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
1758
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
### Return type
|
|
1762
|
+
|
|
1763
|
+
**PaginatedSendingDomainList**
|
|
1764
|
+
|
|
1765
|
+
### Authorization
|
|
1766
|
+
|
|
1767
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1768
|
+
|
|
1769
|
+
### HTTP request headers
|
|
1770
|
+
|
|
1771
|
+
- **Content-Type**: Not defined
|
|
1772
|
+
- **Accept**: application/json
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
### HTTP response details
|
|
1776
|
+
| Status code | Description | Response headers |
|
|
1777
|
+
|-------------|-------------|------------------|
|
|
1778
|
+
|**200** | | - |
|
|
1779
|
+
|
|
1780
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1781
|
+
|
|
1782
|
+
# **emailServicesList**
|
|
1783
|
+
> PaginatedEmailServiceList emailServicesList()
|
|
1784
|
+
|
|
1785
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1786
|
+
|
|
1787
|
+
### Example
|
|
1788
|
+
|
|
1789
|
+
```typescript
|
|
1790
|
+
import {
|
|
1791
|
+
EmailApi,
|
|
1792
|
+
Configuration
|
|
1793
|
+
} from '@pidginhost/sdk';
|
|
1794
|
+
|
|
1795
|
+
const configuration = new Configuration();
|
|
1796
|
+
const apiInstance = new EmailApi(configuration);
|
|
1797
|
+
|
|
1798
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1799
|
+
|
|
1800
|
+
const { status, data } = await apiInstance.emailServicesList(
|
|
1801
|
+
page
|
|
1802
|
+
);
|
|
1803
|
+
```
|
|
1804
|
+
|
|
1805
|
+
### Parameters
|
|
1806
|
+
|
|
1807
|
+
|Name | Type | Description | Notes|
|
|
1808
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1809
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
### Return type
|
|
1813
|
+
|
|
1814
|
+
**PaginatedEmailServiceList**
|
|
1815
|
+
|
|
1816
|
+
### Authorization
|
|
1817
|
+
|
|
1818
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1819
|
+
|
|
1820
|
+
### HTTP request headers
|
|
1821
|
+
|
|
1822
|
+
- **Content-Type**: Not defined
|
|
1823
|
+
- **Accept**: application/json
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
### HTTP response details
|
|
1827
|
+
| Status code | Description | Response headers |
|
|
1828
|
+
|-------------|-------------|------------------|
|
|
1829
|
+
|**200** | | - |
|
|
1830
|
+
|
|
1831
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1832
|
+
|
|
1833
|
+
# **emailServicesMessagesRetrieve**
|
|
1834
|
+
> emailServicesMessagesRetrieve()
|
|
1835
|
+
|
|
1836
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1837
|
+
|
|
1838
|
+
### Example
|
|
1839
|
+
|
|
1840
|
+
```typescript
|
|
1841
|
+
import {
|
|
1842
|
+
EmailApi,
|
|
1843
|
+
Configuration
|
|
1844
|
+
} from '@pidginhost/sdk';
|
|
1845
|
+
|
|
1846
|
+
const configuration = new Configuration();
|
|
1847
|
+
const apiInstance = new EmailApi(configuration);
|
|
1848
|
+
|
|
1849
|
+
let servicePk: number; // (default to undefined)
|
|
1850
|
+
|
|
1851
|
+
const { status, data } = await apiInstance.emailServicesMessagesRetrieve(
|
|
1852
|
+
servicePk
|
|
1853
|
+
);
|
|
1854
|
+
```
|
|
1855
|
+
|
|
1856
|
+
### Parameters
|
|
1857
|
+
|
|
1858
|
+
|Name | Type | Description | Notes|
|
|
1859
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1860
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
1861
|
+
|
|
1862
|
+
|
|
1863
|
+
### Return type
|
|
1864
|
+
|
|
1865
|
+
void (empty response body)
|
|
1866
|
+
|
|
1867
|
+
### Authorization
|
|
1868
|
+
|
|
1869
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1870
|
+
|
|
1871
|
+
### HTTP request headers
|
|
1872
|
+
|
|
1873
|
+
- **Content-Type**: Not defined
|
|
1874
|
+
- **Accept**: Not defined
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
### HTTP response details
|
|
1878
|
+
| Status code | Description | Response headers |
|
|
1879
|
+
|-------------|-------------|------------------|
|
|
1880
|
+
|**200** | No response body | - |
|
|
1881
|
+
|
|
1882
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1883
|
+
|
|
1884
|
+
# **emailServicesPartialUpdate**
|
|
1885
|
+
> EmailService emailServicesPartialUpdate()
|
|
1886
|
+
|
|
1887
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1888
|
+
|
|
1889
|
+
### Example
|
|
1890
|
+
|
|
1891
|
+
```typescript
|
|
1892
|
+
import {
|
|
1893
|
+
EmailApi,
|
|
1894
|
+
Configuration,
|
|
1895
|
+
PatchedEmailService
|
|
1896
|
+
} from '@pidginhost/sdk';
|
|
1897
|
+
|
|
1898
|
+
const configuration = new Configuration();
|
|
1899
|
+
const apiInstance = new EmailApi(configuration);
|
|
1900
|
+
|
|
1901
|
+
let id: number; //A unique integer value identifying this email service. (default to undefined)
|
|
1902
|
+
let patchedEmailService: PatchedEmailService; // (optional)
|
|
1903
|
+
|
|
1904
|
+
const { status, data } = await apiInstance.emailServicesPartialUpdate(
|
|
1905
|
+
id,
|
|
1906
|
+
patchedEmailService
|
|
1907
|
+
);
|
|
1908
|
+
```
|
|
1909
|
+
|
|
1910
|
+
### Parameters
|
|
1911
|
+
|
|
1912
|
+
|Name | Type | Description | Notes|
|
|
1913
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1914
|
+
| **patchedEmailService** | **PatchedEmailService**| | |
|
|
1915
|
+
| **id** | [**number**] | A unique integer value identifying this email service. | defaults to undefined|
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
### Return type
|
|
1919
|
+
|
|
1920
|
+
**EmailService**
|
|
1921
|
+
|
|
1922
|
+
### Authorization
|
|
1923
|
+
|
|
1924
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1925
|
+
|
|
1926
|
+
### HTTP request headers
|
|
1927
|
+
|
|
1928
|
+
- **Content-Type**: application/json
|
|
1929
|
+
- **Accept**: application/json
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
### HTTP response details
|
|
1933
|
+
| Status code | Description | Response headers |
|
|
1934
|
+
|-------------|-------------|------------------|
|
|
1935
|
+
|**200** | | - |
|
|
1936
|
+
|
|
1937
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1938
|
+
|
|
1939
|
+
# **emailServicesRestoreCreate**
|
|
1940
|
+
> EmailService emailServicesRestoreCreate()
|
|
1941
|
+
|
|
1942
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1943
|
+
|
|
1944
|
+
### Example
|
|
1945
|
+
|
|
1946
|
+
```typescript
|
|
1947
|
+
import {
|
|
1948
|
+
EmailApi,
|
|
1949
|
+
Configuration
|
|
1950
|
+
} from '@pidginhost/sdk';
|
|
1951
|
+
|
|
1952
|
+
const configuration = new Configuration();
|
|
1953
|
+
const apiInstance = new EmailApi(configuration);
|
|
1954
|
+
|
|
1955
|
+
let id: number; //A unique integer value identifying this email service. (default to undefined)
|
|
1956
|
+
|
|
1957
|
+
const { status, data } = await apiInstance.emailServicesRestoreCreate(
|
|
1958
|
+
id
|
|
1959
|
+
);
|
|
1960
|
+
```
|
|
1961
|
+
|
|
1962
|
+
### Parameters
|
|
1963
|
+
|
|
1964
|
+
|Name | Type | Description | Notes|
|
|
1965
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1966
|
+
| **id** | [**number**] | A unique integer value identifying this email service. | defaults to undefined|
|
|
1967
|
+
|
|
1968
|
+
|
|
1969
|
+
### Return type
|
|
1970
|
+
|
|
1971
|
+
**EmailService**
|
|
1972
|
+
|
|
1973
|
+
### Authorization
|
|
1974
|
+
|
|
1975
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1976
|
+
|
|
1977
|
+
### HTTP request headers
|
|
1978
|
+
|
|
1979
|
+
- **Content-Type**: Not defined
|
|
1980
|
+
- **Accept**: application/json
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
### HTTP response details
|
|
1984
|
+
| Status code | Description | Response headers |
|
|
1985
|
+
|-------------|-------------|------------------|
|
|
1986
|
+
|**200** | | - |
|
|
1987
|
+
|
|
1988
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1989
|
+
|
|
1990
|
+
# **emailServicesRetrieve**
|
|
1991
|
+
> EmailService emailServicesRetrieve()
|
|
1992
|
+
|
|
1993
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1994
|
+
|
|
1995
|
+
### Example
|
|
1996
|
+
|
|
1997
|
+
```typescript
|
|
1998
|
+
import {
|
|
1999
|
+
EmailApi,
|
|
2000
|
+
Configuration
|
|
2001
|
+
} from '@pidginhost/sdk';
|
|
2002
|
+
|
|
2003
|
+
const configuration = new Configuration();
|
|
2004
|
+
const apiInstance = new EmailApi(configuration);
|
|
2005
|
+
|
|
2006
|
+
let id: number; //A unique integer value identifying this email service. (default to undefined)
|
|
2007
|
+
|
|
2008
|
+
const { status, data } = await apiInstance.emailServicesRetrieve(
|
|
2009
|
+
id
|
|
2010
|
+
);
|
|
2011
|
+
```
|
|
2012
|
+
|
|
2013
|
+
### Parameters
|
|
2014
|
+
|
|
2015
|
+
|Name | Type | Description | Notes|
|
|
2016
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2017
|
+
| **id** | [**number**] | A unique integer value identifying this email service. | defaults to undefined|
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
### Return type
|
|
2021
|
+
|
|
2022
|
+
**EmailService**
|
|
2023
|
+
|
|
2024
|
+
### Authorization
|
|
2025
|
+
|
|
2026
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2027
|
+
|
|
2028
|
+
### HTTP request headers
|
|
2029
|
+
|
|
2030
|
+
- **Content-Type**: Not defined
|
|
2031
|
+
- **Accept**: application/json
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
### HTTP response details
|
|
2035
|
+
| Status code | Description | Response headers |
|
|
2036
|
+
|-------------|-------------|------------------|
|
|
2037
|
+
|**200** | | - |
|
|
2038
|
+
|
|
2039
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2040
|
+
|
|
2041
|
+
# **emailServicesSandboxAddressesCreate**
|
|
2042
|
+
> SandboxAddress emailServicesSandboxAddressesCreate(sandboxAddress)
|
|
2043
|
+
|
|
2044
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2045
|
+
|
|
2046
|
+
### Example
|
|
2047
|
+
|
|
2048
|
+
```typescript
|
|
2049
|
+
import {
|
|
2050
|
+
EmailApi,
|
|
2051
|
+
Configuration,
|
|
2052
|
+
SandboxAddress
|
|
2053
|
+
} from '@pidginhost/sdk';
|
|
2054
|
+
|
|
2055
|
+
const configuration = new Configuration();
|
|
2056
|
+
const apiInstance = new EmailApi(configuration);
|
|
2057
|
+
|
|
2058
|
+
let servicePk: number; // (default to undefined)
|
|
2059
|
+
let sandboxAddress: SandboxAddress; //
|
|
2060
|
+
|
|
2061
|
+
const { status, data } = await apiInstance.emailServicesSandboxAddressesCreate(
|
|
2062
|
+
servicePk,
|
|
2063
|
+
sandboxAddress
|
|
2064
|
+
);
|
|
2065
|
+
```
|
|
2066
|
+
|
|
2067
|
+
### Parameters
|
|
2068
|
+
|
|
2069
|
+
|Name | Type | Description | Notes|
|
|
2070
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2071
|
+
| **sandboxAddress** | **SandboxAddress**| | |
|
|
2072
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
### Return type
|
|
2076
|
+
|
|
2077
|
+
**SandboxAddress**
|
|
2078
|
+
|
|
2079
|
+
### Authorization
|
|
2080
|
+
|
|
2081
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2082
|
+
|
|
2083
|
+
### HTTP request headers
|
|
2084
|
+
|
|
2085
|
+
- **Content-Type**: application/json
|
|
2086
|
+
- **Accept**: application/json
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
### HTTP response details
|
|
2090
|
+
| Status code | Description | Response headers |
|
|
2091
|
+
|-------------|-------------|------------------|
|
|
2092
|
+
|**201** | | - |
|
|
2093
|
+
|
|
2094
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2095
|
+
|
|
2096
|
+
# **emailServicesSandboxAddressesList**
|
|
2097
|
+
> PaginatedSandboxAddressList emailServicesSandboxAddressesList()
|
|
2098
|
+
|
|
2099
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2100
|
+
|
|
2101
|
+
### Example
|
|
2102
|
+
|
|
2103
|
+
```typescript
|
|
2104
|
+
import {
|
|
2105
|
+
EmailApi,
|
|
2106
|
+
Configuration
|
|
2107
|
+
} from '@pidginhost/sdk';
|
|
2108
|
+
|
|
2109
|
+
const configuration = new Configuration();
|
|
2110
|
+
const apiInstance = new EmailApi(configuration);
|
|
2111
|
+
|
|
2112
|
+
let servicePk: number; // (default to undefined)
|
|
2113
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
2114
|
+
|
|
2115
|
+
const { status, data } = await apiInstance.emailServicesSandboxAddressesList(
|
|
2116
|
+
servicePk,
|
|
2117
|
+
page
|
|
2118
|
+
);
|
|
2119
|
+
```
|
|
2120
|
+
|
|
2121
|
+
### Parameters
|
|
2122
|
+
|
|
2123
|
+
|Name | Type | Description | Notes|
|
|
2124
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2125
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
2126
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
### Return type
|
|
2130
|
+
|
|
2131
|
+
**PaginatedSandboxAddressList**
|
|
2132
|
+
|
|
2133
|
+
### Authorization
|
|
2134
|
+
|
|
2135
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2136
|
+
|
|
2137
|
+
### HTTP request headers
|
|
2138
|
+
|
|
2139
|
+
- **Content-Type**: Not defined
|
|
2140
|
+
- **Accept**: application/json
|
|
2141
|
+
|
|
2142
|
+
|
|
2143
|
+
### HTTP response details
|
|
2144
|
+
| Status code | Description | Response headers |
|
|
2145
|
+
|-------------|-------------|------------------|
|
|
2146
|
+
|**200** | | - |
|
|
2147
|
+
|
|
2148
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2149
|
+
|
|
2150
|
+
# **emailServicesSmtpCredentialsCreate**
|
|
2151
|
+
> SmtpCredential emailServicesSmtpCredentialsCreate()
|
|
2152
|
+
|
|
2153
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2154
|
+
|
|
2155
|
+
### Example
|
|
2156
|
+
|
|
2157
|
+
```typescript
|
|
2158
|
+
import {
|
|
2159
|
+
EmailApi,
|
|
2160
|
+
Configuration,
|
|
2161
|
+
SmtpCredential
|
|
2162
|
+
} from '@pidginhost/sdk';
|
|
2163
|
+
|
|
2164
|
+
const configuration = new Configuration();
|
|
2165
|
+
const apiInstance = new EmailApi(configuration);
|
|
2166
|
+
|
|
2167
|
+
let servicePk: number; // (default to undefined)
|
|
2168
|
+
let smtpCredential: SmtpCredential; // (optional)
|
|
2169
|
+
|
|
2170
|
+
const { status, data } = await apiInstance.emailServicesSmtpCredentialsCreate(
|
|
2171
|
+
servicePk,
|
|
2172
|
+
smtpCredential
|
|
2173
|
+
);
|
|
2174
|
+
```
|
|
2175
|
+
|
|
2176
|
+
### Parameters
|
|
2177
|
+
|
|
2178
|
+
|Name | Type | Description | Notes|
|
|
2179
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2180
|
+
| **smtpCredential** | **SmtpCredential**| | |
|
|
2181
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
### Return type
|
|
2185
|
+
|
|
2186
|
+
**SmtpCredential**
|
|
2187
|
+
|
|
2188
|
+
### Authorization
|
|
2189
|
+
|
|
2190
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2191
|
+
|
|
2192
|
+
### HTTP request headers
|
|
2193
|
+
|
|
2194
|
+
- **Content-Type**: application/json
|
|
2195
|
+
- **Accept**: application/json
|
|
2196
|
+
|
|
2197
|
+
|
|
2198
|
+
### HTTP response details
|
|
2199
|
+
| Status code | Description | Response headers |
|
|
2200
|
+
|-------------|-------------|------------------|
|
|
2201
|
+
|**201** | | - |
|
|
2202
|
+
|
|
2203
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2204
|
+
|
|
2205
|
+
# **emailServicesSmtpCredentialsList**
|
|
2206
|
+
> PaginatedSmtpCredentialList emailServicesSmtpCredentialsList()
|
|
2207
|
+
|
|
2208
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2209
|
+
|
|
2210
|
+
### Example
|
|
2211
|
+
|
|
2212
|
+
```typescript
|
|
2213
|
+
import {
|
|
2214
|
+
EmailApi,
|
|
2215
|
+
Configuration
|
|
2216
|
+
} from '@pidginhost/sdk';
|
|
2217
|
+
|
|
2218
|
+
const configuration = new Configuration();
|
|
2219
|
+
const apiInstance = new EmailApi(configuration);
|
|
2220
|
+
|
|
2221
|
+
let servicePk: number; // (default to undefined)
|
|
2222
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
2223
|
+
|
|
2224
|
+
const { status, data } = await apiInstance.emailServicesSmtpCredentialsList(
|
|
2225
|
+
servicePk,
|
|
2226
|
+
page
|
|
2227
|
+
);
|
|
2228
|
+
```
|
|
2229
|
+
|
|
2230
|
+
### Parameters
|
|
2231
|
+
|
|
2232
|
+
|Name | Type | Description | Notes|
|
|
2233
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2234
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
2235
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
2236
|
+
|
|
2237
|
+
|
|
2238
|
+
### Return type
|
|
2239
|
+
|
|
2240
|
+
**PaginatedSmtpCredentialList**
|
|
2241
|
+
|
|
2242
|
+
### Authorization
|
|
2243
|
+
|
|
2244
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2245
|
+
|
|
2246
|
+
### HTTP request headers
|
|
2247
|
+
|
|
2248
|
+
- **Content-Type**: Not defined
|
|
2249
|
+
- **Accept**: application/json
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
### HTTP response details
|
|
2253
|
+
| Status code | Description | Response headers |
|
|
2254
|
+
|-------------|-------------|------------------|
|
|
2255
|
+
|**200** | | - |
|
|
2256
|
+
|
|
2257
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2258
|
+
|
|
2259
|
+
# **emailServicesStatsRetrieve**
|
|
2260
|
+
> emailServicesStatsRetrieve()
|
|
2261
|
+
|
|
2262
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2263
|
+
|
|
2264
|
+
### Example
|
|
2265
|
+
|
|
2266
|
+
```typescript
|
|
2267
|
+
import {
|
|
2268
|
+
EmailApi,
|
|
2269
|
+
Configuration
|
|
2270
|
+
} from '@pidginhost/sdk';
|
|
2271
|
+
|
|
2272
|
+
const configuration = new Configuration();
|
|
2273
|
+
const apiInstance = new EmailApi(configuration);
|
|
2274
|
+
|
|
2275
|
+
let servicePk: number; // (default to undefined)
|
|
2276
|
+
|
|
2277
|
+
const { status, data } = await apiInstance.emailServicesStatsRetrieve(
|
|
2278
|
+
servicePk
|
|
2279
|
+
);
|
|
2280
|
+
```
|
|
2281
|
+
|
|
2282
|
+
### Parameters
|
|
2283
|
+
|
|
2284
|
+
|Name | Type | Description | Notes|
|
|
2285
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2286
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
2287
|
+
|
|
2288
|
+
|
|
2289
|
+
### Return type
|
|
2290
|
+
|
|
2291
|
+
void (empty response body)
|
|
2292
|
+
|
|
2293
|
+
### Authorization
|
|
2294
|
+
|
|
2295
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2296
|
+
|
|
2297
|
+
### HTTP request headers
|
|
2298
|
+
|
|
2299
|
+
- **Content-Type**: Not defined
|
|
2300
|
+
- **Accept**: Not defined
|
|
2301
|
+
|
|
2302
|
+
|
|
2303
|
+
### HTTP response details
|
|
2304
|
+
| Status code | Description | Response headers |
|
|
2305
|
+
|-------------|-------------|------------------|
|
|
2306
|
+
|**200** | No response body | - |
|
|
2307
|
+
|
|
2308
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2309
|
+
|
|
2310
|
+
# **emailServicesSuppressionsCreate**
|
|
2311
|
+
> SuppressionEntry emailServicesSuppressionsCreate()
|
|
2312
|
+
|
|
2313
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2314
|
+
|
|
2315
|
+
### Example
|
|
2316
|
+
|
|
2317
|
+
```typescript
|
|
2318
|
+
import {
|
|
2319
|
+
EmailApi,
|
|
2320
|
+
Configuration,
|
|
2321
|
+
SuppressionEntry
|
|
2322
|
+
} from '@pidginhost/sdk';
|
|
2323
|
+
|
|
2324
|
+
const configuration = new Configuration();
|
|
2325
|
+
const apiInstance = new EmailApi(configuration);
|
|
2326
|
+
|
|
2327
|
+
let servicePk: number; // (default to undefined)
|
|
2328
|
+
let suppressionEntry: SuppressionEntry; // (optional)
|
|
2329
|
+
|
|
2330
|
+
const { status, data } = await apiInstance.emailServicesSuppressionsCreate(
|
|
2331
|
+
servicePk,
|
|
2332
|
+
suppressionEntry
|
|
2333
|
+
);
|
|
2334
|
+
```
|
|
2335
|
+
|
|
2336
|
+
### Parameters
|
|
2337
|
+
|
|
2338
|
+
|Name | Type | Description | Notes|
|
|
2339
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2340
|
+
| **suppressionEntry** | **SuppressionEntry**| | |
|
|
2341
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
2342
|
+
|
|
2343
|
+
|
|
2344
|
+
### Return type
|
|
2345
|
+
|
|
2346
|
+
**SuppressionEntry**
|
|
2347
|
+
|
|
2348
|
+
### Authorization
|
|
2349
|
+
|
|
2350
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2351
|
+
|
|
2352
|
+
### HTTP request headers
|
|
2353
|
+
|
|
2354
|
+
- **Content-Type**: application/json
|
|
2355
|
+
- **Accept**: application/json
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
### HTTP response details
|
|
2359
|
+
| Status code | Description | Response headers |
|
|
2360
|
+
|-------------|-------------|------------------|
|
|
2361
|
+
|**201** | | - |
|
|
2362
|
+
|
|
2363
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2364
|
+
|
|
2365
|
+
# **emailServicesSuppressionsList**
|
|
2366
|
+
> PaginatedSuppressionEntryList emailServicesSuppressionsList()
|
|
2367
|
+
|
|
2368
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2369
|
+
|
|
2370
|
+
### Example
|
|
2371
|
+
|
|
2372
|
+
```typescript
|
|
2373
|
+
import {
|
|
2374
|
+
EmailApi,
|
|
2375
|
+
Configuration
|
|
2376
|
+
} from '@pidginhost/sdk';
|
|
2377
|
+
|
|
2378
|
+
const configuration = new Configuration();
|
|
2379
|
+
const apiInstance = new EmailApi(configuration);
|
|
2380
|
+
|
|
2381
|
+
let servicePk: number; // (default to undefined)
|
|
2382
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
2383
|
+
|
|
2384
|
+
const { status, data } = await apiInstance.emailServicesSuppressionsList(
|
|
2385
|
+
servicePk,
|
|
2386
|
+
page
|
|
2387
|
+
);
|
|
2388
|
+
```
|
|
2389
|
+
|
|
2390
|
+
### Parameters
|
|
2391
|
+
|
|
2392
|
+
|Name | Type | Description | Notes|
|
|
2393
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2394
|
+
| **servicePk** | [**number**] | | defaults to undefined|
|
|
2395
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
### Return type
|
|
2399
|
+
|
|
2400
|
+
**PaginatedSuppressionEntryList**
|
|
2401
|
+
|
|
2402
|
+
### Authorization
|
|
2403
|
+
|
|
2404
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2405
|
+
|
|
2406
|
+
### HTTP request headers
|
|
2407
|
+
|
|
2408
|
+
- **Content-Type**: Not defined
|
|
2409
|
+
- **Accept**: application/json
|
|
2410
|
+
|
|
2411
|
+
|
|
2412
|
+
### HTTP response details
|
|
2413
|
+
| Status code | Description | Response headers |
|
|
2414
|
+
|-------------|-------------|------------------|
|
|
2415
|
+
|**200** | | - |
|
|
2416
|
+
|
|
2417
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2418
|
+
|
|
2419
|
+
# **emailSmtpCredentialsCreate**
|
|
2420
|
+
> SmtpCredential emailSmtpCredentialsCreate()
|
|
2421
|
+
|
|
2422
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2423
|
+
|
|
2424
|
+
### Example
|
|
2425
|
+
|
|
2426
|
+
```typescript
|
|
2427
|
+
import {
|
|
2428
|
+
EmailApi,
|
|
2429
|
+
Configuration,
|
|
2430
|
+
SmtpCredential
|
|
2431
|
+
} from '@pidginhost/sdk';
|
|
2432
|
+
|
|
2433
|
+
const configuration = new Configuration();
|
|
2434
|
+
const apiInstance = new EmailApi(configuration);
|
|
2435
|
+
|
|
2436
|
+
let smtpCredential: SmtpCredential; // (optional)
|
|
2437
|
+
|
|
2438
|
+
const { status, data } = await apiInstance.emailSmtpCredentialsCreate(
|
|
2439
|
+
smtpCredential
|
|
2440
|
+
);
|
|
2441
|
+
```
|
|
2442
|
+
|
|
2443
|
+
### Parameters
|
|
2444
|
+
|
|
2445
|
+
|Name | Type | Description | Notes|
|
|
2446
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2447
|
+
| **smtpCredential** | **SmtpCredential**| | |
|
|
2448
|
+
|
|
2449
|
+
|
|
2450
|
+
### Return type
|
|
2451
|
+
|
|
2452
|
+
**SmtpCredential**
|
|
2453
|
+
|
|
2454
|
+
### Authorization
|
|
2455
|
+
|
|
2456
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2457
|
+
|
|
2458
|
+
### HTTP request headers
|
|
2459
|
+
|
|
2460
|
+
- **Content-Type**: application/json
|
|
2461
|
+
- **Accept**: application/json
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
### HTTP response details
|
|
2465
|
+
| Status code | Description | Response headers |
|
|
2466
|
+
|-------------|-------------|------------------|
|
|
2467
|
+
|**201** | | - |
|
|
2468
|
+
|
|
2469
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2470
|
+
|
|
2471
|
+
# **emailSmtpCredentialsDestroy**
|
|
2472
|
+
> emailSmtpCredentialsDestroy()
|
|
2473
|
+
|
|
2474
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2475
|
+
|
|
2476
|
+
### Example
|
|
2477
|
+
|
|
2478
|
+
```typescript
|
|
2479
|
+
import {
|
|
2480
|
+
EmailApi,
|
|
2481
|
+
Configuration
|
|
2482
|
+
} from '@pidginhost/sdk';
|
|
2483
|
+
|
|
2484
|
+
const configuration = new Configuration();
|
|
2485
|
+
const apiInstance = new EmailApi(configuration);
|
|
2486
|
+
|
|
2487
|
+
let id: number; //A unique integer value identifying this smtp credential. (default to undefined)
|
|
2488
|
+
|
|
2489
|
+
const { status, data } = await apiInstance.emailSmtpCredentialsDestroy(
|
|
2490
|
+
id
|
|
2491
|
+
);
|
|
2492
|
+
```
|
|
2493
|
+
|
|
2494
|
+
### Parameters
|
|
2495
|
+
|
|
2496
|
+
|Name | Type | Description | Notes|
|
|
2497
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2498
|
+
| **id** | [**number**] | A unique integer value identifying this smtp credential. | defaults to undefined|
|
|
2499
|
+
|
|
2500
|
+
|
|
2501
|
+
### Return type
|
|
2502
|
+
|
|
2503
|
+
void (empty response body)
|
|
2504
|
+
|
|
2505
|
+
### Authorization
|
|
2506
|
+
|
|
2507
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2508
|
+
|
|
2509
|
+
### HTTP request headers
|
|
2510
|
+
|
|
2511
|
+
- **Content-Type**: Not defined
|
|
2512
|
+
- **Accept**: Not defined
|
|
2513
|
+
|
|
2514
|
+
|
|
2515
|
+
### HTTP response details
|
|
2516
|
+
| Status code | Description | Response headers |
|
|
2517
|
+
|-------------|-------------|------------------|
|
|
2518
|
+
|**204** | No response body | - |
|
|
2519
|
+
|
|
2520
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2521
|
+
|
|
2522
|
+
# **emailSmtpCredentialsList**
|
|
2523
|
+
> PaginatedSmtpCredentialList emailSmtpCredentialsList()
|
|
2524
|
+
|
|
2525
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2526
|
+
|
|
2527
|
+
### Example
|
|
2528
|
+
|
|
2529
|
+
```typescript
|
|
2530
|
+
import {
|
|
2531
|
+
EmailApi,
|
|
2532
|
+
Configuration
|
|
2533
|
+
} from '@pidginhost/sdk';
|
|
2534
|
+
|
|
2535
|
+
const configuration = new Configuration();
|
|
2536
|
+
const apiInstance = new EmailApi(configuration);
|
|
2537
|
+
|
|
2538
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
2539
|
+
|
|
2540
|
+
const { status, data } = await apiInstance.emailSmtpCredentialsList(
|
|
2541
|
+
page
|
|
2542
|
+
);
|
|
2543
|
+
```
|
|
2544
|
+
|
|
2545
|
+
### Parameters
|
|
2546
|
+
|
|
2547
|
+
|Name | Type | Description | Notes|
|
|
2548
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2549
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
2550
|
+
|
|
2551
|
+
|
|
2552
|
+
### Return type
|
|
2553
|
+
|
|
2554
|
+
**PaginatedSmtpCredentialList**
|
|
2555
|
+
|
|
2556
|
+
### Authorization
|
|
2557
|
+
|
|
2558
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2559
|
+
|
|
2560
|
+
### HTTP request headers
|
|
2561
|
+
|
|
2562
|
+
- **Content-Type**: Not defined
|
|
2563
|
+
- **Accept**: application/json
|
|
2564
|
+
|
|
2565
|
+
|
|
2566
|
+
### HTTP response details
|
|
2567
|
+
| Status code | Description | Response headers |
|
|
2568
|
+
|-------------|-------------|------------------|
|
|
2569
|
+
|**200** | | - |
|
|
2570
|
+
|
|
2571
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2572
|
+
|
|
2573
|
+
# **emailSmtpCredentialsRetrieve**
|
|
2574
|
+
> SmtpCredential emailSmtpCredentialsRetrieve()
|
|
2575
|
+
|
|
2576
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2577
|
+
|
|
2578
|
+
### Example
|
|
2579
|
+
|
|
2580
|
+
```typescript
|
|
2581
|
+
import {
|
|
2582
|
+
EmailApi,
|
|
2583
|
+
Configuration
|
|
2584
|
+
} from '@pidginhost/sdk';
|
|
2585
|
+
|
|
2586
|
+
const configuration = new Configuration();
|
|
2587
|
+
const apiInstance = new EmailApi(configuration);
|
|
2588
|
+
|
|
2589
|
+
let id: number; //A unique integer value identifying this smtp credential. (default to undefined)
|
|
2590
|
+
|
|
2591
|
+
const { status, data } = await apiInstance.emailSmtpCredentialsRetrieve(
|
|
2592
|
+
id
|
|
2593
|
+
);
|
|
2594
|
+
```
|
|
2595
|
+
|
|
2596
|
+
### Parameters
|
|
2597
|
+
|
|
2598
|
+
|Name | Type | Description | Notes|
|
|
2599
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2600
|
+
| **id** | [**number**] | A unique integer value identifying this smtp credential. | defaults to undefined|
|
|
2601
|
+
|
|
2602
|
+
|
|
2603
|
+
### Return type
|
|
2604
|
+
|
|
2605
|
+
**SmtpCredential**
|
|
2606
|
+
|
|
2607
|
+
### Authorization
|
|
2608
|
+
|
|
2609
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2610
|
+
|
|
2611
|
+
### HTTP request headers
|
|
2612
|
+
|
|
2613
|
+
- **Content-Type**: Not defined
|
|
2614
|
+
- **Accept**: application/json
|
|
2615
|
+
|
|
2616
|
+
|
|
2617
|
+
### HTTP response details
|
|
2618
|
+
| Status code | Description | Response headers |
|
|
2619
|
+
|-------------|-------------|------------------|
|
|
2620
|
+
|**200** | | - |
|
|
2621
|
+
|
|
2622
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2623
|
+
|
|
2624
|
+
# **emailSuppressionsCreate**
|
|
2625
|
+
> SuppressionEntry emailSuppressionsCreate()
|
|
2626
|
+
|
|
2627
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2628
|
+
|
|
2629
|
+
### Example
|
|
2630
|
+
|
|
2631
|
+
```typescript
|
|
2632
|
+
import {
|
|
2633
|
+
EmailApi,
|
|
2634
|
+
Configuration,
|
|
2635
|
+
SuppressionEntry
|
|
2636
|
+
} from '@pidginhost/sdk';
|
|
2637
|
+
|
|
2638
|
+
const configuration = new Configuration();
|
|
2639
|
+
const apiInstance = new EmailApi(configuration);
|
|
2640
|
+
|
|
2641
|
+
let suppressionEntry: SuppressionEntry; // (optional)
|
|
2642
|
+
|
|
2643
|
+
const { status, data } = await apiInstance.emailSuppressionsCreate(
|
|
2644
|
+
suppressionEntry
|
|
2645
|
+
);
|
|
2646
|
+
```
|
|
2647
|
+
|
|
2648
|
+
### Parameters
|
|
2649
|
+
|
|
2650
|
+
|Name | Type | Description | Notes|
|
|
2651
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2652
|
+
| **suppressionEntry** | **SuppressionEntry**| | |
|
|
2653
|
+
|
|
2654
|
+
|
|
2655
|
+
### Return type
|
|
2656
|
+
|
|
2657
|
+
**SuppressionEntry**
|
|
2658
|
+
|
|
2659
|
+
### Authorization
|
|
2660
|
+
|
|
2661
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2662
|
+
|
|
2663
|
+
### HTTP request headers
|
|
2664
|
+
|
|
2665
|
+
- **Content-Type**: application/json
|
|
2666
|
+
- **Accept**: application/json
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
### HTTP response details
|
|
2670
|
+
| Status code | Description | Response headers |
|
|
2671
|
+
|-------------|-------------|------------------|
|
|
2672
|
+
|**201** | | - |
|
|
2673
|
+
|
|
2674
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2675
|
+
|
|
2676
|
+
# **emailSuppressionsDestroy**
|
|
2677
|
+
> emailSuppressionsDestroy()
|
|
2678
|
+
|
|
2679
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2680
|
+
|
|
2681
|
+
### Example
|
|
2682
|
+
|
|
2683
|
+
```typescript
|
|
2684
|
+
import {
|
|
2685
|
+
EmailApi,
|
|
2686
|
+
Configuration
|
|
2687
|
+
} from '@pidginhost/sdk';
|
|
2688
|
+
|
|
2689
|
+
const configuration = new Configuration();
|
|
2690
|
+
const apiInstance = new EmailApi(configuration);
|
|
2691
|
+
|
|
2692
|
+
let id: number; //A unique integer value identifying this suppression entry. (default to undefined)
|
|
2693
|
+
|
|
2694
|
+
const { status, data } = await apiInstance.emailSuppressionsDestroy(
|
|
2695
|
+
id
|
|
2696
|
+
);
|
|
2697
|
+
```
|
|
2698
|
+
|
|
2699
|
+
### Parameters
|
|
2700
|
+
|
|
2701
|
+
|Name | Type | Description | Notes|
|
|
2702
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2703
|
+
| **id** | [**number**] | A unique integer value identifying this suppression entry. | defaults to undefined|
|
|
2704
|
+
|
|
2705
|
+
|
|
2706
|
+
### Return type
|
|
2707
|
+
|
|
2708
|
+
void (empty response body)
|
|
2709
|
+
|
|
2710
|
+
### Authorization
|
|
2711
|
+
|
|
2712
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2713
|
+
|
|
2714
|
+
### HTTP request headers
|
|
2715
|
+
|
|
2716
|
+
- **Content-Type**: Not defined
|
|
2717
|
+
- **Accept**: Not defined
|
|
2718
|
+
|
|
2719
|
+
|
|
2720
|
+
### HTTP response details
|
|
2721
|
+
| Status code | Description | Response headers |
|
|
2722
|
+
|-------------|-------------|------------------|
|
|
2723
|
+
|**204** | No response body | - |
|
|
2724
|
+
|
|
2725
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2726
|
+
|
|
2727
|
+
# **emailSuppressionsList**
|
|
2728
|
+
> PaginatedSuppressionEntryList emailSuppressionsList()
|
|
2729
|
+
|
|
2730
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2731
|
+
|
|
2732
|
+
### Example
|
|
2733
|
+
|
|
2734
|
+
```typescript
|
|
2735
|
+
import {
|
|
2736
|
+
EmailApi,
|
|
2737
|
+
Configuration
|
|
2738
|
+
} from '@pidginhost/sdk';
|
|
2739
|
+
|
|
2740
|
+
const configuration = new Configuration();
|
|
2741
|
+
const apiInstance = new EmailApi(configuration);
|
|
2742
|
+
|
|
2743
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
2744
|
+
|
|
2745
|
+
const { status, data } = await apiInstance.emailSuppressionsList(
|
|
2746
|
+
page
|
|
2747
|
+
);
|
|
2748
|
+
```
|
|
2749
|
+
|
|
2750
|
+
### Parameters
|
|
2751
|
+
|
|
2752
|
+
|Name | Type | Description | Notes|
|
|
2753
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2754
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
2755
|
+
|
|
2756
|
+
|
|
2757
|
+
### Return type
|
|
2758
|
+
|
|
2759
|
+
**PaginatedSuppressionEntryList**
|
|
2760
|
+
|
|
2761
|
+
### Authorization
|
|
2762
|
+
|
|
2763
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2764
|
+
|
|
2765
|
+
### HTTP request headers
|
|
2766
|
+
|
|
2767
|
+
- **Content-Type**: Not defined
|
|
2768
|
+
- **Accept**: application/json
|
|
2769
|
+
|
|
2770
|
+
|
|
2771
|
+
### HTTP response details
|
|
2772
|
+
| Status code | Description | Response headers |
|
|
2773
|
+
|-------------|-------------|------------------|
|
|
2774
|
+
|**200** | | - |
|
|
2775
|
+
|
|
2776
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2777
|
+
|
|
2778
|
+
# **emailSuppressionsRetrieve**
|
|
2779
|
+
> SuppressionEntry emailSuppressionsRetrieve()
|
|
2780
|
+
|
|
2781
|
+
Require complete user profile for provisioning (create) API actions.
|
|
2782
|
+
|
|
2783
|
+
### Example
|
|
2784
|
+
|
|
2785
|
+
```typescript
|
|
2786
|
+
import {
|
|
2787
|
+
EmailApi,
|
|
2788
|
+
Configuration
|
|
2789
|
+
} from '@pidginhost/sdk';
|
|
2790
|
+
|
|
2791
|
+
const configuration = new Configuration();
|
|
2792
|
+
const apiInstance = new EmailApi(configuration);
|
|
2793
|
+
|
|
2794
|
+
let id: number; //A unique integer value identifying this suppression entry. (default to undefined)
|
|
2795
|
+
|
|
2796
|
+
const { status, data } = await apiInstance.emailSuppressionsRetrieve(
|
|
2797
|
+
id
|
|
2798
|
+
);
|
|
2799
|
+
```
|
|
2800
|
+
|
|
2801
|
+
### Parameters
|
|
2802
|
+
|
|
2803
|
+
|Name | Type | Description | Notes|
|
|
2804
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2805
|
+
| **id** | [**number**] | A unique integer value identifying this suppression entry. | defaults to undefined|
|
|
2806
|
+
|
|
2807
|
+
|
|
2808
|
+
### Return type
|
|
2809
|
+
|
|
2810
|
+
**SuppressionEntry**
|
|
2811
|
+
|
|
2812
|
+
### Authorization
|
|
2813
|
+
|
|
2814
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
2815
|
+
|
|
2816
|
+
### HTTP request headers
|
|
2817
|
+
|
|
2818
|
+
- **Content-Type**: Not defined
|
|
2819
|
+
- **Accept**: application/json
|
|
2820
|
+
|
|
2821
|
+
|
|
2822
|
+
### HTTP response details
|
|
2823
|
+
| Status code | Description | Response headers |
|
|
2824
|
+
|-------------|-------------|------------------|
|
|
2825
|
+
|**200** | | - |
|
|
2826
|
+
|
|
2827
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2828
|
+
|