mailslurp_client 7.0.8 → 7.2.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (230) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client.rb +12 -3
  3. metadata +11 -372
  4. data/Gemfile +0 -9
  5. data/LICENSE +0 -22
  6. data/Makefile +0 -3
  7. data/README.md +0 -239
  8. data/Rakefile +0 -10
  9. data/docs/AliasControllerApi.md +0 -337
  10. data/docs/AttachmentControllerApi.md +0 -126
  11. data/docs/AttachmentMetaData.md +0 -23
  12. data/docs/BasicAuthOptions.md +0 -19
  13. data/docs/BulkActionsControllerApi.md +0 -165
  14. data/docs/BulkSendEmailOptions.md +0 -19
  15. data/docs/CommonActionsControllerApi.md +0 -218
  16. data/docs/ContactControllerApi.md +0 -274
  17. data/docs/ContactDto.md +0 -31
  18. data/docs/ContactProjection.md +0 -27
  19. data/docs/CreateAnonymousAliasOptions.md +0 -17
  20. data/docs/CreateContactOptions.md +0 -31
  21. data/docs/CreateDomainOptions.md +0 -17
  22. data/docs/CreateGroupOptions.md +0 -19
  23. data/docs/CreateOwnedAliasOptions.md +0 -23
  24. data/docs/CreateTemplateOptions.md +0 -19
  25. data/docs/CreateWebhookOptions.md +0 -21
  26. data/docs/DomainControllerApi.md +0 -223
  27. data/docs/DomainDto.md +0 -29
  28. data/docs/DomainPreview.md +0 -21
  29. data/docs/Email.md +0 -49
  30. data/docs/EmailAnalysis.md +0 -25
  31. data/docs/EmailControllerApi.md +0 -740
  32. data/docs/EmailPreview.md +0 -31
  33. data/docs/EmailProjection.md +0 -33
  34. data/docs/FormControllerApi.md +0 -79
  35. data/docs/ForwardEmailOptions.md +0 -23
  36. data/docs/GroupContactsDto.md +0 -19
  37. data/docs/GroupControllerApi.md +0 -437
  38. data/docs/GroupDto.md +0 -23
  39. data/docs/GroupProjection.md +0 -23
  40. data/docs/HTMLValidationResult.md +0 -21
  41. data/docs/Inbox.md +0 -33
  42. data/docs/InboxControllerApi.md +0 -705
  43. data/docs/InboxProjection.md +0 -29
  44. data/docs/JsonNode.md +0 -59
  45. data/docs/MatchOption.md +0 -21
  46. data/docs/MatchOptions.md +0 -17
  47. data/docs/ModelAlias.md +0 -31
  48. data/docs/PageAlias.md +0 -37
  49. data/docs/PageContactProjection.md +0 -37
  50. data/docs/PageEmailPreview.md +0 -37
  51. data/docs/PageEmailProjection.md +0 -37
  52. data/docs/PageGroupProjection.md +0 -37
  53. data/docs/PageInboxProjection.md +0 -37
  54. data/docs/PageTemplateProjection.md +0 -37
  55. data/docs/PageWebhookProjection.md +0 -37
  56. data/docs/Pageable.md +0 -27
  57. data/docs/RawEmailJson.md +0 -17
  58. data/docs/SendEmailOptions.md +0 -45
  59. data/docs/SetInboxFavouritedOptions.md +0 -17
  60. data/docs/SimpleSendEmailOptions.md +0 -23
  61. data/docs/Sort.md +0 -21
  62. data/docs/TemplateControllerApi.md +0 -274
  63. data/docs/TemplateDto.md +0 -25
  64. data/docs/TemplateProjection.md +0 -25
  65. data/docs/TemplateVariable.md +0 -19
  66. data/docs/UnreadCount.md +0 -17
  67. data/docs/UpdateGroupContacts.md +0 -17
  68. data/docs/UpdateInboxOptions.md +0 -25
  69. data/docs/UploadAttachmentOptions.md +0 -21
  70. data/docs/ValidationDto.md +0 -19
  71. data/docs/ValidationMessage.md +0 -19
  72. data/docs/WaitForConditions.md +0 -29
  73. data/docs/WaitForControllerApi.md +0 -317
  74. data/docs/WebhookControllerApi.md +0 -339
  75. data/docs/WebhookDto.md +0 -33
  76. data/docs/WebhookProjection.md +0 -27
  77. data/docs/WebhookTestRequest.md +0 -23
  78. data/docs/WebhookTestResponse.md +0 -19
  79. data/docs/WebhookTestResult.md +0 -21
  80. data/git_push.sh +0 -58
  81. data/lib/mailslurp_client/api/alias_controller_api.rb +0 -405
  82. data/lib/mailslurp_client/api/attachment_controller_api.rb +0 -160
  83. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +0 -203
  84. data/lib/mailslurp_client/api/common_actions_controller_api.rb +0 -257
  85. data/lib/mailslurp_client/api/contact_controller_api.rb +0 -323
  86. data/lib/mailslurp_client/api/domain_controller_api.rb +0 -264
  87. data/lib/mailslurp_client/api/email_controller_api.rb +0 -852
  88. data/lib/mailslurp_client/api/form_controller_api.rb +0 -104
  89. data/lib/mailslurp_client/api/group_controller_api.rb +0 -519
  90. data/lib/mailslurp_client/api/inbox_controller_api.rb +0 -822
  91. data/lib/mailslurp_client/api/template_controller_api.rb +0 -323
  92. data/lib/mailslurp_client/api/wait_for_controller_api.rb +0 -359
  93. data/lib/mailslurp_client/api/webhook_controller_api.rb +0 -405
  94. data/lib/mailslurp_client/api_client.rb +0 -386
  95. data/lib/mailslurp_client/api_error.rb +0 -57
  96. data/lib/mailslurp_client/configuration.rb +0 -248
  97. data/lib/mailslurp_client/models/attachment_meta_data.rb +0 -238
  98. data/lib/mailslurp_client/models/basic_auth_options.rb +0 -226
  99. data/lib/mailslurp_client/models/bulk_send_email_options.rb +0 -219
  100. data/lib/mailslurp_client/models/contact_dto.rb +0 -288
  101. data/lib/mailslurp_client/models/contact_projection.rb +0 -261
  102. data/lib/mailslurp_client/models/create_anonymous_alias_options.rb +0 -208
  103. data/lib/mailslurp_client/models/create_contact_options.rb +0 -277
  104. data/lib/mailslurp_client/models/create_domain_options.rb +0 -208
  105. data/lib/mailslurp_client/models/create_group_options.rb +0 -220
  106. data/lib/mailslurp_client/models/create_owned_alias_options.rb +0 -238
  107. data/lib/mailslurp_client/models/create_template_options.rb +0 -225
  108. data/lib/mailslurp_client/models/create_webhook_options.rb +0 -227
  109. data/lib/mailslurp_client/models/domain_dto.rb +0 -296
  110. data/lib/mailslurp_client/models/domain_preview.rb +0 -240
  111. data/lib/mailslurp_client/models/email.rb +0 -376
  112. data/lib/mailslurp_client/models/email_analysis.rb +0 -248
  113. data/lib/mailslurp_client/models/email_preview.rb +0 -286
  114. data/lib/mailslurp_client/models/email_projection.rb +0 -307
  115. data/lib/mailslurp_client/models/forward_email_options.rb +0 -244
  116. data/lib/mailslurp_client/models/group_contacts_dto.rb +0 -227
  117. data/lib/mailslurp_client/models/group_dto.rb +0 -248
  118. data/lib/mailslurp_client/models/group_projection.rb +0 -248
  119. data/lib/mailslurp_client/models/html_validation_result.rb +0 -243
  120. data/lib/mailslurp_client/models/inbox.rb +0 -290
  121. data/lib/mailslurp_client/models/inbox_projection.rb +0 -272
  122. data/lib/mailslurp_client/models/json_node.rb +0 -429
  123. data/lib/mailslurp_client/models/match_option.rb +0 -274
  124. data/lib/mailslurp_client/models/match_options.rb +0 -210
  125. data/lib/mailslurp_client/models/model_alias.rb +0 -284
  126. data/lib/mailslurp_client/models/page_alias.rb +0 -298
  127. data/lib/mailslurp_client/models/page_contact_projection.rb +0 -298
  128. data/lib/mailslurp_client/models/page_email_preview.rb +0 -298
  129. data/lib/mailslurp_client/models/page_email_projection.rb +0 -298
  130. data/lib/mailslurp_client/models/page_group_projection.rb +0 -298
  131. data/lib/mailslurp_client/models/page_inbox_projection.rb +0 -298
  132. data/lib/mailslurp_client/models/page_template_projection.rb +0 -298
  133. data/lib/mailslurp_client/models/page_webhook_projection.rb +0 -298
  134. data/lib/mailslurp_client/models/pageable.rb +0 -251
  135. data/lib/mailslurp_client/models/raw_email_json.rb +0 -211
  136. data/lib/mailslurp_client/models/send_email_options.rb +0 -392
  137. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +0 -208
  138. data/lib/mailslurp_client/models/simple_send_email_options.rb +0 -237
  139. data/lib/mailslurp_client/models/sort.rb +0 -224
  140. data/lib/mailslurp_client/models/template_dto.rb +0 -269
  141. data/lib/mailslurp_client/models/template_projection.rb +0 -269
  142. data/lib/mailslurp_client/models/template_variable.rb +0 -259
  143. data/lib/mailslurp_client/models/unread_count.rb +0 -211
  144. data/lib/mailslurp_client/models/update_group_contacts.rb +0 -213
  145. data/lib/mailslurp_client/models/update_inbox_options.rb +0 -250
  146. data/lib/mailslurp_client/models/upload_attachment_options.rb +0 -228
  147. data/lib/mailslurp_client/models/validation_dto.rb +0 -217
  148. data/lib/mailslurp_client/models/validation_message.rb +0 -220
  149. data/lib/mailslurp_client/models/wait_for_conditions.rb +0 -316
  150. data/lib/mailslurp_client/models/webhook_dto.rb +0 -326
  151. data/lib/mailslurp_client/models/webhook_projection.rb +0 -277
  152. data/lib/mailslurp_client/models/webhook_test_request.rb +0 -284
  153. data/lib/mailslurp_client/models/webhook_test_response.rb +0 -215
  154. data/lib/mailslurp_client/models/webhook_test_result.rb +0 -235
  155. data/lib/mailslurp_client/version.rb +0 -15
  156. data/mailslurp_client.gemspec +0 -39
  157. data/spec/api/alias_controller_api_spec.rb +0 -107
  158. data/spec/api/attachment_controller_api_spec.rb +0 -61
  159. data/spec/api/bulk_actions_controller_api_spec.rb +0 -68
  160. data/spec/api/common_actions_controller_api_spec.rb +0 -129
  161. data/spec/api/contact_controller_api_spec.rb +0 -91
  162. data/spec/api/domain_controller_api_spec.rb +0 -82
  163. data/spec/api/email_controller_api_spec.rb +0 -162
  164. data/spec/api/form_controller_api_spec.rb +0 -54
  165. data/spec/api/group_controller_api_spec.rb +0 -126
  166. data/spec/api/inbox_controller_api_spec.rb +0 -172
  167. data/spec/api/template_controller_api_spec.rb +0 -91
  168. data/spec/api/wait_for_controller_api_spec.rb +0 -107
  169. data/spec/api/webhook_controller_api_spec.rb +0 -107
  170. data/spec/api_client_spec.rb +0 -226
  171. data/spec/configuration_spec.rb +0 -42
  172. data/spec/models/attachment_meta_data_spec.rb +0 -59
  173. data/spec/models/basic_auth_options_spec.rb +0 -47
  174. data/spec/models/bulk_send_email_options_spec.rb +0 -47
  175. data/spec/models/contact_dto_spec.rb +0 -83
  176. data/spec/models/contact_projection_spec.rb +0 -71
  177. data/spec/models/create_anonymous_alias_options_spec.rb +0 -41
  178. data/spec/models/create_contact_options_spec.rb +0 -83
  179. data/spec/models/create_domain_options_spec.rb +0 -41
  180. data/spec/models/create_group_options_spec.rb +0 -47
  181. data/spec/models/create_owned_alias_options_spec.rb +0 -59
  182. data/spec/models/create_template_options_spec.rb +0 -47
  183. data/spec/models/create_webhook_options_spec.rb +0 -53
  184. data/spec/models/domain_dto_spec.rb +0 -77
  185. data/spec/models/domain_preview_spec.rb +0 -53
  186. data/spec/models/email_analysis_spec.rb +0 -65
  187. data/spec/models/email_preview_spec.rb +0 -83
  188. data/spec/models/email_projection_spec.rb +0 -89
  189. data/spec/models/email_spec.rb +0 -137
  190. data/spec/models/forward_email_options_spec.rb +0 -59
  191. data/spec/models/group_contacts_dto_spec.rb +0 -47
  192. data/spec/models/group_dto_spec.rb +0 -59
  193. data/spec/models/group_projection_spec.rb +0 -59
  194. data/spec/models/html_validation_result_spec.rb +0 -53
  195. data/spec/models/inbox_projection_spec.rb +0 -77
  196. data/spec/models/inbox_spec.rb +0 -89
  197. data/spec/models/json_node_spec.rb +0 -171
  198. data/spec/models/match_option_spec.rb +0 -61
  199. data/spec/models/match_options_spec.rb +0 -41
  200. data/spec/models/model_alias_spec.rb +0 -83
  201. data/spec/models/page_alias_spec.rb +0 -101
  202. data/spec/models/page_contact_projection_spec.rb +0 -101
  203. data/spec/models/page_email_preview_spec.rb +0 -101
  204. data/spec/models/page_email_projection_spec.rb +0 -101
  205. data/spec/models/page_group_projection_spec.rb +0 -101
  206. data/spec/models/page_inbox_projection_spec.rb +0 -101
  207. data/spec/models/page_template_projection_spec.rb +0 -101
  208. data/spec/models/page_webhook_projection_spec.rb +0 -101
  209. data/spec/models/pageable_spec.rb +0 -71
  210. data/spec/models/raw_email_json_spec.rb +0 -41
  211. data/spec/models/send_email_options_spec.rb +0 -129
  212. data/spec/models/set_inbox_favourited_options_spec.rb +0 -41
  213. data/spec/models/simple_send_email_options_spec.rb +0 -59
  214. data/spec/models/sort_spec.rb +0 -53
  215. data/spec/models/template_dto_spec.rb +0 -65
  216. data/spec/models/template_projection_spec.rb +0 -65
  217. data/spec/models/template_variable_spec.rb +0 -51
  218. data/spec/models/unread_count_spec.rb +0 -41
  219. data/spec/models/update_group_contacts_spec.rb +0 -41
  220. data/spec/models/update_inbox_options_spec.rb +0 -65
  221. data/spec/models/upload_attachment_options_spec.rb +0 -53
  222. data/spec/models/validation_dto_spec.rb +0 -47
  223. data/spec/models/validation_message_spec.rb +0 -47
  224. data/spec/models/wait_for_conditions_spec.rb +0 -85
  225. data/spec/models/webhook_dto_spec.rb +0 -93
  226. data/spec/models/webhook_projection_spec.rb +0 -71
  227. data/spec/models/webhook_test_request_spec.rb +0 -63
  228. data/spec/models/webhook_test_response_spec.rb +0 -47
  229. data/spec/models/webhook_test_result_spec.rb +0 -53
  230. data/spec/spec_helper.rb +0 -111
@@ -1,23 +0,0 @@
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
-
@@ -1,23 +0,0 @@
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
-
@@ -1,21 +0,0 @@
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
-
@@ -1,33 +0,0 @@
1
- # MailSlurpClient::Inbox
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
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
- ```
32
-
33
-
@@ -1,705 +0,0 @@
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_inbox_tags**](InboxControllerApi.md#get_inbox_tags) | **GET** /inboxes/tags | Get inbox tags
15
- [**get_inboxes**](InboxControllerApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
16
- [**send_email**](InboxControllerApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
17
- [**set_inbox_favourited**](InboxControllerApi.md#set_inbox_favourited) | **PUT** /inboxes/{inboxId}/favourite | Set inbox favourited state
18
- [**update_inbox**](InboxControllerApi.md#update_inbox) | **PATCH** /inboxes/{inboxId} | Update Inbox
19
-
20
-
21
-
22
- ## create_inbox
23
-
24
- > Inbox create_inbox(opts)
25
-
26
- Create an Inbox (email address)
27
-
28
- 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.
29
-
30
- ### Example
31
-
32
- ```ruby
33
- # load the gem
34
- require 'mailslurp_client'
35
- # setup authorization
36
- MailSlurpClient.configure do |config|
37
- # Configure API key authorization: API_KEY
38
- config.api_key['x-api-key'] = 'YOUR API KEY'
39
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
40
- #config.api_key_prefix['x-api-key'] = 'Bearer'
41
- end
42
-
43
- api_instance = MailSlurpClient::InboxControllerApi.new
44
- opts = {
45
- description: 'description_example', # String | Optional description for an inbox.
46
- 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.
47
- 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
48
- favourite: true, # Boolean | Is inbox favourited.
49
- name: 'name_example', # String | Optional name for an inbox.
50
- tags: ['tags_example'] # Array<String> | Optional tags for an inbox. Can be used for searching and filtering inboxes.
51
- }
52
-
53
- begin
54
- #Create an Inbox (email address)
55
- result = api_instance.create_inbox(opts)
56
- p result
57
- rescue MailSlurpClient::ApiError => e
58
- puts "Exception when calling InboxControllerApi->create_inbox: #{e}"
59
- end
60
- ```
61
-
62
- ### Parameters
63
-
64
-
65
- Name | Type | Description | Notes
66
- ------------- | ------------- | ------------- | -------------
67
- **description** | **String**| Optional description for an inbox. | [optional]
68
- **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]
69
- **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]
70
- **favourite** | **Boolean**| Is inbox favourited. | [optional]
71
- **name** | **String**| Optional name for an inbox. | [optional]
72
- **tags** | [**Array&lt;String&gt;**](String.md)| Optional tags for an inbox. Can be used for searching and filtering inboxes. | [optional]
73
-
74
- ### Return type
75
-
76
- [**Inbox**](Inbox.md)
77
-
78
- ### Authorization
79
-
80
- [API_KEY](../README.md#API_KEY)
81
-
82
- ### HTTP request headers
83
-
84
- - **Content-Type**: Not defined
85
- - **Accept**: application/json
86
-
87
-
88
- ## delete_all_inboxes
89
-
90
- > delete_all_inboxes
91
-
92
- Delete all inboxes
93
-
94
- 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.
95
-
96
- ### Example
97
-
98
- ```ruby
99
- # load the gem
100
- require 'mailslurp_client'
101
- # setup authorization
102
- MailSlurpClient.configure do |config|
103
- # Configure API key authorization: API_KEY
104
- config.api_key['x-api-key'] = 'YOUR API KEY'
105
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
106
- #config.api_key_prefix['x-api-key'] = 'Bearer'
107
- end
108
-
109
- api_instance = MailSlurpClient::InboxControllerApi.new
110
-
111
- begin
112
- #Delete all inboxes
113
- api_instance.delete_all_inboxes
114
- rescue MailSlurpClient::ApiError => e
115
- puts "Exception when calling InboxControllerApi->delete_all_inboxes: #{e}"
116
- end
117
- ```
118
-
119
- ### Parameters
120
-
121
- This endpoint does not need any parameter.
122
-
123
- ### Return type
124
-
125
- nil (empty response body)
126
-
127
- ### Authorization
128
-
129
- [API_KEY](../README.md#API_KEY)
130
-
131
- ### HTTP request headers
132
-
133
- - **Content-Type**: Not defined
134
- - **Accept**: Not defined
135
-
136
-
137
- ## delete_inbox
138
-
139
- > delete_inbox(inbox_id)
140
-
141
- Delete inbox
142
-
143
- 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.
144
-
145
- ### Example
146
-
147
- ```ruby
148
- # load the gem
149
- require 'mailslurp_client'
150
- # setup authorization
151
- MailSlurpClient.configure do |config|
152
- # Configure API key authorization: API_KEY
153
- config.api_key['x-api-key'] = 'YOUR API KEY'
154
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
155
- #config.api_key_prefix['x-api-key'] = 'Bearer'
156
- end
157
-
158
- api_instance = MailSlurpClient::InboxControllerApi.new
159
- inbox_id = 'inbox_id_example' # String | inboxId
160
-
161
- begin
162
- #Delete inbox
163
- api_instance.delete_inbox(inbox_id)
164
- rescue MailSlurpClient::ApiError => e
165
- puts "Exception when calling InboxControllerApi->delete_inbox: #{e}"
166
- end
167
- ```
168
-
169
- ### Parameters
170
-
171
-
172
- Name | Type | Description | Notes
173
- ------------- | ------------- | ------------- | -------------
174
- **inbox_id** | [**String**](.md)| inboxId |
175
-
176
- ### Return type
177
-
178
- nil (empty response body)
179
-
180
- ### Authorization
181
-
182
- [API_KEY](../README.md#API_KEY)
183
-
184
- ### HTTP request headers
185
-
186
- - **Content-Type**: Not defined
187
- - **Accept**: Not defined
188
-
189
-
190
- ## get_all_inboxes
191
-
192
- > PageInboxProjection get_all_inboxes(opts)
193
-
194
- List Inboxes Paginated
195
-
196
- List inboxes in paginated form. Allows for page index, page size, and sort direction. Can also filter by favourited or email address like pattern.
197
-
198
- ### Example
199
-
200
- ```ruby
201
- # load the gem
202
- require 'mailslurp_client'
203
- # setup authorization
204
- MailSlurpClient.configure do |config|
205
- # Configure API key authorization: API_KEY
206
- config.api_key['x-api-key'] = 'YOUR API KEY'
207
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
208
- #config.api_key_prefix['x-api-key'] = 'Bearer'
209
- end
210
-
211
- api_instance = MailSlurpClient::InboxControllerApi.new
212
- opts = {
213
- favourite: false, # Boolean | Optionally filter results for favourites only
214
- page: 0, # Integer | Optional page index in inbox list pagination
215
- search: 'search_example', # String | Optionally filter by search words partial matching ID, tags, name, and email address
216
- size: 20, # Integer | Optional page size in inbox list pagination
217
- sort: 'ASC', # String | Optional createdAt sort direction ASC or DESC
218
- tag: 'tag_example' # String | Optionally filter by tags
219
- }
220
-
221
- begin
222
- #List Inboxes Paginated
223
- result = api_instance.get_all_inboxes(opts)
224
- p result
225
- rescue MailSlurpClient::ApiError => e
226
- puts "Exception when calling InboxControllerApi->get_all_inboxes: #{e}"
227
- end
228
- ```
229
-
230
- ### Parameters
231
-
232
-
233
- Name | Type | Description | Notes
234
- ------------- | ------------- | ------------- | -------------
235
- **favourite** | **Boolean**| Optionally filter results for favourites only | [optional] [default to false]
236
- **page** | **Integer**| Optional page index in inbox list pagination | [optional] [default to 0]
237
- **search** | **String**| Optionally filter by search words partial matching ID, tags, name, and email address | [optional]
238
- **size** | **Integer**| Optional page size in inbox list pagination | [optional] [default to 20]
239
- **sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to &#39;ASC&#39;]
240
- **tag** | **String**| Optionally filter by tags | [optional]
241
-
242
- ### Return type
243
-
244
- [**PageInboxProjection**](PageInboxProjection.md)
245
-
246
- ### Authorization
247
-
248
- [API_KEY](../README.md#API_KEY)
249
-
250
- ### HTTP request headers
251
-
252
- - **Content-Type**: Not defined
253
- - **Accept**: application/json
254
-
255
-
256
- ## get_emails
257
-
258
- > Array&lt;EmailPreview&gt; get_emails(inbox_id, opts)
259
-
260
- Get emails in an Inbox
261
-
262
- 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
263
-
264
- ### Example
265
-
266
- ```ruby
267
- # load the gem
268
- require 'mailslurp_client'
269
- # setup authorization
270
- MailSlurpClient.configure do |config|
271
- # Configure API key authorization: API_KEY
272
- config.api_key['x-api-key'] = 'YOUR API KEY'
273
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
274
- #config.api_key_prefix['x-api-key'] = 'Bearer'
275
- end
276
-
277
- api_instance = MailSlurpClient::InboxControllerApi.new
278
- inbox_id = 'inbox_id_example' # String | Id of inbox that emails belongs to
279
- opts = {
280
- limit: 56, # Integer | Limit the result set, ordered by received date time sort direction
281
- min_count: 56, # Integer | Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
282
- retry_timeout: 56, # Integer | Maximum milliseconds to spend retrying inbox database until minCount emails are returned
283
- since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Exclude emails received before this ISO 8601 date time
284
- sort: 'sort_example' # String | Sort the results by received date and direction ASC or DESC
285
- }
286
-
287
- begin
288
- #Get emails in an Inbox
289
- result = api_instance.get_emails(inbox_id, opts)
290
- p result
291
- rescue MailSlurpClient::ApiError => e
292
- puts "Exception when calling InboxControllerApi->get_emails: #{e}"
293
- end
294
- ```
295
-
296
- ### Parameters
297
-
298
-
299
- Name | Type | Description | Notes
300
- ------------- | ------------- | ------------- | -------------
301
- **inbox_id** | [**String**](.md)| Id of inbox that emails belongs to |
302
- **limit** | **Integer**| Limit the result set, ordered by received date time sort direction | [optional]
303
- **min_count** | **Integer**| Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. | [optional]
304
- **retry_timeout** | **Integer**| Maximum milliseconds to spend retrying inbox database until minCount emails are returned | [optional]
305
- **since** | **DateTime**| Exclude emails received before this ISO 8601 date time | [optional]
306
- **sort** | **String**| Sort the results by received date and direction ASC or DESC | [optional]
307
-
308
- ### Return type
309
-
310
- [**Array&lt;EmailPreview&gt;**](EmailPreview.md)
311
-
312
- ### Authorization
313
-
314
- [API_KEY](../README.md#API_KEY)
315
-
316
- ### HTTP request headers
317
-
318
- - **Content-Type**: Not defined
319
- - **Accept**: application/json
320
-
321
-
322
- ## get_inbox
323
-
324
- > Inbox get_inbox(inbox_id)
325
-
326
- Get Inbox
327
-
328
- Returns an inbox's properties, including its email address and ID.
329
-
330
- ### Example
331
-
332
- ```ruby
333
- # load the gem
334
- require 'mailslurp_client'
335
- # setup authorization
336
- MailSlurpClient.configure do |config|
337
- # Configure API key authorization: API_KEY
338
- config.api_key['x-api-key'] = 'YOUR API KEY'
339
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
340
- #config.api_key_prefix['x-api-key'] = 'Bearer'
341
- end
342
-
343
- api_instance = MailSlurpClient::InboxControllerApi.new
344
- inbox_id = 'inbox_id_example' # String | inboxId
345
-
346
- begin
347
- #Get Inbox
348
- result = api_instance.get_inbox(inbox_id)
349
- p result
350
- rescue MailSlurpClient::ApiError => e
351
- puts "Exception when calling InboxControllerApi->get_inbox: #{e}"
352
- end
353
- ```
354
-
355
- ### Parameters
356
-
357
-
358
- Name | Type | Description | Notes
359
- ------------- | ------------- | ------------- | -------------
360
- **inbox_id** | [**String**](.md)| inboxId |
361
-
362
- ### Return type
363
-
364
- [**Inbox**](Inbox.md)
365
-
366
- ### Authorization
367
-
368
- [API_KEY](../README.md#API_KEY)
369
-
370
- ### HTTP request headers
371
-
372
- - **Content-Type**: Not defined
373
- - **Accept**: application/json
374
-
375
-
376
- ## get_inbox_emails_paginated
377
-
378
- > PageEmailPreview get_inbox_emails_paginated(inbox_id, opts)
379
-
380
- Get inbox emails paginated
381
-
382
- Get a paginated list of emails in an inbox. Does not hold connections open.
383
-
384
- ### Example
385
-
386
- ```ruby
387
- # load the gem
388
- require 'mailslurp_client'
389
- # setup authorization
390
- MailSlurpClient.configure do |config|
391
- # Configure API key authorization: API_KEY
392
- config.api_key['x-api-key'] = 'YOUR API KEY'
393
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
394
- #config.api_key_prefix['x-api-key'] = 'Bearer'
395
- end
396
-
397
- api_instance = MailSlurpClient::InboxControllerApi.new
398
- inbox_id = 'inbox_id_example' # String | Id of inbox that emails belongs to
399
- opts = {
400
- page: 0, # Integer | Optional page index in inbox emails list pagination
401
- size: 20, # Integer | Optional page size in inbox emails list pagination
402
- sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
403
- }
404
-
405
- begin
406
- #Get inbox emails paginated
407
- result = api_instance.get_inbox_emails_paginated(inbox_id, opts)
408
- p result
409
- rescue MailSlurpClient::ApiError => e
410
- puts "Exception when calling InboxControllerApi->get_inbox_emails_paginated: #{e}"
411
- end
412
- ```
413
-
414
- ### Parameters
415
-
416
-
417
- Name | Type | Description | Notes
418
- ------------- | ------------- | ------------- | -------------
419
- **inbox_id** | [**String**](.md)| Id of inbox that emails belongs to |
420
- **page** | **Integer**| Optional page index in inbox emails list pagination | [optional] [default to 0]
421
- **size** | **Integer**| Optional page size in inbox emails list pagination | [optional] [default to 20]
422
- **sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to &#39;ASC&#39;]
423
-
424
- ### Return type
425
-
426
- [**PageEmailPreview**](PageEmailPreview.md)
427
-
428
- ### Authorization
429
-
430
- [API_KEY](../README.md#API_KEY)
431
-
432
- ### HTTP request headers
433
-
434
- - **Content-Type**: Not defined
435
- - **Accept**: application/json
436
-
437
-
438
- ## get_inbox_tags
439
-
440
- > Array&lt;String&gt; get_inbox_tags
441
-
442
- Get inbox tags
443
-
444
- Get all inbox tags
445
-
446
- ### Example
447
-
448
- ```ruby
449
- # load the gem
450
- require 'mailslurp_client'
451
- # setup authorization
452
- MailSlurpClient.configure do |config|
453
- # Configure API key authorization: API_KEY
454
- config.api_key['x-api-key'] = 'YOUR API KEY'
455
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
456
- #config.api_key_prefix['x-api-key'] = 'Bearer'
457
- end
458
-
459
- api_instance = MailSlurpClient::InboxControllerApi.new
460
-
461
- begin
462
- #Get inbox tags
463
- result = api_instance.get_inbox_tags
464
- p result
465
- rescue MailSlurpClient::ApiError => e
466
- puts "Exception when calling InboxControllerApi->get_inbox_tags: #{e}"
467
- end
468
- ```
469
-
470
- ### Parameters
471
-
472
- This endpoint does not need any parameter.
473
-
474
- ### Return type
475
-
476
- **Array&lt;String&gt;**
477
-
478
- ### Authorization
479
-
480
- [API_KEY](../README.md#API_KEY)
481
-
482
- ### HTTP request headers
483
-
484
- - **Content-Type**: Not defined
485
- - **Accept**: application/json
486
-
487
-
488
- ## get_inboxes
489
-
490
- > Array&lt;Inbox&gt; get_inboxes
491
-
492
- List Inboxes / Email Addresses
493
-
494
- List the inboxes you have created
495
-
496
- ### Example
497
-
498
- ```ruby
499
- # load the gem
500
- require 'mailslurp_client'
501
- # setup authorization
502
- MailSlurpClient.configure do |config|
503
- # Configure API key authorization: API_KEY
504
- config.api_key['x-api-key'] = 'YOUR API KEY'
505
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
506
- #config.api_key_prefix['x-api-key'] = 'Bearer'
507
- end
508
-
509
- api_instance = MailSlurpClient::InboxControllerApi.new
510
-
511
- begin
512
- #List Inboxes / Email Addresses
513
- result = api_instance.get_inboxes
514
- p result
515
- rescue MailSlurpClient::ApiError => e
516
- puts "Exception when calling InboxControllerApi->get_inboxes: #{e}"
517
- end
518
- ```
519
-
520
- ### Parameters
521
-
522
- This endpoint does not need any parameter.
523
-
524
- ### Return type
525
-
526
- [**Array&lt;Inbox&gt;**](Inbox.md)
527
-
528
- ### Authorization
529
-
530
- [API_KEY](../README.md#API_KEY)
531
-
532
- ### HTTP request headers
533
-
534
- - **Content-Type**: Not defined
535
- - **Accept**: application/json
536
-
537
-
538
- ## send_email
539
-
540
- > send_email(inbox_id, opts)
541
-
542
- Send Email
543
-
544
- 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.
545
-
546
- ### Example
547
-
548
- ```ruby
549
- # load the gem
550
- require 'mailslurp_client'
551
- # setup authorization
552
- MailSlurpClient.configure do |config|
553
- # Configure API key authorization: API_KEY
554
- config.api_key['x-api-key'] = 'YOUR API KEY'
555
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
556
- #config.api_key_prefix['x-api-key'] = 'Bearer'
557
- end
558
-
559
- api_instance = MailSlurpClient::InboxControllerApi.new
560
- inbox_id = 'inbox_id_example' # String | ID of the inbox you want to send the email from
561
- opts = {
562
- send_email_options: MailSlurpClient::SendEmailOptions.new # SendEmailOptions | Options for the email
563
- }
564
-
565
- begin
566
- #Send Email
567
- api_instance.send_email(inbox_id, opts)
568
- rescue MailSlurpClient::ApiError => e
569
- puts "Exception when calling InboxControllerApi->send_email: #{e}"
570
- end
571
- ```
572
-
573
- ### Parameters
574
-
575
-
576
- Name | Type | Description | Notes
577
- ------------- | ------------- | ------------- | -------------
578
- **inbox_id** | [**String**](.md)| ID of the inbox you want to send the email from |
579
- **send_email_options** | [**SendEmailOptions**](SendEmailOptions.md)| Options for the email | [optional]
580
-
581
- ### Return type
582
-
583
- nil (empty response body)
584
-
585
- ### Authorization
586
-
587
- [API_KEY](../README.md#API_KEY)
588
-
589
- ### HTTP request headers
590
-
591
- - **Content-Type**: application/json
592
- - **Accept**: Not defined
593
-
594
-
595
- ## set_inbox_favourited
596
-
597
- > Inbox set_inbox_favourited(inbox_id, set_inbox_favourited_options)
598
-
599
- Set inbox favourited state
600
-
601
- Set and return new favourite state for an inbox
602
-
603
- ### Example
604
-
605
- ```ruby
606
- # load the gem
607
- require 'mailslurp_client'
608
- # setup authorization
609
- MailSlurpClient.configure do |config|
610
- # Configure API key authorization: API_KEY
611
- config.api_key['x-api-key'] = 'YOUR API KEY'
612
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
613
- #config.api_key_prefix['x-api-key'] = 'Bearer'
614
- end
615
-
616
- api_instance = MailSlurpClient::InboxControllerApi.new
617
- inbox_id = 'inbox_id_example' # String | inboxId
618
- set_inbox_favourited_options = MailSlurpClient::SetInboxFavouritedOptions.new # SetInboxFavouritedOptions | setInboxFavouritedOptions
619
-
620
- begin
621
- #Set inbox favourited state
622
- result = api_instance.set_inbox_favourited(inbox_id, set_inbox_favourited_options)
623
- p result
624
- rescue MailSlurpClient::ApiError => e
625
- puts "Exception when calling InboxControllerApi->set_inbox_favourited: #{e}"
626
- end
627
- ```
628
-
629
- ### Parameters
630
-
631
-
632
- Name | Type | Description | Notes
633
- ------------- | ------------- | ------------- | -------------
634
- **inbox_id** | [**String**](.md)| inboxId |
635
- **set_inbox_favourited_options** | [**SetInboxFavouritedOptions**](SetInboxFavouritedOptions.md)| setInboxFavouritedOptions |
636
-
637
- ### Return type
638
-
639
- [**Inbox**](Inbox.md)
640
-
641
- ### Authorization
642
-
643
- [API_KEY](../README.md#API_KEY)
644
-
645
- ### HTTP request headers
646
-
647
- - **Content-Type**: application/json
648
- - **Accept**: application/json
649
-
650
-
651
- ## update_inbox
652
-
653
- > Inbox update_inbox(inbox_id, update_inbox_options)
654
-
655
- Update Inbox
656
-
657
- Update editable fields on an inbox
658
-
659
- ### Example
660
-
661
- ```ruby
662
- # load the gem
663
- require 'mailslurp_client'
664
- # setup authorization
665
- MailSlurpClient.configure do |config|
666
- # Configure API key authorization: API_KEY
667
- config.api_key['x-api-key'] = 'YOUR API KEY'
668
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
669
- #config.api_key_prefix['x-api-key'] = 'Bearer'
670
- end
671
-
672
- api_instance = MailSlurpClient::InboxControllerApi.new
673
- inbox_id = 'inbox_id_example' # String | inboxId
674
- update_inbox_options = MailSlurpClient::UpdateInboxOptions.new # UpdateInboxOptions | updateInboxOptions
675
-
676
- begin
677
- #Update Inbox
678
- result = api_instance.update_inbox(inbox_id, update_inbox_options)
679
- p result
680
- rescue MailSlurpClient::ApiError => e
681
- puts "Exception when calling InboxControllerApi->update_inbox: #{e}"
682
- end
683
- ```
684
-
685
- ### Parameters
686
-
687
-
688
- Name | Type | Description | Notes
689
- ------------- | ------------- | ------------- | -------------
690
- **inbox_id** | [**String**](.md)| inboxId |
691
- **update_inbox_options** | [**UpdateInboxOptions**](UpdateInboxOptions.md)| updateInboxOptions |
692
-
693
- ### Return type
694
-
695
- [**Inbox**](Inbox.md)
696
-
697
- ### Authorization
698
-
699
- [API_KEY](../README.md#API_KEY)
700
-
701
- ### HTTP request headers
702
-
703
- - **Content-Type**: application/json
704
- - **Accept**: application/json
705
-