mailslurp_client 5.0.0 → 7.0.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (214) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -0
  3. data/README.md +127 -40
  4. data/docs/AttachmentControllerApi.md +124 -0
  5. data/docs/AttachmentMetaData.md +23 -0
  6. data/docs/BasicAuthOptions.md +10 -0
  7. data/docs/BulkActionsControllerApi.md +165 -0
  8. data/docs/BulkSendEmailOptions.md +11 -1
  9. data/docs/CommonActionsControllerApi.md +167 -0
  10. data/docs/ContactControllerApi.md +274 -0
  11. data/docs/ContactDto.md +31 -0
  12. data/docs/ContactProjection.md +27 -0
  13. data/docs/CreateContactOptions.md +31 -0
  14. data/docs/CreateDomainOptions.md +17 -0
  15. data/docs/CreateGroupOptions.md +19 -0
  16. data/docs/CreateTemplateOptions.md +19 -0
  17. data/docs/CreateWebhookOptions.md +13 -2
  18. data/docs/DomainControllerApi.md +223 -0
  19. data/docs/DomainDto.md +29 -0
  20. data/docs/DomainPreview.md +21 -0
  21. data/docs/Email.md +40 -15
  22. data/docs/EmailAnalysis.md +18 -5
  23. data/docs/EmailControllerApi.md +740 -0
  24. data/docs/EmailPreview.md +24 -6
  25. data/docs/EmailProjection.md +33 -0
  26. data/docs/ForwardEmailOptions.md +12 -0
  27. data/docs/GroupContactsDto.md +19 -0
  28. data/docs/GroupControllerApi.md +437 -0
  29. data/docs/GroupDto.md +23 -0
  30. data/docs/GroupProjection.md +23 -0
  31. data/docs/HTMLValidationResult.md +21 -0
  32. data/docs/Inbox.md +26 -4
  33. data/docs/InboxControllerApi.md +652 -0
  34. data/docs/InboxProjection.md +29 -0
  35. data/docs/JsonNode.md +59 -0
  36. data/docs/MatchOption.md +13 -2
  37. data/docs/MatchOptions.md +9 -0
  38. data/docs/PageContactProjection.md +37 -0
  39. data/docs/PageEmailPreview.md +37 -0
  40. data/docs/PageEmailProjection.md +37 -0
  41. data/docs/PageGroupProjection.md +37 -0
  42. data/docs/PageInboxProjection.md +37 -0
  43. data/docs/PageTemplateProjection.md +37 -0
  44. data/docs/PageWebhookProjection.md +37 -0
  45. data/docs/Pageable.md +27 -0
  46. data/docs/RawEmailJson.md +17 -0
  47. data/docs/SendEmailOptions.md +33 -6
  48. data/docs/SetInboxFavouritedOptions.md +17 -0
  49. data/docs/Sort.md +21 -0
  50. data/docs/TemplateControllerApi.md +274 -0
  51. data/docs/TemplateDto.md +25 -0
  52. data/docs/TemplateProjection.md +25 -0
  53. data/docs/TemplateVariable.md +19 -0
  54. data/docs/UnreadCount.md +17 -0
  55. data/docs/UpdateGroupContacts.md +17 -0
  56. data/docs/UpdateInboxOptions.md +25 -0
  57. data/docs/UploadAttachmentOptions.md +12 -1
  58. data/docs/ValidationDto.md +19 -0
  59. data/docs/ValidationMessage.md +19 -0
  60. data/docs/WaitForConditions.md +29 -0
  61. data/docs/WaitForControllerApi.md +317 -0
  62. data/docs/WebhookControllerApi.md +339 -0
  63. data/docs/WebhookDto.md +33 -0
  64. data/docs/WebhookProjection.md +27 -0
  65. data/docs/WebhookTestRequest.md +23 -0
  66. data/docs/WebhookTestResponse.md +19 -0
  67. data/docs/WebhookTestResult.md +21 -0
  68. data/git_push.sh +10 -7
  69. data/lib/mailslurp_client.rb +56 -7
  70. data/lib/mailslurp_client/api/attachment_controller_api.rb +157 -0
  71. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +203 -0
  72. data/lib/mailslurp_client/api/common_actions_controller_api.rb +201 -0
  73. data/lib/mailslurp_client/api/contact_controller_api.rb +323 -0
  74. data/lib/mailslurp_client/api/domain_controller_api.rb +264 -0
  75. data/lib/mailslurp_client/api/email_controller_api.rb +852 -0
  76. data/lib/mailslurp_client/api/group_controller_api.rb +519 -0
  77. data/lib/mailslurp_client/api/inbox_controller_api.rb +763 -0
  78. data/lib/mailslurp_client/api/template_controller_api.rb +323 -0
  79. data/lib/mailslurp_client/api/wait_for_controller_api.rb +359 -0
  80. data/lib/mailslurp_client/api/webhook_controller_api.rb +405 -0
  81. data/lib/mailslurp_client/api_client.rb +36 -39
  82. data/lib/mailslurp_client/api_error.rb +23 -4
  83. data/lib/mailslurp_client/configuration.rb +8 -11
  84. data/lib/mailslurp_client/models/attachment_meta_data.rb +253 -0
  85. data/lib/mailslurp_client/models/basic_auth_options.rb +39 -15
  86. data/lib/mailslurp_client/models/bulk_send_email_options.rb +42 -19
  87. data/lib/mailslurp_client/models/contact_dto.rb +288 -0
  88. data/lib/mailslurp_client/models/contact_projection.rb +261 -0
  89. data/lib/mailslurp_client/models/create_contact_options.rb +277 -0
  90. data/lib/mailslurp_client/models/create_domain_options.rb +208 -0
  91. data/lib/mailslurp_client/models/create_group_options.rb +220 -0
  92. data/lib/mailslurp_client/models/create_template_options.rb +225 -0
  93. data/lib/mailslurp_client/models/create_webhook_options.rb +54 -29
  94. data/lib/mailslurp_client/models/domain_dto.rb +296 -0
  95. data/lib/mailslurp_client/models/domain_preview.rb +240 -0
  96. data/lib/mailslurp_client/models/email.rb +86 -78
  97. data/lib/mailslurp_client/models/email_analysis.rb +46 -48
  98. data/lib/mailslurp_client/models/email_preview.rb +77 -41
  99. data/lib/mailslurp_client/models/email_projection.rb +306 -0
  100. data/lib/mailslurp_client/models/forward_email_options.rb +40 -17
  101. data/lib/mailslurp_client/models/group_contacts_dto.rb +227 -0
  102. data/lib/mailslurp_client/models/{webhook.rb → group_dto.rb} +60 -54
  103. data/lib/mailslurp_client/models/group_projection.rb +248 -0
  104. data/lib/mailslurp_client/models/html_validation_result.rb +243 -0
  105. data/lib/mailslurp_client/models/inbox.rb +104 -26
  106. data/lib/mailslurp_client/models/inbox_projection.rb +272 -0
  107. data/lib/mailslurp_client/models/json_node.rb +429 -0
  108. data/lib/mailslurp_client/models/match_option.rb +48 -24
  109. data/lib/mailslurp_client/models/match_options.rb +37 -14
  110. data/lib/mailslurp_client/models/page_contact_projection.rb +298 -0
  111. data/lib/mailslurp_client/models/page_email_preview.rb +298 -0
  112. data/lib/mailslurp_client/models/page_email_projection.rb +298 -0
  113. data/lib/mailslurp_client/models/page_group_projection.rb +298 -0
  114. data/lib/mailslurp_client/models/page_inbox_projection.rb +298 -0
  115. data/lib/mailslurp_client/models/page_template_projection.rb +298 -0
  116. data/lib/mailslurp_client/models/page_webhook_projection.rb +298 -0
  117. data/lib/mailslurp_client/models/pageable.rb +251 -0
  118. data/lib/mailslurp_client/models/raw_email_json.rb +211 -0
  119. data/lib/mailslurp_client/models/send_email_options.rb +141 -46
  120. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +208 -0
  121. data/lib/mailslurp_client/models/sort.rb +224 -0
  122. data/lib/mailslurp_client/models/template_dto.rb +269 -0
  123. data/lib/mailslurp_client/models/template_projection.rb +269 -0
  124. data/lib/mailslurp_client/models/template_variable.rb +259 -0
  125. data/lib/mailslurp_client/models/unread_count.rb +211 -0
  126. data/lib/mailslurp_client/models/update_group_contacts.rb +213 -0
  127. data/lib/mailslurp_client/models/update_inbox_options.rb +250 -0
  128. data/lib/mailslurp_client/models/upload_attachment_options.rb +43 -20
  129. data/lib/mailslurp_client/models/validation_dto.rb +225 -0
  130. data/lib/mailslurp_client/models/validation_message.rb +220 -0
  131. data/lib/mailslurp_client/models/wait_for_conditions.rb +315 -0
  132. data/lib/mailslurp_client/models/webhook_dto.rb +326 -0
  133. data/lib/mailslurp_client/models/webhook_projection.rb +277 -0
  134. data/lib/mailslurp_client/models/webhook_test_request.rb +284 -0
  135. data/lib/mailslurp_client/models/webhook_test_response.rb +215 -0
  136. data/lib/mailslurp_client/models/webhook_test_result.rb +235 -0
  137. data/lib/mailslurp_client/version.rb +5 -5
  138. data/mailslurp_client.gemspec +4 -10
  139. data/spec/api/attachment_controller_api_spec.rb +61 -0
  140. data/spec/api/bulk_actions_controller_api_spec.rb +68 -0
  141. data/spec/api/common_actions_controller_api_spec.rb +129 -0
  142. data/spec/api/contact_controller_api_spec.rb +91 -0
  143. data/spec/api/domain_controller_api_spec.rb +82 -0
  144. data/spec/api/email_controller_api_spec.rb +162 -0
  145. data/spec/api/group_controller_api_spec.rb +126 -0
  146. data/spec/api/inbox_controller_api_spec.rb +172 -0
  147. data/spec/api/template_controller_api_spec.rb +91 -0
  148. data/spec/api/wait_for_controller_api_spec.rb +107 -0
  149. data/spec/api/webhook_controller_api_spec.rb +107 -0
  150. data/spec/api_client_spec.rb +5 -5
  151. data/spec/configuration_spec.rb +4 -4
  152. data/spec/models/attachment_meta_data_spec.rb +59 -0
  153. data/spec/models/basic_auth_options_spec.rb +4 -4
  154. data/spec/models/bulk_send_email_options_spec.rb +4 -4
  155. data/spec/models/contact_dto_spec.rb +83 -0
  156. data/spec/models/contact_projection_spec.rb +71 -0
  157. data/spec/models/create_contact_options_spec.rb +83 -0
  158. data/spec/models/create_domain_options_spec.rb +41 -0
  159. data/spec/models/create_group_options_spec.rb +47 -0
  160. data/spec/models/create_template_options_spec.rb +47 -0
  161. data/spec/models/create_webhook_options_spec.rb +6 -6
  162. data/spec/models/domain_dto_spec.rb +77 -0
  163. data/spec/models/domain_preview_spec.rb +53 -0
  164. data/spec/models/email_analysis_spec.rb +4 -4
  165. data/spec/models/email_preview_spec.rb +41 -5
  166. data/spec/models/email_projection_spec.rb +89 -0
  167. data/spec/models/email_spec.rb +17 -5
  168. data/spec/models/forward_email_options_spec.rb +4 -4
  169. data/spec/models/group_contacts_dto_spec.rb +47 -0
  170. data/spec/models/group_dto_spec.rb +59 -0
  171. data/spec/models/group_projection_spec.rb +59 -0
  172. data/spec/models/html_validation_result_spec.rb +53 -0
  173. data/spec/models/inbox_projection_spec.rb +77 -0
  174. data/spec/models/inbox_spec.rb +35 -5
  175. data/spec/models/json_node_spec.rb +171 -0
  176. data/spec/models/match_option_spec.rb +4 -4
  177. data/spec/models/match_options_spec.rb +4 -4
  178. data/spec/models/page_contact_projection_spec.rb +101 -0
  179. data/spec/models/page_email_preview_spec.rb +101 -0
  180. data/spec/models/page_email_projection_spec.rb +101 -0
  181. data/spec/models/page_group_projection_spec.rb +101 -0
  182. data/spec/models/page_inbox_projection_spec.rb +101 -0
  183. data/spec/models/page_template_projection_spec.rb +101 -0
  184. data/spec/models/page_webhook_projection_spec.rb +101 -0
  185. data/spec/models/pageable_spec.rb +71 -0
  186. data/spec/models/raw_email_json_spec.rb +41 -0
  187. data/spec/models/send_email_options_spec.rb +45 -5
  188. data/spec/models/set_inbox_favourited_options_spec.rb +41 -0
  189. data/spec/models/sort_spec.rb +53 -0
  190. data/spec/models/template_dto_spec.rb +65 -0
  191. data/spec/models/template_projection_spec.rb +65 -0
  192. data/spec/models/template_variable_spec.rb +51 -0
  193. data/spec/models/unread_count_spec.rb +41 -0
  194. data/spec/models/update_group_contacts_spec.rb +41 -0
  195. data/spec/models/{webhook_spec.rb → update_inbox_options_spec.rb} +14 -20
  196. data/spec/models/upload_attachment_options_spec.rb +4 -4
  197. data/spec/models/validation_dto_spec.rb +47 -0
  198. data/spec/models/validation_message_spec.rb +47 -0
  199. data/spec/models/wait_for_conditions_spec.rb +85 -0
  200. data/spec/models/webhook_dto_spec.rb +93 -0
  201. data/spec/models/webhook_projection_spec.rb +71 -0
  202. data/spec/models/webhook_test_request_spec.rb +63 -0
  203. data/spec/models/webhook_test_response_spec.rb +47 -0
  204. data/spec/models/webhook_test_result_spec.rb +53 -0
  205. data/spec/spec_helper.rb +4 -4
  206. metadata +223 -149
  207. data/Gemfile.lock +0 -79
  208. data/docs/CommonOperationsApi.md +0 -499
  209. data/docs/ExtraOperationsApi.md +0 -1021
  210. data/docs/Webhook.md +0 -13
  211. data/lib/mailslurp_client/api/common_operations_api.rb +0 -502
  212. data/lib/mailslurp_client/api/extra_operations_api.rb +0 -1054
  213. data/spec/api/common_operations_api_spec.rb +0 -95
  214. data/spec/api/extra_operations_api_spec.rb +0 -231
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6ab644202c77e9ac19da611943b30e7d49f278c27bc3e625d71bff3029657f61
4
- data.tar.gz: 54c10683483eda6020cd978e1fc5b8b9824778e2e93f5380ad5605360bd0831f
3
+ metadata.gz: 1eb19727caca8022cb4d3907951bf899d0997612b73b6134aee265976ff13b19
4
+ data.tar.gz: fb9b675ca0ee08127d5332d3c5beb127f737dabfe668b92d39552f661f97018c
5
5
  SHA512:
6
- metadata.gz: b5ce39607a184f9ed52b3920283ade106a85a2259426c0ba6f0a29ebc7ecf6a10bd49d398a94a2e549121c926dc1dbd49e206d0c6a79ad7aeec22965c6dd462f
7
- data.tar.gz: 3068bd2b2b802a3fa0abb52a49b21d252402e9e73fcb21ede6d45e305533034f1fe8a516e58b47803a9322d5491f0823798a493dc82cea93205993b089de7fb0
6
+ metadata.gz: 4711176ad05203ebff18ae15775541f904848cdaa0c5295216f32834d9e9ce4397e26ccbda6bc5c7cfaca298ba105207e1795cf68793cb99c77d83dd9b178c26
7
+ data.tar.gz: 608d7c75c599ca5d50cf75b2cc6349edfc8980c334f19010a3a25e8b90bd68292b9906acca9a949325d0d15d24d4baa0d0150b0f4484f0b0123cc830bd5b5333
data/Gemfile CHANGED
@@ -5,4 +5,5 @@ gemspec
5
5
  group :development, :test do
6
6
  gem 'rake', '~> 12.0.0'
7
7
  gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
8
9
  end
data/README.md CHANGED
@@ -2,14 +2,20 @@
2
2
 
3
3
  MailSlurpClient - the Ruby gem for the MailSlurp API
4
4
 
5
- For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
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
+
6
13
 
7
14
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
15
 
9
- - API version: 0.0.1-alpha
10
- - Package version: 5.0.0
16
+ - API version: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
17
+ - Package version: 7.0.7
11
18
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
- For more information, please visit [https://www.mailslurp.com](https://www.mailslurp.com)
13
19
 
14
20
  ## Installation
15
21
 
@@ -24,15 +30,16 @@ gem build mailslurp_client.gemspec
24
30
  Then either install the gem locally:
25
31
 
26
32
  ```shell
27
- gem install ./mailslurp_client-5.0.0.gem
33
+ gem install ./mailslurp_client-7.0.7.gem
28
34
  ```
29
- (for development, run `gem install --dev ./mailslurp_client-5.0.0.gem` to install the development dependencies)
35
+
36
+ (for development, run `gem install --dev ./mailslurp_client-7.0.7.gem` to install the development dependencies)
30
37
 
31
38
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
39
 
33
40
  Finally add this to the Gemfile:
34
41
 
35
- gem 'mailslurp_client', '~> 5.0.0'
42
+ gem 'mailslurp_client', '~> 7.0.7'
36
43
 
37
44
  ### Install from Git
38
45
 
@@ -51,6 +58,7 @@ ruby -Ilib script.rb
51
58
  ## Getting Started
52
59
 
53
60
  Please follow the [installation](#installation) procedure and then run the following code:
61
+
54
62
  ```ruby
55
63
  # Load the gem
56
64
  require 'mailslurp_client'
@@ -63,14 +71,15 @@ MailSlurpClient.configure do |config|
63
71
  #config.api_key_prefix['x-api-key'] = 'Bearer'
64
72
  end
65
73
 
66
- api_instance = MailSlurpClient::CommonOperationsApi.new
74
+ api_instance = MailSlurpClient::AttachmentControllerApi.new
75
+ upload_options = MailSlurpClient::UploadAttachmentOptions.new # UploadAttachmentOptions | uploadOptions
67
76
 
68
77
  begin
69
- #Create new email address
70
- result = api_instance.create_new_email_address
78
+ #Upload an attachment for sending
79
+ result = api_instance.upload_attachment(upload_options)
71
80
  p result
72
81
  rescue MailSlurpClient::ApiError => e
73
- puts "Exception when calling CommonOperationsApi->create_new_email_address: #{e}"
82
+ puts "Exception when calling AttachmentControllerApi->upload_attachment: #{e}"
74
83
  end
75
84
 
76
85
  ```
@@ -81,51 +90,128 @@ All URIs are relative to *https://api.mailslurp.com*
81
90
 
82
91
  Class | Method | HTTP request | Description
83
92
  ------------ | ------------- | ------------- | -------------
84
- *MailSlurpClient::CommonOperationsApi* | [**create_new_email_address**](docs/CommonOperationsApi.md#create_new_email_address) | **POST** /newEmailAddress | Create new email address
85
- *MailSlurpClient::CommonOperationsApi* | [**delete_email**](docs/CommonOperationsApi.md#delete_email) | **DELETE** /deleteEmail | Delete an email
86
- *MailSlurpClient::CommonOperationsApi* | [**delete_email_address**](docs/CommonOperationsApi.md#delete_email_address) | **DELETE** /deleteEmailAddress | Delete email address and its emails
87
- *MailSlurpClient::CommonOperationsApi* | [**empty_inbox**](docs/CommonOperationsApi.md#empty_inbox) | **DELETE** /emptyInbox | Delete all emails in an inbox
88
- *MailSlurpClient::CommonOperationsApi* | [**send_email_simple**](docs/CommonOperationsApi.md#send_email_simple) | **POST** /sendEmail | Send an email from a random email address
89
- *MailSlurpClient::CommonOperationsApi* | [**wait_for_email_count**](docs/CommonOperationsApi.md#wait_for_email_count) | **GET** /waitForEmailCount | Wait for and return count number of emails
90
- *MailSlurpClient::CommonOperationsApi* | [**wait_for_latest_email**](docs/CommonOperationsApi.md#wait_for_latest_email) | **GET** /waitForLatestEmail | Fetch inbox's latest email or if empty wait for email to arrive
91
- *MailSlurpClient::CommonOperationsApi* | [**wait_for_matching_email**](docs/CommonOperationsApi.md#wait_for_matching_email) | **POST** /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns
92
- *MailSlurpClient::CommonOperationsApi* | [**wait_for_nth_email**](docs/CommonOperationsApi.md#wait_for_nth_email) | **GET** /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified
93
- *MailSlurpClient::ExtraOperationsApi* | [**bulk_create_inboxes**](docs/ExtraOperationsApi.md#bulk_create_inboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)
94
- *MailSlurpClient::ExtraOperationsApi* | [**bulk_delete_inboxes**](docs/ExtraOperationsApi.md#bulk_delete_inboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes
95
- *MailSlurpClient::ExtraOperationsApi* | [**bulk_send_emails**](docs/ExtraOperationsApi.md#bulk_send_emails) | **POST** /bulk/send | Bulk Send Emails
96
- *MailSlurpClient::ExtraOperationsApi* | [**create_inbox**](docs/ExtraOperationsApi.md#create_inbox) | **POST** /inboxes | Create an Inbox (email address)
97
- *MailSlurpClient::ExtraOperationsApi* | [**create_webhook**](docs/ExtraOperationsApi.md#create_webhook) | **POST** /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox
98
- *MailSlurpClient::ExtraOperationsApi* | [**delete_email1**](docs/ExtraOperationsApi.md#delete_email1) | **DELETE** /emails/{emailId} | Delete Email
99
- *MailSlurpClient::ExtraOperationsApi* | [**delete_inbox**](docs/ExtraOperationsApi.md#delete_inbox) | **DELETE** /inboxes/{inboxId} | Delete Inbox / Email Address
100
- *MailSlurpClient::ExtraOperationsApi* | [**delete_webhook**](docs/ExtraOperationsApi.md#delete_webhook) | **DELETE** /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a WebHook for an Inbox
101
- *MailSlurpClient::ExtraOperationsApi* | [**download_attachment**](docs/ExtraOperationsApi.md#download_attachment) | **GET** /emails/{emailId}/attachments/{attachmentId} | Get email attachment
102
- *MailSlurpClient::ExtraOperationsApi* | [**forward_email**](docs/ExtraOperationsApi.md#forward_email) | **POST** /emails/{emailId}/forward | Forward Email
103
- *MailSlurpClient::ExtraOperationsApi* | [**get_email**](docs/ExtraOperationsApi.md#get_email) | **GET** /emails/{emailId} | Get Email Content
104
- *MailSlurpClient::ExtraOperationsApi* | [**get_emails**](docs/ExtraOperationsApi.md#get_emails) | **GET** /inboxes/{inboxId}/emails | List Emails in an Inbox / EmailAddress
105
- *MailSlurpClient::ExtraOperationsApi* | [**get_inbox**](docs/ExtraOperationsApi.md#get_inbox) | **GET** /inboxes/{inboxId} | Get Inbox / EmailAddress
106
- *MailSlurpClient::ExtraOperationsApi* | [**get_inboxes**](docs/ExtraOperationsApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
107
- *MailSlurpClient::ExtraOperationsApi* | [**get_raw_email_contents**](docs/ExtraOperationsApi.md#get_raw_email_contents) | **GET** /emails/{emailId}/raw | Get Raw Email Content
108
- *MailSlurpClient::ExtraOperationsApi* | [**get_webhooks**](docs/ExtraOperationsApi.md#get_webhooks) | **GET** /inboxes/{inboxId}/webhooks | Get all WebHooks for an Inbox
109
- *MailSlurpClient::ExtraOperationsApi* | [**send_email**](docs/ExtraOperationsApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
110
- *MailSlurpClient::ExtraOperationsApi* | [**upload_attachment**](docs/ExtraOperationsApi.md#upload_attachment) | **POST** /attachments | Upload an attachment for sending
111
- *MailSlurpClient::ExtraOperationsApi* | [**upload_multipart_form**](docs/ExtraOperationsApi.md#upload_multipart_form) | **POST** /attachments/multipart | Upload an attachment for sending using Multipart Form
93
+ *MailSlurpClient::AttachmentControllerApi* | [**upload_attachment**](docs/AttachmentControllerApi.md#upload_attachment) | **POST** /attachments | Upload an attachment for sending
94
+ *MailSlurpClient::AttachmentControllerApi* | [**upload_multipart_form**](docs/AttachmentControllerApi.md#upload_multipart_form) | **POST** /attachments/multipart | Upload an attachment for sending using Multipart Form
95
+ *MailSlurpClient::BulkActionsControllerApi* | [**bulk_create_inboxes**](docs/BulkActionsControllerApi.md#bulk_create_inboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)
96
+ *MailSlurpClient::BulkActionsControllerApi* | [**bulk_delete_inboxes**](docs/BulkActionsControllerApi.md#bulk_delete_inboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes
97
+ *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
99
+ *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
101
+ *MailSlurpClient::ContactControllerApi* | [**create_contact**](docs/ContactControllerApi.md#create_contact) | **POST** /contacts | Create a contact
102
+ *MailSlurpClient::ContactControllerApi* | [**delete_contact**](docs/ContactControllerApi.md#delete_contact) | **DELETE** /contacts/{contactId} | Delete contact
103
+ *MailSlurpClient::ContactControllerApi* | [**get_all_contacts**](docs/ContactControllerApi.md#get_all_contacts) | **GET** /contacts/paginated | Get all contacts
104
+ *MailSlurpClient::ContactControllerApi* | [**get_contact**](docs/ContactControllerApi.md#get_contact) | **GET** /contacts/{contactId} | Get contact
105
+ *MailSlurpClient::ContactControllerApi* | [**get_contacts**](docs/ContactControllerApi.md#get_contacts) | **GET** /contacts | Get all contacts
106
+ *MailSlurpClient::DomainControllerApi* | [**create_domain**](docs/DomainControllerApi.md#create_domain) | **POST** /domains | Create Domain
107
+ *MailSlurpClient::DomainControllerApi* | [**delete_domain**](docs/DomainControllerApi.md#delete_domain) | **DELETE** /domains/{id} | Delete a domain
108
+ *MailSlurpClient::DomainControllerApi* | [**get_domain**](docs/DomainControllerApi.md#get_domain) | **GET** /domains/{id} | Get a domain
109
+ *MailSlurpClient::DomainControllerApi* | [**get_domains**](docs/DomainControllerApi.md#get_domains) | **GET** /domains | Get domains
110
+ *MailSlurpClient::EmailControllerApi* | [**delete_all_emails**](docs/EmailControllerApi.md#delete_all_emails) | **DELETE** /emails | Delete all emails
111
+ *MailSlurpClient::EmailControllerApi* | [**delete_email**](docs/EmailControllerApi.md#delete_email) | **DELETE** /emails/{emailId} | Delete an email
112
+ *MailSlurpClient::EmailControllerApi* | [**download_attachment**](docs/EmailControllerApi.md#download_attachment) | **GET** /emails/{emailId}/attachments/{attachmentId} | Get email attachment bytes
113
+ *MailSlurpClient::EmailControllerApi* | [**forward_email**](docs/EmailControllerApi.md#forward_email) | **POST** /emails/{emailId}/forward | Forward email
114
+ *MailSlurpClient::EmailControllerApi* | [**get_attachment_meta_data**](docs/EmailControllerApi.md#get_attachment_meta_data) | **GET** /emails/{emailId}/attachments/{attachmentId}/metadata | Get email attachment metadata
115
+ *MailSlurpClient::EmailControllerApi* | [**get_attachments**](docs/EmailControllerApi.md#get_attachments) | **GET** /emails/{emailId}/attachments | Get all email attachment metadata
116
+ *MailSlurpClient::EmailControllerApi* | [**get_email**](docs/EmailControllerApi.md#get_email) | **GET** /emails/{emailId} | Get email content
117
+ *MailSlurpClient::EmailControllerApi* | [**get_email_html**](docs/EmailControllerApi.md#get_email_html) | **GET** /emails/{emailId}/html | Get email content as HTML
118
+ *MailSlurpClient::EmailControllerApi* | [**get_emails_paginated**](docs/EmailControllerApi.md#get_emails_paginated) | **GET** /emails | Get all emails
119
+ *MailSlurpClient::EmailControllerApi* | [**get_raw_email_contents**](docs/EmailControllerApi.md#get_raw_email_contents) | **GET** /emails/{emailId}/raw | Get raw email string
120
+ *MailSlurpClient::EmailControllerApi* | [**get_raw_email_json**](docs/EmailControllerApi.md#get_raw_email_json) | **GET** /emails/{emailId}/raw/json | Get raw email in JSON
121
+ *MailSlurpClient::EmailControllerApi* | [**get_unread_email_count**](docs/EmailControllerApi.md#get_unread_email_count) | **GET** /emails/unreadCount | Get unread email count
122
+ *MailSlurpClient::EmailControllerApi* | [**validate_email**](docs/EmailControllerApi.md#validate_email) | **POST** /emails/{emailId}/validate | Validate email
123
+ *MailSlurpClient::GroupControllerApi* | [**add_contacts_to_group**](docs/GroupControllerApi.md#add_contacts_to_group) | **PUT** /groups/{groupId}/contacts | Add contacts to a group
124
+ *MailSlurpClient::GroupControllerApi* | [**create_group**](docs/GroupControllerApi.md#create_group) | **POST** /groups | Create a group
125
+ *MailSlurpClient::GroupControllerApi* | [**delete_group**](docs/GroupControllerApi.md#delete_group) | **DELETE** /groups/{groupId} | Delete group
126
+ *MailSlurpClient::GroupControllerApi* | [**get_all_groups**](docs/GroupControllerApi.md#get_all_groups) | **GET** /groups/paginated | Get all Contact Groups in paginated format
127
+ *MailSlurpClient::GroupControllerApi* | [**get_group**](docs/GroupControllerApi.md#get_group) | **GET** /groups/{groupId} | Get group
128
+ *MailSlurpClient::GroupControllerApi* | [**get_group_with_contacts**](docs/GroupControllerApi.md#get_group_with_contacts) | **GET** /groups/{groupId}/contacts | Get group and contacts belonging to it
129
+ *MailSlurpClient::GroupControllerApi* | [**get_groups**](docs/GroupControllerApi.md#get_groups) | **GET** /groups | Get all groups
130
+ *MailSlurpClient::GroupControllerApi* | [**remove_contacts_from_group**](docs/GroupControllerApi.md#remove_contacts_from_group) | **DELETE** /groups/{groupId}/contacts | Remove contacts from a group
131
+ *MailSlurpClient::InboxControllerApi* | [**create_inbox**](docs/InboxControllerApi.md#create_inbox) | **POST** /inboxes | Create an Inbox (email address)
132
+ *MailSlurpClient::InboxControllerApi* | [**delete_all_inboxes**](docs/InboxControllerApi.md#delete_all_inboxes) | **DELETE** /inboxes | Delete all inboxes
133
+ *MailSlurpClient::InboxControllerApi* | [**delete_inbox**](docs/InboxControllerApi.md#delete_inbox) | **DELETE** /inboxes/{inboxId} | Delete inbox
134
+ *MailSlurpClient::InboxControllerApi* | [**get_all_inboxes**](docs/InboxControllerApi.md#get_all_inboxes) | **GET** /inboxes/paginated | List Inboxes Paginated
135
+ *MailSlurpClient::InboxControllerApi* | [**get_emails**](docs/InboxControllerApi.md#get_emails) | **GET** /inboxes/{inboxId}/emails | Get emails in an Inbox
136
+ *MailSlurpClient::InboxControllerApi* | [**get_inbox**](docs/InboxControllerApi.md#get_inbox) | **GET** /inboxes/{inboxId} | Get Inbox
137
+ *MailSlurpClient::InboxControllerApi* | [**get_inbox_emails_paginated**](docs/InboxControllerApi.md#get_inbox_emails_paginated) | **GET** /inboxes/{inboxId}/emails/paginated | Get inbox emails paginated
138
+ *MailSlurpClient::InboxControllerApi* | [**get_inboxes**](docs/InboxControllerApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
139
+ *MailSlurpClient::InboxControllerApi* | [**send_email**](docs/InboxControllerApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
140
+ *MailSlurpClient::InboxControllerApi* | [**set_inbox_favourited**](docs/InboxControllerApi.md#set_inbox_favourited) | **PUT** /inboxes/{inboxId}/favourite | Set inbox favourited state
141
+ *MailSlurpClient::InboxControllerApi* | [**update_inbox**](docs/InboxControllerApi.md#update_inbox) | **PATCH** /inboxes/{inboxId} | Update Inbox
142
+ *MailSlurpClient::TemplateControllerApi* | [**create_template**](docs/TemplateControllerApi.md#create_template) | **POST** /templates | Create a Template
143
+ *MailSlurpClient::TemplateControllerApi* | [**delete_template**](docs/TemplateControllerApi.md#delete_template) | **DELETE** /templates/{TemplateId} | Delete Template
144
+ *MailSlurpClient::TemplateControllerApi* | [**get_all_templates**](docs/TemplateControllerApi.md#get_all_templates) | **GET** /templates/paginated | Get all Templates in paginated format
145
+ *MailSlurpClient::TemplateControllerApi* | [**get_template**](docs/TemplateControllerApi.md#get_template) | **GET** /templates/{TemplateId} | Get Template
146
+ *MailSlurpClient::TemplateControllerApi* | [**get_templates**](docs/TemplateControllerApi.md#get_templates) | **GET** /templates | Get all Templates
147
+ *MailSlurpClient::WaitForControllerApi* | [**wait_for**](docs/WaitForControllerApi.md#wait_for) | **POST** /waitFor | Wait for conditions to be met
148
+ *MailSlurpClient::WaitForControllerApi* | [**wait_for_email_count**](docs/WaitForControllerApi.md#wait_for_email_count) | **GET** /waitForEmailCount | Wait for and return count number of emails
149
+ *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
150
+ *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
151
+ *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
152
+ *MailSlurpClient::WebhookControllerApi* | [**create_webhook**](docs/WebhookControllerApi.md#create_webhook) | **POST** /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox
153
+ *MailSlurpClient::WebhookControllerApi* | [**delete_webhook**](docs/WebhookControllerApi.md#delete_webhook) | **DELETE** /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a Webhook for an Inbox
154
+ *MailSlurpClient::WebhookControllerApi* | [**get_all_webhooks**](docs/WebhookControllerApi.md#get_all_webhooks) | **GET** /webhooks/paginated | List Webhooks Paginated
155
+ *MailSlurpClient::WebhookControllerApi* | [**get_webhook**](docs/WebhookControllerApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook for an Inbox
156
+ *MailSlurpClient::WebhookControllerApi* | [**get_webhooks**](docs/WebhookControllerApi.md#get_webhooks) | **GET** /inboxes/{inboxId}/webhooks | Get all Webhooks for an Inbox
157
+ *MailSlurpClient::WebhookControllerApi* | [**send_test_data**](docs/WebhookControllerApi.md#send_test_data) | **POST** /webhooks/{webhookId}/test | Send webhook test data
112
158
 
113
159
 
114
160
  ## Documentation for Models
115
161
 
162
+ - [MailSlurpClient::AttachmentMetaData](docs/AttachmentMetaData.md)
116
163
  - [MailSlurpClient::BasicAuthOptions](docs/BasicAuthOptions.md)
117
164
  - [MailSlurpClient::BulkSendEmailOptions](docs/BulkSendEmailOptions.md)
165
+ - [MailSlurpClient::ContactDto](docs/ContactDto.md)
166
+ - [MailSlurpClient::ContactProjection](docs/ContactProjection.md)
167
+ - [MailSlurpClient::CreateContactOptions](docs/CreateContactOptions.md)
168
+ - [MailSlurpClient::CreateDomainOptions](docs/CreateDomainOptions.md)
169
+ - [MailSlurpClient::CreateGroupOptions](docs/CreateGroupOptions.md)
170
+ - [MailSlurpClient::CreateTemplateOptions](docs/CreateTemplateOptions.md)
118
171
  - [MailSlurpClient::CreateWebhookOptions](docs/CreateWebhookOptions.md)
172
+ - [MailSlurpClient::DomainDto](docs/DomainDto.md)
173
+ - [MailSlurpClient::DomainPreview](docs/DomainPreview.md)
119
174
  - [MailSlurpClient::Email](docs/Email.md)
120
175
  - [MailSlurpClient::EmailAnalysis](docs/EmailAnalysis.md)
121
176
  - [MailSlurpClient::EmailPreview](docs/EmailPreview.md)
177
+ - [MailSlurpClient::EmailProjection](docs/EmailProjection.md)
122
178
  - [MailSlurpClient::ForwardEmailOptions](docs/ForwardEmailOptions.md)
179
+ - [MailSlurpClient::GroupContactsDto](docs/GroupContactsDto.md)
180
+ - [MailSlurpClient::GroupDto](docs/GroupDto.md)
181
+ - [MailSlurpClient::GroupProjection](docs/GroupProjection.md)
182
+ - [MailSlurpClient::HTMLValidationResult](docs/HTMLValidationResult.md)
123
183
  - [MailSlurpClient::Inbox](docs/Inbox.md)
184
+ - [MailSlurpClient::InboxProjection](docs/InboxProjection.md)
185
+ - [MailSlurpClient::JsonNode](docs/JsonNode.md)
124
186
  - [MailSlurpClient::MatchOption](docs/MatchOption.md)
125
187
  - [MailSlurpClient::MatchOptions](docs/MatchOptions.md)
188
+ - [MailSlurpClient::PageContactProjection](docs/PageContactProjection.md)
189
+ - [MailSlurpClient::PageEmailPreview](docs/PageEmailPreview.md)
190
+ - [MailSlurpClient::PageEmailProjection](docs/PageEmailProjection.md)
191
+ - [MailSlurpClient::PageGroupProjection](docs/PageGroupProjection.md)
192
+ - [MailSlurpClient::PageInboxProjection](docs/PageInboxProjection.md)
193
+ - [MailSlurpClient::PageTemplateProjection](docs/PageTemplateProjection.md)
194
+ - [MailSlurpClient::PageWebhookProjection](docs/PageWebhookProjection.md)
195
+ - [MailSlurpClient::Pageable](docs/Pageable.md)
196
+ - [MailSlurpClient::RawEmailJson](docs/RawEmailJson.md)
126
197
  - [MailSlurpClient::SendEmailOptions](docs/SendEmailOptions.md)
198
+ - [MailSlurpClient::SetInboxFavouritedOptions](docs/SetInboxFavouritedOptions.md)
199
+ - [MailSlurpClient::Sort](docs/Sort.md)
200
+ - [MailSlurpClient::TemplateDto](docs/TemplateDto.md)
201
+ - [MailSlurpClient::TemplateProjection](docs/TemplateProjection.md)
202
+ - [MailSlurpClient::TemplateVariable](docs/TemplateVariable.md)
203
+ - [MailSlurpClient::UnreadCount](docs/UnreadCount.md)
204
+ - [MailSlurpClient::UpdateGroupContacts](docs/UpdateGroupContacts.md)
205
+ - [MailSlurpClient::UpdateInboxOptions](docs/UpdateInboxOptions.md)
127
206
  - [MailSlurpClient::UploadAttachmentOptions](docs/UploadAttachmentOptions.md)
128
- - [MailSlurpClient::Webhook](docs/Webhook.md)
207
+ - [MailSlurpClient::ValidationDto](docs/ValidationDto.md)
208
+ - [MailSlurpClient::ValidationMessage](docs/ValidationMessage.md)
209
+ - [MailSlurpClient::WaitForConditions](docs/WaitForConditions.md)
210
+ - [MailSlurpClient::WebhookDto](docs/WebhookDto.md)
211
+ - [MailSlurpClient::WebhookProjection](docs/WebhookProjection.md)
212
+ - [MailSlurpClient::WebhookTestRequest](docs/WebhookTestRequest.md)
213
+ - [MailSlurpClient::WebhookTestResponse](docs/WebhookTestResponse.md)
214
+ - [MailSlurpClient::WebhookTestResult](docs/WebhookTestResult.md)
129
215
 
130
216
 
131
217
  ## Documentation for Authorization
@@ -133,6 +219,7 @@ Class | Method | HTTP request | Description
133
219
 
134
220
  ### API_KEY
135
221
 
222
+
136
223
  - **Type**: API key
137
224
  - **API key parameter name**: x-api-key
138
225
  - **Location**: HTTP header
@@ -0,0 +1,124 @@
1
+ # MailSlurpClient::AttachmentControllerApi
2
+
3
+ All URIs are relative to *https://api.mailslurp.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**upload_attachment**](AttachmentControllerApi.md#upload_attachment) | **POST** /attachments | Upload an attachment for sending
8
+ [**upload_multipart_form**](AttachmentControllerApi.md#upload_multipart_form) | **POST** /attachments/multipart | Upload an attachment for sending using Multipart Form
9
+
10
+
11
+
12
+ ## upload_attachment
13
+
14
+ > Array<String> upload_attachment(upload_options)
15
+
16
+ Upload an attachment for sending
17
+
18
+ When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
19
+
20
+ ### Example
21
+
22
+ ```ruby
23
+ # load the gem
24
+ require 'mailslurp_client'
25
+ # setup authorization
26
+ MailSlurpClient.configure do |config|
27
+ # Configure API key authorization: API_KEY
28
+ config.api_key['x-api-key'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = MailSlurpClient::AttachmentControllerApi.new
34
+ upload_options = MailSlurpClient::UploadAttachmentOptions.new # UploadAttachmentOptions | uploadOptions
35
+
36
+ begin
37
+ #Upload an attachment for sending
38
+ result = api_instance.upload_attachment(upload_options)
39
+ p result
40
+ rescue MailSlurpClient::ApiError => e
41
+ puts "Exception when calling AttachmentControllerApi->upload_attachment: #{e}"
42
+ end
43
+ ```
44
+
45
+ ### Parameters
46
+
47
+
48
+ Name | Type | Description | Notes
49
+ ------------- | ------------- | ------------- | -------------
50
+ **upload_options** | [**UploadAttachmentOptions**](UploadAttachmentOptions.md)| uploadOptions |
51
+
52
+ ### Return type
53
+
54
+ **Array<String>**
55
+
56
+ ### Authorization
57
+
58
+ [API_KEY](../README.md#API_KEY)
59
+
60
+ ### HTTP request headers
61
+
62
+ - **Content-Type**: application/json
63
+ - **Accept**: application/json
64
+
65
+
66
+ ## upload_multipart_form
67
+
68
+ > Array<String> upload_multipart_form(file, opts)
69
+
70
+ Upload an attachment for sending using Multipart Form
71
+
72
+ When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
73
+
74
+ ### Example
75
+
76
+ ```ruby
77
+ # load the gem
78
+ require 'mailslurp_client'
79
+ # setup authorization
80
+ MailSlurpClient.configure do |config|
81
+ # Configure API key authorization: API_KEY
82
+ config.api_key['x-api-key'] = 'YOUR API KEY'
83
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
85
+ end
86
+
87
+ api_instance = MailSlurpClient::AttachmentControllerApi.new
88
+ file = File.new('/path/to/file') # File | file
89
+ opts = {
90
+ content_type: 'content_type_example', # String | contentType
91
+ filename: 'filename_example' # String | filename
92
+ }
93
+
94
+ begin
95
+ #Upload an attachment for sending using Multipart Form
96
+ result = api_instance.upload_multipart_form(file, opts)
97
+ p result
98
+ rescue MailSlurpClient::ApiError => e
99
+ puts "Exception when calling AttachmentControllerApi->upload_multipart_form: #{e}"
100
+ end
101
+ ```
102
+
103
+ ### Parameters
104
+
105
+
106
+ Name | Type | Description | Notes
107
+ ------------- | ------------- | ------------- | -------------
108
+ **file** | **File**| file |
109
+ **content_type** | **String**| contentType | [optional]
110
+ **filename** | **String**| filename | [optional]
111
+
112
+ ### Return type
113
+
114
+ **Array<String>**
115
+
116
+ ### Authorization
117
+
118
+ [API_KEY](../README.md#API_KEY)
119
+
120
+ ### HTTP request headers
121
+
122
+ - **Content-Type**: multipart/form-data
123
+ - **Accept**: application/json
124
+
@@ -0,0 +1,23 @@
1
+ # MailSlurpClient::AttachmentMetaData
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **content_length** | **Integer** | |
8
+ **content_type** | **String** | |
9
+ **id** | **String** | |
10
+ **name** | **String** | |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'MailSlurpClient'
16
+
17
+ instance = MailSlurpClient::AttachmentMetaData.new(content_length: null,
18
+ content_type: null,
19
+ id: null,
20
+ name: null)
21
+ ```
22
+
23
+
@@ -1,9 +1,19 @@
1
1
  # MailSlurpClient::BasicAuthOptions
2
2
 
3
3
  ## Properties
4
+
4
5
  Name | Type | Description | Notes
5
6
  ------------ | ------------- | ------------- | -------------
6
7
  **username** | **String** | |
7
8
  **password** | **String** | |
8
9
 
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'MailSlurpClient'
14
+
15
+ instance = MailSlurpClient::BasicAuthOptions.new(username: null,
16
+ password: null)
17
+ ```
18
+
9
19
 
@@ -0,0 +1,165 @@
1
+ # MailSlurpClient::BulkActionsControllerApi
2
+
3
+ All URIs are relative to *https://api.mailslurp.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**bulk_create_inboxes**](BulkActionsControllerApi.md#bulk_create_inboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)
8
+ [**bulk_delete_inboxes**](BulkActionsControllerApi.md#bulk_delete_inboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes
9
+ [**bulk_send_emails**](BulkActionsControllerApi.md#bulk_send_emails) | **POST** /bulk/send | Bulk Send Emails
10
+
11
+
12
+
13
+ ## bulk_create_inboxes
14
+
15
+ > Array<Inbox> bulk_create_inboxes(count)
16
+
17
+ Bulk create Inboxes (email addresses)
18
+
19
+ ### Example
20
+
21
+ ```ruby
22
+ # load the gem
23
+ require 'mailslurp_client'
24
+ # setup authorization
25
+ MailSlurpClient.configure do |config|
26
+ # Configure API key authorization: API_KEY
27
+ config.api_key['x-api-key'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
30
+ end
31
+
32
+ api_instance = MailSlurpClient::BulkActionsControllerApi.new
33
+ count = 56 # Integer | Number of inboxes to be created in bulk
34
+
35
+ begin
36
+ #Bulk create Inboxes (email addresses)
37
+ result = api_instance.bulk_create_inboxes(count)
38
+ p result
39
+ rescue MailSlurpClient::ApiError => e
40
+ puts "Exception when calling BulkActionsControllerApi->bulk_create_inboxes: #{e}"
41
+ end
42
+ ```
43
+
44
+ ### Parameters
45
+
46
+
47
+ Name | Type | Description | Notes
48
+ ------------- | ------------- | ------------- | -------------
49
+ **count** | **Integer**| Number of inboxes to be created in bulk |
50
+
51
+ ### Return type
52
+
53
+ [**Array<Inbox>**](Inbox.md)
54
+
55
+ ### Authorization
56
+
57
+ [API_KEY](../README.md#API_KEY)
58
+
59
+ ### HTTP request headers
60
+
61
+ - **Content-Type**: Not defined
62
+ - **Accept**: application/json
63
+
64
+
65
+ ## bulk_delete_inboxes
66
+
67
+ > bulk_delete_inboxes(ids)
68
+
69
+ Bulk Delete Inboxes
70
+
71
+ ### Example
72
+
73
+ ```ruby
74
+ # load the gem
75
+ require 'mailslurp_client'
76
+ # setup authorization
77
+ MailSlurpClient.configure do |config|
78
+ # Configure API key authorization: API_KEY
79
+ config.api_key['x-api-key'] = 'YOUR API KEY'
80
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
81
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
82
+ end
83
+
84
+ api_instance = MailSlurpClient::BulkActionsControllerApi.new
85
+ ids = ['ids_example'] # Array<String> | ids
86
+
87
+ begin
88
+ #Bulk Delete Inboxes
89
+ api_instance.bulk_delete_inboxes(ids)
90
+ rescue MailSlurpClient::ApiError => e
91
+ puts "Exception when calling BulkActionsControllerApi->bulk_delete_inboxes: #{e}"
92
+ end
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+
98
+ Name | Type | Description | Notes
99
+ ------------- | ------------- | ------------- | -------------
100
+ **ids** | [**Array&lt;String&gt;**](String.md)| ids |
101
+
102
+ ### Return type
103
+
104
+ nil (empty response body)
105
+
106
+ ### Authorization
107
+
108
+ [API_KEY](../README.md#API_KEY)
109
+
110
+ ### HTTP request headers
111
+
112
+ - **Content-Type**: application/json
113
+ - **Accept**: Not defined
114
+
115
+
116
+ ## bulk_send_emails
117
+
118
+ > bulk_send_emails(bulk_send_email_options)
119
+
120
+ Bulk Send Emails
121
+
122
+ ### Example
123
+
124
+ ```ruby
125
+ # load the gem
126
+ require 'mailslurp_client'
127
+ # setup authorization
128
+ MailSlurpClient.configure do |config|
129
+ # Configure API key authorization: API_KEY
130
+ config.api_key['x-api-key'] = 'YOUR API KEY'
131
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
132
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
133
+ end
134
+
135
+ api_instance = MailSlurpClient::BulkActionsControllerApi.new
136
+ bulk_send_email_options = MailSlurpClient::BulkSendEmailOptions.new # BulkSendEmailOptions | bulkSendEmailOptions
137
+
138
+ begin
139
+ #Bulk Send Emails
140
+ api_instance.bulk_send_emails(bulk_send_email_options)
141
+ rescue MailSlurpClient::ApiError => e
142
+ puts "Exception when calling BulkActionsControllerApi->bulk_send_emails: #{e}"
143
+ end
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+
149
+ Name | Type | Description | Notes
150
+ ------------- | ------------- | ------------- | -------------
151
+ **bulk_send_email_options** | [**BulkSendEmailOptions**](BulkSendEmailOptions.md)| bulkSendEmailOptions |
152
+
153
+ ### Return type
154
+
155
+ nil (empty response body)
156
+
157
+ ### Authorization
158
+
159
+ [API_KEY](../README.md#API_KEY)
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: application/json
164
+ - **Accept**: Not defined
165
+