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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +100 -0
- data/LICENSE +21 -0
- data/README.md +157 -0
- data/lib/qubrics/management/client.rb +99 -0
- data/lib/qubrics/management/version.rb +7 -0
- data/lib/qubrics/management.rb +12 -0
- data/lib/qubrics_management_generated/api/billing_api.rb +221 -0
- data/lib/qubrics_management_generated/api/connection_api.rb +82 -0
- data/lib/qubrics_management_generated/api/domain_filters_api.rb +161 -0
- data/lib/qubrics_management_generated/api/domains_api.rb +492 -0
- data/lib/qubrics_management_generated/api/emails_api.rb +258 -0
- data/lib/qubrics_management_generated/api/inboxes_api.rb +175 -0
- data/lib/qubrics_management_generated/api/mailbox_filters_api.rb +161 -0
- data/lib/qubrics_management_generated/api/mailboxes_api.rb +996 -0
- data/lib/qubrics_management_generated/api/sending_accounts_api.rb +1009 -0
- data/lib/qubrics_management_generated/api/webhooks_api.rb +666 -0
- data/lib/qubrics_management_generated/api_client.rb +447 -0
- data/lib/qubrics_management_generated/api_error.rb +58 -0
- data/lib/qubrics_management_generated/api_model_base.rb +95 -0
- data/lib/qubrics_management_generated/configuration.rb +400 -0
- data/lib/qubrics_management_generated/models/api_error_detail.rb +219 -0
- data/lib/qubrics_management_generated/models/api_error_error.rb +275 -0
- data/lib/qubrics_management_generated/models/api_error_meta.rb +164 -0
- data/lib/qubrics_management_generated/models/api_error_response.rb +216 -0
- data/lib/qubrics_management_generated/models/balance.rb +293 -0
- data/lib/qubrics_management_generated/models/balance_auto_topup.rb +226 -0
- data/lib/qubrics_management_generated/models/balance_response.rb +223 -0
- data/lib/qubrics_management_generated/models/connection.rb +273 -0
- data/lib/qubrics_management_generated/models/connection_credential.rb +226 -0
- data/lib/qubrics_management_generated/models/connection_mailboxes_inner.rb +190 -0
- data/lib/qubrics_management_generated/models/connection_response.rb +223 -0
- data/lib/qubrics_management_generated/models/connection_team.rb +190 -0
- data/lib/qubrics_management_generated/models/cursor_pagination.rb +173 -0
- data/lib/qubrics_management_generated/models/delivery_log_detail.rb +573 -0
- data/lib/qubrics_management_generated/models/delivery_log_item.rb +543 -0
- data/lib/qubrics_management_generated/models/delivery_log_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/delivery_log_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/delivery_log_recipient.rb +254 -0
- data/lib/qubrics_management_generated/models/domain_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/domain_deleted_response_all_of_data.rb +190 -0
- data/lib/qubrics_management_generated/models/domain_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/domain_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/domain_verify_response.rb +223 -0
- data/lib/qubrics_management_generated/models/email_metrics.rb +218 -0
- data/lib/qubrics_management_generated/models/email_metrics_comparison.rb +294 -0
- data/lib/qubrics_management_generated/models/email_metrics_comparison_change_pct.rb +268 -0
- data/lib/qubrics_management_generated/models/email_metrics_response.rb +223 -0
- data/lib/qubrics_management_generated/models/email_metrics_summary.rb +268 -0
- data/lib/qubrics_management_generated/models/email_metrics_timeseries_inner.rb +294 -0
- data/lib/qubrics_management_generated/models/filter_rule.rb +242 -0
- data/lib/qubrics_management_generated/models/filter_state.rb +218 -0
- data/lib/qubrics_management_generated/models/filter_state_response.rb +223 -0
- data/lib/qubrics_management_generated/models/incoming_log_item.rb +465 -0
- data/lib/qubrics_management_generated/models/incoming_log_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/incoming_log_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mail_webhook_event_payload.rb +296 -0
- data/lib/qubrics_management_generated/models/mailbox.rb +284 -0
- data/lib/qubrics_management_generated/models/mailbox_app_password_result.rb +164 -0
- data/lib/qubrics_management_generated/models/mailbox_app_password_result_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_availability_reason.rb +45 -0
- data/lib/qubrics_management_generated/models/mailbox_availability_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_availability_result.rb +240 -0
- data/lib/qubrics_management_generated/models/mailbox_cost_usage.rb +409 -0
- data/lib/qubrics_management_generated/models/mailbox_cost_usage_incoming.rb +422 -0
- data/lib/qubrics_management_generated/models/mailbox_cost_usage_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_cost_usage_storage.rb +299 -0
- data/lib/qubrics_management_generated/models/mailbox_create_result.rb +190 -0
- data/lib/qubrics_management_generated/models/mailbox_create_result_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_credential.rb +352 -0
- data/lib/qubrics_management_generated/models/mailbox_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_domain.rb +452 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_dns_records.rb +303 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_mail_from_records.rb +191 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_mx_record.rb +190 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_name_value_record.rb +191 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_named_mx_record.rb +217 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_verify_checks.rb +300 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_verify_result.rb +377 -0
- data/lib/qubrics_management_generated/models/mailbox_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/mailbox_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_key_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy.rb +196 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_allowed_from.rb +213 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_allowed_reply_to.rb +213 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_recipients.rb +158 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_recipients_allow.rb +201 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_recipients_deny.rb +201 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_snapshot.rb +202 -0
- data/lib/qubrics_management_generated/models/mailbox_send_scope.rb +213 -0
- data/lib/qubrics_management_generated/models/management_create_domain_request.rb +209 -0
- data/lib/qubrics_management_generated/models/management_create_mailbox_key_request.rb +183 -0
- data/lib/qubrics_management_generated/models/management_create_mailbox_request.rb +270 -0
- data/lib/qubrics_management_generated/models/management_create_mailbox_request_send_scope.rb +214 -0
- data/lib/qubrics_management_generated/models/management_test_webhook200_response.rb +223 -0
- data/lib/qubrics_management_generated/models/management_update_domain_request.rb +189 -0
- data/lib/qubrics_management_generated/models/provider_allowed_actions.rb +294 -0
- data/lib/qubrics_management_generated/models/provider_create_body.rb +611 -0
- data/lib/qubrics_management_generated/models/provider_create_body_quotas.rb +174 -0
- data/lib/qubrics_management_generated/models/provider_create_body_quotas_per_day.rb +104 -0
- data/lib/qubrics_management_generated/models/provider_deleted.rb +190 -0
- data/lib/qubrics_management_generated/models/provider_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_item.rb +733 -0
- data/lib/qubrics_management_generated/models/provider_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/provider_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_limits.rb +190 -0
- data/lib/qubrics_management_generated/models/provider_limits_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_list_item.rb +695 -0
- data/lib/qubrics_management_generated/models/provider_quota_range.rb +208 -0
- data/lib/qubrics_management_generated/models/provider_quotas.rb +186 -0
- data/lib/qubrics_management_generated/models/provider_stats.rb +325 -0
- data/lib/qubrics_management_generated/models/provider_stats_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_status_counts.rb +242 -0
- data/lib/qubrics_management_generated/models/provider_test_result.rb +251 -0
- data/lib/qubrics_management_generated/models/provider_test_result_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_type_counts.rb +246 -0
- data/lib/qubrics_management_generated/models/provider_update_body.rb +569 -0
- data/lib/qubrics_management_generated/models/provider_usage.rb +216 -0
- data/lib/qubrics_management_generated/models/provider_usage_item.rb +374 -0
- data/lib/qubrics_management_generated/models/provider_usage_response.rb +223 -0
- data/lib/qubrics_management_generated/models/replace_mailbox_send_policy.rb +165 -0
- data/lib/qubrics_management_generated/models/resource_limit_snapshot.rb +420 -0
- data/lib/qubrics_management_generated/models/response_meta.rb +164 -0
- data/lib/qubrics_management_generated/models/sending_account_limit_request.rb +190 -0
- data/lib/qubrics_management_generated/models/sending_account_limit_request_response.rb +223 -0
- data/lib/qubrics_management_generated/models/set_filter_state_body.rb +226 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit.rb +315 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request.rb +361 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_cancel.rb +190 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_cancel_response.rb +223 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_create.rb +190 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_create_response.rb +223 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_page.rb +176 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_page_response.rb +223 -0
- data/lib/qubrics_management_generated/models/spend_summary.rb +292 -0
- data/lib/qubrics_management_generated/models/spend_summary_response.rb +223 -0
- data/lib/qubrics_management_generated/models/success_envelope.rb +192 -0
- data/lib/qubrics_management_generated/models/transaction.rb +332 -0
- data/lib/qubrics_management_generated/models/transaction_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/update_mailbox_body.rb +211 -0
- data/lib/qubrics_management_generated/models/update_mailbox_body_send_scope.rb +214 -0
- data/lib/qubrics_management_generated/models/webhook_create_body.rb +269 -0
- data/lib/qubrics_management_generated/models/webhook_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/webhook_delivery_attempt.rb +560 -0
- data/lib/qubrics_management_generated/models/webhook_delivery_attempt_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/webhook_delivery_payload.rb +337 -0
- data/lib/qubrics_management_generated/models/webhook_delivery_payload_response.rb +223 -0
- data/lib/qubrics_management_generated/models/webhook_event_data.rb +406 -0
- data/lib/qubrics_management_generated/models/webhook_event_payload.rb +304 -0
- data/lib/qubrics_management_generated/models/webhook_filters.rb +168 -0
- data/lib/qubrics_management_generated/models/webhook_subscription.rb +368 -0
- data/lib/qubrics_management_generated/models/webhook_subscription_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/webhook_subscription_response.rb +223 -0
- data/lib/qubrics_management_generated/models/webhook_subscription_with_secret.rb +395 -0
- data/lib/qubrics_management_generated/models/webhook_subscription_with_secret_response.rb +223 -0
- data/lib/qubrics_management_generated/models/webhook_test_response.rb +165 -0
- data/lib/qubrics_management_generated/models/webhook_update_body.rb +233 -0
- data/lib/qubrics_management_generated/version.rb +15 -0
- data/lib/qubrics_management_generated.rb +195 -0
- metadata +283 -0
|
@@ -0,0 +1,82 @@
|
|
|
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 ConnectionApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Get Management connection
|
|
23
|
+
# Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [String] :if_none_match ETag from a previous response. A match returns 304 with no body after rechecking authentication.
|
|
26
|
+
# @return [ConnectionResponse]
|
|
27
|
+
def management_get_connection(opts = {})
|
|
28
|
+
data, _status_code, _headers = management_get_connection_with_http_info(opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Get Management connection
|
|
33
|
+
# Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.
|
|
34
|
+
# @param [Hash] opts the optional parameters
|
|
35
|
+
# @option opts [String] :if_none_match ETag from a previous response. A match returns 304 with no body after rechecking authentication.
|
|
36
|
+
# @return [Array<(ConnectionResponse, Integer, Hash)>] ConnectionResponse data, response status code and response headers
|
|
37
|
+
def management_get_connection_with_http_info(opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: ConnectionApi.management_get_connection ...'
|
|
40
|
+
end
|
|
41
|
+
# resource path
|
|
42
|
+
local_var_path = '/me'
|
|
43
|
+
|
|
44
|
+
# query parameters
|
|
45
|
+
query_params = opts[:query_params] || {}
|
|
46
|
+
|
|
47
|
+
# header parameters
|
|
48
|
+
header_params = opts[:header_params] || {}
|
|
49
|
+
# HTTP header 'Accept' (if needed)
|
|
50
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
51
|
+
header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
|
|
52
|
+
|
|
53
|
+
# form parameters
|
|
54
|
+
form_params = opts[:form_params] || {}
|
|
55
|
+
|
|
56
|
+
# http body (model)
|
|
57
|
+
post_body = opts[:debug_body]
|
|
58
|
+
|
|
59
|
+
# return_type
|
|
60
|
+
return_type = opts[:debug_return_type] || 'ConnectionResponse'
|
|
61
|
+
|
|
62
|
+
# auth_names
|
|
63
|
+
auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
|
|
64
|
+
|
|
65
|
+
new_options = opts.merge(
|
|
66
|
+
:operation => :"ConnectionApi.management_get_connection",
|
|
67
|
+
:header_params => header_params,
|
|
68
|
+
:query_params => query_params,
|
|
69
|
+
:form_params => form_params,
|
|
70
|
+
:body => post_body,
|
|
71
|
+
:auth_names => auth_names,
|
|
72
|
+
:return_type => return_type
|
|
73
|
+
)
|
|
74
|
+
|
|
75
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
76
|
+
if @api_client.config.debugging
|
|
77
|
+
@api_client.config.logger.debug "API called: ConnectionApi#management_get_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
78
|
+
end
|
|
79
|
+
return data, status_code, headers
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
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 DomainFiltersApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Get domain-wide sender filters
|
|
23
|
+
# Returns the current sender-filter mode and rule set applied to every mailbox under this domain. Only sending and receiving domains support domain-wide filters. Per-mailbox rules take precedence at match time. 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_domain_filters(public_id, opts = {})
|
|
29
|
+
data, _status_code, _headers = management_get_domain_filters_with_http_info(public_id, opts)
|
|
30
|
+
data
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Get domain-wide sender filters
|
|
34
|
+
# Returns the current sender-filter mode and rule set applied to every mailbox under this domain. Only sending and receiving domains support domain-wide filters. Per-mailbox rules take precedence at match time. 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.
|
|
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_domain_filters_with_http_info(public_id, opts = {})
|
|
40
|
+
if @api_client.config.debugging
|
|
41
|
+
@api_client.config.logger.debug 'Calling API: DomainFiltersApi.management_get_domain_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 DomainFiltersApi.management_get_domain_filters"
|
|
46
|
+
end
|
|
47
|
+
# resource path
|
|
48
|
+
local_var_path = '/domains/{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 => :"DomainFiltersApi.management_get_domain_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: DomainFiltersApi#management_get_domain_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
84
|
+
end
|
|
85
|
+
return data, status_code, headers
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Replace domain-wide sender filters
|
|
89
|
+
# Atomically replaces the sender-filter mode and rule set for an entire sending and receiving domain. Applies to every mailbox under the domain unless that mailbox has its own per-mailbox rules (which take precedence). Maximum 1000 rules per request. 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_domain_filters(public_id, opts = {})
|
|
96
|
+
data, _status_code, _headers = management_set_domain_filters_with_http_info(public_id, opts)
|
|
97
|
+
data
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Replace domain-wide sender filters
|
|
101
|
+
# Atomically replaces the sender-filter mode and rule set for an entire sending and receiving domain. Applies to every mailbox under the domain unless that mailbox has its own per-mailbox rules (which take precedence). Maximum 1000 rules per request. 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.
|
|
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_domain_filters_with_http_info(public_id, opts = {})
|
|
108
|
+
if @api_client.config.debugging
|
|
109
|
+
@api_client.config.logger.debug 'Calling API: DomainFiltersApi.management_set_domain_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 DomainFiltersApi.management_set_domain_filters"
|
|
114
|
+
end
|
|
115
|
+
# resource path
|
|
116
|
+
local_var_path = '/domains/{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 => :"DomainFiltersApi.management_set_domain_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: DomainFiltersApi#management_set_domain_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
157
|
+
end
|
|
158
|
+
return data, status_code, headers
|
|
159
|
+
end
|
|
160
|
+
end
|
|
161
|
+
end
|