mailslurp_client 7.0.8 → 7.2.4
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 +12 -3
- metadata +11 -372
- data/Gemfile +0 -9
- data/LICENSE +0 -22
- data/Makefile +0 -3
- data/README.md +0 -239
- data/Rakefile +0 -10
- data/docs/AliasControllerApi.md +0 -337
- data/docs/AttachmentControllerApi.md +0 -126
- 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 -218
- data/docs/ContactControllerApi.md +0 -274
- data/docs/ContactDto.md +0 -31
- data/docs/ContactProjection.md +0 -27
- data/docs/CreateAnonymousAliasOptions.md +0 -17
- data/docs/CreateContactOptions.md +0 -31
- data/docs/CreateDomainOptions.md +0 -17
- data/docs/CreateGroupOptions.md +0 -19
- data/docs/CreateOwnedAliasOptions.md +0 -23
- 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/FormControllerApi.md +0 -79
- 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 -705
- 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/ModelAlias.md +0 -31
- data/docs/PageAlias.md +0 -37
- 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/SimpleSendEmailOptions.md +0 -23
- 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/alias_controller_api.rb +0 -405
- data/lib/mailslurp_client/api/attachment_controller_api.rb +0 -160
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +0 -203
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +0 -257
- 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/form_controller_api.rb +0 -104
- data/lib/mailslurp_client/api/group_controller_api.rb +0 -519
- data/lib/mailslurp_client/api/inbox_controller_api.rb +0 -822
- 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 -238
- data/lib/mailslurp_client/models/basic_auth_options.rb +0 -226
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +0 -219
- 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_anonymous_alias_options.rb +0 -208
- 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_owned_alias_options.rb +0 -238
- 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 -248
- data/lib/mailslurp_client/models/email_preview.rb +0 -286
- data/lib/mailslurp_client/models/email_projection.rb +0 -307
- data/lib/mailslurp_client/models/forward_email_options.rb +0 -244
- 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/model_alias.rb +0 -284
- data/lib/mailslurp_client/models/page_alias.rb +0 -298
- 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/simple_send_email_options.rb +0 -237
- 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 -217
- data/lib/mailslurp_client/models/validation_message.rb +0 -220
- data/lib/mailslurp_client/models/wait_for_conditions.rb +0 -316
- 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/alias_controller_api_spec.rb +0 -107
- 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/form_controller_api_spec.rb +0 -54
- 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_anonymous_alias_options_spec.rb +0 -41
- 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_owned_alias_options_spec.rb +0 -59
- 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/model_alias_spec.rb +0 -83
- data/spec/models/page_alias_spec.rb +0 -101
- 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/simple_send_email_options_spec.rb +0 -59
- 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/Gemfile
DELETED
data/LICENSE
DELETED
@@ -1,22 +0,0 @@
|
|
1
|
-
|
2
|
-
MIT License
|
3
|
-
|
4
|
-
Copyright (c) MailSlurp, PettmanOU
|
5
|
-
|
6
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
7
|
-
of this software and associated documentation files (the "Software"), to deal
|
8
|
-
in the Software without restriction, including without limitation the rights
|
9
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
10
|
-
copies of the Software, and to permit persons to whom the Software is
|
11
|
-
furnished to do so, subject to the following conditions:
|
12
|
-
|
13
|
-
The above copyright notice and this permission notice shall be included in all
|
14
|
-
copies or substantial portions of the Software.
|
15
|
-
|
16
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
17
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
18
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
19
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
20
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
21
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
22
|
-
SOFTWARE.
|
data/Makefile
DELETED
data/README.md
DELETED
@@ -1,239 +0,0 @@
|
|
1
|
-
# mailslurp_client
|
2
|
-
|
3
|
-
MailSlurpClient - the Ruby gem for the MailSlurp API
|
4
|
-
|
5
|
-
MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.
|
6
|
-
|
7
|
-
## Resources
|
8
|
-
- [Homepage](https://www.mailslurp.com)
|
9
|
-
- Get an [API KEY](https://app.mailslurp.com/sign-up/)
|
10
|
-
- Generated [SDK Clients](https://www.mailslurp.com/docs/)
|
11
|
-
- [Examples](https://github.com/mailslurp/examples) repository
|
12
|
-
|
13
|
-
|
14
|
-
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
15
|
-
|
16
|
-
- API version: d1659dc1567a5b62f65d0612107a50aace03e085
|
17
|
-
- Package version: 7.0.8
|
18
|
-
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
19
|
-
|
20
|
-
## Installation
|
21
|
-
|
22
|
-
### Build a gem
|
23
|
-
|
24
|
-
To build the Ruby code into a gem:
|
25
|
-
|
26
|
-
```shell
|
27
|
-
gem build mailslurp_client.gemspec
|
28
|
-
```
|
29
|
-
|
30
|
-
Then either install the gem locally:
|
31
|
-
|
32
|
-
```shell
|
33
|
-
gem install ./mailslurp_client-7.0.8.gem
|
34
|
-
```
|
35
|
-
|
36
|
-
(for development, run `gem install --dev ./mailslurp_client-7.0.8.gem` to install the development dependencies)
|
37
|
-
|
38
|
-
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
39
|
-
|
40
|
-
Finally add this to the Gemfile:
|
41
|
-
|
42
|
-
gem 'mailslurp_client', '~> 7.0.8'
|
43
|
-
|
44
|
-
### Install from Git
|
45
|
-
|
46
|
-
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
47
|
-
|
48
|
-
gem 'mailslurp_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
49
|
-
|
50
|
-
### Include the Ruby code directly
|
51
|
-
|
52
|
-
Include the Ruby code directly using `-I` as follows:
|
53
|
-
|
54
|
-
```shell
|
55
|
-
ruby -Ilib script.rb
|
56
|
-
```
|
57
|
-
|
58
|
-
## Getting Started
|
59
|
-
|
60
|
-
Please follow the [installation](#installation) procedure and then run the following code:
|
61
|
-
|
62
|
-
```ruby
|
63
|
-
# Load the gem
|
64
|
-
require 'mailslurp_client'
|
65
|
-
|
66
|
-
# Setup authorization
|
67
|
-
MailSlurpClient.configure do |config|
|
68
|
-
# Configure API key authorization: API_KEY
|
69
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
70
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
71
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
72
|
-
end
|
73
|
-
|
74
|
-
api_instance = MailSlurpClient::AliasControllerApi.new
|
75
|
-
create_owned_alias_options = MailSlurpClient::CreateOwnedAliasOptions.new # CreateOwnedAliasOptions | createOwnedAliasOptions
|
76
|
-
|
77
|
-
begin
|
78
|
-
#Create an email alias
|
79
|
-
api_instance.create_alias(create_owned_alias_options)
|
80
|
-
rescue MailSlurpClient::ApiError => e
|
81
|
-
puts "Exception when calling AliasControllerApi->create_alias: #{e}"
|
82
|
-
end
|
83
|
-
|
84
|
-
```
|
85
|
-
|
86
|
-
## Documentation for API Endpoints
|
87
|
-
|
88
|
-
All URIs are relative to *https://api.mailslurp.com*
|
89
|
-
|
90
|
-
Class | Method | HTTP request | Description
|
91
|
-
------------ | ------------- | ------------- | -------------
|
92
|
-
*MailSlurpClient::AliasControllerApi* | [**create_alias**](docs/AliasControllerApi.md#create_alias) | **POST** /aliases | Create an email alias
|
93
|
-
*MailSlurpClient::AliasControllerApi* | [**create_anonymous_alias**](docs/AliasControllerApi.md#create_anonymous_alias) | **POST** /aliases/anonymous | Create an anonymous email alias
|
94
|
-
*MailSlurpClient::AliasControllerApi* | [**delete_alias**](docs/AliasControllerApi.md#delete_alias) | **DELETE** /aliases/{aliasId} | Delete an owned alias
|
95
|
-
*MailSlurpClient::AliasControllerApi* | [**get_alias**](docs/AliasControllerApi.md#get_alias) | **GET** /aliases/{aliasId} | Get an email alias
|
96
|
-
*MailSlurpClient::AliasControllerApi* | [**get_aliases**](docs/AliasControllerApi.md#get_aliases) | **GET** /aliases | Get all email aliases
|
97
|
-
*MailSlurpClient::AliasControllerApi* | [**update_alias**](docs/AliasControllerApi.md#update_alias) | **PUT** /aliases/{aliasId} | Update an owned alias
|
98
|
-
*MailSlurpClient::AttachmentControllerApi* | [**upload_attachment**](docs/AttachmentControllerApi.md#upload_attachment) | **POST** /attachments | Upload an attachment for sending
|
99
|
-
*MailSlurpClient::AttachmentControllerApi* | [**upload_multipart_form**](docs/AttachmentControllerApi.md#upload_multipart_form) | **POST** /attachments/multipart | Upload an attachment for sending using Multipart Form
|
100
|
-
*MailSlurpClient::BulkActionsControllerApi* | [**bulk_create_inboxes**](docs/BulkActionsControllerApi.md#bulk_create_inboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)
|
101
|
-
*MailSlurpClient::BulkActionsControllerApi* | [**bulk_delete_inboxes**](docs/BulkActionsControllerApi.md#bulk_delete_inboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes
|
102
|
-
*MailSlurpClient::BulkActionsControllerApi* | [**bulk_send_emails**](docs/BulkActionsControllerApi.md#bulk_send_emails) | **POST** /bulk/send | Bulk Send Emails
|
103
|
-
*MailSlurpClient::CommonActionsControllerApi* | [**create_new_email_address**](docs/CommonActionsControllerApi.md#create_new_email_address) | **POST** /createInbox | Create new random inbox
|
104
|
-
*MailSlurpClient::CommonActionsControllerApi* | [**create_new_email_address1**](docs/CommonActionsControllerApi.md#create_new_email_address1) | **POST** /newEmailAddress | Create new random inbox
|
105
|
-
*MailSlurpClient::CommonActionsControllerApi* | [**empty_inbox**](docs/CommonActionsControllerApi.md#empty_inbox) | **DELETE** /emptyInbox | Delete all emails in an inbox
|
106
|
-
*MailSlurpClient::CommonActionsControllerApi* | [**send_email_simple**](docs/CommonActionsControllerApi.md#send_email_simple) | **POST** /sendEmail | Send an email
|
107
|
-
*MailSlurpClient::ContactControllerApi* | [**create_contact**](docs/ContactControllerApi.md#create_contact) | **POST** /contacts | Create a contact
|
108
|
-
*MailSlurpClient::ContactControllerApi* | [**delete_contact**](docs/ContactControllerApi.md#delete_contact) | **DELETE** /contacts/{contactId} | Delete contact
|
109
|
-
*MailSlurpClient::ContactControllerApi* | [**get_all_contacts**](docs/ContactControllerApi.md#get_all_contacts) | **GET** /contacts/paginated | Get all contacts
|
110
|
-
*MailSlurpClient::ContactControllerApi* | [**get_contact**](docs/ContactControllerApi.md#get_contact) | **GET** /contacts/{contactId} | Get contact
|
111
|
-
*MailSlurpClient::ContactControllerApi* | [**get_contacts**](docs/ContactControllerApi.md#get_contacts) | **GET** /contacts | Get all contacts
|
112
|
-
*MailSlurpClient::DomainControllerApi* | [**create_domain**](docs/DomainControllerApi.md#create_domain) | **POST** /domains | Create Domain
|
113
|
-
*MailSlurpClient::DomainControllerApi* | [**delete_domain**](docs/DomainControllerApi.md#delete_domain) | **DELETE** /domains/{id} | Delete a domain
|
114
|
-
*MailSlurpClient::DomainControllerApi* | [**get_domain**](docs/DomainControllerApi.md#get_domain) | **GET** /domains/{id} | Get a domain
|
115
|
-
*MailSlurpClient::DomainControllerApi* | [**get_domains**](docs/DomainControllerApi.md#get_domains) | **GET** /domains | Get domains
|
116
|
-
*MailSlurpClient::EmailControllerApi* | [**delete_all_emails**](docs/EmailControllerApi.md#delete_all_emails) | **DELETE** /emails | Delete all emails
|
117
|
-
*MailSlurpClient::EmailControllerApi* | [**delete_email**](docs/EmailControllerApi.md#delete_email) | **DELETE** /emails/{emailId} | Delete an email
|
118
|
-
*MailSlurpClient::EmailControllerApi* | [**download_attachment**](docs/EmailControllerApi.md#download_attachment) | **GET** /emails/{emailId}/attachments/{attachmentId} | Get email attachment bytes
|
119
|
-
*MailSlurpClient::EmailControllerApi* | [**forward_email**](docs/EmailControllerApi.md#forward_email) | **POST** /emails/{emailId}/forward | Forward email
|
120
|
-
*MailSlurpClient::EmailControllerApi* | [**get_attachment_meta_data**](docs/EmailControllerApi.md#get_attachment_meta_data) | **GET** /emails/{emailId}/attachments/{attachmentId}/metadata | Get email attachment metadata
|
121
|
-
*MailSlurpClient::EmailControllerApi* | [**get_attachments**](docs/EmailControllerApi.md#get_attachments) | **GET** /emails/{emailId}/attachments | Get all email attachment metadata
|
122
|
-
*MailSlurpClient::EmailControllerApi* | [**get_email**](docs/EmailControllerApi.md#get_email) | **GET** /emails/{emailId} | Get email content
|
123
|
-
*MailSlurpClient::EmailControllerApi* | [**get_email_html**](docs/EmailControllerApi.md#get_email_html) | **GET** /emails/{emailId}/html | Get email content as HTML
|
124
|
-
*MailSlurpClient::EmailControllerApi* | [**get_emails_paginated**](docs/EmailControllerApi.md#get_emails_paginated) | **GET** /emails | Get all emails
|
125
|
-
*MailSlurpClient::EmailControllerApi* | [**get_raw_email_contents**](docs/EmailControllerApi.md#get_raw_email_contents) | **GET** /emails/{emailId}/raw | Get raw email string
|
126
|
-
*MailSlurpClient::EmailControllerApi* | [**get_raw_email_json**](docs/EmailControllerApi.md#get_raw_email_json) | **GET** /emails/{emailId}/raw/json | Get raw email in JSON
|
127
|
-
*MailSlurpClient::EmailControllerApi* | [**get_unread_email_count**](docs/EmailControllerApi.md#get_unread_email_count) | **GET** /emails/unreadCount | Get unread email count
|
128
|
-
*MailSlurpClient::EmailControllerApi* | [**validate_email**](docs/EmailControllerApi.md#validate_email) | **POST** /emails/{emailId}/validate | Validate email
|
129
|
-
*MailSlurpClient::FormControllerApi* | [**submit_form**](docs/FormControllerApi.md#submit_form) | **POST** /forms | Submit a form to be parsed and sent as an email to an address determined by the form fields
|
130
|
-
*MailSlurpClient::GroupControllerApi* | [**add_contacts_to_group**](docs/GroupControllerApi.md#add_contacts_to_group) | **PUT** /groups/{groupId}/contacts | Add contacts to a group
|
131
|
-
*MailSlurpClient::GroupControllerApi* | [**create_group**](docs/GroupControllerApi.md#create_group) | **POST** /groups | Create a group
|
132
|
-
*MailSlurpClient::GroupControllerApi* | [**delete_group**](docs/GroupControllerApi.md#delete_group) | **DELETE** /groups/{groupId} | Delete group
|
133
|
-
*MailSlurpClient::GroupControllerApi* | [**get_all_groups**](docs/GroupControllerApi.md#get_all_groups) | **GET** /groups/paginated | Get all Contact Groups in paginated format
|
134
|
-
*MailSlurpClient::GroupControllerApi* | [**get_group**](docs/GroupControllerApi.md#get_group) | **GET** /groups/{groupId} | Get group
|
135
|
-
*MailSlurpClient::GroupControllerApi* | [**get_group_with_contacts**](docs/GroupControllerApi.md#get_group_with_contacts) | **GET** /groups/{groupId}/contacts | Get group and contacts belonging to it
|
136
|
-
*MailSlurpClient::GroupControllerApi* | [**get_groups**](docs/GroupControllerApi.md#get_groups) | **GET** /groups | Get all groups
|
137
|
-
*MailSlurpClient::GroupControllerApi* | [**remove_contacts_from_group**](docs/GroupControllerApi.md#remove_contacts_from_group) | **DELETE** /groups/{groupId}/contacts | Remove contacts from a group
|
138
|
-
*MailSlurpClient::InboxControllerApi* | [**create_inbox**](docs/InboxControllerApi.md#create_inbox) | **POST** /inboxes | Create an Inbox (email address)
|
139
|
-
*MailSlurpClient::InboxControllerApi* | [**delete_all_inboxes**](docs/InboxControllerApi.md#delete_all_inboxes) | **DELETE** /inboxes | Delete all inboxes
|
140
|
-
*MailSlurpClient::InboxControllerApi* | [**delete_inbox**](docs/InboxControllerApi.md#delete_inbox) | **DELETE** /inboxes/{inboxId} | Delete inbox
|
141
|
-
*MailSlurpClient::InboxControllerApi* | [**get_all_inboxes**](docs/InboxControllerApi.md#get_all_inboxes) | **GET** /inboxes/paginated | List Inboxes Paginated
|
142
|
-
*MailSlurpClient::InboxControllerApi* | [**get_emails**](docs/InboxControllerApi.md#get_emails) | **GET** /inboxes/{inboxId}/emails | Get emails in an Inbox
|
143
|
-
*MailSlurpClient::InboxControllerApi* | [**get_inbox**](docs/InboxControllerApi.md#get_inbox) | **GET** /inboxes/{inboxId} | Get Inbox
|
144
|
-
*MailSlurpClient::InboxControllerApi* | [**get_inbox_emails_paginated**](docs/InboxControllerApi.md#get_inbox_emails_paginated) | **GET** /inboxes/{inboxId}/emails/paginated | Get inbox emails paginated
|
145
|
-
*MailSlurpClient::InboxControllerApi* | [**get_inbox_tags**](docs/InboxControllerApi.md#get_inbox_tags) | **GET** /inboxes/tags | Get inbox tags
|
146
|
-
*MailSlurpClient::InboxControllerApi* | [**get_inboxes**](docs/InboxControllerApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
|
147
|
-
*MailSlurpClient::InboxControllerApi* | [**send_email**](docs/InboxControllerApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
|
148
|
-
*MailSlurpClient::InboxControllerApi* | [**set_inbox_favourited**](docs/InboxControllerApi.md#set_inbox_favourited) | **PUT** /inboxes/{inboxId}/favourite | Set inbox favourited state
|
149
|
-
*MailSlurpClient::InboxControllerApi* | [**update_inbox**](docs/InboxControllerApi.md#update_inbox) | **PATCH** /inboxes/{inboxId} | Update Inbox
|
150
|
-
*MailSlurpClient::TemplateControllerApi* | [**create_template**](docs/TemplateControllerApi.md#create_template) | **POST** /templates | Create a Template
|
151
|
-
*MailSlurpClient::TemplateControllerApi* | [**delete_template**](docs/TemplateControllerApi.md#delete_template) | **DELETE** /templates/{TemplateId} | Delete Template
|
152
|
-
*MailSlurpClient::TemplateControllerApi* | [**get_all_templates**](docs/TemplateControllerApi.md#get_all_templates) | **GET** /templates/paginated | Get all Templates in paginated format
|
153
|
-
*MailSlurpClient::TemplateControllerApi* | [**get_template**](docs/TemplateControllerApi.md#get_template) | **GET** /templates/{TemplateId} | Get Template
|
154
|
-
*MailSlurpClient::TemplateControllerApi* | [**get_templates**](docs/TemplateControllerApi.md#get_templates) | **GET** /templates | Get all Templates
|
155
|
-
*MailSlurpClient::WaitForControllerApi* | [**wait_for**](docs/WaitForControllerApi.md#wait_for) | **POST** /waitFor | Wait for conditions to be met
|
156
|
-
*MailSlurpClient::WaitForControllerApi* | [**wait_for_email_count**](docs/WaitForControllerApi.md#wait_for_email_count) | **GET** /waitForEmailCount | Wait for and return count number of emails
|
157
|
-
*MailSlurpClient::WaitForControllerApi* | [**wait_for_latest_email**](docs/WaitForControllerApi.md#wait_for_latest_email) | **GET** /waitForLatestEmail | Fetch inbox's latest email or if empty wait for an email to arrive
|
158
|
-
*MailSlurpClient::WaitForControllerApi* | [**wait_for_matching_email**](docs/WaitForControllerApi.md#wait_for_matching_email) | **POST** /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns
|
159
|
-
*MailSlurpClient::WaitForControllerApi* | [**wait_for_nth_email**](docs/WaitForControllerApi.md#wait_for_nth_email) | **GET** /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified
|
160
|
-
*MailSlurpClient::WebhookControllerApi* | [**create_webhook**](docs/WebhookControllerApi.md#create_webhook) | **POST** /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox
|
161
|
-
*MailSlurpClient::WebhookControllerApi* | [**delete_webhook**](docs/WebhookControllerApi.md#delete_webhook) | **DELETE** /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a Webhook for an Inbox
|
162
|
-
*MailSlurpClient::WebhookControllerApi* | [**get_all_webhooks**](docs/WebhookControllerApi.md#get_all_webhooks) | **GET** /webhooks/paginated | List Webhooks Paginated
|
163
|
-
*MailSlurpClient::WebhookControllerApi* | [**get_webhook**](docs/WebhookControllerApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook for an Inbox
|
164
|
-
*MailSlurpClient::WebhookControllerApi* | [**get_webhooks**](docs/WebhookControllerApi.md#get_webhooks) | **GET** /inboxes/{inboxId}/webhooks | Get all Webhooks for an Inbox
|
165
|
-
*MailSlurpClient::WebhookControllerApi* | [**send_test_data**](docs/WebhookControllerApi.md#send_test_data) | **POST** /webhooks/{webhookId}/test | Send webhook test data
|
166
|
-
|
167
|
-
|
168
|
-
## Documentation for Models
|
169
|
-
|
170
|
-
- [MailSlurpClient::AttachmentMetaData](docs/AttachmentMetaData.md)
|
171
|
-
- [MailSlurpClient::BasicAuthOptions](docs/BasicAuthOptions.md)
|
172
|
-
- [MailSlurpClient::BulkSendEmailOptions](docs/BulkSendEmailOptions.md)
|
173
|
-
- [MailSlurpClient::ContactDto](docs/ContactDto.md)
|
174
|
-
- [MailSlurpClient::ContactProjection](docs/ContactProjection.md)
|
175
|
-
- [MailSlurpClient::CreateAnonymousAliasOptions](docs/CreateAnonymousAliasOptions.md)
|
176
|
-
- [MailSlurpClient::CreateContactOptions](docs/CreateContactOptions.md)
|
177
|
-
- [MailSlurpClient::CreateDomainOptions](docs/CreateDomainOptions.md)
|
178
|
-
- [MailSlurpClient::CreateGroupOptions](docs/CreateGroupOptions.md)
|
179
|
-
- [MailSlurpClient::CreateOwnedAliasOptions](docs/CreateOwnedAliasOptions.md)
|
180
|
-
- [MailSlurpClient::CreateTemplateOptions](docs/CreateTemplateOptions.md)
|
181
|
-
- [MailSlurpClient::CreateWebhookOptions](docs/CreateWebhookOptions.md)
|
182
|
-
- [MailSlurpClient::DomainDto](docs/DomainDto.md)
|
183
|
-
- [MailSlurpClient::DomainPreview](docs/DomainPreview.md)
|
184
|
-
- [MailSlurpClient::Email](docs/Email.md)
|
185
|
-
- [MailSlurpClient::EmailAnalysis](docs/EmailAnalysis.md)
|
186
|
-
- [MailSlurpClient::EmailPreview](docs/EmailPreview.md)
|
187
|
-
- [MailSlurpClient::EmailProjection](docs/EmailProjection.md)
|
188
|
-
- [MailSlurpClient::ForwardEmailOptions](docs/ForwardEmailOptions.md)
|
189
|
-
- [MailSlurpClient::GroupContactsDto](docs/GroupContactsDto.md)
|
190
|
-
- [MailSlurpClient::GroupDto](docs/GroupDto.md)
|
191
|
-
- [MailSlurpClient::GroupProjection](docs/GroupProjection.md)
|
192
|
-
- [MailSlurpClient::HTMLValidationResult](docs/HTMLValidationResult.md)
|
193
|
-
- [MailSlurpClient::Inbox](docs/Inbox.md)
|
194
|
-
- [MailSlurpClient::InboxProjection](docs/InboxProjection.md)
|
195
|
-
- [MailSlurpClient::JsonNode](docs/JsonNode.md)
|
196
|
-
- [MailSlurpClient::MatchOption](docs/MatchOption.md)
|
197
|
-
- [MailSlurpClient::MatchOptions](docs/MatchOptions.md)
|
198
|
-
- [MailSlurpClient::ModelAlias](docs/ModelAlias.md)
|
199
|
-
- [MailSlurpClient::PageAlias](docs/PageAlias.md)
|
200
|
-
- [MailSlurpClient::PageContactProjection](docs/PageContactProjection.md)
|
201
|
-
- [MailSlurpClient::PageEmailPreview](docs/PageEmailPreview.md)
|
202
|
-
- [MailSlurpClient::PageEmailProjection](docs/PageEmailProjection.md)
|
203
|
-
- [MailSlurpClient::PageGroupProjection](docs/PageGroupProjection.md)
|
204
|
-
- [MailSlurpClient::PageInboxProjection](docs/PageInboxProjection.md)
|
205
|
-
- [MailSlurpClient::PageTemplateProjection](docs/PageTemplateProjection.md)
|
206
|
-
- [MailSlurpClient::PageWebhookProjection](docs/PageWebhookProjection.md)
|
207
|
-
- [MailSlurpClient::Pageable](docs/Pageable.md)
|
208
|
-
- [MailSlurpClient::RawEmailJson](docs/RawEmailJson.md)
|
209
|
-
- [MailSlurpClient::SendEmailOptions](docs/SendEmailOptions.md)
|
210
|
-
- [MailSlurpClient::SetInboxFavouritedOptions](docs/SetInboxFavouritedOptions.md)
|
211
|
-
- [MailSlurpClient::SimpleSendEmailOptions](docs/SimpleSendEmailOptions.md)
|
212
|
-
- [MailSlurpClient::Sort](docs/Sort.md)
|
213
|
-
- [MailSlurpClient::TemplateDto](docs/TemplateDto.md)
|
214
|
-
- [MailSlurpClient::TemplateProjection](docs/TemplateProjection.md)
|
215
|
-
- [MailSlurpClient::TemplateVariable](docs/TemplateVariable.md)
|
216
|
-
- [MailSlurpClient::UnreadCount](docs/UnreadCount.md)
|
217
|
-
- [MailSlurpClient::UpdateGroupContacts](docs/UpdateGroupContacts.md)
|
218
|
-
- [MailSlurpClient::UpdateInboxOptions](docs/UpdateInboxOptions.md)
|
219
|
-
- [MailSlurpClient::UploadAttachmentOptions](docs/UploadAttachmentOptions.md)
|
220
|
-
- [MailSlurpClient::ValidationDto](docs/ValidationDto.md)
|
221
|
-
- [MailSlurpClient::ValidationMessage](docs/ValidationMessage.md)
|
222
|
-
- [MailSlurpClient::WaitForConditions](docs/WaitForConditions.md)
|
223
|
-
- [MailSlurpClient::WebhookDto](docs/WebhookDto.md)
|
224
|
-
- [MailSlurpClient::WebhookProjection](docs/WebhookProjection.md)
|
225
|
-
- [MailSlurpClient::WebhookTestRequest](docs/WebhookTestRequest.md)
|
226
|
-
- [MailSlurpClient::WebhookTestResponse](docs/WebhookTestResponse.md)
|
227
|
-
- [MailSlurpClient::WebhookTestResult](docs/WebhookTestResult.md)
|
228
|
-
|
229
|
-
|
230
|
-
## Documentation for Authorization
|
231
|
-
|
232
|
-
|
233
|
-
### API_KEY
|
234
|
-
|
235
|
-
|
236
|
-
- **Type**: API key
|
237
|
-
- **API key parameter name**: x-api-key
|
238
|
-
- **Location**: HTTP header
|
239
|
-
|
data/Rakefile
DELETED
data/docs/AliasControllerApi.md
DELETED
@@ -1,337 +0,0 @@
|
|
1
|
-
# MailSlurpClient::AliasControllerApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.mailslurp.com*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**create_alias**](AliasControllerApi.md#create_alias) | **POST** /aliases | Create an email alias
|
8
|
-
[**create_anonymous_alias**](AliasControllerApi.md#create_anonymous_alias) | **POST** /aliases/anonymous | Create an anonymous email alias
|
9
|
-
[**delete_alias**](AliasControllerApi.md#delete_alias) | **DELETE** /aliases/{aliasId} | Delete an owned alias
|
10
|
-
[**get_alias**](AliasControllerApi.md#get_alias) | **GET** /aliases/{aliasId} | Get an email alias
|
11
|
-
[**get_aliases**](AliasControllerApi.md#get_aliases) | **GET** /aliases | Get all email aliases
|
12
|
-
[**update_alias**](AliasControllerApi.md#update_alias) | **PUT** /aliases/{aliasId} | Update an owned alias
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
## create_alias
|
17
|
-
|
18
|
-
> create_alias(create_owned_alias_options)
|
19
|
-
|
20
|
-
Create an email alias
|
21
|
-
|
22
|
-
Create an email alias belonging to a user ID. To create anonymous aliases use the `createAnonymousAlias` method.
|
23
|
-
|
24
|
-
### Example
|
25
|
-
|
26
|
-
```ruby
|
27
|
-
# load the gem
|
28
|
-
require 'mailslurp_client'
|
29
|
-
# setup authorization
|
30
|
-
MailSlurpClient.configure do |config|
|
31
|
-
# Configure API key authorization: API_KEY
|
32
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
33
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
35
|
-
end
|
36
|
-
|
37
|
-
api_instance = MailSlurpClient::AliasControllerApi.new
|
38
|
-
create_owned_alias_options = MailSlurpClient::CreateOwnedAliasOptions.new # CreateOwnedAliasOptions | createOwnedAliasOptions
|
39
|
-
|
40
|
-
begin
|
41
|
-
#Create an email alias
|
42
|
-
api_instance.create_alias(create_owned_alias_options)
|
43
|
-
rescue MailSlurpClient::ApiError => e
|
44
|
-
puts "Exception when calling AliasControllerApi->create_alias: #{e}"
|
45
|
-
end
|
46
|
-
```
|
47
|
-
|
48
|
-
### Parameters
|
49
|
-
|
50
|
-
|
51
|
-
Name | Type | Description | Notes
|
52
|
-
------------- | ------------- | ------------- | -------------
|
53
|
-
**create_owned_alias_options** | [**CreateOwnedAliasOptions**](CreateOwnedAliasOptions.md)| createOwnedAliasOptions |
|
54
|
-
|
55
|
-
### Return type
|
56
|
-
|
57
|
-
nil (empty response body)
|
58
|
-
|
59
|
-
### Authorization
|
60
|
-
|
61
|
-
[API_KEY](../README.md#API_KEY)
|
62
|
-
|
63
|
-
### HTTP request headers
|
64
|
-
|
65
|
-
- **Content-Type**: application/json
|
66
|
-
- **Accept**: application/json
|
67
|
-
|
68
|
-
|
69
|
-
## create_anonymous_alias
|
70
|
-
|
71
|
-
> ModelAlias create_anonymous_alias(create_anonymous_alias_options)
|
72
|
-
|
73
|
-
Create an anonymous email alias
|
74
|
-
|
75
|
-
### Example
|
76
|
-
|
77
|
-
```ruby
|
78
|
-
# load the gem
|
79
|
-
require 'mailslurp_client'
|
80
|
-
# setup authorization
|
81
|
-
MailSlurpClient.configure do |config|
|
82
|
-
# Configure API key authorization: API_KEY
|
83
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
84
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
85
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
86
|
-
end
|
87
|
-
|
88
|
-
api_instance = MailSlurpClient::AliasControllerApi.new
|
89
|
-
create_anonymous_alias_options = MailSlurpClient::CreateAnonymousAliasOptions.new # CreateAnonymousAliasOptions | createAnonymousAliasOptions
|
90
|
-
|
91
|
-
begin
|
92
|
-
#Create an anonymous email alias
|
93
|
-
result = api_instance.create_anonymous_alias(create_anonymous_alias_options)
|
94
|
-
p result
|
95
|
-
rescue MailSlurpClient::ApiError => e
|
96
|
-
puts "Exception when calling AliasControllerApi->create_anonymous_alias: #{e}"
|
97
|
-
end
|
98
|
-
```
|
99
|
-
|
100
|
-
### Parameters
|
101
|
-
|
102
|
-
|
103
|
-
Name | Type | Description | Notes
|
104
|
-
------------- | ------------- | ------------- | -------------
|
105
|
-
**create_anonymous_alias_options** | [**CreateAnonymousAliasOptions**](CreateAnonymousAliasOptions.md)| createAnonymousAliasOptions |
|
106
|
-
|
107
|
-
### Return type
|
108
|
-
|
109
|
-
[**ModelAlias**](ModelAlias.md)
|
110
|
-
|
111
|
-
### Authorization
|
112
|
-
|
113
|
-
[API_KEY](../README.md#API_KEY)
|
114
|
-
|
115
|
-
### HTTP request headers
|
116
|
-
|
117
|
-
- **Content-Type**: application/json
|
118
|
-
- **Accept**: application/json
|
119
|
-
|
120
|
-
|
121
|
-
## delete_alias
|
122
|
-
|
123
|
-
> delete_alias(alias_id)
|
124
|
-
|
125
|
-
Delete an owned alias
|
126
|
-
|
127
|
-
### Example
|
128
|
-
|
129
|
-
```ruby
|
130
|
-
# load the gem
|
131
|
-
require 'mailslurp_client'
|
132
|
-
# setup authorization
|
133
|
-
MailSlurpClient.configure do |config|
|
134
|
-
# Configure API key authorization: API_KEY
|
135
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
136
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
137
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
138
|
-
end
|
139
|
-
|
140
|
-
api_instance = MailSlurpClient::AliasControllerApi.new
|
141
|
-
alias_id = 'alias_id_example' # String | aliasId
|
142
|
-
|
143
|
-
begin
|
144
|
-
#Delete an owned alias
|
145
|
-
api_instance.delete_alias(alias_id)
|
146
|
-
rescue MailSlurpClient::ApiError => e
|
147
|
-
puts "Exception when calling AliasControllerApi->delete_alias: #{e}"
|
148
|
-
end
|
149
|
-
```
|
150
|
-
|
151
|
-
### Parameters
|
152
|
-
|
153
|
-
|
154
|
-
Name | Type | Description | Notes
|
155
|
-
------------- | ------------- | ------------- | -------------
|
156
|
-
**alias_id** | [**String**](.md)| aliasId |
|
157
|
-
|
158
|
-
### Return type
|
159
|
-
|
160
|
-
nil (empty response body)
|
161
|
-
|
162
|
-
### Authorization
|
163
|
-
|
164
|
-
[API_KEY](../README.md#API_KEY)
|
165
|
-
|
166
|
-
### HTTP request headers
|
167
|
-
|
168
|
-
- **Content-Type**: Not defined
|
169
|
-
- **Accept**: Not defined
|
170
|
-
|
171
|
-
|
172
|
-
## get_alias
|
173
|
-
|
174
|
-
> ModelAlias get_alias(alias_id)
|
175
|
-
|
176
|
-
Get an email alias
|
177
|
-
|
178
|
-
Get an email alias by ID
|
179
|
-
|
180
|
-
### Example
|
181
|
-
|
182
|
-
```ruby
|
183
|
-
# load the gem
|
184
|
-
require 'mailslurp_client'
|
185
|
-
# setup authorization
|
186
|
-
MailSlurpClient.configure do |config|
|
187
|
-
# Configure API key authorization: API_KEY
|
188
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
189
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
190
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
191
|
-
end
|
192
|
-
|
193
|
-
api_instance = MailSlurpClient::AliasControllerApi.new
|
194
|
-
alias_id = 'alias_id_example' # String | aliasId
|
195
|
-
|
196
|
-
begin
|
197
|
-
#Get an email alias
|
198
|
-
result = api_instance.get_alias(alias_id)
|
199
|
-
p result
|
200
|
-
rescue MailSlurpClient::ApiError => e
|
201
|
-
puts "Exception when calling AliasControllerApi->get_alias: #{e}"
|
202
|
-
end
|
203
|
-
```
|
204
|
-
|
205
|
-
### Parameters
|
206
|
-
|
207
|
-
|
208
|
-
Name | Type | Description | Notes
|
209
|
-
------------- | ------------- | ------------- | -------------
|
210
|
-
**alias_id** | [**String**](.md)| aliasId |
|
211
|
-
|
212
|
-
### Return type
|
213
|
-
|
214
|
-
[**ModelAlias**](ModelAlias.md)
|
215
|
-
|
216
|
-
### Authorization
|
217
|
-
|
218
|
-
[API_KEY](../README.md#API_KEY)
|
219
|
-
|
220
|
-
### HTTP request headers
|
221
|
-
|
222
|
-
- **Content-Type**: Not defined
|
223
|
-
- **Accept**: application/json
|
224
|
-
|
225
|
-
|
226
|
-
## get_aliases
|
227
|
-
|
228
|
-
> PageAlias get_aliases(opts)
|
229
|
-
|
230
|
-
Get all email aliases
|
231
|
-
|
232
|
-
Get all email aliases in paginated form
|
233
|
-
|
234
|
-
### Example
|
235
|
-
|
236
|
-
```ruby
|
237
|
-
# load the gem
|
238
|
-
require 'mailslurp_client'
|
239
|
-
# setup authorization
|
240
|
-
MailSlurpClient.configure do |config|
|
241
|
-
# Configure API key authorization: API_KEY
|
242
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
243
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
244
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
245
|
-
end
|
246
|
-
|
247
|
-
api_instance = MailSlurpClient::AliasControllerApi.new
|
248
|
-
opts = {
|
249
|
-
page: 0, # Integer | Optional page index in alias list pagination
|
250
|
-
size: 20, # Integer | Optional page size in alias list pagination
|
251
|
-
sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
|
252
|
-
}
|
253
|
-
|
254
|
-
begin
|
255
|
-
#Get all email aliases
|
256
|
-
result = api_instance.get_aliases(opts)
|
257
|
-
p result
|
258
|
-
rescue MailSlurpClient::ApiError => e
|
259
|
-
puts "Exception when calling AliasControllerApi->get_aliases: #{e}"
|
260
|
-
end
|
261
|
-
```
|
262
|
-
|
263
|
-
### Parameters
|
264
|
-
|
265
|
-
|
266
|
-
Name | Type | Description | Notes
|
267
|
-
------------- | ------------- | ------------- | -------------
|
268
|
-
**page** | **Integer**| Optional page index in alias list pagination | [optional] [default to 0]
|
269
|
-
**size** | **Integer**| Optional page size in alias list pagination | [optional] [default to 20]
|
270
|
-
**sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC']
|
271
|
-
|
272
|
-
### Return type
|
273
|
-
|
274
|
-
[**PageAlias**](PageAlias.md)
|
275
|
-
|
276
|
-
### Authorization
|
277
|
-
|
278
|
-
[API_KEY](../README.md#API_KEY)
|
279
|
-
|
280
|
-
### HTTP request headers
|
281
|
-
|
282
|
-
- **Content-Type**: Not defined
|
283
|
-
- **Accept**: application/json
|
284
|
-
|
285
|
-
|
286
|
-
## update_alias
|
287
|
-
|
288
|
-
> update_alias(alias_id, create_owned_alias_options)
|
289
|
-
|
290
|
-
Update an owned alias
|
291
|
-
|
292
|
-
### Example
|
293
|
-
|
294
|
-
```ruby
|
295
|
-
# load the gem
|
296
|
-
require 'mailslurp_client'
|
297
|
-
# setup authorization
|
298
|
-
MailSlurpClient.configure do |config|
|
299
|
-
# Configure API key authorization: API_KEY
|
300
|
-
config.api_key['x-api-key'] = 'YOUR API KEY'
|
301
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
302
|
-
#config.api_key_prefix['x-api-key'] = 'Bearer'
|
303
|
-
end
|
304
|
-
|
305
|
-
api_instance = MailSlurpClient::AliasControllerApi.new
|
306
|
-
alias_id = 'alias_id_example' # String | aliasId
|
307
|
-
create_owned_alias_options = MailSlurpClient::CreateOwnedAliasOptions.new # CreateOwnedAliasOptions | createOwnedAliasOptions
|
308
|
-
|
309
|
-
begin
|
310
|
-
#Update an owned alias
|
311
|
-
api_instance.update_alias(alias_id, create_owned_alias_options)
|
312
|
-
rescue MailSlurpClient::ApiError => e
|
313
|
-
puts "Exception when calling AliasControllerApi->update_alias: #{e}"
|
314
|
-
end
|
315
|
-
```
|
316
|
-
|
317
|
-
### Parameters
|
318
|
-
|
319
|
-
|
320
|
-
Name | Type | Description | Notes
|
321
|
-
------------- | ------------- | ------------- | -------------
|
322
|
-
**alias_id** | [**String**](.md)| aliasId |
|
323
|
-
**create_owned_alias_options** | [**CreateOwnedAliasOptions**](CreateOwnedAliasOptions.md)| createOwnedAliasOptions |
|
324
|
-
|
325
|
-
### Return type
|
326
|
-
|
327
|
-
nil (empty response body)
|
328
|
-
|
329
|
-
### Authorization
|
330
|
-
|
331
|
-
[API_KEY](../README.md#API_KEY)
|
332
|
-
|
333
|
-
### HTTP request headers
|
334
|
-
|
335
|
-
- **Content-Type**: application/json
|
336
|
-
- **Accept**: application/json
|
337
|
-
|