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
data/docs/GroupDto.md ADDED
@@ -0,0 +1,23 @@
1
+ # MailSlurpClient::GroupDto
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **created_at** | **DateTime** | |
8
+ **description** | **String** | | [optional]
9
+ **id** | **String** | |
10
+ **name** | **String** | |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'MailSlurpClient'
16
+
17
+ instance = MailSlurpClient::GroupDto.new(created_at: null,
18
+ description: null,
19
+ id: null,
20
+ name: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # MailSlurpClient::GroupProjection
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **created_at** | **DateTime** | |
8
+ **description** | **String** | | [optional]
9
+ **id** | **String** | |
10
+ **name** | **String** | |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'MailSlurpClient'
16
+
17
+ instance = MailSlurpClient::GroupProjection.new(created_at: null,
18
+ description: null,
19
+ id: null,
20
+ name: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,21 @@
1
+ # MailSlurpClient::HTMLValidationResult
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **errors** | [**Array<ValidationMessage>**](ValidationMessage.md) | |
8
+ **is_valid** | **Boolean** | |
9
+ **warnings** | [**Array<ValidationMessage>**](ValidationMessage.md) | |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'MailSlurpClient'
15
+
16
+ instance = MailSlurpClient::HTMLValidationResult.new(errors: null,
17
+ is_valid: null,
18
+ warnings: null)
19
+ ```
20
+
21
+
data/docs/Inbox.md CHANGED
@@ -1,11 +1,33 @@
1
1
  # MailSlurpClient::Inbox
2
2
 
3
3
  ## Properties
4
+
4
5
  Name | Type | Description | Notes
5
6
  ------------ | ------------- | ------------- | -------------
6
- **created** | **DateTime** | | [optional]
7
- **email_address** | **String** | The inbox's email address. Send an email to this address and the inbox will receive it | [optional]
8
- **id** | **String** | | [optional]
9
- **user_id** | **String** | | [optional]
7
+ **created_at** | **DateTime** | When was the inbox created | [optional]
8
+ **description** | **String** | Optional description of an inbox for labelling purposes | [optional]
9
+ **email_address** | **String** | The inbox's email address. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints. | [optional]
10
+ **expires_at** | **DateTime** | When, if ever, will the inbox expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. | [optional]
11
+ **favourite** | **Boolean** | Is the inbox favourited | [optional]
12
+ **id** | **String** | ID of the inbox | [optional]
13
+ **name** | **String** | Optional name of the inbox. Displayed in the dashboard for easier search | [optional]
14
+ **tags** | **Array<String>** | Tags that inbox has been tagged with | [optional]
15
+ **user_id** | **String** | ID of user that inbox belongs to | [optional]
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'MailSlurpClient'
21
+
22
+ instance = MailSlurpClient::Inbox.new(created_at: null,
23
+ description: null,
24
+ email_address: null,
25
+ expires_at: null,
26
+ favourite: null,
27
+ id: null,
28
+ name: null,
29
+ tags: null,
30
+ user_id: null)
31
+ ```
10
32
 
11
33
 
@@ -0,0 +1,652 @@
1
+ # MailSlurpClient::InboxControllerApi
2
+
3
+ All URIs are relative to *https://api.mailslurp.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_inbox**](InboxControllerApi.md#create_inbox) | **POST** /inboxes | Create an Inbox (email address)
8
+ [**delete_all_inboxes**](InboxControllerApi.md#delete_all_inboxes) | **DELETE** /inboxes | Delete all inboxes
9
+ [**delete_inbox**](InboxControllerApi.md#delete_inbox) | **DELETE** /inboxes/{inboxId} | Delete inbox
10
+ [**get_all_inboxes**](InboxControllerApi.md#get_all_inboxes) | **GET** /inboxes/paginated | List Inboxes Paginated
11
+ [**get_emails**](InboxControllerApi.md#get_emails) | **GET** /inboxes/{inboxId}/emails | Get emails in an Inbox
12
+ [**get_inbox**](InboxControllerApi.md#get_inbox) | **GET** /inboxes/{inboxId} | Get Inbox
13
+ [**get_inbox_emails_paginated**](InboxControllerApi.md#get_inbox_emails_paginated) | **GET** /inboxes/{inboxId}/emails/paginated | Get inbox emails paginated
14
+ [**get_inboxes**](InboxControllerApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
15
+ [**send_email**](InboxControllerApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
16
+ [**set_inbox_favourited**](InboxControllerApi.md#set_inbox_favourited) | **PUT** /inboxes/{inboxId}/favourite | Set inbox favourited state
17
+ [**update_inbox**](InboxControllerApi.md#update_inbox) | **PATCH** /inboxes/{inboxId} | Update Inbox
18
+
19
+
20
+
21
+ ## create_inbox
22
+
23
+ > Inbox create_inbox(opts)
24
+
25
+ Create an Inbox (email address)
26
+
27
+ Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
28
+
29
+ ### Example
30
+
31
+ ```ruby
32
+ # load the gem
33
+ require 'mailslurp_client'
34
+ # setup authorization
35
+ MailSlurpClient.configure do |config|
36
+ # Configure API key authorization: API_KEY
37
+ config.api_key['x-api-key'] = 'YOUR API KEY'
38
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
40
+ end
41
+
42
+ api_instance = MailSlurpClient::InboxControllerApi.new
43
+ opts = {
44
+ description: 'description_example', # String | Optional description for an inbox.
45
+ email_address: 'email_address_example', # String | Optional email address including domain you wish inbox to use (eg: test123@mydomain.com). Only supports domains that you have registered and verified with MailSlurp using dashboard or `createDomain` method.
46
+ expires_at: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Optional expires at timestamp. If your plan supports this feature you can specify when an inbox should expire. If left empty inbox will exist permanently or expire when your plan dictates
47
+ favourite: true, # Boolean | Is inbox favourited.
48
+ name: 'name_example', # String | Optional name for an inbox.
49
+ tags: ['tags_example'] # Array<String> | Optional tags for an inbox. Can be used for searching and filtering inboxes.
50
+ }
51
+
52
+ begin
53
+ #Create an Inbox (email address)
54
+ result = api_instance.create_inbox(opts)
55
+ p result
56
+ rescue MailSlurpClient::ApiError => e
57
+ puts "Exception when calling InboxControllerApi->create_inbox: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+
64
+ Name | Type | Description | Notes
65
+ ------------- | ------------- | ------------- | -------------
66
+ **description** | **String**| Optional description for an inbox. | [optional]
67
+ **email_address** | **String**| Optional email address including domain you wish inbox to use (eg: test123@mydomain.com). Only supports domains that you have registered and verified with MailSlurp using dashboard or &#x60;createDomain&#x60; method. | [optional]
68
+ **expires_at** | **DateTime**| Optional expires at timestamp. If your plan supports this feature you can specify when an inbox should expire. If left empty inbox will exist permanently or expire when your plan dictates | [optional]
69
+ **favourite** | **Boolean**| Is inbox favourited. | [optional]
70
+ **name** | **String**| Optional name for an inbox. | [optional]
71
+ **tags** | [**Array&lt;String&gt;**](String.md)| Optional tags for an inbox. Can be used for searching and filtering inboxes. | [optional]
72
+
73
+ ### Return type
74
+
75
+ [**Inbox**](Inbox.md)
76
+
77
+ ### Authorization
78
+
79
+ [API_KEY](../README.md#API_KEY)
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: Not defined
84
+ - **Accept**: application/json
85
+
86
+
87
+ ## delete_all_inboxes
88
+
89
+ > delete_all_inboxes
90
+
91
+ Delete all inboxes
92
+
93
+ Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
94
+
95
+ ### Example
96
+
97
+ ```ruby
98
+ # load the gem
99
+ require 'mailslurp_client'
100
+ # setup authorization
101
+ MailSlurpClient.configure do |config|
102
+ # Configure API key authorization: API_KEY
103
+ config.api_key['x-api-key'] = 'YOUR API KEY'
104
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
105
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
106
+ end
107
+
108
+ api_instance = MailSlurpClient::InboxControllerApi.new
109
+
110
+ begin
111
+ #Delete all inboxes
112
+ api_instance.delete_all_inboxes
113
+ rescue MailSlurpClient::ApiError => e
114
+ puts "Exception when calling InboxControllerApi->delete_all_inboxes: #{e}"
115
+ end
116
+ ```
117
+
118
+ ### Parameters
119
+
120
+ This endpoint does not need any parameter.
121
+
122
+ ### Return type
123
+
124
+ nil (empty response body)
125
+
126
+ ### Authorization
127
+
128
+ [API_KEY](../README.md#API_KEY)
129
+
130
+ ### HTTP request headers
131
+
132
+ - **Content-Type**: Not defined
133
+ - **Accept**: Not defined
134
+
135
+
136
+ ## delete_inbox
137
+
138
+ > delete_inbox(inbox_id)
139
+
140
+ Delete inbox
141
+
142
+ Permanently delete an inbox and associated email address aswell as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
143
+
144
+ ### Example
145
+
146
+ ```ruby
147
+ # load the gem
148
+ require 'mailslurp_client'
149
+ # setup authorization
150
+ MailSlurpClient.configure do |config|
151
+ # Configure API key authorization: API_KEY
152
+ config.api_key['x-api-key'] = 'YOUR API KEY'
153
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
154
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
155
+ end
156
+
157
+ api_instance = MailSlurpClient::InboxControllerApi.new
158
+ inbox_id = 'inbox_id_example' # String | inboxId
159
+
160
+ begin
161
+ #Delete inbox
162
+ api_instance.delete_inbox(inbox_id)
163
+ rescue MailSlurpClient::ApiError => e
164
+ puts "Exception when calling InboxControllerApi->delete_inbox: #{e}"
165
+ end
166
+ ```
167
+
168
+ ### Parameters
169
+
170
+
171
+ Name | Type | Description | Notes
172
+ ------------- | ------------- | ------------- | -------------
173
+ **inbox_id** | [**String**](.md)| inboxId |
174
+
175
+ ### Return type
176
+
177
+ nil (empty response body)
178
+
179
+ ### Authorization
180
+
181
+ [API_KEY](../README.md#API_KEY)
182
+
183
+ ### HTTP request headers
184
+
185
+ - **Content-Type**: Not defined
186
+ - **Accept**: Not defined
187
+
188
+
189
+ ## get_all_inboxes
190
+
191
+ > PageInboxProjection get_all_inboxes(opts)
192
+
193
+ List Inboxes Paginated
194
+
195
+ List inboxes in paginated form. Allows for page index, page size, and sort direction. Can also filter by favourited or email address like pattern.
196
+
197
+ ### Example
198
+
199
+ ```ruby
200
+ # load the gem
201
+ require 'mailslurp_client'
202
+ # setup authorization
203
+ MailSlurpClient.configure do |config|
204
+ # Configure API key authorization: API_KEY
205
+ config.api_key['x-api-key'] = 'YOUR API KEY'
206
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
207
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
208
+ end
209
+
210
+ api_instance = MailSlurpClient::InboxControllerApi.new
211
+ opts = {
212
+ favourite: false, # Boolean | Optionally filter results for favourites only
213
+ page: 0, # Integer | Optional page index in inbox list pagination
214
+ search: 'search_example', # String | Optionally filter by search words partial matching ID, tags, name, and email address
215
+ size: 20, # Integer | Optional page size in inbox list pagination
216
+ sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
217
+ }
218
+
219
+ begin
220
+ #List Inboxes Paginated
221
+ result = api_instance.get_all_inboxes(opts)
222
+ p result
223
+ rescue MailSlurpClient::ApiError => e
224
+ puts "Exception when calling InboxControllerApi->get_all_inboxes: #{e}"
225
+ end
226
+ ```
227
+
228
+ ### Parameters
229
+
230
+
231
+ Name | Type | Description | Notes
232
+ ------------- | ------------- | ------------- | -------------
233
+ **favourite** | **Boolean**| Optionally filter results for favourites only | [optional] [default to false]
234
+ **page** | **Integer**| Optional page index in inbox list pagination | [optional] [default to 0]
235
+ **search** | **String**| Optionally filter by search words partial matching ID, tags, name, and email address | [optional]
236
+ **size** | **Integer**| Optional page size in inbox list pagination | [optional] [default to 20]
237
+ **sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to &#39;ASC&#39;]
238
+
239
+ ### Return type
240
+
241
+ [**PageInboxProjection**](PageInboxProjection.md)
242
+
243
+ ### Authorization
244
+
245
+ [API_KEY](../README.md#API_KEY)
246
+
247
+ ### HTTP request headers
248
+
249
+ - **Content-Type**: Not defined
250
+ - **Accept**: application/json
251
+
252
+
253
+ ## get_emails
254
+
255
+ > Array&lt;EmailPreview&gt; get_emails(inbox_id, opts)
256
+
257
+ Get emails in an Inbox
258
+
259
+ List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
260
+
261
+ ### Example
262
+
263
+ ```ruby
264
+ # load the gem
265
+ require 'mailslurp_client'
266
+ # setup authorization
267
+ MailSlurpClient.configure do |config|
268
+ # Configure API key authorization: API_KEY
269
+ config.api_key['x-api-key'] = 'YOUR API KEY'
270
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
271
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
272
+ end
273
+
274
+ api_instance = MailSlurpClient::InboxControllerApi.new
275
+ inbox_id = 'inbox_id_example' # String | Id of inbox that emails belongs to
276
+ opts = {
277
+ limit: 56, # Integer | Limit the result set, ordered by received date time sort direction
278
+ min_count: 56, # Integer | Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
279
+ retry_timeout: 56, # Integer | Maximum milliseconds to spend retrying inbox database until minCount emails are returned
280
+ since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Exclude emails received before this ISO 8601 date time
281
+ sort: 'sort_example' # String | Sort the results by received date and direction ASC or DESC
282
+ }
283
+
284
+ begin
285
+ #Get emails in an Inbox
286
+ result = api_instance.get_emails(inbox_id, opts)
287
+ p result
288
+ rescue MailSlurpClient::ApiError => e
289
+ puts "Exception when calling InboxControllerApi->get_emails: #{e}"
290
+ end
291
+ ```
292
+
293
+ ### Parameters
294
+
295
+
296
+ Name | Type | Description | Notes
297
+ ------------- | ------------- | ------------- | -------------
298
+ **inbox_id** | [**String**](.md)| Id of inbox that emails belongs to |
299
+ **limit** | **Integer**| Limit the result set, ordered by received date time sort direction | [optional]
300
+ **min_count** | **Integer**| Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. | [optional]
301
+ **retry_timeout** | **Integer**| Maximum milliseconds to spend retrying inbox database until minCount emails are returned | [optional]
302
+ **since** | **DateTime**| Exclude emails received before this ISO 8601 date time | [optional]
303
+ **sort** | **String**| Sort the results by received date and direction ASC or DESC | [optional]
304
+
305
+ ### Return type
306
+
307
+ [**Array&lt;EmailPreview&gt;**](EmailPreview.md)
308
+
309
+ ### Authorization
310
+
311
+ [API_KEY](../README.md#API_KEY)
312
+
313
+ ### HTTP request headers
314
+
315
+ - **Content-Type**: Not defined
316
+ - **Accept**: application/json
317
+
318
+
319
+ ## get_inbox
320
+
321
+ > Inbox get_inbox(inbox_id)
322
+
323
+ Get Inbox
324
+
325
+ Returns an inbox's properties, including its email address and ID.
326
+
327
+ ### Example
328
+
329
+ ```ruby
330
+ # load the gem
331
+ require 'mailslurp_client'
332
+ # setup authorization
333
+ MailSlurpClient.configure do |config|
334
+ # Configure API key authorization: API_KEY
335
+ config.api_key['x-api-key'] = 'YOUR API KEY'
336
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
337
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
338
+ end
339
+
340
+ api_instance = MailSlurpClient::InboxControllerApi.new
341
+ inbox_id = 'inbox_id_example' # String | inboxId
342
+
343
+ begin
344
+ #Get Inbox
345
+ result = api_instance.get_inbox(inbox_id)
346
+ p result
347
+ rescue MailSlurpClient::ApiError => e
348
+ puts "Exception when calling InboxControllerApi->get_inbox: #{e}"
349
+ end
350
+ ```
351
+
352
+ ### Parameters
353
+
354
+
355
+ Name | Type | Description | Notes
356
+ ------------- | ------------- | ------------- | -------------
357
+ **inbox_id** | [**String**](.md)| inboxId |
358
+
359
+ ### Return type
360
+
361
+ [**Inbox**](Inbox.md)
362
+
363
+ ### Authorization
364
+
365
+ [API_KEY](../README.md#API_KEY)
366
+
367
+ ### HTTP request headers
368
+
369
+ - **Content-Type**: Not defined
370
+ - **Accept**: application/json
371
+
372
+
373
+ ## get_inbox_emails_paginated
374
+
375
+ > PageEmailPreview get_inbox_emails_paginated(inbox_id, opts)
376
+
377
+ Get inbox emails paginated
378
+
379
+ Get a paginated list of emails in an inbox. Does not hold connections open.
380
+
381
+ ### Example
382
+
383
+ ```ruby
384
+ # load the gem
385
+ require 'mailslurp_client'
386
+ # setup authorization
387
+ MailSlurpClient.configure do |config|
388
+ # Configure API key authorization: API_KEY
389
+ config.api_key['x-api-key'] = 'YOUR API KEY'
390
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
391
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
392
+ end
393
+
394
+ api_instance = MailSlurpClient::InboxControllerApi.new
395
+ inbox_id = 'inbox_id_example' # String | Id of inbox that emails belongs to
396
+ opts = {
397
+ page: 0, # Integer | Optional page index in inbox emails list pagination
398
+ size: 20, # Integer | Optional page size in inbox emails list pagination
399
+ sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
400
+ }
401
+
402
+ begin
403
+ #Get inbox emails paginated
404
+ result = api_instance.get_inbox_emails_paginated(inbox_id, opts)
405
+ p result
406
+ rescue MailSlurpClient::ApiError => e
407
+ puts "Exception when calling InboxControllerApi->get_inbox_emails_paginated: #{e}"
408
+ end
409
+ ```
410
+
411
+ ### Parameters
412
+
413
+
414
+ Name | Type | Description | Notes
415
+ ------------- | ------------- | ------------- | -------------
416
+ **inbox_id** | [**String**](.md)| Id of inbox that emails belongs to |
417
+ **page** | **Integer**| Optional page index in inbox emails list pagination | [optional] [default to 0]
418
+ **size** | **Integer**| Optional page size in inbox emails list pagination | [optional] [default to 20]
419
+ **sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to &#39;ASC&#39;]
420
+
421
+ ### Return type
422
+
423
+ [**PageEmailPreview**](PageEmailPreview.md)
424
+
425
+ ### Authorization
426
+
427
+ [API_KEY](../README.md#API_KEY)
428
+
429
+ ### HTTP request headers
430
+
431
+ - **Content-Type**: Not defined
432
+ - **Accept**: application/json
433
+
434
+
435
+ ## get_inboxes
436
+
437
+ > Array&lt;Inbox&gt; get_inboxes
438
+
439
+ List Inboxes / Email Addresses
440
+
441
+ List the inboxes you have created
442
+
443
+ ### Example
444
+
445
+ ```ruby
446
+ # load the gem
447
+ require 'mailslurp_client'
448
+ # setup authorization
449
+ MailSlurpClient.configure do |config|
450
+ # Configure API key authorization: API_KEY
451
+ config.api_key['x-api-key'] = 'YOUR API KEY'
452
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
453
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
454
+ end
455
+
456
+ api_instance = MailSlurpClient::InboxControllerApi.new
457
+
458
+ begin
459
+ #List Inboxes / Email Addresses
460
+ result = api_instance.get_inboxes
461
+ p result
462
+ rescue MailSlurpClient::ApiError => e
463
+ puts "Exception when calling InboxControllerApi->get_inboxes: #{e}"
464
+ end
465
+ ```
466
+
467
+ ### Parameters
468
+
469
+ This endpoint does not need any parameter.
470
+
471
+ ### Return type
472
+
473
+ [**Array&lt;Inbox&gt;**](Inbox.md)
474
+
475
+ ### Authorization
476
+
477
+ [API_KEY](../README.md#API_KEY)
478
+
479
+ ### HTTP request headers
480
+
481
+ - **Content-Type**: Not defined
482
+ - **Accept**: application/json
483
+
484
+
485
+ ## send_email
486
+
487
+ > send_email(inbox_id, opts)
488
+
489
+ Send Email
490
+
491
+ Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails.
492
+
493
+ ### Example
494
+
495
+ ```ruby
496
+ # load the gem
497
+ require 'mailslurp_client'
498
+ # setup authorization
499
+ MailSlurpClient.configure do |config|
500
+ # Configure API key authorization: API_KEY
501
+ config.api_key['x-api-key'] = 'YOUR API KEY'
502
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
503
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
504
+ end
505
+
506
+ api_instance = MailSlurpClient::InboxControllerApi.new
507
+ inbox_id = 'inbox_id_example' # String | ID of the inbox you want to send the email from
508
+ opts = {
509
+ send_email_options: MailSlurpClient::SendEmailOptions.new # SendEmailOptions | Options for the email
510
+ }
511
+
512
+ begin
513
+ #Send Email
514
+ api_instance.send_email(inbox_id, opts)
515
+ rescue MailSlurpClient::ApiError => e
516
+ puts "Exception when calling InboxControllerApi->send_email: #{e}"
517
+ end
518
+ ```
519
+
520
+ ### Parameters
521
+
522
+
523
+ Name | Type | Description | Notes
524
+ ------------- | ------------- | ------------- | -------------
525
+ **inbox_id** | [**String**](.md)| ID of the inbox you want to send the email from |
526
+ **send_email_options** | [**SendEmailOptions**](SendEmailOptions.md)| Options for the email | [optional]
527
+
528
+ ### Return type
529
+
530
+ nil (empty response body)
531
+
532
+ ### Authorization
533
+
534
+ [API_KEY](../README.md#API_KEY)
535
+
536
+ ### HTTP request headers
537
+
538
+ - **Content-Type**: application/json
539
+ - **Accept**: Not defined
540
+
541
+
542
+ ## set_inbox_favourited
543
+
544
+ > Inbox set_inbox_favourited(inbox_id, set_inbox_favourited_options)
545
+
546
+ Set inbox favourited state
547
+
548
+ Set and return new favourite state for an inbox
549
+
550
+ ### Example
551
+
552
+ ```ruby
553
+ # load the gem
554
+ require 'mailslurp_client'
555
+ # setup authorization
556
+ MailSlurpClient.configure do |config|
557
+ # Configure API key authorization: API_KEY
558
+ config.api_key['x-api-key'] = 'YOUR API KEY'
559
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
560
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
561
+ end
562
+
563
+ api_instance = MailSlurpClient::InboxControllerApi.new
564
+ inbox_id = 'inbox_id_example' # String | inboxId
565
+ set_inbox_favourited_options = MailSlurpClient::SetInboxFavouritedOptions.new # SetInboxFavouritedOptions | setInboxFavouritedOptions
566
+
567
+ begin
568
+ #Set inbox favourited state
569
+ result = api_instance.set_inbox_favourited(inbox_id, set_inbox_favourited_options)
570
+ p result
571
+ rescue MailSlurpClient::ApiError => e
572
+ puts "Exception when calling InboxControllerApi->set_inbox_favourited: #{e}"
573
+ end
574
+ ```
575
+
576
+ ### Parameters
577
+
578
+
579
+ Name | Type | Description | Notes
580
+ ------------- | ------------- | ------------- | -------------
581
+ **inbox_id** | [**String**](.md)| inboxId |
582
+ **set_inbox_favourited_options** | [**SetInboxFavouritedOptions**](SetInboxFavouritedOptions.md)| setInboxFavouritedOptions |
583
+
584
+ ### Return type
585
+
586
+ [**Inbox**](Inbox.md)
587
+
588
+ ### Authorization
589
+
590
+ [API_KEY](../README.md#API_KEY)
591
+
592
+ ### HTTP request headers
593
+
594
+ - **Content-Type**: application/json
595
+ - **Accept**: application/json
596
+
597
+
598
+ ## update_inbox
599
+
600
+ > Inbox update_inbox(inbox_id, update_inbox_options)
601
+
602
+ Update Inbox
603
+
604
+ Update editable fields on an inbox
605
+
606
+ ### Example
607
+
608
+ ```ruby
609
+ # load the gem
610
+ require 'mailslurp_client'
611
+ # setup authorization
612
+ MailSlurpClient.configure do |config|
613
+ # Configure API key authorization: API_KEY
614
+ config.api_key['x-api-key'] = 'YOUR API KEY'
615
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
616
+ #config.api_key_prefix['x-api-key'] = 'Bearer'
617
+ end
618
+
619
+ api_instance = MailSlurpClient::InboxControllerApi.new
620
+ inbox_id = 'inbox_id_example' # String | inboxId
621
+ update_inbox_options = MailSlurpClient::UpdateInboxOptions.new # UpdateInboxOptions | updateInboxOptions
622
+
623
+ begin
624
+ #Update Inbox
625
+ result = api_instance.update_inbox(inbox_id, update_inbox_options)
626
+ p result
627
+ rescue MailSlurpClient::ApiError => e
628
+ puts "Exception when calling InboxControllerApi->update_inbox: #{e}"
629
+ end
630
+ ```
631
+
632
+ ### Parameters
633
+
634
+
635
+ Name | Type | Description | Notes
636
+ ------------- | ------------- | ------------- | -------------
637
+ **inbox_id** | [**String**](.md)| inboxId |
638
+ **update_inbox_options** | [**UpdateInboxOptions**](UpdateInboxOptions.md)| updateInboxOptions |
639
+
640
+ ### Return type
641
+
642
+ [**Inbox**](Inbox.md)
643
+
644
+ ### Authorization
645
+
646
+ [API_KEY](../README.md#API_KEY)
647
+
648
+ ### HTTP request headers
649
+
650
+ - **Content-Type**: application/json
651
+ - **Accept**: application/json
652
+