mailslurp_client 7.0.7 → 7.0.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. checksums.yaml +4 -4
  2. data/Makefile +3 -0
  3. data/README.md +26 -13
  4. data/docs/AliasControllerApi.md +337 -0
  5. data/docs/AttachmentControllerApi.md +3 -1
  6. data/docs/AttachmentMetaData.md +4 -4
  7. data/docs/BulkSendEmailOptions.md +1 -1
  8. data/docs/CommonActionsControllerApi.md +60 -9
  9. data/docs/CreateAnonymousAliasOptions.md +17 -0
  10. data/docs/CreateOwnedAliasOptions.md +23 -0
  11. data/docs/EmailAnalysis.md +5 -5
  12. data/docs/FormControllerApi.md +79 -0
  13. data/docs/ForwardEmailOptions.md +7 -7
  14. data/docs/InboxControllerApi.md +54 -1
  15. data/docs/ModelAlias.md +31 -0
  16. data/docs/PageAlias.md +37 -0
  17. data/docs/SimpleSendEmailOptions.md +23 -0
  18. data/docs/ValidationDto.md +2 -2
  19. data/docs/WaitForConditions.md +6 -6
  20. data/docs/WaitForControllerApi.md +3 -3
  21. data/lib/mailslurp_client.rb +8 -1
  22. data/lib/mailslurp_client/api/alias_controller_api.rb +405 -0
  23. data/lib/mailslurp_client/api/attachment_controller_api.rb +4 -1
  24. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +1 -1
  25. data/lib/mailslurp_client/api/common_actions_controller_api.rb +71 -15
  26. data/lib/mailslurp_client/api/contact_controller_api.rb +1 -1
  27. data/lib/mailslurp_client/api/domain_controller_api.rb +1 -1
  28. data/lib/mailslurp_client/api/email_controller_api.rb +1 -1
  29. data/lib/mailslurp_client/api/form_controller_api.rb +104 -0
  30. data/lib/mailslurp_client/api/group_controller_api.rb +1 -1
  31. data/lib/mailslurp_client/api/inbox_controller_api.rb +60 -1
  32. data/lib/mailslurp_client/api/template_controller_api.rb +1 -1
  33. data/lib/mailslurp_client/api/wait_for_controller_api.rb +5 -5
  34. data/lib/mailslurp_client/api/webhook_controller_api.rb +1 -1
  35. data/lib/mailslurp_client/api_client.rb +1 -1
  36. data/lib/mailslurp_client/api_error.rb +1 -1
  37. data/lib/mailslurp_client/configuration.rb +1 -1
  38. data/lib/mailslurp_client/models/attachment_meta_data.rb +6 -21
  39. data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
  40. data/lib/mailslurp_client/models/bulk_send_email_options.rb +2 -7
  41. data/lib/mailslurp_client/models/contact_dto.rb +1 -1
  42. data/lib/mailslurp_client/models/contact_projection.rb +1 -1
  43. data/lib/mailslurp_client/models/create_anonymous_alias_options.rb +208 -0
  44. data/lib/mailslurp_client/models/create_contact_options.rb +1 -1
  45. data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
  46. data/lib/mailslurp_client/models/create_group_options.rb +1 -1
  47. data/lib/mailslurp_client/models/create_owned_alias_options.rb +238 -0
  48. data/lib/mailslurp_client/models/create_template_options.rb +1 -1
  49. data/lib/mailslurp_client/models/create_webhook_options.rb +1 -1
  50. data/lib/mailslurp_client/models/domain_dto.rb +1 -1
  51. data/lib/mailslurp_client/models/domain_preview.rb +1 -1
  52. data/lib/mailslurp_client/models/email.rb +2 -2
  53. data/lib/mailslurp_client/models/email_analysis.rb +7 -2
  54. data/lib/mailslurp_client/models/email_preview.rb +2 -2
  55. data/lib/mailslurp_client/models/email_projection.rb +2 -1
  56. data/lib/mailslurp_client/models/forward_email_options.rb +29 -30
  57. data/lib/mailslurp_client/models/group_contacts_dto.rb +1 -1
  58. data/lib/mailslurp_client/models/group_dto.rb +1 -1
  59. data/lib/mailslurp_client/models/group_projection.rb +1 -1
  60. data/lib/mailslurp_client/models/html_validation_result.rb +1 -1
  61. data/lib/mailslurp_client/models/inbox.rb +1 -1
  62. data/lib/mailslurp_client/models/inbox_projection.rb +1 -1
  63. data/lib/mailslurp_client/models/json_node.rb +1 -1
  64. data/lib/mailslurp_client/models/match_option.rb +1 -1
  65. data/lib/mailslurp_client/models/match_options.rb +2 -2
  66. data/lib/mailslurp_client/models/model_alias.rb +284 -0
  67. data/lib/mailslurp_client/models/page_alias.rb +298 -0
  68. data/lib/mailslurp_client/models/page_contact_projection.rb +1 -1
  69. data/lib/mailslurp_client/models/page_email_preview.rb +1 -1
  70. data/lib/mailslurp_client/models/page_email_projection.rb +1 -1
  71. data/lib/mailslurp_client/models/page_group_projection.rb +1 -1
  72. data/lib/mailslurp_client/models/page_inbox_projection.rb +1 -1
  73. data/lib/mailslurp_client/models/page_template_projection.rb +1 -1
  74. data/lib/mailslurp_client/models/page_webhook_projection.rb +1 -1
  75. data/lib/mailslurp_client/models/pageable.rb +1 -1
  76. data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
  77. data/lib/mailslurp_client/models/send_email_options.rb +1 -1
  78. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +1 -1
  79. data/lib/mailslurp_client/models/simple_send_email_options.rb +237 -0
  80. data/lib/mailslurp_client/models/sort.rb +1 -1
  81. data/lib/mailslurp_client/models/template_dto.rb +1 -1
  82. data/lib/mailslurp_client/models/template_projection.rb +1 -1
  83. data/lib/mailslurp_client/models/template_variable.rb +1 -1
  84. data/lib/mailslurp_client/models/unread_count.rb +1 -1
  85. data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
  86. data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
  87. data/lib/mailslurp_client/models/upload_attachment_options.rb +2 -2
  88. data/lib/mailslurp_client/models/validation_dto.rb +3 -11
  89. data/lib/mailslurp_client/models/validation_message.rb +1 -1
  90. data/lib/mailslurp_client/models/wait_for_conditions.rb +8 -7
  91. data/lib/mailslurp_client/models/webhook_dto.rb +1 -1
  92. data/lib/mailslurp_client/models/webhook_projection.rb +1 -1
  93. data/lib/mailslurp_client/models/webhook_test_request.rb +1 -1
  94. data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
  95. data/lib/mailslurp_client/models/webhook_test_result.rb +1 -1
  96. data/lib/mailslurp_client/version.rb +2 -2
  97. data/mailslurp_client.gemspec +2 -2
  98. data/spec/api/alias_controller_api_spec.rb +107 -0
  99. data/spec/api/form_controller_api_spec.rb +54 -0
  100. data/spec/models/create_anonymous_alias_options_spec.rb +41 -0
  101. data/spec/models/create_owned_alias_options_spec.rb +59 -0
  102. data/spec/models/model_alias_spec.rb +83 -0
  103. data/spec/models/page_alias_spec.rb +101 -0
  104. data/spec/models/simple_send_email_options_spec.rb +59 -0
  105. metadata +33 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1eb19727caca8022cb4d3907951bf899d0997612b73b6134aee265976ff13b19
4
- data.tar.gz: fb9b675ca0ee08127d5332d3c5beb127f737dabfe668b92d39552f661f97018c
3
+ metadata.gz: 781f9cd6795f5538fb195caef9ade1d3c504fa17183a6ca88c7db12e0559177d
4
+ data.tar.gz: c6e95e8ab7915807a4793e0750997ee0e8d1317de43c12d4b8d98618c878c870
5
5
  SHA512:
6
- metadata.gz: 4711176ad05203ebff18ae15775541f904848cdaa0c5295216f32834d9e9ce4397e26ccbda6bc5c7cfaca298ba105207e1795cf68793cb99c77d83dd9b178c26
7
- data.tar.gz: 608d7c75c599ca5d50cf75b2cc6349edfc8980c334f19010a3a25e8b90bd68292b9906acca9a949325d0d15d24d4baa0d0150b0f4484f0b0123cc830bd5b5333
6
+ metadata.gz: d25620ca5219162bf4bde47986a554ddcfaeaac2b00d208544f6ff6be6c88d67daf660ed26bd4a60bb2dbb508b61fb3facb17709ef51816ca3a9bd8923d0be2a
7
+ data.tar.gz: b26dae3f1df097c04b3700c69511d0705b07d217ec31e8fee17a538850e35b25fa68d79735c567f5a2012098cead5c7b4c06c3353c75242e36f2ca42d65bb556
data/Makefile ADDED
@@ -0,0 +1,3 @@
1
+ deploy:
2
+ gem build mailslurp_client.gemspec
3
+ gem push *.gem
data/README.md CHANGED
@@ -13,8 +13,8 @@ MailSlurp is an API for sending and receiving emails from dynamically allocated
13
13
 
14
14
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
15
15
 
16
- - API version: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
17
- - Package version: 7.0.7
16
+ - API version: d1659dc1567a5b62f65d0612107a50aace03e085
17
+ - Package version: 7.0.8
18
18
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
19
19
 
20
20
  ## Installation
@@ -30,16 +30,16 @@ gem build mailslurp_client.gemspec
30
30
  Then either install the gem locally:
31
31
 
32
32
  ```shell
33
- gem install ./mailslurp_client-7.0.7.gem
33
+ gem install ./mailslurp_client-7.0.8.gem
34
34
  ```
35
35
 
36
- (for development, run `gem install --dev ./mailslurp_client-7.0.7.gem` to install the development dependencies)
36
+ (for development, run `gem install --dev ./mailslurp_client-7.0.8.gem` to install the development dependencies)
37
37
 
38
38
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
39
39
 
40
40
  Finally add this to the Gemfile:
41
41
 
42
- gem 'mailslurp_client', '~> 7.0.7'
42
+ gem 'mailslurp_client', '~> 7.0.8'
43
43
 
44
44
  ### Install from Git
45
45
 
@@ -71,15 +71,14 @@ MailSlurpClient.configure do |config|
71
71
  #config.api_key_prefix['x-api-key'] = 'Bearer'
72
72
  end
73
73
 
74
- api_instance = MailSlurpClient::AttachmentControllerApi.new
75
- upload_options = MailSlurpClient::UploadAttachmentOptions.new # UploadAttachmentOptions | uploadOptions
74
+ api_instance = MailSlurpClient::AliasControllerApi.new
75
+ create_owned_alias_options = MailSlurpClient::CreateOwnedAliasOptions.new # CreateOwnedAliasOptions | createOwnedAliasOptions
76
76
 
77
77
  begin
78
- #Upload an attachment for sending
79
- result = api_instance.upload_attachment(upload_options)
80
- p result
78
+ #Create an email alias
79
+ api_instance.create_alias(create_owned_alias_options)
81
80
  rescue MailSlurpClient::ApiError => e
82
- puts "Exception when calling AttachmentControllerApi->upload_attachment: #{e}"
81
+ puts "Exception when calling AliasControllerApi->create_alias: #{e}"
83
82
  end
84
83
 
85
84
  ```
@@ -90,14 +89,21 @@ All URIs are relative to *https://api.mailslurp.com*
90
89
 
91
90
  Class | Method | HTTP request | Description
92
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
93
98
  *MailSlurpClient::AttachmentControllerApi* | [**upload_attachment**](docs/AttachmentControllerApi.md#upload_attachment) | **POST** /attachments | Upload an attachment for sending
94
99
  *MailSlurpClient::AttachmentControllerApi* | [**upload_multipart_form**](docs/AttachmentControllerApi.md#upload_multipart_form) | **POST** /attachments/multipart | Upload an attachment for sending using Multipart Form
95
100
  *MailSlurpClient::BulkActionsControllerApi* | [**bulk_create_inboxes**](docs/BulkActionsControllerApi.md#bulk_create_inboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)
96
101
  *MailSlurpClient::BulkActionsControllerApi* | [**bulk_delete_inboxes**](docs/BulkActionsControllerApi.md#bulk_delete_inboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes
97
102
  *MailSlurpClient::BulkActionsControllerApi* | [**bulk_send_emails**](docs/BulkActionsControllerApi.md#bulk_send_emails) | **POST** /bulk/send | Bulk Send Emails
98
- *MailSlurpClient::CommonActionsControllerApi* | [**create_new_email_address**](docs/CommonActionsControllerApi.md#create_new_email_address) | **POST** /newEmailAddress | Create new random inbox
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
99
105
  *MailSlurpClient::CommonActionsControllerApi* | [**empty_inbox**](docs/CommonActionsControllerApi.md#empty_inbox) | **DELETE** /emptyInbox | Delete all emails in an inbox
100
- *MailSlurpClient::CommonActionsControllerApi* | [**send_email_simple**](docs/CommonActionsControllerApi.md#send_email_simple) | **POST** /sendEmail | Send an email from a random email address
106
+ *MailSlurpClient::CommonActionsControllerApi* | [**send_email_simple**](docs/CommonActionsControllerApi.md#send_email_simple) | **POST** /sendEmail | Send an email
101
107
  *MailSlurpClient::ContactControllerApi* | [**create_contact**](docs/ContactControllerApi.md#create_contact) | **POST** /contacts | Create a contact
102
108
  *MailSlurpClient::ContactControllerApi* | [**delete_contact**](docs/ContactControllerApi.md#delete_contact) | **DELETE** /contacts/{contactId} | Delete contact
103
109
  *MailSlurpClient::ContactControllerApi* | [**get_all_contacts**](docs/ContactControllerApi.md#get_all_contacts) | **GET** /contacts/paginated | Get all contacts
@@ -120,6 +126,7 @@ Class | Method | HTTP request | Description
120
126
  *MailSlurpClient::EmailControllerApi* | [**get_raw_email_json**](docs/EmailControllerApi.md#get_raw_email_json) | **GET** /emails/{emailId}/raw/json | Get raw email in JSON
121
127
  *MailSlurpClient::EmailControllerApi* | [**get_unread_email_count**](docs/EmailControllerApi.md#get_unread_email_count) | **GET** /emails/unreadCount | Get unread email count
122
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
123
130
  *MailSlurpClient::GroupControllerApi* | [**add_contacts_to_group**](docs/GroupControllerApi.md#add_contacts_to_group) | **PUT** /groups/{groupId}/contacts | Add contacts to a group
124
131
  *MailSlurpClient::GroupControllerApi* | [**create_group**](docs/GroupControllerApi.md#create_group) | **POST** /groups | Create a group
125
132
  *MailSlurpClient::GroupControllerApi* | [**delete_group**](docs/GroupControllerApi.md#delete_group) | **DELETE** /groups/{groupId} | Delete group
@@ -135,6 +142,7 @@ Class | Method | HTTP request | Description
135
142
  *MailSlurpClient::InboxControllerApi* | [**get_emails**](docs/InboxControllerApi.md#get_emails) | **GET** /inboxes/{inboxId}/emails | Get emails in an Inbox
136
143
  *MailSlurpClient::InboxControllerApi* | [**get_inbox**](docs/InboxControllerApi.md#get_inbox) | **GET** /inboxes/{inboxId} | Get Inbox
137
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
138
146
  *MailSlurpClient::InboxControllerApi* | [**get_inboxes**](docs/InboxControllerApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
139
147
  *MailSlurpClient::InboxControllerApi* | [**send_email**](docs/InboxControllerApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
140
148
  *MailSlurpClient::InboxControllerApi* | [**set_inbox_favourited**](docs/InboxControllerApi.md#set_inbox_favourited) | **PUT** /inboxes/{inboxId}/favourite | Set inbox favourited state
@@ -164,9 +172,11 @@ Class | Method | HTTP request | Description
164
172
  - [MailSlurpClient::BulkSendEmailOptions](docs/BulkSendEmailOptions.md)
165
173
  - [MailSlurpClient::ContactDto](docs/ContactDto.md)
166
174
  - [MailSlurpClient::ContactProjection](docs/ContactProjection.md)
175
+ - [MailSlurpClient::CreateAnonymousAliasOptions](docs/CreateAnonymousAliasOptions.md)
167
176
  - [MailSlurpClient::CreateContactOptions](docs/CreateContactOptions.md)
168
177
  - [MailSlurpClient::CreateDomainOptions](docs/CreateDomainOptions.md)
169
178
  - [MailSlurpClient::CreateGroupOptions](docs/CreateGroupOptions.md)
179
+ - [MailSlurpClient::CreateOwnedAliasOptions](docs/CreateOwnedAliasOptions.md)
170
180
  - [MailSlurpClient::CreateTemplateOptions](docs/CreateTemplateOptions.md)
171
181
  - [MailSlurpClient::CreateWebhookOptions](docs/CreateWebhookOptions.md)
172
182
  - [MailSlurpClient::DomainDto](docs/DomainDto.md)
@@ -185,6 +195,8 @@ Class | Method | HTTP request | Description
185
195
  - [MailSlurpClient::JsonNode](docs/JsonNode.md)
186
196
  - [MailSlurpClient::MatchOption](docs/MatchOption.md)
187
197
  - [MailSlurpClient::MatchOptions](docs/MatchOptions.md)
198
+ - [MailSlurpClient::ModelAlias](docs/ModelAlias.md)
199
+ - [MailSlurpClient::PageAlias](docs/PageAlias.md)
188
200
  - [MailSlurpClient::PageContactProjection](docs/PageContactProjection.md)
189
201
  - [MailSlurpClient::PageEmailPreview](docs/PageEmailPreview.md)
190
202
  - [MailSlurpClient::PageEmailProjection](docs/PageEmailProjection.md)
@@ -196,6 +208,7 @@ Class | Method | HTTP request | Description
196
208
  - [MailSlurpClient::RawEmailJson](docs/RawEmailJson.md)
197
209
  - [MailSlurpClient::SendEmailOptions](docs/SendEmailOptions.md)
198
210
  - [MailSlurpClient::SetInboxFavouritedOptions](docs/SetInboxFavouritedOptions.md)
211
+ - [MailSlurpClient::SimpleSendEmailOptions](docs/SimpleSendEmailOptions.md)
199
212
  - [MailSlurpClient::Sort](docs/Sort.md)
200
213
  - [MailSlurpClient::TemplateDto](docs/TemplateDto.md)
201
214
  - [MailSlurpClient::TemplateProjection](docs/TemplateProjection.md)
@@ -0,0 +1,337 @@
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
+