mailslurp_client 7.0.7 → 8.0.1

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