mailslurp_client 7.0.8 → 8.0.2

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,25 +0,0 @@
1
- # MailSlurpClient::TemplateProjection
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **created_at** | **DateTime** | |
8
- **id** | **String** | |
9
- **name** | **String** | |
10
- **updated_at** | **DateTime** | |
11
- **variables** | **Array<String>** | |
12
-
13
- ## Code Sample
14
-
15
- ```ruby
16
- require 'MailSlurpClient'
17
-
18
- instance = MailSlurpClient::TemplateProjection.new(created_at: null,
19
- id: null,
20
- name: null,
21
- updated_at: null,
22
- variables: null)
23
- ```
24
-
25
-
@@ -1,19 +0,0 @@
1
- # MailSlurpClient::TemplateVariable
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | |
8
- **variable_type** | **String** | |
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'MailSlurpClient'
14
-
15
- instance = MailSlurpClient::TemplateVariable.new(name: null,
16
- variable_type: null)
17
- ```
18
-
19
-
@@ -1,17 +0,0 @@
1
- # MailSlurpClient::UnreadCount
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **count** | **Integer** | |
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'MailSlurpClient'
13
-
14
- instance = MailSlurpClient::UnreadCount.new(count: null)
15
- ```
16
-
17
-
@@ -1,17 +0,0 @@
1
- # MailSlurpClient::UpdateGroupContacts
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **contact_ids** | **Array<String>** | |
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'MailSlurpClient'
13
-
14
- instance = MailSlurpClient::UpdateGroupContacts.new(contact_ids: null)
15
- ```
16
-
17
-
@@ -1,25 +0,0 @@
1
- # MailSlurpClient::UpdateInboxOptions
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **description** | **String** | Optional description of an inbox for labelling purposes | [optional]
8
- **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]
9
- **favourite** | **Boolean** | Is the inbox favourited | [optional]
10
- **name** | **String** | Optional name of the inbox. Displayed in the dashboard for easier search | [optional]
11
- **tags** | **Array<String>** | Tags that inbox has been tagged with | [optional]
12
-
13
- ## Code Sample
14
-
15
- ```ruby
16
- require 'MailSlurpClient'
17
-
18
- instance = MailSlurpClient::UpdateInboxOptions.new(description: null,
19
- expires_at: null,
20
- favourite: null,
21
- name: null,
22
- tags: null)
23
- ```
24
-
25
-
@@ -1,21 +0,0 @@
1
- # MailSlurpClient::UploadAttachmentOptions
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **base64_contents** | **String** | Base64 encoded string of file contents | [optional]
8
- **content_type** | **String** | Optional contentType for file. For instance `application/pdf` | [optional]
9
- **filename** | **String** | Optional filename to save upload with | [optional]
10
-
11
- ## Code Sample
12
-
13
- ```ruby
14
- require 'MailSlurpClient'
15
-
16
- instance = MailSlurpClient::UploadAttachmentOptions.new(base64_contents: null,
17
- content_type: null,
18
- filename: null)
19
- ```
20
-
21
-
@@ -1,19 +0,0 @@
1
- # MailSlurpClient::ValidationDto
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **email_id** | **String** | ID of the email validated | [optional]
8
- **html** | [**HTMLValidationResult**](HTMLValidationResult.md) | | [optional]
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'MailSlurpClient'
14
-
15
- instance = MailSlurpClient::ValidationDto.new(email_id: null,
16
- html: null)
17
- ```
18
-
19
-
@@ -1,19 +0,0 @@
1
- # MailSlurpClient::ValidationMessage
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **line_number** | **Integer** | |
8
- **message** | **String** | | [optional]
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'MailSlurpClient'
14
-
15
- instance = MailSlurpClient::ValidationMessage.new(line_number: null,
16
- message: null)
17
- ```
18
-
19
-
@@ -1,29 +0,0 @@
1
- # MailSlurpClient::WaitForConditions
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **count** | **Integer** | Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation. | [optional]
8
- **count_type** | **String** | How should the found count be compared to the expected count. | [optional]
9
- **inbox_id** | **String** | ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count. | [optional]
10
- **matches** | [**Array<MatchOption>**](MatchOption.md) | Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for. | [optional]
11
- **sort_direction** | **String** | Direction to sort matching emails by created time | [optional]
12
- **timeout** | **Integer** | Max time in milliseconds to retry the `waitFor` operation until conditions are met. | [optional]
13
- **unread_only** | **Boolean** | Apply conditions only to **unread** emails. All emails begin with `read=false`. An email is marked `read=true` when an `EmailDto` representation of it has been returned to the user at least once. For example you have called `getEmail` or `waitForLatestEmail` etc., or you have viewed the email in the dashboard. | [optional]
14
-
15
- ## Code Sample
16
-
17
- ```ruby
18
- require 'MailSlurpClient'
19
-
20
- instance = MailSlurpClient::WaitForConditions.new(count: null,
21
- count_type: null,
22
- inbox_id: null,
23
- matches: null,
24
- sort_direction: null,
25
- timeout: null,
26
- unread_only: null)
27
- ```
28
-
29
-
@@ -1,317 +0,0 @@
1
- # MailSlurpClient::WaitForControllerApi
2
-
3
- All URIs are relative to *https://api.mailslurp.com*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**wait_for**](WaitForControllerApi.md#wait_for) | **POST** /waitFor | Wait for conditions to be met
8
- [**wait_for_email_count**](WaitForControllerApi.md#wait_for_email_count) | **GET** /waitForEmailCount | Wait for and return count number of emails
9
- [**wait_for_latest_email**](WaitForControllerApi.md#wait_for_latest_email) | **GET** /waitForLatestEmail | Fetch inbox's latest email or if empty wait for an email to arrive
10
- [**wait_for_matching_email**](WaitForControllerApi.md#wait_for_matching_email) | **POST** /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns
11
- [**wait_for_nth_email**](WaitForControllerApi.md#wait_for_nth_email) | **GET** /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified
12
-
13
-
14
-
15
- ## wait_for
16
-
17
- > Array<EmailPreview> wait_for(opts)
18
-
19
- Wait for conditions to be met
20
-
21
- Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
22
-
23
- ### Example
24
-
25
- ```ruby
26
- # load the gem
27
- require 'mailslurp_client'
28
- # setup authorization
29
- MailSlurpClient.configure do |config|
30
- # Configure API key authorization: API_KEY
31
- config.api_key['x-api-key'] = 'YOUR API KEY'
32
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
- #config.api_key_prefix['x-api-key'] = 'Bearer'
34
- end
35
-
36
- api_instance = MailSlurpClient::WaitForControllerApi.new
37
- opts = {
38
- wait_for_conditions: MailSlurpClient::WaitForConditions.new # WaitForConditions | Conditions to wait for
39
- }
40
-
41
- begin
42
- #Wait for conditions to be met
43
- result = api_instance.wait_for(opts)
44
- p result
45
- rescue MailSlurpClient::ApiError => e
46
- puts "Exception when calling WaitForControllerApi->wait_for: #{e}"
47
- end
48
- ```
49
-
50
- ### Parameters
51
-
52
-
53
- Name | Type | Description | Notes
54
- ------------- | ------------- | ------------- | -------------
55
- **wait_for_conditions** | [**WaitForConditions**](WaitForConditions.md)| Conditions to wait for | [optional]
56
-
57
- ### Return type
58
-
59
- [**Array<EmailPreview>**](EmailPreview.md)
60
-
61
- ### Authorization
62
-
63
- [API_KEY](../README.md#API_KEY)
64
-
65
- ### HTTP request headers
66
-
67
- - **Content-Type**: application/json
68
- - **Accept**: application/json
69
-
70
-
71
- ## wait_for_email_count
72
-
73
- > Array<EmailPreview> wait_for_email_count(opts)
74
-
75
- Wait for and return count number of emails
76
-
77
- If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
78
-
79
- ### Example
80
-
81
- ```ruby
82
- # load the gem
83
- require 'mailslurp_client'
84
- # setup authorization
85
- MailSlurpClient.configure do |config|
86
- # Configure API key authorization: API_KEY
87
- config.api_key['x-api-key'] = 'YOUR API KEY'
88
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
89
- #config.api_key_prefix['x-api-key'] = 'Bearer'
90
- end
91
-
92
- api_instance = MailSlurpClient::WaitForControllerApi.new
93
- opts = {
94
- count: 56, # Integer | Number of emails to wait for. Must be greater that 1
95
- inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
96
- timeout: 56, # Integer | Max milliseconds to wait
97
- unread_only: false # Boolean | Optional filter for unread only
98
- }
99
-
100
- begin
101
- #Wait for and return count number of emails
102
- result = api_instance.wait_for_email_count(opts)
103
- p result
104
- rescue MailSlurpClient::ApiError => e
105
- puts "Exception when calling WaitForControllerApi->wait_for_email_count: #{e}"
106
- end
107
- ```
108
-
109
- ### Parameters
110
-
111
-
112
- Name | Type | Description | Notes
113
- ------------- | ------------- | ------------- | -------------
114
- **count** | **Integer**| Number of emails to wait for. Must be greater that 1 | [optional]
115
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional]
116
- **timeout** | **Integer**| Max milliseconds to wait | [optional]
117
- **unread_only** | **Boolean**| Optional filter for unread only | [optional] [default to false]
118
-
119
- ### Return type
120
-
121
- [**Array<EmailPreview>**](EmailPreview.md)
122
-
123
- ### Authorization
124
-
125
- [API_KEY](../README.md#API_KEY)
126
-
127
- ### HTTP request headers
128
-
129
- - **Content-Type**: Not defined
130
- - **Accept**: application/json
131
-
132
-
133
- ## wait_for_latest_email
134
-
135
- > Email wait_for_latest_email(opts)
136
-
137
- Fetch inbox's latest email or if empty wait for an email to arrive
138
-
139
- Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`.
140
-
141
- ### Example
142
-
143
- ```ruby
144
- # load the gem
145
- require 'mailslurp_client'
146
- # setup authorization
147
- MailSlurpClient.configure do |config|
148
- # Configure API key authorization: API_KEY
149
- config.api_key['x-api-key'] = 'YOUR API KEY'
150
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
151
- #config.api_key_prefix['x-api-key'] = 'Bearer'
152
- end
153
-
154
- api_instance = MailSlurpClient::WaitForControllerApi.new
155
- opts = {
156
- inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
157
- timeout: 56, # Integer | Max milliseconds to wait
158
- unread_only: false # Boolean | Optional filter for unread only.
159
- }
160
-
161
- begin
162
- #Fetch inbox's latest email or if empty wait for an email to arrive
163
- result = api_instance.wait_for_latest_email(opts)
164
- p result
165
- rescue MailSlurpClient::ApiError => e
166
- puts "Exception when calling WaitForControllerApi->wait_for_latest_email: #{e}"
167
- end
168
- ```
169
-
170
- ### Parameters
171
-
172
-
173
- Name | Type | Description | Notes
174
- ------------- | ------------- | ------------- | -------------
175
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional]
176
- **timeout** | **Integer**| Max milliseconds to wait | [optional]
177
- **unread_only** | **Boolean**| Optional filter for unread only. | [optional] [default to false]
178
-
179
- ### Return type
180
-
181
- [**Email**](Email.md)
182
-
183
- ### Authorization
184
-
185
- [API_KEY](../README.md#API_KEY)
186
-
187
- ### HTTP request headers
188
-
189
- - **Content-Type**: Not defined
190
- - **Accept**: application/json
191
-
192
-
193
- ## wait_for_matching_email
194
-
195
- > Array<EmailPreview> wait_for_matching_email(match_options, opts)
196
-
197
- Wait or return list of emails that match simple matching patterns
198
-
199
- Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options.
200
-
201
- ### Example
202
-
203
- ```ruby
204
- # load the gem
205
- require 'mailslurp_client'
206
- # setup authorization
207
- MailSlurpClient.configure do |config|
208
- # Configure API key authorization: API_KEY
209
- config.api_key['x-api-key'] = 'YOUR API KEY'
210
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
211
- #config.api_key_prefix['x-api-key'] = 'Bearer'
212
- end
213
-
214
- api_instance = MailSlurpClient::WaitForControllerApi.new
215
- match_options = MailSlurpClient::MatchOptions.new # MatchOptions | matchOptions
216
- opts = {
217
- count: 56, # Integer | Number of emails to wait for. Must be greater that 1
218
- inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
219
- timeout: 56, # Integer | Max milliseconds to wait
220
- unread_only: false # Boolean | Optional filter for unread only
221
- }
222
-
223
- begin
224
- #Wait or return list of emails that match simple matching patterns
225
- result = api_instance.wait_for_matching_email(match_options, opts)
226
- p result
227
- rescue MailSlurpClient::ApiError => e
228
- puts "Exception when calling WaitForControllerApi->wait_for_matching_email: #{e}"
229
- end
230
- ```
231
-
232
- ### Parameters
233
-
234
-
235
- Name | Type | Description | Notes
236
- ------------- | ------------- | ------------- | -------------
237
- **match_options** | [**MatchOptions**](MatchOptions.md)| matchOptions |
238
- **count** | **Integer**| Number of emails to wait for. Must be greater that 1 | [optional]
239
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional]
240
- **timeout** | **Integer**| Max milliseconds to wait | [optional]
241
- **unread_only** | **Boolean**| Optional filter for unread only | [optional] [default to false]
242
-
243
- ### Return type
244
-
245
- [**Array<EmailPreview>**](EmailPreview.md)
246
-
247
- ### Authorization
248
-
249
- [API_KEY](../README.md#API_KEY)
250
-
251
- ### HTTP request headers
252
-
253
- - **Content-Type**: application/json
254
- - **Accept**: application/json
255
-
256
-
257
- ## wait_for_nth_email
258
-
259
- > Email wait_for_nth_email(opts)
260
-
261
- Wait for or fetch the email with a given index in the inbox specified
262
-
263
- If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
264
-
265
- ### Example
266
-
267
- ```ruby
268
- # load the gem
269
- require 'mailslurp_client'
270
- # setup authorization
271
- MailSlurpClient.configure do |config|
272
- # Configure API key authorization: API_KEY
273
- config.api_key['x-api-key'] = 'YOUR API KEY'
274
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
275
- #config.api_key_prefix['x-api-key'] = 'Bearer'
276
- end
277
-
278
- api_instance = MailSlurpClient::WaitForControllerApi.new
279
- opts = {
280
- inbox_id: 'inbox_id_example', # String | Id of the inbox you are fetching emails from
281
- index: 56, # Integer | Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1
282
- timeout: 56, # Integer | Max milliseconds to wait for the nth email if not already present
283
- unread_only: false # Boolean | Optional filter for unread only
284
- }
285
-
286
- begin
287
- #Wait for or fetch the email with a given index in the inbox specified
288
- result = api_instance.wait_for_nth_email(opts)
289
- p result
290
- rescue MailSlurpClient::ApiError => e
291
- puts "Exception when calling WaitForControllerApi->wait_for_nth_email: #{e}"
292
- end
293
- ```
294
-
295
- ### Parameters
296
-
297
-
298
- Name | Type | Description | Notes
299
- ------------- | ------------- | ------------- | -------------
300
- **inbox_id** | [**String**](.md)| Id of the inbox you are fetching emails from | [optional]
301
- **index** | **Integer**| Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 | [optional]
302
- **timeout** | **Integer**| Max milliseconds to wait for the nth email if not already present | [optional]
303
- **unread_only** | **Boolean**| Optional filter for unread only | [optional] [default to false]
304
-
305
- ### Return type
306
-
307
- [**Email**](Email.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
-