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,339 +0,0 @@
1
- # MailSlurpClient::WebhookControllerApi
2
-
3
- All URIs are relative to *https://api.mailslurp.com*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_webhook**](WebhookControllerApi.md#create_webhook) | **POST** /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox
8
- [**delete_webhook**](WebhookControllerApi.md#delete_webhook) | **DELETE** /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a Webhook for an Inbox
9
- [**get_all_webhooks**](WebhookControllerApi.md#get_all_webhooks) | **GET** /webhooks/paginated | List Webhooks Paginated
10
- [**get_webhook**](WebhookControllerApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook for an Inbox
11
- [**get_webhooks**](WebhookControllerApi.md#get_webhooks) | **GET** /inboxes/{inboxId}/webhooks | Get all Webhooks for an Inbox
12
- [**send_test_data**](WebhookControllerApi.md#send_test_data) | **POST** /webhooks/{webhookId}/test | Send webhook test data
13
-
14
-
15
-
16
- ## create_webhook
17
-
18
- > WebhookDto create_webhook(inbox_id, webhook_options)
19
-
20
- Attach a WebHook URL to an inbox
21
-
22
- Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
23
-
24
- ### Example
25
-
26
- ```ruby
27
- # load the gem
28
- require 'mailslurp_client'
29
- # setup authorization
30
- MailSlurpClient.configure do |config|
31
- # Configure API key authorization: API_KEY
32
- config.api_key['x-api-key'] = 'YOUR API KEY'
33
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
34
- #config.api_key_prefix['x-api-key'] = 'Bearer'
35
- end
36
-
37
- api_instance = MailSlurpClient::WebhookControllerApi.new
38
- inbox_id = 'inbox_id_example' # String | inboxId
39
- webhook_options = MailSlurpClient::CreateWebhookOptions.new # CreateWebhookOptions | webhookOptions
40
-
41
- begin
42
- #Attach a WebHook URL to an inbox
43
- result = api_instance.create_webhook(inbox_id, webhook_options)
44
- p result
45
- rescue MailSlurpClient::ApiError => e
46
- puts "Exception when calling WebhookControllerApi->create_webhook: #{e}"
47
- end
48
- ```
49
-
50
- ### Parameters
51
-
52
-
53
- Name | Type | Description | Notes
54
- ------------- | ------------- | ------------- | -------------
55
- **inbox_id** | [**String**](.md)| inboxId |
56
- **webhook_options** | [**CreateWebhookOptions**](CreateWebhookOptions.md)| webhookOptions |
57
-
58
- ### Return type
59
-
60
- [**WebhookDto**](WebhookDto.md)
61
-
62
- ### Authorization
63
-
64
- [API_KEY](../README.md#API_KEY)
65
-
66
- ### HTTP request headers
67
-
68
- - **Content-Type**: application/json
69
- - **Accept**: application/json
70
-
71
-
72
- ## delete_webhook
73
-
74
- > delete_webhook(inbox_id, webhook_id)
75
-
76
- Delete and disable a Webhook for an Inbox
77
-
78
- ### Example
79
-
80
- ```ruby
81
- # load the gem
82
- require 'mailslurp_client'
83
- # setup authorization
84
- MailSlurpClient.configure do |config|
85
- # Configure API key authorization: API_KEY
86
- config.api_key['x-api-key'] = 'YOUR API KEY'
87
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
88
- #config.api_key_prefix['x-api-key'] = 'Bearer'
89
- end
90
-
91
- api_instance = MailSlurpClient::WebhookControllerApi.new
92
- inbox_id = 'inbox_id_example' # String | inboxId
93
- webhook_id = 'webhook_id_example' # String | webhookId
94
-
95
- begin
96
- #Delete and disable a Webhook for an Inbox
97
- api_instance.delete_webhook(inbox_id, webhook_id)
98
- rescue MailSlurpClient::ApiError => e
99
- puts "Exception when calling WebhookControllerApi->delete_webhook: #{e}"
100
- end
101
- ```
102
-
103
- ### Parameters
104
-
105
-
106
- Name | Type | Description | Notes
107
- ------------- | ------------- | ------------- | -------------
108
- **inbox_id** | [**String**](.md)| inboxId |
109
- **webhook_id** | [**String**](.md)| webhookId |
110
-
111
- ### Return type
112
-
113
- nil (empty response body)
114
-
115
- ### Authorization
116
-
117
- [API_KEY](../README.md#API_KEY)
118
-
119
- ### HTTP request headers
120
-
121
- - **Content-Type**: Not defined
122
- - **Accept**: Not defined
123
-
124
-
125
- ## get_all_webhooks
126
-
127
- > PageWebhookProjection get_all_webhooks(opts)
128
-
129
- List Webhooks Paginated
130
-
131
- List webhooks in paginated form. Allows for page index, page size, and sort direction.
132
-
133
- ### Example
134
-
135
- ```ruby
136
- # load the gem
137
- require 'mailslurp_client'
138
- # setup authorization
139
- MailSlurpClient.configure do |config|
140
- # Configure API key authorization: API_KEY
141
- config.api_key['x-api-key'] = 'YOUR API KEY'
142
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
143
- #config.api_key_prefix['x-api-key'] = 'Bearer'
144
- end
145
-
146
- api_instance = MailSlurpClient::WebhookControllerApi.new
147
- opts = {
148
- page: 0, # Integer | Optional page index in inbox list pagination
149
- size: 20, # Integer | Optional page size in inbox list pagination
150
- sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
151
- }
152
-
153
- begin
154
- #List Webhooks Paginated
155
- result = api_instance.get_all_webhooks(opts)
156
- p result
157
- rescue MailSlurpClient::ApiError => e
158
- puts "Exception when calling WebhookControllerApi->get_all_webhooks: #{e}"
159
- end
160
- ```
161
-
162
- ### Parameters
163
-
164
-
165
- Name | Type | Description | Notes
166
- ------------- | ------------- | ------------- | -------------
167
- **page** | **Integer**| Optional page index in inbox list pagination | [optional] [default to 0]
168
- **size** | **Integer**| Optional page size in inbox list pagination | [optional] [default to 20]
169
- **sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC']
170
-
171
- ### Return type
172
-
173
- [**PageWebhookProjection**](PageWebhookProjection.md)
174
-
175
- ### Authorization
176
-
177
- [API_KEY](../README.md#API_KEY)
178
-
179
- ### HTTP request headers
180
-
181
- - **Content-Type**: Not defined
182
- - **Accept**: application/json
183
-
184
-
185
- ## get_webhook
186
-
187
- > WebhookDto get_webhook(webhook_id)
188
-
189
- Get a webhook for an Inbox
190
-
191
- ### Example
192
-
193
- ```ruby
194
- # load the gem
195
- require 'mailslurp_client'
196
- # setup authorization
197
- MailSlurpClient.configure do |config|
198
- # Configure API key authorization: API_KEY
199
- config.api_key['x-api-key'] = 'YOUR API KEY'
200
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
201
- #config.api_key_prefix['x-api-key'] = 'Bearer'
202
- end
203
-
204
- api_instance = MailSlurpClient::WebhookControllerApi.new
205
- webhook_id = 'webhook_id_example' # String | webhookId
206
-
207
- begin
208
- #Get a webhook for an Inbox
209
- result = api_instance.get_webhook(webhook_id)
210
- p result
211
- rescue MailSlurpClient::ApiError => e
212
- puts "Exception when calling WebhookControllerApi->get_webhook: #{e}"
213
- end
214
- ```
215
-
216
- ### Parameters
217
-
218
-
219
- Name | Type | Description | Notes
220
- ------------- | ------------- | ------------- | -------------
221
- **webhook_id** | [**String**](.md)| webhookId |
222
-
223
- ### Return type
224
-
225
- [**WebhookDto**](WebhookDto.md)
226
-
227
- ### Authorization
228
-
229
- [API_KEY](../README.md#API_KEY)
230
-
231
- ### HTTP request headers
232
-
233
- - **Content-Type**: Not defined
234
- - **Accept**: application/json
235
-
236
-
237
- ## get_webhooks
238
-
239
- > Array<WebhookDto> get_webhooks(inbox_id)
240
-
241
- Get all Webhooks for an Inbox
242
-
243
- ### Example
244
-
245
- ```ruby
246
- # load the gem
247
- require 'mailslurp_client'
248
- # setup authorization
249
- MailSlurpClient.configure do |config|
250
- # Configure API key authorization: API_KEY
251
- config.api_key['x-api-key'] = 'YOUR API KEY'
252
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
253
- #config.api_key_prefix['x-api-key'] = 'Bearer'
254
- end
255
-
256
- api_instance = MailSlurpClient::WebhookControllerApi.new
257
- inbox_id = 'inbox_id_example' # String | inboxId
258
-
259
- begin
260
- #Get all Webhooks for an Inbox
261
- result = api_instance.get_webhooks(inbox_id)
262
- p result
263
- rescue MailSlurpClient::ApiError => e
264
- puts "Exception when calling WebhookControllerApi->get_webhooks: #{e}"
265
- end
266
- ```
267
-
268
- ### Parameters
269
-
270
-
271
- Name | Type | Description | Notes
272
- ------------- | ------------- | ------------- | -------------
273
- **inbox_id** | [**String**](.md)| inboxId |
274
-
275
- ### Return type
276
-
277
- [**Array<WebhookDto>**](WebhookDto.md)
278
-
279
- ### Authorization
280
-
281
- [API_KEY](../README.md#API_KEY)
282
-
283
- ### HTTP request headers
284
-
285
- - **Content-Type**: Not defined
286
- - **Accept**: application/json
287
-
288
-
289
- ## send_test_data
290
-
291
- > WebhookTestResult send_test_data(webhook_id)
292
-
293
- Send webhook test data
294
-
295
- ### Example
296
-
297
- ```ruby
298
- # load the gem
299
- require 'mailslurp_client'
300
- # setup authorization
301
- MailSlurpClient.configure do |config|
302
- # Configure API key authorization: API_KEY
303
- config.api_key['x-api-key'] = 'YOUR API KEY'
304
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
305
- #config.api_key_prefix['x-api-key'] = 'Bearer'
306
- end
307
-
308
- api_instance = MailSlurpClient::WebhookControllerApi.new
309
- webhook_id = 'webhook_id_example' # String | webhookId
310
-
311
- begin
312
- #Send webhook test data
313
- result = api_instance.send_test_data(webhook_id)
314
- p result
315
- rescue MailSlurpClient::ApiError => e
316
- puts "Exception when calling WebhookControllerApi->send_test_data: #{e}"
317
- end
318
- ```
319
-
320
- ### Parameters
321
-
322
-
323
- Name | Type | Description | Notes
324
- ------------- | ------------- | ------------- | -------------
325
- **webhook_id** | [**String**](.md)| webhookId |
326
-
327
- ### Return type
328
-
329
- [**WebhookTestResult**](WebhookTestResult.md)
330
-
331
- ### Authorization
332
-
333
- [API_KEY](../README.md#API_KEY)
334
-
335
- ### HTTP request headers
336
-
337
- - **Content-Type**: Not defined
338
- - **Accept**: application/json
339
-
@@ -1,33 +0,0 @@
1
- # MailSlurpClient::WebhookDto
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **basic_auth** | **Boolean** | Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself. | [optional]
8
- **created_at** | **DateTime** | When the webhook was created | [optional]
9
- **id** | **String** | ID of the Webhook | [optional]
10
- **inbox_id** | **String** | The inbox that the Webhook will be triggered by | [optional]
11
- **method** | **String** | HTTP method that your server endpoint must listen for | [optional]
12
- **name** | **String** | Name of the webhook | [optional]
13
- **payload_json_schema** | **String** | JSON Schema for the payload that will be sent to your URL via the HTTP method described. | [optional]
14
- **updated_at** | **DateTime** | |
15
- **url** | **String** | URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema. | [optional]
16
-
17
- ## Code Sample
18
-
19
- ```ruby
20
- require 'MailSlurpClient'
21
-
22
- instance = MailSlurpClient::WebhookDto.new(basic_auth: null,
23
- created_at: null,
24
- id: null,
25
- inbox_id: null,
26
- method: null,
27
- name: null,
28
- payload_json_schema: null,
29
- updated_at: null,
30
- url: null)
31
- ```
32
-
33
-
@@ -1,27 +0,0 @@
1
- # MailSlurpClient::WebhookProjection
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **created_at** | **DateTime** | |
8
- **id** | **String** | |
9
- **inbox_id** | **String** | |
10
- **name** | **String** | | [optional]
11
- **updated_at** | **DateTime** | |
12
- **url** | **String** | |
13
-
14
- ## Code Sample
15
-
16
- ```ruby
17
- require 'MailSlurpClient'
18
-
19
- instance = MailSlurpClient::WebhookProjection.new(created_at: null,
20
- id: null,
21
- inbox_id: null,
22
- name: null,
23
- updated_at: null,
24
- url: null)
25
- ```
26
-
27
-
@@ -1,23 +0,0 @@
1
- # MailSlurpClient::WebhookTestRequest
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **headers** | **Hash<String, String>** | |
8
- **method** | **String** | |
9
- **payload** | **String** | | [optional]
10
- **url** | **String** | |
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'MailSlurpClient'
16
-
17
- instance = MailSlurpClient::WebhookTestRequest.new(headers: null,
18
- method: null,
19
- payload: null,
20
- url: null)
21
- ```
22
-
23
-
@@ -1,19 +0,0 @@
1
- # MailSlurpClient::WebhookTestResponse
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **message** | **String** | | [optional]
8
- **status_code** | **Integer** | | [optional]
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'MailSlurpClient'
14
-
15
- instance = MailSlurpClient::WebhookTestResponse.new(message: null,
16
- status_code: null)
17
- ```
18
-
19
-
@@ -1,21 +0,0 @@
1
- # MailSlurpClient::WebhookTestResult
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **message** | **String** | | [optional]
8
- **request** | [**WebhookTestRequest**](WebhookTestRequest.md) | |
9
- **response** | [**WebhookTestResponse**](WebhookTestResponse.md) | |
10
-
11
- ## Code Sample
12
-
13
- ```ruby
14
- require 'MailSlurpClient'
15
-
16
- instance = MailSlurpClient::WebhookTestResult.new(message: null,
17
- request: null,
18
- response: null)
19
- ```
20
-
21
-