mailslurp_client 7.0.7 → 8.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/mailslurp_client.rb +19 -3
- metadata +14 -345
- data/Gemfile +0 -9
- data/LICENSE +0 -22
- data/README.md +0 -226
- data/Rakefile +0 -10
- data/docs/AttachmentControllerApi.md +0 -124
- data/docs/AttachmentMetaData.md +0 -23
- data/docs/BasicAuthOptions.md +0 -19
- data/docs/BulkActionsControllerApi.md +0 -165
- data/docs/BulkSendEmailOptions.md +0 -19
- data/docs/CommonActionsControllerApi.md +0 -167
- data/docs/ContactControllerApi.md +0 -274
- data/docs/ContactDto.md +0 -31
- data/docs/ContactProjection.md +0 -27
- data/docs/CreateContactOptions.md +0 -31
- data/docs/CreateDomainOptions.md +0 -17
- data/docs/CreateGroupOptions.md +0 -19
- data/docs/CreateTemplateOptions.md +0 -19
- data/docs/CreateWebhookOptions.md +0 -21
- data/docs/DomainControllerApi.md +0 -223
- data/docs/DomainDto.md +0 -29
- data/docs/DomainPreview.md +0 -21
- data/docs/Email.md +0 -49
- data/docs/EmailAnalysis.md +0 -25
- data/docs/EmailControllerApi.md +0 -740
- data/docs/EmailPreview.md +0 -31
- data/docs/EmailProjection.md +0 -33
- data/docs/ForwardEmailOptions.md +0 -23
- data/docs/GroupContactsDto.md +0 -19
- data/docs/GroupControllerApi.md +0 -437
- data/docs/GroupDto.md +0 -23
- data/docs/GroupProjection.md +0 -23
- data/docs/HTMLValidationResult.md +0 -21
- data/docs/Inbox.md +0 -33
- data/docs/InboxControllerApi.md +0 -652
- data/docs/InboxProjection.md +0 -29
- data/docs/JsonNode.md +0 -59
- data/docs/MatchOption.md +0 -21
- data/docs/MatchOptions.md +0 -17
- data/docs/PageContactProjection.md +0 -37
- data/docs/PageEmailPreview.md +0 -37
- data/docs/PageEmailProjection.md +0 -37
- data/docs/PageGroupProjection.md +0 -37
- data/docs/PageInboxProjection.md +0 -37
- data/docs/PageTemplateProjection.md +0 -37
- data/docs/PageWebhookProjection.md +0 -37
- data/docs/Pageable.md +0 -27
- data/docs/RawEmailJson.md +0 -17
- data/docs/SendEmailOptions.md +0 -45
- data/docs/SetInboxFavouritedOptions.md +0 -17
- data/docs/Sort.md +0 -21
- data/docs/TemplateControllerApi.md +0 -274
- data/docs/TemplateDto.md +0 -25
- data/docs/TemplateProjection.md +0 -25
- data/docs/TemplateVariable.md +0 -19
- data/docs/UnreadCount.md +0 -17
- data/docs/UpdateGroupContacts.md +0 -17
- data/docs/UpdateInboxOptions.md +0 -25
- data/docs/UploadAttachmentOptions.md +0 -21
- data/docs/ValidationDto.md +0 -19
- data/docs/ValidationMessage.md +0 -19
- data/docs/WaitForConditions.md +0 -29
- data/docs/WaitForControllerApi.md +0 -317
- data/docs/WebhookControllerApi.md +0 -339
- data/docs/WebhookDto.md +0 -33
- data/docs/WebhookProjection.md +0 -27
- data/docs/WebhookTestRequest.md +0 -23
- data/docs/WebhookTestResponse.md +0 -19
- data/docs/WebhookTestResult.md +0 -21
- data/git_push.sh +0 -58
- data/lib/mailslurp_client/api/attachment_controller_api.rb +0 -157
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +0 -203
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +0 -201
- data/lib/mailslurp_client/api/contact_controller_api.rb +0 -323
- data/lib/mailslurp_client/api/domain_controller_api.rb +0 -264
- data/lib/mailslurp_client/api/email_controller_api.rb +0 -852
- data/lib/mailslurp_client/api/group_controller_api.rb +0 -519
- data/lib/mailslurp_client/api/inbox_controller_api.rb +0 -763
- data/lib/mailslurp_client/api/template_controller_api.rb +0 -323
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +0 -359
- data/lib/mailslurp_client/api/webhook_controller_api.rb +0 -405
- data/lib/mailslurp_client/api_client.rb +0 -386
- data/lib/mailslurp_client/api_error.rb +0 -57
- data/lib/mailslurp_client/configuration.rb +0 -248
- data/lib/mailslurp_client/models/attachment_meta_data.rb +0 -253
- data/lib/mailslurp_client/models/basic_auth_options.rb +0 -226
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +0 -224
- data/lib/mailslurp_client/models/contact_dto.rb +0 -288
- data/lib/mailslurp_client/models/contact_projection.rb +0 -261
- data/lib/mailslurp_client/models/create_contact_options.rb +0 -277
- data/lib/mailslurp_client/models/create_domain_options.rb +0 -208
- data/lib/mailslurp_client/models/create_group_options.rb +0 -220
- data/lib/mailslurp_client/models/create_template_options.rb +0 -225
- data/lib/mailslurp_client/models/create_webhook_options.rb +0 -227
- data/lib/mailslurp_client/models/domain_dto.rb +0 -296
- data/lib/mailslurp_client/models/domain_preview.rb +0 -240
- data/lib/mailslurp_client/models/email.rb +0 -376
- data/lib/mailslurp_client/models/email_analysis.rb +0 -243
- data/lib/mailslurp_client/models/email_preview.rb +0 -286
- data/lib/mailslurp_client/models/email_projection.rb +0 -306
- data/lib/mailslurp_client/models/forward_email_options.rb +0 -245
- data/lib/mailslurp_client/models/group_contacts_dto.rb +0 -227
- data/lib/mailslurp_client/models/group_dto.rb +0 -248
- data/lib/mailslurp_client/models/group_projection.rb +0 -248
- data/lib/mailslurp_client/models/html_validation_result.rb +0 -243
- data/lib/mailslurp_client/models/inbox.rb +0 -290
- data/lib/mailslurp_client/models/inbox_projection.rb +0 -272
- data/lib/mailslurp_client/models/json_node.rb +0 -429
- data/lib/mailslurp_client/models/match_option.rb +0 -274
- data/lib/mailslurp_client/models/match_options.rb +0 -210
- data/lib/mailslurp_client/models/page_contact_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_email_preview.rb +0 -298
- data/lib/mailslurp_client/models/page_email_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_group_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_inbox_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_template_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_webhook_projection.rb +0 -298
- data/lib/mailslurp_client/models/pageable.rb +0 -251
- data/lib/mailslurp_client/models/raw_email_json.rb +0 -211
- data/lib/mailslurp_client/models/send_email_options.rb +0 -392
- data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +0 -208
- data/lib/mailslurp_client/models/sort.rb +0 -224
- data/lib/mailslurp_client/models/template_dto.rb +0 -269
- data/lib/mailslurp_client/models/template_projection.rb +0 -269
- data/lib/mailslurp_client/models/template_variable.rb +0 -259
- data/lib/mailslurp_client/models/unread_count.rb +0 -211
- data/lib/mailslurp_client/models/update_group_contacts.rb +0 -213
- data/lib/mailslurp_client/models/update_inbox_options.rb +0 -250
- data/lib/mailslurp_client/models/upload_attachment_options.rb +0 -228
- data/lib/mailslurp_client/models/validation_dto.rb +0 -225
- data/lib/mailslurp_client/models/validation_message.rb +0 -220
- data/lib/mailslurp_client/models/wait_for_conditions.rb +0 -315
- data/lib/mailslurp_client/models/webhook_dto.rb +0 -326
- data/lib/mailslurp_client/models/webhook_projection.rb +0 -277
- data/lib/mailslurp_client/models/webhook_test_request.rb +0 -284
- data/lib/mailslurp_client/models/webhook_test_response.rb +0 -215
- data/lib/mailslurp_client/models/webhook_test_result.rb +0 -235
- data/lib/mailslurp_client/version.rb +0 -15
- data/mailslurp_client.gemspec +0 -39
- data/spec/api/attachment_controller_api_spec.rb +0 -61
- data/spec/api/bulk_actions_controller_api_spec.rb +0 -68
- data/spec/api/common_actions_controller_api_spec.rb +0 -129
- data/spec/api/contact_controller_api_spec.rb +0 -91
- data/spec/api/domain_controller_api_spec.rb +0 -82
- data/spec/api/email_controller_api_spec.rb +0 -162
- data/spec/api/group_controller_api_spec.rb +0 -126
- data/spec/api/inbox_controller_api_spec.rb +0 -172
- data/spec/api/template_controller_api_spec.rb +0 -91
- data/spec/api/wait_for_controller_api_spec.rb +0 -107
- data/spec/api/webhook_controller_api_spec.rb +0 -107
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/attachment_meta_data_spec.rb +0 -59
- data/spec/models/basic_auth_options_spec.rb +0 -47
- data/spec/models/bulk_send_email_options_spec.rb +0 -47
- data/spec/models/contact_dto_spec.rb +0 -83
- data/spec/models/contact_projection_spec.rb +0 -71
- data/spec/models/create_contact_options_spec.rb +0 -83
- data/spec/models/create_domain_options_spec.rb +0 -41
- data/spec/models/create_group_options_spec.rb +0 -47
- data/spec/models/create_template_options_spec.rb +0 -47
- data/spec/models/create_webhook_options_spec.rb +0 -53
- data/spec/models/domain_dto_spec.rb +0 -77
- data/spec/models/domain_preview_spec.rb +0 -53
- data/spec/models/email_analysis_spec.rb +0 -65
- data/spec/models/email_preview_spec.rb +0 -83
- data/spec/models/email_projection_spec.rb +0 -89
- data/spec/models/email_spec.rb +0 -137
- data/spec/models/forward_email_options_spec.rb +0 -59
- data/spec/models/group_contacts_dto_spec.rb +0 -47
- data/spec/models/group_dto_spec.rb +0 -59
- data/spec/models/group_projection_spec.rb +0 -59
- data/spec/models/html_validation_result_spec.rb +0 -53
- data/spec/models/inbox_projection_spec.rb +0 -77
- data/spec/models/inbox_spec.rb +0 -89
- data/spec/models/json_node_spec.rb +0 -171
- data/spec/models/match_option_spec.rb +0 -61
- data/spec/models/match_options_spec.rb +0 -41
- data/spec/models/page_contact_projection_spec.rb +0 -101
- data/spec/models/page_email_preview_spec.rb +0 -101
- data/spec/models/page_email_projection_spec.rb +0 -101
- data/spec/models/page_group_projection_spec.rb +0 -101
- data/spec/models/page_inbox_projection_spec.rb +0 -101
- data/spec/models/page_template_projection_spec.rb +0 -101
- data/spec/models/page_webhook_projection_spec.rb +0 -101
- data/spec/models/pageable_spec.rb +0 -71
- data/spec/models/raw_email_json_spec.rb +0 -41
- data/spec/models/send_email_options_spec.rb +0 -129
- data/spec/models/set_inbox_favourited_options_spec.rb +0 -41
- data/spec/models/sort_spec.rb +0 -53
- data/spec/models/template_dto_spec.rb +0 -65
- data/spec/models/template_projection_spec.rb +0 -65
- data/spec/models/template_variable_spec.rb +0 -51
- data/spec/models/unread_count_spec.rb +0 -41
- data/spec/models/update_group_contacts_spec.rb +0 -41
- data/spec/models/update_inbox_options_spec.rb +0 -65
- data/spec/models/upload_attachment_options_spec.rb +0 -53
- data/spec/models/validation_dto_spec.rb +0 -47
- data/spec/models/validation_message_spec.rb +0 -47
- data/spec/models/wait_for_conditions_spec.rb +0 -85
- data/spec/models/webhook_dto_spec.rb +0 -93
- data/spec/models/webhook_projection_spec.rb +0 -71
- data/spec/models/webhook_test_request_spec.rb +0 -63
- data/spec/models/webhook_test_response_spec.rb +0 -47
- data/spec/models/webhook_test_result_spec.rb +0 -53
- data/spec/spec_helper.rb +0 -111
data/docs/ContactDto.md
DELETED
@@ -1,31 +0,0 @@
|
|
1
|
-
# MailSlurpClient::ContactDto
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**company** | **String** | | [optional]
|
8
|
-
**email_addresses** | **Array<String>** | |
|
9
|
-
**first_name** | **String** | | [optional]
|
10
|
-
**id** | **String** | |
|
11
|
-
**last_name** | **String** | | [optional]
|
12
|
-
**meta_data** | [**JsonNode**](JsonNode.md) | | [optional]
|
13
|
-
**opt_out** | **Boolean** | | [optional]
|
14
|
-
**tags** | **Array<String>** | |
|
15
|
-
|
16
|
-
## Code Sample
|
17
|
-
|
18
|
-
```ruby
|
19
|
-
require 'MailSlurpClient'
|
20
|
-
|
21
|
-
instance = MailSlurpClient::ContactDto.new(company: null,
|
22
|
-
email_addresses: null,
|
23
|
-
first_name: null,
|
24
|
-
id: null,
|
25
|
-
last_name: null,
|
26
|
-
meta_data: null,
|
27
|
-
opt_out: null,
|
28
|
-
tags: null)
|
29
|
-
```
|
30
|
-
|
31
|
-
|
data/docs/ContactProjection.md
DELETED
@@ -1,27 +0,0 @@
|
|
1
|
-
# MailSlurpClient::ContactProjection
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**company** | **String** | | [optional]
|
8
|
-
**created_at** | **DateTime** | |
|
9
|
-
**first_name** | **String** | | [optional]
|
10
|
-
**id** | **String** | |
|
11
|
-
**last_name** | **String** | | [optional]
|
12
|
-
**opt_out** | **Boolean** | | [optional]
|
13
|
-
|
14
|
-
## Code Sample
|
15
|
-
|
16
|
-
```ruby
|
17
|
-
require 'MailSlurpClient'
|
18
|
-
|
19
|
-
instance = MailSlurpClient::ContactProjection.new(company: null,
|
20
|
-
created_at: null,
|
21
|
-
first_name: null,
|
22
|
-
id: null,
|
23
|
-
last_name: null,
|
24
|
-
opt_out: null)
|
25
|
-
```
|
26
|
-
|
27
|
-
|
@@ -1,31 +0,0 @@
|
|
1
|
-
# MailSlurpClient::CreateContactOptions
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**email_addresses** | **Array<String>** | Set of email addresses belonging to the contact | [optional]
|
8
|
-
**first_name** | **String** | | [optional]
|
9
|
-
**group_id** | **String** | Group IDs that contact belongs to | [optional]
|
10
|
-
**meta_data** | [**JsonNode**](JsonNode.md) | | [optional]
|
11
|
-
**opt_out** | **Boolean** | Has the user explicitly or implicitly opted out of being contacted? If so MailSlurp will ignore them in all actions. | [optional]
|
12
|
-
**tags** | **Array<String>** | Tags that can be used to search and group contacts | [optional]
|
13
|
-
**last_name** | **String** | | [optional]
|
14
|
-
**company** | **String** | | [optional]
|
15
|
-
|
16
|
-
## Code Sample
|
17
|
-
|
18
|
-
```ruby
|
19
|
-
require 'MailSlurpClient'
|
20
|
-
|
21
|
-
instance = MailSlurpClient::CreateContactOptions.new(email_addresses: null,
|
22
|
-
first_name: null,
|
23
|
-
group_id: null,
|
24
|
-
meta_data: null,
|
25
|
-
opt_out: null,
|
26
|
-
tags: null,
|
27
|
-
last_name: null,
|
28
|
-
company: null)
|
29
|
-
```
|
30
|
-
|
31
|
-
|
data/docs/CreateDomainOptions.md
DELETED
@@ -1,17 +0,0 @@
|
|
1
|
-
# MailSlurpClient::CreateDomainOptions
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**domain** | **String** | The top level domain you wish to use with MailSlurp | [optional]
|
8
|
-
|
9
|
-
## Code Sample
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'MailSlurpClient'
|
13
|
-
|
14
|
-
instance = MailSlurpClient::CreateDomainOptions.new(domain: null)
|
15
|
-
```
|
16
|
-
|
17
|
-
|
data/docs/CreateGroupOptions.md
DELETED
@@ -1,19 +0,0 @@
|
|
1
|
-
# MailSlurpClient::CreateGroupOptions
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**name** | **String** | |
|
8
|
-
**description** | **String** | | [optional]
|
9
|
-
|
10
|
-
## Code Sample
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'MailSlurpClient'
|
14
|
-
|
15
|
-
instance = MailSlurpClient::CreateGroupOptions.new(name: null,
|
16
|
-
description: null)
|
17
|
-
```
|
18
|
-
|
19
|
-
|
@@ -1,19 +0,0 @@
|
|
1
|
-
# MailSlurpClient::CreateTemplateOptions
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**name** | **String** | |
|
8
|
-
**content** | **String** | |
|
9
|
-
|
10
|
-
## Code Sample
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'MailSlurpClient'
|
14
|
-
|
15
|
-
instance = MailSlurpClient::CreateTemplateOptions.new(name: null,
|
16
|
-
content: null)
|
17
|
-
```
|
18
|
-
|
19
|
-
|
@@ -1,21 +0,0 @@
|
|
1
|
-
# MailSlurpClient::CreateWebhookOptions
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**basic_auth** | [**BasicAuthOptions**](BasicAuthOptions.md) | | [optional]
|
8
|
-
**name** | **String** | Optional name for the webhook | [optional]
|
9
|
-
**url** | **String** | Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received. The payload of the submitted JSON is described by https://api.mailslurp.com/schemas/webhook-payload | [optional]
|
10
|
-
|
11
|
-
## Code Sample
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'MailSlurpClient'
|
15
|
-
|
16
|
-
instance = MailSlurpClient::CreateWebhookOptions.new(basic_auth: null,
|
17
|
-
name: null,
|
18
|
-
url: null)
|
19
|
-
```
|
20
|
-
|
21
|
-
|
data/docs/DomainControllerApi.md
DELETED
@@ -1,223 +0,0 @@
|
|
1
|
-
# MailSlurpClient::DomainControllerApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.mailslurp.com*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**create_domain**](DomainControllerApi.md#create_domain) | **POST** /domains | Create Domain
|
8
|
-
[**delete_domain**](DomainControllerApi.md#delete_domain) | **DELETE** /domains/{id} | Delete a domain
|
9
|
-
[**get_domain**](DomainControllerApi.md#get_domain) | **GET** /domains/{id} | Get a domain
|
10
|
-
[**get_domains**](DomainControllerApi.md#get_domains) | **GET** /domains | Get domains
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
## create_domain
|
15
|
-
|
16
|
-
> DomainDto create_domain(domain_options)
|
17
|
-
|
18
|
-
Create Domain
|
19
|
-
|
20
|
-
Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.
|
21
|
-
|
22
|
-
### Example
|
23
|
-
|
24
|
-
```ruby
|
25
|
-
# load the gem
|
26
|
-
require 'mailslurp_client'
|
27
|
-
# setup authorization
|
28
|
-
MailSlurpClient.configure do |config|
|
29
|
-
# Configure API key authorization: API_KEY
|
30
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
31
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
33
|
-
end
|
34
|
-
|
35
|
-
api_instance = MailSlurpClient::DomainControllerApi.new
|
36
|
-
domain_options = MailSlurpClient::CreateDomainOptions.new # CreateDomainOptions | domainOptions
|
37
|
-
|
38
|
-
begin
|
39
|
-
#Create Domain
|
40
|
-
result = api_instance.create_domain(domain_options)
|
41
|
-
p result
|
42
|
-
rescue MailSlurpClient::ApiError => e
|
43
|
-
puts "Exception when calling DomainControllerApi->create_domain: #{e}"
|
44
|
-
end
|
45
|
-
```
|
46
|
-
|
47
|
-
### Parameters
|
48
|
-
|
49
|
-
|
50
|
-
Name | Type | Description | Notes
|
51
|
-
------------- | ------------- | ------------- | -------------
|
52
|
-
**domain_options** | [**CreateDomainOptions**](CreateDomainOptions.md)| domainOptions |
|
53
|
-
|
54
|
-
### Return type
|
55
|
-
|
56
|
-
[**DomainDto**](DomainDto.md)
|
57
|
-
|
58
|
-
### Authorization
|
59
|
-
|
60
|
-
[API_KEY](../README.md#API_KEY)
|
61
|
-
|
62
|
-
### HTTP request headers
|
63
|
-
|
64
|
-
- **Content-Type**: application/json
|
65
|
-
- **Accept**: application/json
|
66
|
-
|
67
|
-
|
68
|
-
## delete_domain
|
69
|
-
|
70
|
-
> delete_domain(id)
|
71
|
-
|
72
|
-
Delete a domain
|
73
|
-
|
74
|
-
Delete a domain. This will disable any existing inboxes that use this domain.
|
75
|
-
|
76
|
-
### Example
|
77
|
-
|
78
|
-
```ruby
|
79
|
-
# load the gem
|
80
|
-
require 'mailslurp_client'
|
81
|
-
# setup authorization
|
82
|
-
MailSlurpClient.configure do |config|
|
83
|
-
# Configure API key authorization: API_KEY
|
84
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
85
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
86
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
87
|
-
end
|
88
|
-
|
89
|
-
api_instance = MailSlurpClient::DomainControllerApi.new
|
90
|
-
id = 'id_example' # String | id
|
91
|
-
|
92
|
-
begin
|
93
|
-
#Delete a domain
|
94
|
-
api_instance.delete_domain(id)
|
95
|
-
rescue MailSlurpClient::ApiError => e
|
96
|
-
puts "Exception when calling DomainControllerApi->delete_domain: #{e}"
|
97
|
-
end
|
98
|
-
```
|
99
|
-
|
100
|
-
### Parameters
|
101
|
-
|
102
|
-
|
103
|
-
Name | Type | Description | Notes
|
104
|
-
------------- | ------------- | ------------- | -------------
|
105
|
-
**id** | [**String**](.md)| id |
|
106
|
-
|
107
|
-
### Return type
|
108
|
-
|
109
|
-
nil (empty response body)
|
110
|
-
|
111
|
-
### Authorization
|
112
|
-
|
113
|
-
[API_KEY](../README.md#API_KEY)
|
114
|
-
|
115
|
-
### HTTP request headers
|
116
|
-
|
117
|
-
- **Content-Type**: Not defined
|
118
|
-
- **Accept**: Not defined
|
119
|
-
|
120
|
-
|
121
|
-
## get_domain
|
122
|
-
|
123
|
-
> DomainDto get_domain(id)
|
124
|
-
|
125
|
-
Get a domain
|
126
|
-
|
127
|
-
Returns domain verification status and tokens for a given domain
|
128
|
-
|
129
|
-
### Example
|
130
|
-
|
131
|
-
```ruby
|
132
|
-
# load the gem
|
133
|
-
require 'mailslurp_client'
|
134
|
-
# setup authorization
|
135
|
-
MailSlurpClient.configure do |config|
|
136
|
-
# Configure API key authorization: API_KEY
|
137
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
138
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
139
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
140
|
-
end
|
141
|
-
|
142
|
-
api_instance = MailSlurpClient::DomainControllerApi.new
|
143
|
-
id = 'id_example' # String | id
|
144
|
-
|
145
|
-
begin
|
146
|
-
#Get a domain
|
147
|
-
result = api_instance.get_domain(id)
|
148
|
-
p result
|
149
|
-
rescue MailSlurpClient::ApiError => e
|
150
|
-
puts "Exception when calling DomainControllerApi->get_domain: #{e}"
|
151
|
-
end
|
152
|
-
```
|
153
|
-
|
154
|
-
### Parameters
|
155
|
-
|
156
|
-
|
157
|
-
Name | Type | Description | Notes
|
158
|
-
------------- | ------------- | ------------- | -------------
|
159
|
-
**id** | [**String**](.md)| id |
|
160
|
-
|
161
|
-
### Return type
|
162
|
-
|
163
|
-
[**DomainDto**](DomainDto.md)
|
164
|
-
|
165
|
-
### Authorization
|
166
|
-
|
167
|
-
[API_KEY](../README.md#API_KEY)
|
168
|
-
|
169
|
-
### HTTP request headers
|
170
|
-
|
171
|
-
- **Content-Type**: Not defined
|
172
|
-
- **Accept**: application/json
|
173
|
-
|
174
|
-
|
175
|
-
## get_domains
|
176
|
-
|
177
|
-
> Array<DomainPreview> get_domains
|
178
|
-
|
179
|
-
Get domains
|
180
|
-
|
181
|
-
List all custom domains you have created
|
182
|
-
|
183
|
-
### Example
|
184
|
-
|
185
|
-
```ruby
|
186
|
-
# load the gem
|
187
|
-
require 'mailslurp_client'
|
188
|
-
# setup authorization
|
189
|
-
MailSlurpClient.configure do |config|
|
190
|
-
# Configure API key authorization: API_KEY
|
191
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
192
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
193
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
194
|
-
end
|
195
|
-
|
196
|
-
api_instance = MailSlurpClient::DomainControllerApi.new
|
197
|
-
|
198
|
-
begin
|
199
|
-
#Get domains
|
200
|
-
result = api_instance.get_domains
|
201
|
-
p result
|
202
|
-
rescue MailSlurpClient::ApiError => e
|
203
|
-
puts "Exception when calling DomainControllerApi->get_domains: #{e}"
|
204
|
-
end
|
205
|
-
```
|
206
|
-
|
207
|
-
### Parameters
|
208
|
-
|
209
|
-
This endpoint does not need any parameter.
|
210
|
-
|
211
|
-
### Return type
|
212
|
-
|
213
|
-
[**Array<DomainPreview>**](DomainPreview.md)
|
214
|
-
|
215
|
-
### Authorization
|
216
|
-
|
217
|
-
[API_KEY](../README.md#API_KEY)
|
218
|
-
|
219
|
-
### HTTP request headers
|
220
|
-
|
221
|
-
- **Content-Type**: Not defined
|
222
|
-
- **Accept**: application/json
|
223
|
-
|
data/docs/DomainDto.md
DELETED
@@ -1,29 +0,0 @@
|
|
1
|
-
# MailSlurpClient::DomainDto
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**created_at** | **DateTime** | |
|
8
|
-
**domain** | **String** | |
|
9
|
-
**id** | **String** | |
|
10
|
-
**is_verified** | **Boolean** | |
|
11
|
-
**updated_at** | **DateTime** | |
|
12
|
-
**user_id** | **String** | |
|
13
|
-
**verification_token** | **String** | |
|
14
|
-
|
15
|
-
## Code Sample
|
16
|
-
|
17
|
-
```ruby
|
18
|
-
require 'MailSlurpClient'
|
19
|
-
|
20
|
-
instance = MailSlurpClient::DomainDto.new(created_at: null,
|
21
|
-
domain: null,
|
22
|
-
id: null,
|
23
|
-
is_verified: null,
|
24
|
-
updated_at: null,
|
25
|
-
user_id: null,
|
26
|
-
verification_token: null)
|
27
|
-
```
|
28
|
-
|
29
|
-
|
data/docs/DomainPreview.md
DELETED
@@ -1,21 +0,0 @@
|
|
1
|
-
# MailSlurpClient::DomainPreview
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
------------ | ------------- | ------------- | -------------
|
7
|
-
**created_at** | **DateTime** | |
|
8
|
-
**domain** | **String** | |
|
9
|
-
**id** | **String** | |
|
10
|
-
|
11
|
-
## Code Sample
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'MailSlurpClient'
|
15
|
-
|
16
|
-
instance = MailSlurpClient::DomainPreview.new(created_at: null,
|
17
|
-
domain: null,
|
18
|
-
id: null)
|
19
|
-
```
|
20
|
-
|
21
|
-
|