qubrics-management 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (161) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +100 -0
  3. data/LICENSE +21 -0
  4. data/README.md +157 -0
  5. data/lib/qubrics/management/client.rb +99 -0
  6. data/lib/qubrics/management/version.rb +7 -0
  7. data/lib/qubrics/management.rb +12 -0
  8. data/lib/qubrics_management_generated/api/billing_api.rb +221 -0
  9. data/lib/qubrics_management_generated/api/connection_api.rb +82 -0
  10. data/lib/qubrics_management_generated/api/domain_filters_api.rb +161 -0
  11. data/lib/qubrics_management_generated/api/domains_api.rb +492 -0
  12. data/lib/qubrics_management_generated/api/emails_api.rb +258 -0
  13. data/lib/qubrics_management_generated/api/inboxes_api.rb +175 -0
  14. data/lib/qubrics_management_generated/api/mailbox_filters_api.rb +161 -0
  15. data/lib/qubrics_management_generated/api/mailboxes_api.rb +996 -0
  16. data/lib/qubrics_management_generated/api/sending_accounts_api.rb +1009 -0
  17. data/lib/qubrics_management_generated/api/webhooks_api.rb +666 -0
  18. data/lib/qubrics_management_generated/api_client.rb +447 -0
  19. data/lib/qubrics_management_generated/api_error.rb +58 -0
  20. data/lib/qubrics_management_generated/api_model_base.rb +95 -0
  21. data/lib/qubrics_management_generated/configuration.rb +400 -0
  22. data/lib/qubrics_management_generated/models/api_error_detail.rb +219 -0
  23. data/lib/qubrics_management_generated/models/api_error_error.rb +275 -0
  24. data/lib/qubrics_management_generated/models/api_error_meta.rb +164 -0
  25. data/lib/qubrics_management_generated/models/api_error_response.rb +216 -0
  26. data/lib/qubrics_management_generated/models/balance.rb +293 -0
  27. data/lib/qubrics_management_generated/models/balance_auto_topup.rb +226 -0
  28. data/lib/qubrics_management_generated/models/balance_response.rb +223 -0
  29. data/lib/qubrics_management_generated/models/connection.rb +273 -0
  30. data/lib/qubrics_management_generated/models/connection_credential.rb +226 -0
  31. data/lib/qubrics_management_generated/models/connection_mailboxes_inner.rb +190 -0
  32. data/lib/qubrics_management_generated/models/connection_response.rb +223 -0
  33. data/lib/qubrics_management_generated/models/connection_team.rb +190 -0
  34. data/lib/qubrics_management_generated/models/cursor_pagination.rb +173 -0
  35. data/lib/qubrics_management_generated/models/delivery_log_detail.rb +573 -0
  36. data/lib/qubrics_management_generated/models/delivery_log_item.rb +543 -0
  37. data/lib/qubrics_management_generated/models/delivery_log_item_cursor_list_response.rb +251 -0
  38. data/lib/qubrics_management_generated/models/delivery_log_item_response.rb +223 -0
  39. data/lib/qubrics_management_generated/models/delivery_log_recipient.rb +254 -0
  40. data/lib/qubrics_management_generated/models/domain_deleted_response.rb +223 -0
  41. data/lib/qubrics_management_generated/models/domain_deleted_response_all_of_data.rb +190 -0
  42. data/lib/qubrics_management_generated/models/domain_item_cursor_list_response.rb +251 -0
  43. data/lib/qubrics_management_generated/models/domain_item_response.rb +223 -0
  44. data/lib/qubrics_management_generated/models/domain_verify_response.rb +223 -0
  45. data/lib/qubrics_management_generated/models/email_metrics.rb +218 -0
  46. data/lib/qubrics_management_generated/models/email_metrics_comparison.rb +294 -0
  47. data/lib/qubrics_management_generated/models/email_metrics_comparison_change_pct.rb +268 -0
  48. data/lib/qubrics_management_generated/models/email_metrics_response.rb +223 -0
  49. data/lib/qubrics_management_generated/models/email_metrics_summary.rb +268 -0
  50. data/lib/qubrics_management_generated/models/email_metrics_timeseries_inner.rb +294 -0
  51. data/lib/qubrics_management_generated/models/filter_rule.rb +242 -0
  52. data/lib/qubrics_management_generated/models/filter_state.rb +218 -0
  53. data/lib/qubrics_management_generated/models/filter_state_response.rb +223 -0
  54. data/lib/qubrics_management_generated/models/incoming_log_item.rb +465 -0
  55. data/lib/qubrics_management_generated/models/incoming_log_item_cursor_list_response.rb +251 -0
  56. data/lib/qubrics_management_generated/models/incoming_log_item_response.rb +223 -0
  57. data/lib/qubrics_management_generated/models/mail_webhook_event_payload.rb +296 -0
  58. data/lib/qubrics_management_generated/models/mailbox.rb +284 -0
  59. data/lib/qubrics_management_generated/models/mailbox_app_password_result.rb +164 -0
  60. data/lib/qubrics_management_generated/models/mailbox_app_password_result_response.rb +223 -0
  61. data/lib/qubrics_management_generated/models/mailbox_availability_reason.rb +45 -0
  62. data/lib/qubrics_management_generated/models/mailbox_availability_response.rb +223 -0
  63. data/lib/qubrics_management_generated/models/mailbox_availability_result.rb +240 -0
  64. data/lib/qubrics_management_generated/models/mailbox_cost_usage.rb +409 -0
  65. data/lib/qubrics_management_generated/models/mailbox_cost_usage_incoming.rb +422 -0
  66. data/lib/qubrics_management_generated/models/mailbox_cost_usage_response.rb +223 -0
  67. data/lib/qubrics_management_generated/models/mailbox_cost_usage_storage.rb +299 -0
  68. data/lib/qubrics_management_generated/models/mailbox_create_result.rb +190 -0
  69. data/lib/qubrics_management_generated/models/mailbox_create_result_response.rb +223 -0
  70. data/lib/qubrics_management_generated/models/mailbox_credential.rb +352 -0
  71. data/lib/qubrics_management_generated/models/mailbox_deleted_response.rb +223 -0
  72. data/lib/qubrics_management_generated/models/mailbox_domain.rb +452 -0
  73. data/lib/qubrics_management_generated/models/mailbox_domain_dns_records.rb +303 -0
  74. data/lib/qubrics_management_generated/models/mailbox_domain_mail_from_records.rb +191 -0
  75. data/lib/qubrics_management_generated/models/mailbox_domain_mx_record.rb +190 -0
  76. data/lib/qubrics_management_generated/models/mailbox_domain_name_value_record.rb +191 -0
  77. data/lib/qubrics_management_generated/models/mailbox_domain_named_mx_record.rb +217 -0
  78. data/lib/qubrics_management_generated/models/mailbox_domain_verify_checks.rb +300 -0
  79. data/lib/qubrics_management_generated/models/mailbox_domain_verify_result.rb +377 -0
  80. data/lib/qubrics_management_generated/models/mailbox_item_cursor_list_response.rb +251 -0
  81. data/lib/qubrics_management_generated/models/mailbox_item_response.rb +223 -0
  82. data/lib/qubrics_management_generated/models/mailbox_key_deleted_response.rb +223 -0
  83. data/lib/qubrics_management_generated/models/mailbox_send_policy.rb +196 -0
  84. data/lib/qubrics_management_generated/models/mailbox_send_policy_allowed_from.rb +213 -0
  85. data/lib/qubrics_management_generated/models/mailbox_send_policy_allowed_reply_to.rb +213 -0
  86. data/lib/qubrics_management_generated/models/mailbox_send_policy_recipients.rb +158 -0
  87. data/lib/qubrics_management_generated/models/mailbox_send_policy_recipients_allow.rb +201 -0
  88. data/lib/qubrics_management_generated/models/mailbox_send_policy_recipients_deny.rb +201 -0
  89. data/lib/qubrics_management_generated/models/mailbox_send_policy_response.rb +223 -0
  90. data/lib/qubrics_management_generated/models/mailbox_send_policy_snapshot.rb +202 -0
  91. data/lib/qubrics_management_generated/models/mailbox_send_scope.rb +213 -0
  92. data/lib/qubrics_management_generated/models/management_create_domain_request.rb +209 -0
  93. data/lib/qubrics_management_generated/models/management_create_mailbox_key_request.rb +183 -0
  94. data/lib/qubrics_management_generated/models/management_create_mailbox_request.rb +270 -0
  95. data/lib/qubrics_management_generated/models/management_create_mailbox_request_send_scope.rb +214 -0
  96. data/lib/qubrics_management_generated/models/management_test_webhook200_response.rb +223 -0
  97. data/lib/qubrics_management_generated/models/management_update_domain_request.rb +189 -0
  98. data/lib/qubrics_management_generated/models/provider_allowed_actions.rb +294 -0
  99. data/lib/qubrics_management_generated/models/provider_create_body.rb +611 -0
  100. data/lib/qubrics_management_generated/models/provider_create_body_quotas.rb +174 -0
  101. data/lib/qubrics_management_generated/models/provider_create_body_quotas_per_day.rb +104 -0
  102. data/lib/qubrics_management_generated/models/provider_deleted.rb +190 -0
  103. data/lib/qubrics_management_generated/models/provider_deleted_response.rb +223 -0
  104. data/lib/qubrics_management_generated/models/provider_item.rb +733 -0
  105. data/lib/qubrics_management_generated/models/provider_item_cursor_list_response.rb +251 -0
  106. data/lib/qubrics_management_generated/models/provider_item_response.rb +223 -0
  107. data/lib/qubrics_management_generated/models/provider_limits.rb +190 -0
  108. data/lib/qubrics_management_generated/models/provider_limits_response.rb +223 -0
  109. data/lib/qubrics_management_generated/models/provider_list_item.rb +695 -0
  110. data/lib/qubrics_management_generated/models/provider_quota_range.rb +208 -0
  111. data/lib/qubrics_management_generated/models/provider_quotas.rb +186 -0
  112. data/lib/qubrics_management_generated/models/provider_stats.rb +325 -0
  113. data/lib/qubrics_management_generated/models/provider_stats_response.rb +223 -0
  114. data/lib/qubrics_management_generated/models/provider_status_counts.rb +242 -0
  115. data/lib/qubrics_management_generated/models/provider_test_result.rb +251 -0
  116. data/lib/qubrics_management_generated/models/provider_test_result_response.rb +223 -0
  117. data/lib/qubrics_management_generated/models/provider_type_counts.rb +246 -0
  118. data/lib/qubrics_management_generated/models/provider_update_body.rb +569 -0
  119. data/lib/qubrics_management_generated/models/provider_usage.rb +216 -0
  120. data/lib/qubrics_management_generated/models/provider_usage_item.rb +374 -0
  121. data/lib/qubrics_management_generated/models/provider_usage_response.rb +223 -0
  122. data/lib/qubrics_management_generated/models/replace_mailbox_send_policy.rb +165 -0
  123. data/lib/qubrics_management_generated/models/resource_limit_snapshot.rb +420 -0
  124. data/lib/qubrics_management_generated/models/response_meta.rb +164 -0
  125. data/lib/qubrics_management_generated/models/sending_account_limit_request.rb +190 -0
  126. data/lib/qubrics_management_generated/models/sending_account_limit_request_response.rb +223 -0
  127. data/lib/qubrics_management_generated/models/set_filter_state_body.rb +226 -0
  128. data/lib/qubrics_management_generated/models/shared_amazon_ses_limit.rb +315 -0
  129. data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request.rb +361 -0
  130. data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_cancel.rb +190 -0
  131. data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_cancel_response.rb +223 -0
  132. data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_create.rb +190 -0
  133. data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_create_response.rb +223 -0
  134. data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_page.rb +176 -0
  135. data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_page_response.rb +223 -0
  136. data/lib/qubrics_management_generated/models/spend_summary.rb +292 -0
  137. data/lib/qubrics_management_generated/models/spend_summary_response.rb +223 -0
  138. data/lib/qubrics_management_generated/models/success_envelope.rb +192 -0
  139. data/lib/qubrics_management_generated/models/transaction.rb +332 -0
  140. data/lib/qubrics_management_generated/models/transaction_cursor_list_response.rb +251 -0
  141. data/lib/qubrics_management_generated/models/update_mailbox_body.rb +211 -0
  142. data/lib/qubrics_management_generated/models/update_mailbox_body_send_scope.rb +214 -0
  143. data/lib/qubrics_management_generated/models/webhook_create_body.rb +269 -0
  144. data/lib/qubrics_management_generated/models/webhook_deleted_response.rb +223 -0
  145. data/lib/qubrics_management_generated/models/webhook_delivery_attempt.rb +560 -0
  146. data/lib/qubrics_management_generated/models/webhook_delivery_attempt_cursor_list_response.rb +251 -0
  147. data/lib/qubrics_management_generated/models/webhook_delivery_payload.rb +337 -0
  148. data/lib/qubrics_management_generated/models/webhook_delivery_payload_response.rb +223 -0
  149. data/lib/qubrics_management_generated/models/webhook_event_data.rb +406 -0
  150. data/lib/qubrics_management_generated/models/webhook_event_payload.rb +304 -0
  151. data/lib/qubrics_management_generated/models/webhook_filters.rb +168 -0
  152. data/lib/qubrics_management_generated/models/webhook_subscription.rb +368 -0
  153. data/lib/qubrics_management_generated/models/webhook_subscription_cursor_list_response.rb +251 -0
  154. data/lib/qubrics_management_generated/models/webhook_subscription_response.rb +223 -0
  155. data/lib/qubrics_management_generated/models/webhook_subscription_with_secret.rb +395 -0
  156. data/lib/qubrics_management_generated/models/webhook_subscription_with_secret_response.rb +223 -0
  157. data/lib/qubrics_management_generated/models/webhook_test_response.rb +165 -0
  158. data/lib/qubrics_management_generated/models/webhook_update_body.rb +233 -0
  159. data/lib/qubrics_management_generated/version.rb +15 -0
  160. data/lib/qubrics_management_generated.rb +195 -0
  161. metadata +283 -0
@@ -0,0 +1,258 @@
1
+ =begin
2
+ #Qubrics API
3
+
4
+ #Programmatic access to your Qubrics email infrastructure.
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Qubrics::Management::Generated
16
+ class EmailsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get delivery log
23
+ # Returns a single delivery log by its public ID. Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the log has not changed. Logs in a terminal status (sent/failed/rejected) stop changing, so 304 replay is a real bandwidth win on repeated polls.
24
+ # @param public_id [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :if_none_match
27
+ # @return [DeliveryLogItemResponse]
28
+ def management_get_email_log(public_id, opts = {})
29
+ data, _status_code, _headers = management_get_email_log_with_http_info(public_id, opts)
30
+ data
31
+ end
32
+
33
+ # Get delivery log
34
+ # Returns a single delivery log by its public ID. Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the log has not changed. Logs in a terminal status (sent/failed/rejected) stop changing, so 304 replay is a real bandwidth win on repeated polls.
35
+ # @param public_id [String]
36
+ # @param [Hash] opts the optional parameters
37
+ # @option opts [String] :if_none_match
38
+ # @return [Array<(DeliveryLogItemResponse, Integer, Hash)>] DeliveryLogItemResponse data, response status code and response headers
39
+ def management_get_email_log_with_http_info(public_id, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: EmailsApi.management_get_email_log ...'
42
+ end
43
+ # verify the required parameter 'public_id' is set
44
+ if @api_client.config.client_side_validation && public_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'public_id' when calling EmailsApi.management_get_email_log"
46
+ end
47
+ # resource path
48
+ local_var_path = '/emails/logs/{public_id}'.sub('{public_id}', CGI.escape(public_id.to_s))
49
+
50
+ # query parameters
51
+ query_params = opts[:query_params] || {}
52
+
53
+ # header parameters
54
+ header_params = opts[:header_params] || {}
55
+ # HTTP header 'Accept' (if needed)
56
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
57
+ header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
58
+
59
+ # form parameters
60
+ form_params = opts[:form_params] || {}
61
+
62
+ # http body (model)
63
+ post_body = opts[:debug_body]
64
+
65
+ # return_type
66
+ return_type = opts[:debug_return_type] || 'DeliveryLogItemResponse'
67
+
68
+ # auth_names
69
+ auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
70
+
71
+ new_options = opts.merge(
72
+ :operation => :"EmailsApi.management_get_email_log",
73
+ :header_params => header_params,
74
+ :query_params => query_params,
75
+ :form_params => form_params,
76
+ :body => post_body,
77
+ :auth_names => auth_names,
78
+ :return_type => return_type
79
+ )
80
+
81
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
82
+ if @api_client.config.debugging
83
+ @api_client.config.logger.debug "API called: EmailsApi#management_get_email_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
84
+ end
85
+ return data, status_code, headers
86
+ end
87
+
88
+ # Get email metrics
89
+ # Returns aggregated email delivery counts with flexible time windowing and comparison period.
90
+ # @param [Hash] opts the optional parameters
91
+ # @option opts [String] :window
92
+ # @option opts [String] :from_date
93
+ # @option opts [String] :to_date
94
+ # @option opts [String] :granularity
95
+ # @option opts [String] :provider_id
96
+ # @return [EmailMetricsResponse]
97
+ def management_get_email_metrics(opts = {})
98
+ data, _status_code, _headers = management_get_email_metrics_with_http_info(opts)
99
+ data
100
+ end
101
+
102
+ # Get email metrics
103
+ # Returns aggregated email delivery counts with flexible time windowing and comparison period.
104
+ # @param [Hash] opts the optional parameters
105
+ # @option opts [String] :window
106
+ # @option opts [String] :from_date
107
+ # @option opts [String] :to_date
108
+ # @option opts [String] :granularity
109
+ # @option opts [String] :provider_id
110
+ # @return [Array<(EmailMetricsResponse, Integer, Hash)>] EmailMetricsResponse data, response status code and response headers
111
+ def management_get_email_metrics_with_http_info(opts = {})
112
+ if @api_client.config.debugging
113
+ @api_client.config.logger.debug 'Calling API: EmailsApi.management_get_email_metrics ...'
114
+ end
115
+ allowable_values = ["24h", "7d", "30d", "unknown_default_open_api"]
116
+ if @api_client.config.client_side_validation && opts[:'window'] && !allowable_values.include?(opts[:'window'])
117
+ fail ArgumentError, "invalid value for \"window\", must be one of #{allowable_values}"
118
+ end
119
+ allowable_values = ["hourly", "daily", "unknown_default_open_api"]
120
+ if @api_client.config.client_side_validation && opts[:'granularity'] && !allowable_values.include?(opts[:'granularity'])
121
+ fail ArgumentError, "invalid value for \"granularity\", must be one of #{allowable_values}"
122
+ end
123
+ # resource path
124
+ local_var_path = '/emails/metrics'
125
+
126
+ # query parameters
127
+ query_params = opts[:query_params] || {}
128
+ query_params[:'window'] = opts[:'window'] if !opts[:'window'].nil?
129
+ query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
130
+ query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
131
+ query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?
132
+ query_params[:'provider_id'] = opts[:'provider_id'] if !opts[:'provider_id'].nil?
133
+
134
+ # header parameters
135
+ header_params = opts[:header_params] || {}
136
+ # HTTP header 'Accept' (if needed)
137
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
138
+
139
+ # form parameters
140
+ form_params = opts[:form_params] || {}
141
+
142
+ # http body (model)
143
+ post_body = opts[:debug_body]
144
+
145
+ # return_type
146
+ return_type = opts[:debug_return_type] || 'EmailMetricsResponse'
147
+
148
+ # auth_names
149
+ auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
150
+
151
+ new_options = opts.merge(
152
+ :operation => :"EmailsApi.management_get_email_metrics",
153
+ :header_params => header_params,
154
+ :query_params => query_params,
155
+ :form_params => form_params,
156
+ :body => post_body,
157
+ :auth_names => auth_names,
158
+ :return_type => return_type
159
+ )
160
+
161
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
162
+ if @api_client.config.debugging
163
+ @api_client.config.logger.debug "API called: EmailsApi#management_get_email_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
164
+ end
165
+ return data, status_code, headers
166
+ end
167
+
168
+ # List delivery logs
169
+ # Returns paginated delivery logs with cursor-based pagination and filters.
170
+ # @param [Hash] opts the optional parameters
171
+ # @option opts [Integer] :limit
172
+ # @option opts [String] :cursor
173
+ # @option opts [String] :status
174
+ # @option opts [String] :from_date
175
+ # @option opts [String] :to_date
176
+ # @option opts [String] :provider_id
177
+ # @option opts [String] :search
178
+ # @return [DeliveryLogItemCursorListResponse]
179
+ def management_list_email_logs(opts = {})
180
+ data, _status_code, _headers = management_list_email_logs_with_http_info(opts)
181
+ data
182
+ end
183
+
184
+ # List delivery logs
185
+ # Returns paginated delivery logs with cursor-based pagination and filters.
186
+ # @param [Hash] opts the optional parameters
187
+ # @option opts [Integer] :limit
188
+ # @option opts [String] :cursor
189
+ # @option opts [String] :status
190
+ # @option opts [String] :from_date
191
+ # @option opts [String] :to_date
192
+ # @option opts [String] :provider_id
193
+ # @option opts [String] :search
194
+ # @return [Array<(DeliveryLogItemCursorListResponse, Integer, Hash)>] DeliveryLogItemCursorListResponse data, response status code and response headers
195
+ def management_list_email_logs_with_http_info(opts = {})
196
+ if @api_client.config.debugging
197
+ @api_client.config.logger.debug 'Calling API: EmailsApi.management_list_email_logs ...'
198
+ end
199
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
200
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EmailsApi.management_list_email_logs, must be smaller than or equal to 100.'
201
+ end
202
+
203
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
204
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EmailsApi.management_list_email_logs, must be greater than or equal to 1.'
205
+ end
206
+
207
+ allowable_values = ["pending", "sent", "failed", "rejected", "unknown_default_open_api"]
208
+ if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
209
+ fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
210
+ end
211
+ # resource path
212
+ local_var_path = '/emails/logs'
213
+
214
+ # query parameters
215
+ query_params = opts[:query_params] || {}
216
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
217
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
218
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
219
+ query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
220
+ query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
221
+ query_params[:'provider_id'] = opts[:'provider_id'] if !opts[:'provider_id'].nil?
222
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
223
+
224
+ # header parameters
225
+ header_params = opts[:header_params] || {}
226
+ # HTTP header 'Accept' (if needed)
227
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
228
+
229
+ # form parameters
230
+ form_params = opts[:form_params] || {}
231
+
232
+ # http body (model)
233
+ post_body = opts[:debug_body]
234
+
235
+ # return_type
236
+ return_type = opts[:debug_return_type] || 'DeliveryLogItemCursorListResponse'
237
+
238
+ # auth_names
239
+ auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
240
+
241
+ new_options = opts.merge(
242
+ :operation => :"EmailsApi.management_list_email_logs",
243
+ :header_params => header_params,
244
+ :query_params => query_params,
245
+ :form_params => form_params,
246
+ :body => post_body,
247
+ :auth_names => auth_names,
248
+ :return_type => return_type
249
+ )
250
+
251
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
252
+ if @api_client.config.debugging
253
+ @api_client.config.logger.debug "API called: EmailsApi#management_list_email_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
254
+ end
255
+ return data, status_code, headers
256
+ end
257
+ end
258
+ end
@@ -0,0 +1,175 @@
1
+ =begin
2
+ #Qubrics API
3
+
4
+ #Programmatic access to your Qubrics email infrastructure.
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Qubrics::Management::Generated
16
+ class InboxesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get incoming log
23
+ # Returns one incoming message log by public ID.
24
+ # @param public_id [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [IncomingLogItemResponse]
27
+ def management_get_inbox_log(public_id, opts = {})
28
+ data, _status_code, _headers = management_get_inbox_log_with_http_info(public_id, opts)
29
+ data
30
+ end
31
+
32
+ # Get incoming log
33
+ # Returns one incoming message log by public ID.
34
+ # @param public_id [String]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(IncomingLogItemResponse, Integer, Hash)>] IncomingLogItemResponse data, response status code and response headers
37
+ def management_get_inbox_log_with_http_info(public_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: InboxesApi.management_get_inbox_log ...'
40
+ end
41
+ # verify the required parameter 'public_id' is set
42
+ if @api_client.config.client_side_validation && public_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'public_id' when calling InboxesApi.management_get_inbox_log"
44
+ end
45
+ # resource path
46
+ local_var_path = '/inboxes/logs/{public_id}'.sub('{public_id}', CGI.escape(public_id.to_s))
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(['application/json']) unless header_params['Accept']
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'IncomingLogItemResponse'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"InboxesApi.management_get_inbox_log",
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: InboxesApi#management_get_inbox_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+
85
+ # List incoming logs
86
+ # Returns paginated incoming message logs for billing accountability.
87
+ # @param [Hash] opts the optional parameters
88
+ # @option opts [Integer] :limit
89
+ # @option opts [String] :cursor
90
+ # @option opts [String] :mailbox_id
91
+ # @option opts [String] :event_type
92
+ # @option opts [String] :from_date
93
+ # @option opts [String] :to_date
94
+ # @option opts [String] :search
95
+ # @return [IncomingLogItemCursorListResponse]
96
+ def management_list_inbox_logs(opts = {})
97
+ data, _status_code, _headers = management_list_inbox_logs_with_http_info(opts)
98
+ data
99
+ end
100
+
101
+ # List incoming logs
102
+ # Returns paginated incoming message logs for billing accountability.
103
+ # @param [Hash] opts the optional parameters
104
+ # @option opts [Integer] :limit
105
+ # @option opts [String] :cursor
106
+ # @option opts [String] :mailbox_id
107
+ # @option opts [String] :event_type
108
+ # @option opts [String] :from_date
109
+ # @option opts [String] :to_date
110
+ # @option opts [String] :search
111
+ # @return [Array<(IncomingLogItemCursorListResponse, Integer, Hash)>] IncomingLogItemCursorListResponse data, response status code and response headers
112
+ def management_list_inbox_logs_with_http_info(opts = {})
113
+ if @api_client.config.debugging
114
+ @api_client.config.logger.debug 'Calling API: InboxesApi.management_list_inbox_logs ...'
115
+ end
116
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
117
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboxesApi.management_list_inbox_logs, must be smaller than or equal to 100.'
118
+ end
119
+
120
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
121
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboxesApi.management_list_inbox_logs, must be greater than or equal to 1.'
122
+ end
123
+
124
+ allowable_values = ["message.received", "message.received.spam", "unknown_default_open_api"]
125
+ if @api_client.config.client_side_validation && opts[:'event_type'] && !allowable_values.include?(opts[:'event_type'])
126
+ fail ArgumentError, "invalid value for \"event_type\", must be one of #{allowable_values}"
127
+ end
128
+ # resource path
129
+ local_var_path = '/inboxes/logs'
130
+
131
+ # query parameters
132
+ query_params = opts[:query_params] || {}
133
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
134
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
135
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
136
+ query_params[:'event_type'] = opts[:'event_type'] if !opts[:'event_type'].nil?
137
+ query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
138
+ query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
139
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
140
+
141
+ # header parameters
142
+ header_params = opts[:header_params] || {}
143
+ # HTTP header 'Accept' (if needed)
144
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
145
+
146
+ # form parameters
147
+ form_params = opts[:form_params] || {}
148
+
149
+ # http body (model)
150
+ post_body = opts[:debug_body]
151
+
152
+ # return_type
153
+ return_type = opts[:debug_return_type] || 'IncomingLogItemCursorListResponse'
154
+
155
+ # auth_names
156
+ auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
157
+
158
+ new_options = opts.merge(
159
+ :operation => :"InboxesApi.management_list_inbox_logs",
160
+ :header_params => header_params,
161
+ :query_params => query_params,
162
+ :form_params => form_params,
163
+ :body => post_body,
164
+ :auth_names => auth_names,
165
+ :return_type => return_type
166
+ )
167
+
168
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
169
+ if @api_client.config.debugging
170
+ @api_client.config.logger.debug "API called: InboxesApi#management_list_inbox_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
171
+ end
172
+ return data, status_code, headers
173
+ end
174
+ end
175
+ end
@@ -0,0 +1,161 @@
1
+ =begin
2
+ #Qubrics API
3
+
4
+ #Programmatic access to your Qubrics email infrastructure.
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Qubrics::Management::Generated
16
+ class MailboxFiltersApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get mailbox sender filters
23
+ # Returns the current sender-filter mode and rule set for a mailbox. Mailbox-scoped rules override any domain-wide rules set on the parent domain. Responses carry a weak `ETag` — send it as `If-None-Match` to skip the body when the filter set has not changed (returns `304 Not Modified`). The same ETag is the value to use in `If-Match` on the corresponding PUT for optimistic concurrency.
24
+ # @param public_id [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :if_none_match
27
+ # @return [FilterStateResponse]
28
+ def management_get_mailbox_filters(public_id, opts = {})
29
+ data, _status_code, _headers = management_get_mailbox_filters_with_http_info(public_id, opts)
30
+ data
31
+ end
32
+
33
+ # Get mailbox sender filters
34
+ # Returns the current sender-filter mode and rule set for a mailbox. Mailbox-scoped rules override any domain-wide rules set on the parent domain. Responses carry a weak &#x60;ETag&#x60; — send it as &#x60;If-None-Match&#x60; to skip the body when the filter set has not changed (returns &#x60;304 Not Modified&#x60;). The same ETag is the value to use in &#x60;If-Match&#x60; on the corresponding PUT for optimistic concurrency.
35
+ # @param public_id [String]
36
+ # @param [Hash] opts the optional parameters
37
+ # @option opts [String] :if_none_match
38
+ # @return [Array<(FilterStateResponse, Integer, Hash)>] FilterStateResponse data, response status code and response headers
39
+ def management_get_mailbox_filters_with_http_info(public_id, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: MailboxFiltersApi.management_get_mailbox_filters ...'
42
+ end
43
+ # verify the required parameter 'public_id' is set
44
+ if @api_client.config.client_side_validation && public_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'public_id' when calling MailboxFiltersApi.management_get_mailbox_filters"
46
+ end
47
+ # resource path
48
+ local_var_path = '/mailboxes/{public_id}/filters'.sub('{public_id}', CGI.escape(public_id.to_s))
49
+
50
+ # query parameters
51
+ query_params = opts[:query_params] || {}
52
+
53
+ # header parameters
54
+ header_params = opts[:header_params] || {}
55
+ # HTTP header 'Accept' (if needed)
56
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
57
+ header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
58
+
59
+ # form parameters
60
+ form_params = opts[:form_params] || {}
61
+
62
+ # http body (model)
63
+ post_body = opts[:debug_body]
64
+
65
+ # return_type
66
+ return_type = opts[:debug_return_type] || 'FilterStateResponse'
67
+
68
+ # auth_names
69
+ auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
70
+
71
+ new_options = opts.merge(
72
+ :operation => :"MailboxFiltersApi.management_get_mailbox_filters",
73
+ :header_params => header_params,
74
+ :query_params => query_params,
75
+ :form_params => form_params,
76
+ :body => post_body,
77
+ :auth_names => auth_names,
78
+ :return_type => return_type
79
+ )
80
+
81
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
82
+ if @api_client.config.debugging
83
+ @api_client.config.logger.debug "API called: MailboxFiltersApi#management_get_mailbox_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
84
+ end
85
+ return data, status_code, headers
86
+ end
87
+
88
+ # Replace mailbox sender filters
89
+ # Atomically replaces the sender-filter mode and rule set for a mailbox. The entire rule set is swapped in a single operation — there is no intermediate state where the mailbox has a partial ruleset. A maximum of 1000 rules per request is enforced. For optimistic concurrency, send `If-Match: <etag>` using the ETag from a prior GET. A mismatched `If-Match` returns `409 conflict` (the server's ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
90
+ # @param public_id [String]
91
+ # @param [Hash] opts the optional parameters
92
+ # @option opts [String] :if_match
93
+ # @option opts [SetFilterStateBody] :set_filter_state_body
94
+ # @return [FilterStateResponse]
95
+ def management_set_mailbox_filters(public_id, opts = {})
96
+ data, _status_code, _headers = management_set_mailbox_filters_with_http_info(public_id, opts)
97
+ data
98
+ end
99
+
100
+ # Replace mailbox sender filters
101
+ # Atomically replaces the sender-filter mode and rule set for a mailbox. The entire rule set is swapped in a single operation — there is no intermediate state where the mailbox has a partial ruleset. A maximum of 1000 rules per request is enforced. For optimistic concurrency, send &#x60;If-Match: &lt;etag&gt;&#x60; using the ETag from a prior GET. A mismatched &#x60;If-Match&#x60; returns &#x60;409 conflict&#x60; (the server&#39;s ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
102
+ # @param public_id [String]
103
+ # @param [Hash] opts the optional parameters
104
+ # @option opts [String] :if_match
105
+ # @option opts [SetFilterStateBody] :set_filter_state_body
106
+ # @return [Array<(FilterStateResponse, Integer, Hash)>] FilterStateResponse data, response status code and response headers
107
+ def management_set_mailbox_filters_with_http_info(public_id, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug 'Calling API: MailboxFiltersApi.management_set_mailbox_filters ...'
110
+ end
111
+ # verify the required parameter 'public_id' is set
112
+ if @api_client.config.client_side_validation && public_id.nil?
113
+ fail ArgumentError, "Missing the required parameter 'public_id' when calling MailboxFiltersApi.management_set_mailbox_filters"
114
+ end
115
+ # resource path
116
+ local_var_path = '/mailboxes/{public_id}/filters'.sub('{public_id}', CGI.escape(public_id.to_s))
117
+
118
+ # query parameters
119
+ query_params = opts[:query_params] || {}
120
+
121
+ # header parameters
122
+ header_params = opts[:header_params] || {}
123
+ # HTTP header 'Accept' (if needed)
124
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
125
+ # HTTP header 'Content-Type'
126
+ content_type = @api_client.select_header_content_type(['application/json'])
127
+ if !content_type.nil?
128
+ header_params['Content-Type'] = content_type
129
+ end
130
+ header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
131
+
132
+ # form parameters
133
+ form_params = opts[:form_params] || {}
134
+
135
+ # http body (model)
136
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'set_filter_state_body'])
137
+
138
+ # return_type
139
+ return_type = opts[:debug_return_type] || 'FilterStateResponse'
140
+
141
+ # auth_names
142
+ auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
143
+
144
+ new_options = opts.merge(
145
+ :operation => :"MailboxFiltersApi.management_set_mailbox_filters",
146
+ :header_params => header_params,
147
+ :query_params => query_params,
148
+ :form_params => form_params,
149
+ :body => post_body,
150
+ :auth_names => auth_names,
151
+ :return_type => return_type
152
+ )
153
+
154
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
155
+ if @api_client.config.debugging
156
+ @api_client.config.logger.debug "API called: MailboxFiltersApi#management_set_mailbox_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
157
+ end
158
+ return data, status_code, headers
159
+ end
160
+ end
161
+ end