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,126 +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
- x_filename: 'x_filename_example' # String | x-filename
93
- }
94
-
95
- begin
96
- #Upload an attachment for sending using Multipart Form
97
- result = api_instance.upload_multipart_form(file, opts)
98
- p result
99
- rescue MailSlurpClient::ApiError => e
100
- puts "Exception when calling AttachmentControllerApi->upload_multipart_form: #{e}"
101
- end
102
- ```
103
-
104
- ### Parameters
105
-
106
-
107
- Name | Type | Description | Notes
108
- ------------- | ------------- | ------------- | -------------
109
- **file** | **File**| file |
110
- **content_type** | **String**| contentType | [optional]
111
- **filename** | **String**| filename | [optional]
112
- **x_filename** | **String**| x-filename | [optional]
113
-
114
- ### Return type
115
-
116
- **Array<String>**
117
-
118
- ### Authorization
119
-
120
- [API_KEY](../README.md#API_KEY)
121
-
122
- ### HTTP request headers
123
-
124
- - **Content-Type**: multipart/form-data
125
- - **Accept**: application/json
126
-
@@ -1,23 +0,0 @@
1
- # MailSlurpClient::AttachmentMetaData
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **content_length** | **Integer** | Size of attachment in bytes | [optional]
8
- **content_type** | **String** | Content type of attachment | [optional]
9
- **id** | **String** | ID of attachment | [optional]
10
- **name** | **String** | Name of attachment | [optional]
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
-
@@ -1,19 +0,0 @@
1
- # MailSlurpClient::BulkSendEmailOptions
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **inbox_ids** | **Array&lt;String&gt;** | Inboxes to send the email from | [optional]
8
- **send_email_options** | [**SendEmailOptions**](SendEmailOptions.md) | | [optional]
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'MailSlurpClient'
14
-
15
- instance = MailSlurpClient::BulkSendEmailOptions.new(inbox_ids: null,
16
- send_email_options: null)
17
- ```
18
-
19
-
@@ -1,218 +0,0 @@
1
- # MailSlurpClient::CommonActionsControllerApi
2
-
3
- All URIs are relative to *https://api.mailslurp.com*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_new_email_address**](CommonActionsControllerApi.md#create_new_email_address) | **POST** /createInbox | Create new random inbox
8
- [**create_new_email_address1**](CommonActionsControllerApi.md#create_new_email_address1) | **POST** /newEmailAddress | Create new random inbox
9
- [**empty_inbox**](CommonActionsControllerApi.md#empty_inbox) | **DELETE** /emptyInbox | Delete all emails in an inbox
10
- [**send_email_simple**](CommonActionsControllerApi.md#send_email_simple) | **POST** /sendEmail | Send an email
11
-
12
-
13
-
14
- ## create_new_email_address
15
-
16
- > Inbox create_new_email_address
17
-
18
- Create new random inbox
19
-
20
- Returns an Inbox with an `id` and an `emailAddress`
21
-
22
- ### Example
23
-
24
- ```ruby
25
- # load the gem
26
- require 'mailslurp_client'
27
- # setup authorization
28
- MailSlurpClient.configure do |config|
29
- # Configure API key authorization: API_KEY
30
- config.api_key['x-api-key'] = 'YOUR API KEY'
31
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
- #config.api_key_prefix['x-api-key'] = 'Bearer'
33
- end
34
-
35
- api_instance = MailSlurpClient::CommonActionsControllerApi.new
36
-
37
- begin
38
- #Create new random inbox
39
- result = api_instance.create_new_email_address
40
- p result
41
- rescue MailSlurpClient::ApiError => e
42
- puts "Exception when calling CommonActionsControllerApi->create_new_email_address: #{e}"
43
- end
44
- ```
45
-
46
- ### Parameters
47
-
48
- This endpoint does not need any parameter.
49
-
50
- ### Return type
51
-
52
- [**Inbox**](Inbox.md)
53
-
54
- ### Authorization
55
-
56
- [API_KEY](../README.md#API_KEY)
57
-
58
- ### HTTP request headers
59
-
60
- - **Content-Type**: Not defined
61
- - **Accept**: application/json
62
-
63
-
64
- ## create_new_email_address1
65
-
66
- > Inbox create_new_email_address1
67
-
68
- Create new random inbox
69
-
70
- Returns an Inbox with an `id` and an `emailAddress`
71
-
72
- ### Example
73
-
74
- ```ruby
75
- # load the gem
76
- require 'mailslurp_client'
77
- # setup authorization
78
- MailSlurpClient.configure do |config|
79
- # Configure API key authorization: API_KEY
80
- config.api_key['x-api-key'] = 'YOUR API KEY'
81
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
82
- #config.api_key_prefix['x-api-key'] = 'Bearer'
83
- end
84
-
85
- api_instance = MailSlurpClient::CommonActionsControllerApi.new
86
-
87
- begin
88
- #Create new random inbox
89
- result = api_instance.create_new_email_address1
90
- p result
91
- rescue MailSlurpClient::ApiError => e
92
- puts "Exception when calling CommonActionsControllerApi->create_new_email_address1: #{e}"
93
- end
94
- ```
95
-
96
- ### Parameters
97
-
98
- This endpoint does not need any parameter.
99
-
100
- ### Return type
101
-
102
- [**Inbox**](Inbox.md)
103
-
104
- ### Authorization
105
-
106
- [API_KEY](../README.md#API_KEY)
107
-
108
- ### HTTP request headers
109
-
110
- - **Content-Type**: Not defined
111
- - **Accept**: application/json
112
-
113
-
114
- ## empty_inbox
115
-
116
- > empty_inbox(inbox_id)
117
-
118
- Delete all emails in an inbox
119
-
120
- Deletes all 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::CommonActionsControllerApi.new
136
- inbox_id = 'inbox_id_example' # String | inboxId
137
-
138
- begin
139
- #Delete all emails in an inbox
140
- api_instance.empty_inbox(inbox_id)
141
- rescue MailSlurpClient::ApiError => e
142
- puts "Exception when calling CommonActionsControllerApi->empty_inbox: #{e}"
143
- end
144
- ```
145
-
146
- ### Parameters
147
-
148
-
149
- Name | Type | Description | Notes
150
- ------------- | ------------- | ------------- | -------------
151
- **inbox_id** | [**String**](.md)| inboxId |
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**: Not defined
164
- - **Accept**: Not defined
165
-
166
-
167
- ## send_email_simple
168
-
169
- > send_email_simple(email_options)
170
-
171
- Send an email
172
-
173
- If no senderId or inboxId provided a random email address will be used to send from.
174
-
175
- ### Example
176
-
177
- ```ruby
178
- # load the gem
179
- require 'mailslurp_client'
180
- # setup authorization
181
- MailSlurpClient.configure do |config|
182
- # Configure API key authorization: API_KEY
183
- config.api_key['x-api-key'] = 'YOUR API KEY'
184
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
185
- #config.api_key_prefix['x-api-key'] = 'Bearer'
186
- end
187
-
188
- api_instance = MailSlurpClient::CommonActionsControllerApi.new
189
- email_options = MailSlurpClient::SimpleSendEmailOptions.new # SimpleSendEmailOptions | emailOptions
190
-
191
- begin
192
- #Send an email
193
- api_instance.send_email_simple(email_options)
194
- rescue MailSlurpClient::ApiError => e
195
- puts "Exception when calling CommonActionsControllerApi->send_email_simple: #{e}"
196
- end
197
- ```
198
-
199
- ### Parameters
200
-
201
-
202
- Name | Type | Description | Notes
203
- ------------- | ------------- | ------------- | -------------
204
- **email_options** | [**SimpleSendEmailOptions**](SimpleSendEmailOptions.md)| emailOptions |
205
-
206
- ### Return type
207
-
208
- nil (empty response body)
209
-
210
- ### Authorization
211
-
212
- [API_KEY](../README.md#API_KEY)
213
-
214
- ### HTTP request headers
215
-
216
- - **Content-Type**: application/json
217
- - **Accept**: Not defined
218
-