mailslurp_client 15.16.22 → 15.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client/api/common_actions_controller_api.rb +12 -0
  3. data/lib/mailslurp_client/api/inbox_controller_api.rb +9 -0
  4. data/lib/mailslurp_client/api/inbox_replier_controller_api.rb +488 -0
  5. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +2 -2
  6. data/lib/mailslurp_client/models/alias_projection.rb +15 -15
  7. data/lib/mailslurp_client/models/attachment_projection.rb +15 -15
  8. data/lib/mailslurp_client/models/contact_projection.rb +11 -1
  9. data/lib/mailslurp_client/models/create_alias_options.rb +1 -1
  10. data/lib/mailslurp_client/models/create_inbox_dto.rb +24 -2
  11. data/lib/mailslurp_client/models/create_inbox_replier_options.rb +388 -0
  12. data/lib/mailslurp_client/models/create_webhook_options.rb +16 -5
  13. data/lib/mailslurp_client/models/email_projection.rb +10 -10
  14. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +10 -1
  15. data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +11 -11
  16. data/lib/mailslurp_client/models/inbox_replier_dto.rb +395 -0
  17. data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +316 -0
  18. data/lib/mailslurp_client/models/page_alias.rb +19 -19
  19. data/lib/mailslurp_client/models/page_attachment_entity.rb +19 -19
  20. data/lib/mailslurp_client/models/page_bounced_email.rb +19 -19
  21. data/lib/mailslurp_client/models/page_bounced_recipients.rb +19 -19
  22. data/lib/mailslurp_client/models/page_complaint.rb +19 -19
  23. data/lib/mailslurp_client/models/page_contact_projection.rb +19 -19
  24. data/lib/mailslurp_client/models/page_delivery_status.rb +19 -19
  25. data/lib/mailslurp_client/models/page_email_preview.rb +19 -19
  26. data/lib/mailslurp_client/models/page_email_projection.rb +19 -19
  27. data/lib/mailslurp_client/models/page_email_validation_request.rb +19 -19
  28. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +19 -19
  29. data/lib/mailslurp_client/models/page_group_projection.rb +19 -19
  30. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +19 -19
  31. data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +19 -19
  32. data/lib/mailslurp_client/models/page_inbox_projection.rb +19 -19
  33. data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +308 -0
  34. data/lib/mailslurp_client/models/page_inbox_replier_events.rb +308 -0
  35. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +19 -19
  36. data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +19 -19
  37. data/lib/mailslurp_client/models/page_missed_email_projection.rb +19 -19
  38. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +19 -19
  39. data/lib/mailslurp_client/models/page_phone_number_projection.rb +19 -19
  40. data/lib/mailslurp_client/models/page_scheduled_jobs.rb +19 -19
  41. data/lib/mailslurp_client/models/page_sms_projection.rb +19 -19
  42. data/lib/mailslurp_client/models/page_template_projection.rb +19 -19
  43. data/lib/mailslurp_client/models/page_thread_projection.rb +19 -19
  44. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +19 -19
  45. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +19 -19
  46. data/lib/mailslurp_client/models/page_webhook_projection.rb +19 -19
  47. data/lib/mailslurp_client/models/page_webhook_result.rb +19 -19
  48. data/lib/mailslurp_client/models/phone_number_projection.rb +19 -19
  49. data/lib/mailslurp_client/models/sent_email_projection.rb +30 -30
  50. data/lib/mailslurp_client/models/thread_projection.rb +16 -16
  51. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +10 -10
  52. data/lib/mailslurp_client/models/update_inbox_replier_options.rb +379 -0
  53. data/lib/mailslurp_client/models/webhook_dto.rb +15 -4
  54. data/lib/mailslurp_client/version.rb +1 -1
  55. data/lib/mailslurp_client.rb +7 -0
  56. metadata +9 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3059158f992d5b4169e5a148fad84d48d3a0b25f304204663c6a5fed35890546
4
- data.tar.gz: d4c2d77e0afd394b01fecf8c8e19aaec037f0a6cd26282ec2091be6298681d04
3
+ metadata.gz: 689a4b6259b23936d710609495553961a7575f8ff937b4479e5b8558ad938e7e
4
+ data.tar.gz: c0085338d5181e0f5cac26b9dbdd740ee224238e95314eb05ac0f3eec37d019f
5
5
  SHA512:
6
- metadata.gz: 24d8b0b9bc24797e178b18e425fac1c1b515a02221e96ef96b726bebdb61b55318c7bc6d7b5db31e0bce1e5454ba6f8b90ac4ebe8845a9b82eb8f26dd4842d5a
7
- data.tar.gz: 76a4175a1892148d012e3a6db7d98c4a74427e015367149ebf8585f976985ceb08dc3abd8668255dd447eafc02da4ce096db7bcfcd965fd806ee129ad1aa19c5
6
+ metadata.gz: d51df1c80f7c09a98cbece13f04586acabe94ab362d827afc202d3730c897110c009e153f880e8068c006687375cbd91ba60427ce270444adde2b751f90b2942
7
+ data.tar.gz: 319f31dfe478092592c37399b966d02b4026c2679bb82847a2190dbf09e72d34ac7bd263823af8f0af566385c1f6d35f3a464ba98780d8ebdc5a4510c859aca4
@@ -34,6 +34,8 @@ module MailSlurpClient
34
34
  # @option opts [Boolean] :favourite
35
35
  # @option opts [Boolean] :virtual_inbox
36
36
  # @option opts [Boolean] :use_short_address
37
+ # @option opts [String] :domain_name
38
+ # @option opts [String] :domain_id
37
39
  # @return [InboxDto]
38
40
  def create_new_email_address(opts = {})
39
41
  data, _status_code, _headers = create_new_email_address_with_http_info(opts)
@@ -55,6 +57,8 @@ module MailSlurpClient
55
57
  # @option opts [Boolean] :favourite
56
58
  # @option opts [Boolean] :virtual_inbox
57
59
  # @option opts [Boolean] :use_short_address
60
+ # @option opts [String] :domain_name
61
+ # @option opts [String] :domain_id
58
62
  # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
59
63
  def create_new_email_address_with_http_info(opts = {})
60
64
  if @api_client.config.debugging
@@ -81,6 +85,8 @@ module MailSlurpClient
81
85
  query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
82
86
  query_params[:'virtualInbox'] = opts[:'virtual_inbox'] if !opts[:'virtual_inbox'].nil?
83
87
  query_params[:'useShortAddress'] = opts[:'use_short_address'] if !opts[:'use_short_address'].nil?
88
+ query_params[:'domainName'] = opts[:'domain_name'] if !opts[:'domain_name'].nil?
89
+ query_params[:'domainId'] = opts[:'domain_id'] if !opts[:'domain_id'].nil?
84
90
 
85
91
  # header parameters
86
92
  header_params = opts[:header_params] || {}
@@ -130,6 +136,8 @@ module MailSlurpClient
130
136
  # @option opts [Boolean] :favourite
131
137
  # @option opts [Boolean] :virtual_inbox
132
138
  # @option opts [Boolean] :use_short_address
139
+ # @option opts [String] :domain_name
140
+ # @option opts [String] :domain_id
133
141
  # @return [InboxDto]
134
142
  def create_random_inbox(opts = {})
135
143
  data, _status_code, _headers = create_random_inbox_with_http_info(opts)
@@ -151,6 +159,8 @@ module MailSlurpClient
151
159
  # @option opts [Boolean] :favourite
152
160
  # @option opts [Boolean] :virtual_inbox
153
161
  # @option opts [Boolean] :use_short_address
162
+ # @option opts [String] :domain_name
163
+ # @option opts [String] :domain_id
154
164
  # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
155
165
  def create_random_inbox_with_http_info(opts = {})
156
166
  if @api_client.config.debugging
@@ -177,6 +187,8 @@ module MailSlurpClient
177
187
  query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
178
188
  query_params[:'virtualInbox'] = opts[:'virtual_inbox'] if !opts[:'virtual_inbox'].nil?
179
189
  query_params[:'useShortAddress'] = opts[:'use_short_address'] if !opts[:'use_short_address'].nil?
190
+ query_params[:'domainName'] = opts[:'domain_name'] if !opts[:'domain_name'].nil?
191
+ query_params[:'domainId'] = opts[:'domain_id'] if !opts[:'domain_id'].nil?
180
192
 
181
193
  # header parameters
182
194
  header_params = opts[:header_params] || {}
@@ -96,6 +96,8 @@ module MailSlurpClient
96
96
  # @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at &#x60;mx.mailslurp.com&#x60;.
97
97
  # @option opts [Boolean] :virtual_inbox Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.
98
98
  # @option opts [Boolean] :use_short_address Use a shorter email address under 31 characters
99
+ # @option opts [String] :domain_id ID of custom domain to use for email address.
100
+ # @option opts [String] :domain_name FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the &#x60;emailAddress&#x60; option instead to specify the full custom inbox.
99
101
  # @return [InboxDto]
100
102
  def create_inbox(opts = {})
101
103
  data, _status_code, _headers = create_inbox_with_http_info(opts)
@@ -117,6 +119,8 @@ module MailSlurpClient
117
119
  # @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at &#x60;mx.mailslurp.com&#x60;.
118
120
  # @option opts [Boolean] :virtual_inbox Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.
119
121
  # @option opts [Boolean] :use_short_address Use a shorter email address under 31 characters
122
+ # @option opts [String] :domain_id ID of custom domain to use for email address.
123
+ # @option opts [String] :domain_name FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the &#x60;emailAddress&#x60; option instead to specify the full custom inbox.
120
124
  # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
121
125
  def create_inbox_with_http_info(opts = {})
122
126
  if @api_client.config.debugging
@@ -143,6 +147,8 @@ module MailSlurpClient
143
147
  query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil?
144
148
  query_params[:'virtualInbox'] = opts[:'virtual_inbox'] if !opts[:'virtual_inbox'].nil?
145
149
  query_params[:'useShortAddress'] = opts[:'use_short_address'] if !opts[:'use_short_address'].nil?
150
+ query_params[:'domainId'] = opts[:'domain_id'] if !opts[:'domain_id'].nil?
151
+ query_params[:'domainName'] = opts[:'domain_name'] if !opts[:'domain_name'].nil?
146
152
 
147
153
  # header parameters
148
154
  header_params = opts[:header_params] || {}
@@ -1658,6 +1664,7 @@ module MailSlurpClient
1658
1664
  # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
1659
1665
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1660
1666
  # @option opts [DateTime] :since Optional filter by created after given date time
1667
+ # @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
1661
1668
  # @option opts [DateTime] :before Optional filter by created before given date time
1662
1669
  # @return [Array<InboxDto>]
1663
1670
  def get_inboxes(opts = {})
@@ -1671,6 +1678,7 @@ module MailSlurpClient
1671
1678
  # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
1672
1679
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1673
1680
  # @option opts [DateTime] :since Optional filter by created after given date time
1681
+ # @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
1674
1682
  # @option opts [DateTime] :before Optional filter by created before given date time
1675
1683
  # @return [Array<(Array<InboxDto>, Integer, Hash)>] Array<InboxDto> data, response status code and response headers
1676
1684
  def get_inboxes_with_http_info(opts = {})
@@ -1693,6 +1701,7 @@ module MailSlurpClient
1693
1701
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1694
1702
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1695
1703
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1704
+ query_params[:'excludeCatchAllInboxes'] = opts[:'exclude_catch_all_inboxes'] if !opts[:'exclude_catch_all_inboxes'].nil?
1696
1705
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1697
1706
 
1698
1707
  # header parameters
@@ -0,0 +1,488 @@
1
+ =begin
2
+ #MailSlurp API
3
+
4
+ #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. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
5
+
6
+ The version of the OpenAPI document: 6.5.2
7
+ Contact: contact@mailslurp.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MailSlurpClient
16
+ class InboxReplierControllerApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create an inbox replier
23
+ # Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving
24
+ # @param create_inbox_replier_options [CreateInboxReplierOptions]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [InboxReplierDto]
27
+ def create_new_inbox_replier(create_inbox_replier_options, opts = {})
28
+ data, _status_code, _headers = create_new_inbox_replier_with_http_info(create_inbox_replier_options, opts)
29
+ data
30
+ end
31
+
32
+ # Create an inbox replier
33
+ # Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving
34
+ # @param create_inbox_replier_options [CreateInboxReplierOptions]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(InboxReplierDto, Integer, Hash)>] InboxReplierDto data, response status code and response headers
37
+ def create_new_inbox_replier_with_http_info(create_inbox_replier_options, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.create_new_inbox_replier ...'
40
+ end
41
+ # verify the required parameter 'create_inbox_replier_options' is set
42
+ if @api_client.config.client_side_validation && create_inbox_replier_options.nil?
43
+ fail ArgumentError, "Missing the required parameter 'create_inbox_replier_options' when calling InboxReplierControllerApi.create_new_inbox_replier"
44
+ end
45
+ # resource path
46
+ local_var_path = '/repliers'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
57
+
58
+ # form parameters
59
+ form_params = opts[:form_params] || {}
60
+
61
+ # http body (model)
62
+ post_body = opts[:body] || @api_client.object_to_http_body(create_inbox_replier_options)
63
+
64
+ # return_type
65
+ return_type = opts[:return_type] || 'InboxReplierDto'
66
+
67
+ # auth_names
68
+ auth_names = opts[:auth_names] || ['API_KEY']
69
+
70
+ new_options = opts.merge(
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => return_type
77
+ )
78
+
79
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: InboxReplierControllerApi#create_new_inbox_replier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
85
+
86
+ # Delete an inbox replier
87
+ # Delete inbox replier
88
+ # @param id [String] ID of inbox replier
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [nil]
91
+ def delete_inbox_replier(id, opts = {})
92
+ delete_inbox_replier_with_http_info(id, opts)
93
+ nil
94
+ end
95
+
96
+ # Delete an inbox replier
97
+ # Delete inbox replier
98
+ # @param id [String] ID of inbox replier
99
+ # @param [Hash] opts the optional parameters
100
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
101
+ def delete_inbox_replier_with_http_info(id, opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.delete_inbox_replier ...'
104
+ end
105
+ # verify the required parameter 'id' is set
106
+ if @api_client.config.client_side_validation && id.nil?
107
+ fail ArgumentError, "Missing the required parameter 'id' when calling InboxReplierControllerApi.delete_inbox_replier"
108
+ end
109
+ # resource path
110
+ local_var_path = '/repliers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
111
+
112
+ # query parameters
113
+ query_params = opts[:query_params] || {}
114
+
115
+ # header parameters
116
+ header_params = opts[:header_params] || {}
117
+
118
+ # form parameters
119
+ form_params = opts[:form_params] || {}
120
+
121
+ # http body (model)
122
+ post_body = opts[:body]
123
+
124
+ # return_type
125
+ return_type = opts[:return_type]
126
+
127
+ # auth_names
128
+ auth_names = opts[:auth_names] || ['API_KEY']
129
+
130
+ new_options = opts.merge(
131
+ :header_params => header_params,
132
+ :query_params => query_params,
133
+ :form_params => form_params,
134
+ :body => post_body,
135
+ :auth_names => auth_names,
136
+ :return_type => return_type
137
+ )
138
+
139
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
140
+ if @api_client.config.debugging
141
+ @api_client.config.logger.debug "API called: InboxReplierControllerApi#delete_inbox_replier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
142
+ end
143
+ return data, status_code, headers
144
+ end
145
+
146
+ # Delete inbox repliers
147
+ # Delete inbox repliers. Accepts optional inboxId filter.
148
+ # @param [Hash] opts the optional parameters
149
+ # @option opts [String] :inbox_id Optional inbox id to attach replier to
150
+ # @return [nil]
151
+ def delete_inbox_repliers(opts = {})
152
+ delete_inbox_repliers_with_http_info(opts)
153
+ nil
154
+ end
155
+
156
+ # Delete inbox repliers
157
+ # Delete inbox repliers. Accepts optional inboxId filter.
158
+ # @param [Hash] opts the optional parameters
159
+ # @option opts [String] :inbox_id Optional inbox id to attach replier to
160
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
161
+ def delete_inbox_repliers_with_http_info(opts = {})
162
+ if @api_client.config.debugging
163
+ @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.delete_inbox_repliers ...'
164
+ end
165
+ # resource path
166
+ local_var_path = '/repliers'
167
+
168
+ # query parameters
169
+ query_params = opts[:query_params] || {}
170
+ query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
171
+
172
+ # header parameters
173
+ header_params = opts[:header_params] || {}
174
+
175
+ # form parameters
176
+ form_params = opts[:form_params] || {}
177
+
178
+ # http body (model)
179
+ post_body = opts[:body]
180
+
181
+ # return_type
182
+ return_type = opts[:return_type]
183
+
184
+ # auth_names
185
+ auth_names = opts[:auth_names] || ['API_KEY']
186
+
187
+ new_options = opts.merge(
188
+ :header_params => header_params,
189
+ :query_params => query_params,
190
+ :form_params => form_params,
191
+ :body => post_body,
192
+ :auth_names => auth_names,
193
+ :return_type => return_type
194
+ )
195
+
196
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
197
+ if @api_client.config.debugging
198
+ @api_client.config.logger.debug "API called: InboxReplierControllerApi#delete_inbox_repliers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
199
+ end
200
+ return data, status_code, headers
201
+ end
202
+
203
+ # Get an inbox replier
204
+ # Get inbox ruleset
205
+ # @param id [String] ID of inbox replier
206
+ # @param [Hash] opts the optional parameters
207
+ # @return [InboxReplierDto]
208
+ def get_inbox_replier(id, opts = {})
209
+ data, _status_code, _headers = get_inbox_replier_with_http_info(id, opts)
210
+ data
211
+ end
212
+
213
+ # Get an inbox replier
214
+ # Get inbox ruleset
215
+ # @param id [String] ID of inbox replier
216
+ # @param [Hash] opts the optional parameters
217
+ # @return [Array<(InboxReplierDto, Integer, Hash)>] InboxReplierDto data, response status code and response headers
218
+ def get_inbox_replier_with_http_info(id, opts = {})
219
+ if @api_client.config.debugging
220
+ @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.get_inbox_replier ...'
221
+ end
222
+ # verify the required parameter 'id' is set
223
+ if @api_client.config.client_side_validation && id.nil?
224
+ fail ArgumentError, "Missing the required parameter 'id' when calling InboxReplierControllerApi.get_inbox_replier"
225
+ end
226
+ # resource path
227
+ local_var_path = '/repliers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
228
+
229
+ # query parameters
230
+ query_params = opts[:query_params] || {}
231
+
232
+ # header parameters
233
+ header_params = opts[:header_params] || {}
234
+ # HTTP header 'Accept' (if needed)
235
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
236
+
237
+ # form parameters
238
+ form_params = opts[:form_params] || {}
239
+
240
+ # http body (model)
241
+ post_body = opts[:body]
242
+
243
+ # return_type
244
+ return_type = opts[:return_type] || 'InboxReplierDto'
245
+
246
+ # auth_names
247
+ auth_names = opts[:auth_names] || ['API_KEY']
248
+
249
+ new_options = opts.merge(
250
+ :header_params => header_params,
251
+ :query_params => query_params,
252
+ :form_params => form_params,
253
+ :body => post_body,
254
+ :auth_names => auth_names,
255
+ :return_type => return_type
256
+ )
257
+
258
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
259
+ if @api_client.config.debugging
260
+ @api_client.config.logger.debug "API called: InboxReplierControllerApi#get_inbox_replier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
261
+ end
262
+ return data, status_code, headers
263
+ end
264
+
265
+ # Get an inbox replier event list
266
+ # Get inbox ruleset events
267
+ # @param id [String] ID of inbox replier
268
+ # @param [Hash] opts the optional parameters
269
+ # @option opts [Integer] :page Optional page index in inbox replier event list pagination (default to 0)
270
+ # @option opts [Integer] :size Optional page size in inbox replier event list pagination (default to 20)
271
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
272
+ # @return [PageInboxReplierEvents]
273
+ def get_inbox_replier_events(id, opts = {})
274
+ data, _status_code, _headers = get_inbox_replier_events_with_http_info(id, opts)
275
+ data
276
+ end
277
+
278
+ # Get an inbox replier event list
279
+ # Get inbox ruleset events
280
+ # @param id [String] ID of inbox replier
281
+ # @param [Hash] opts the optional parameters
282
+ # @option opts [Integer] :page Optional page index in inbox replier event list pagination
283
+ # @option opts [Integer] :size Optional page size in inbox replier event list pagination
284
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
285
+ # @return [Array<(PageInboxReplierEvents, Integer, Hash)>] PageInboxReplierEvents data, response status code and response headers
286
+ def get_inbox_replier_events_with_http_info(id, opts = {})
287
+ if @api_client.config.debugging
288
+ @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.get_inbox_replier_events ...'
289
+ end
290
+ # verify the required parameter 'id' is set
291
+ if @api_client.config.client_side_validation && id.nil?
292
+ fail ArgumentError, "Missing the required parameter 'id' when calling InboxReplierControllerApi.get_inbox_replier_events"
293
+ end
294
+ allowable_values = ["ASC", "DESC"]
295
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
296
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
297
+ end
298
+ # resource path
299
+ local_var_path = '/repliers/{id}/events'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
300
+
301
+ # query parameters
302
+ query_params = opts[:query_params] || {}
303
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
304
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
305
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
306
+
307
+ # header parameters
308
+ header_params = opts[:header_params] || {}
309
+ # HTTP header 'Accept' (if needed)
310
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
311
+
312
+ # form parameters
313
+ form_params = opts[:form_params] || {}
314
+
315
+ # http body (model)
316
+ post_body = opts[:body]
317
+
318
+ # return_type
319
+ return_type = opts[:return_type] || 'PageInboxReplierEvents'
320
+
321
+ # auth_names
322
+ auth_names = opts[:auth_names] || ['API_KEY']
323
+
324
+ new_options = opts.merge(
325
+ :header_params => header_params,
326
+ :query_params => query_params,
327
+ :form_params => form_params,
328
+ :body => post_body,
329
+ :auth_names => auth_names,
330
+ :return_type => return_type
331
+ )
332
+
333
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
334
+ if @api_client.config.debugging
335
+ @api_client.config.logger.debug "API called: InboxReplierControllerApi#get_inbox_replier_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
336
+ end
337
+ return data, status_code, headers
338
+ end
339
+
340
+ # List inbox repliers
341
+ # List all repliers attached to an inbox
342
+ # @param [Hash] opts the optional parameters
343
+ # @option opts [String] :inbox_id Optional inbox id to get repliers from
344
+ # @option opts [Integer] :page Optional page index in inbox replier list pagination (default to 0)
345
+ # @option opts [Integer] :size Optional page size in inbox replier list pagination (default to 20)
346
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
347
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
348
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
349
+ # @return [PageInboxReplierDto]
350
+ def get_inbox_repliers(opts = {})
351
+ data, _status_code, _headers = get_inbox_repliers_with_http_info(opts)
352
+ data
353
+ end
354
+
355
+ # List inbox repliers
356
+ # List all repliers attached to an inbox
357
+ # @param [Hash] opts the optional parameters
358
+ # @option opts [String] :inbox_id Optional inbox id to get repliers from
359
+ # @option opts [Integer] :page Optional page index in inbox replier list pagination
360
+ # @option opts [Integer] :size Optional page size in inbox replier list pagination
361
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
362
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
363
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
364
+ # @return [Array<(PageInboxReplierDto, Integer, Hash)>] PageInboxReplierDto data, response status code and response headers
365
+ def get_inbox_repliers_with_http_info(opts = {})
366
+ if @api_client.config.debugging
367
+ @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.get_inbox_repliers ...'
368
+ end
369
+ allowable_values = ["ASC", "DESC"]
370
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
371
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
372
+ end
373
+ # resource path
374
+ local_var_path = '/repliers'
375
+
376
+ # query parameters
377
+ query_params = opts[:query_params] || {}
378
+ query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
379
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
380
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
381
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
382
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
383
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
384
+
385
+ # header parameters
386
+ header_params = opts[:header_params] || {}
387
+ # HTTP header 'Accept' (if needed)
388
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
389
+
390
+ # form parameters
391
+ form_params = opts[:form_params] || {}
392
+
393
+ # http body (model)
394
+ post_body = opts[:body]
395
+
396
+ # return_type
397
+ return_type = opts[:return_type] || 'PageInboxReplierDto'
398
+
399
+ # auth_names
400
+ auth_names = opts[:auth_names] || ['API_KEY']
401
+
402
+ new_options = opts.merge(
403
+ :header_params => header_params,
404
+ :query_params => query_params,
405
+ :form_params => form_params,
406
+ :body => post_body,
407
+ :auth_names => auth_names,
408
+ :return_type => return_type
409
+ )
410
+
411
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
412
+ if @api_client.config.debugging
413
+ @api_client.config.logger.debug "API called: InboxReplierControllerApi#get_inbox_repliers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
414
+ end
415
+ return data, status_code, headers
416
+ end
417
+
418
+ # Update an inbox replier
419
+ # Update inbox ruleset
420
+ # @param id [String] ID of inbox replier
421
+ # @param update_inbox_replier_options [UpdateInboxReplierOptions]
422
+ # @param [Hash] opts the optional parameters
423
+ # @return [InboxReplierDto]
424
+ def update_inbox_replier(id, update_inbox_replier_options, opts = {})
425
+ data, _status_code, _headers = update_inbox_replier_with_http_info(id, update_inbox_replier_options, opts)
426
+ data
427
+ end
428
+
429
+ # Update an inbox replier
430
+ # Update inbox ruleset
431
+ # @param id [String] ID of inbox replier
432
+ # @param update_inbox_replier_options [UpdateInboxReplierOptions]
433
+ # @param [Hash] opts the optional parameters
434
+ # @return [Array<(InboxReplierDto, Integer, Hash)>] InboxReplierDto data, response status code and response headers
435
+ def update_inbox_replier_with_http_info(id, update_inbox_replier_options, opts = {})
436
+ if @api_client.config.debugging
437
+ @api_client.config.logger.debug 'Calling API: InboxReplierControllerApi.update_inbox_replier ...'
438
+ end
439
+ # verify the required parameter 'id' is set
440
+ if @api_client.config.client_side_validation && id.nil?
441
+ fail ArgumentError, "Missing the required parameter 'id' when calling InboxReplierControllerApi.update_inbox_replier"
442
+ end
443
+ # verify the required parameter 'update_inbox_replier_options' is set
444
+ if @api_client.config.client_side_validation && update_inbox_replier_options.nil?
445
+ fail ArgumentError, "Missing the required parameter 'update_inbox_replier_options' when calling InboxReplierControllerApi.update_inbox_replier"
446
+ end
447
+ # resource path
448
+ local_var_path = '/repliers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
449
+
450
+ # query parameters
451
+ query_params = opts[:query_params] || {}
452
+
453
+ # header parameters
454
+ header_params = opts[:header_params] || {}
455
+ # HTTP header 'Accept' (if needed)
456
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
457
+ # HTTP header 'Content-Type'
458
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
459
+
460
+ # form parameters
461
+ form_params = opts[:form_params] || {}
462
+
463
+ # http body (model)
464
+ post_body = opts[:body] || @api_client.object_to_http_body(update_inbox_replier_options)
465
+
466
+ # return_type
467
+ return_type = opts[:return_type] || 'InboxReplierDto'
468
+
469
+ # auth_names
470
+ auth_names = opts[:auth_names] || ['API_KEY']
471
+
472
+ new_options = opts.merge(
473
+ :header_params => header_params,
474
+ :query_params => query_params,
475
+ :form_params => form_params,
476
+ :body => post_body,
477
+ :auth_names => auth_names,
478
+ :return_type => return_type
479
+ )
480
+
481
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
482
+ if @api_client.config.debugging
483
+ @api_client.config.logger.debug "API called: InboxReplierControllerApi#update_inbox_replier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
484
+ end
485
+ return data, status_code, headers
486
+ end
487
+ end
488
+ end
@@ -463,7 +463,7 @@ module MailSlurpClient
463
463
  end
464
464
 
465
465
  # Get all sent email delivery statuses
466
- # @param sent_id [String]
466
+ # @param sent_id [String] ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email
467
467
  # @param [Hash] opts the optional parameters
468
468
  # @option opts [Integer] :page Optional page index in delivery status list pagination (default to 0)
469
469
  # @option opts [Integer] :size Optional page size in delivery status list pagination (default to 20)
@@ -477,7 +477,7 @@ module MailSlurpClient
477
477
  end
478
478
 
479
479
  # Get all sent email delivery statuses
480
- # @param sent_id [String]
480
+ # @param sent_id [String] ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email
481
481
  # @param [Hash] opts the optional parameters
482
482
  # @option opts [Integer] :page Optional page index in delivery status list pagination
483
483
  # @option opts [Integer] :size Optional page size in delivery status list pagination