sendmux-management 2.0.1 → 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 (147) hide show
  1. checksums.yaml +4 -4
  2. metadata +13 -224
  3. data/CHANGELOG.md +0 -92
  4. data/LICENSE +0 -21
  5. data/README.md +0 -157
  6. data/lib/sendmux/management/client.rb +0 -77
  7. data/lib/sendmux/management/version.rb +0 -7
  8. data/lib/sendmux/management.rb +0 -12
  9. data/lib/sendmux_management_generated/api/billing_api.rb +0 -221
  10. data/lib/sendmux_management_generated/api/connection_api.rb +0 -82
  11. data/lib/sendmux_management_generated/api/domain_filters_api.rb +0 -161
  12. data/lib/sendmux_management_generated/api/domains_api.rb +0 -492
  13. data/lib/sendmux_management_generated/api/emails_api.rb +0 -258
  14. data/lib/sendmux_management_generated/api/inboxes_api.rb +0 -175
  15. data/lib/sendmux_management_generated/api/mailbox_filters_api.rb +0 -161
  16. data/lib/sendmux_management_generated/api/mailboxes_api.rb +0 -723
  17. data/lib/sendmux_management_generated/api/sending_accounts_api.rb +0 -1009
  18. data/lib/sendmux_management_generated/api/webhooks_api.rb +0 -666
  19. data/lib/sendmux_management_generated/api_client.rb +0 -447
  20. data/lib/sendmux_management_generated/api_error.rb +0 -58
  21. data/lib/sendmux_management_generated/api_model_base.rb +0 -88
  22. data/lib/sendmux_management_generated/configuration.rb +0 -400
  23. data/lib/sendmux_management_generated/models/api_error_detail.rb +0 -219
  24. data/lib/sendmux_management_generated/models/api_error_error.rb +0 -275
  25. data/lib/sendmux_management_generated/models/api_error_meta.rb +0 -164
  26. data/lib/sendmux_management_generated/models/api_error_response.rb +0 -216
  27. data/lib/sendmux_management_generated/models/balance.rb +0 -293
  28. data/lib/sendmux_management_generated/models/balance_auto_topup.rb +0 -226
  29. data/lib/sendmux_management_generated/models/balance_response.rb +0 -223
  30. data/lib/sendmux_management_generated/models/connection.rb +0 -273
  31. data/lib/sendmux_management_generated/models/connection_credential.rb +0 -226
  32. data/lib/sendmux_management_generated/models/connection_mailboxes_inner.rb +0 -190
  33. data/lib/sendmux_management_generated/models/connection_response.rb +0 -223
  34. data/lib/sendmux_management_generated/models/connection_team.rb +0 -190
  35. data/lib/sendmux_management_generated/models/cursor_pagination.rb +0 -173
  36. data/lib/sendmux_management_generated/models/delivery_log_detail.rb +0 -573
  37. data/lib/sendmux_management_generated/models/delivery_log_item.rb +0 -543
  38. data/lib/sendmux_management_generated/models/delivery_log_item_cursor_list_response.rb +0 -251
  39. data/lib/sendmux_management_generated/models/delivery_log_item_response.rb +0 -223
  40. data/lib/sendmux_management_generated/models/delivery_log_recipient.rb +0 -254
  41. data/lib/sendmux_management_generated/models/domain_deleted_response.rb +0 -223
  42. data/lib/sendmux_management_generated/models/domain_deleted_response_all_of_data.rb +0 -190
  43. data/lib/sendmux_management_generated/models/domain_item_cursor_list_response.rb +0 -251
  44. data/lib/sendmux_management_generated/models/domain_item_response.rb +0 -223
  45. data/lib/sendmux_management_generated/models/domain_verify_response.rb +0 -223
  46. data/lib/sendmux_management_generated/models/email_metrics.rb +0 -218
  47. data/lib/sendmux_management_generated/models/email_metrics_comparison.rb +0 -294
  48. data/lib/sendmux_management_generated/models/email_metrics_comparison_change_pct.rb +0 -268
  49. data/lib/sendmux_management_generated/models/email_metrics_response.rb +0 -223
  50. data/lib/sendmux_management_generated/models/email_metrics_summary.rb +0 -268
  51. data/lib/sendmux_management_generated/models/email_metrics_timeseries_inner.rb +0 -294
  52. data/lib/sendmux_management_generated/models/filter_rule.rb +0 -242
  53. data/lib/sendmux_management_generated/models/filter_state.rb +0 -218
  54. data/lib/sendmux_management_generated/models/filter_state_response.rb +0 -223
  55. data/lib/sendmux_management_generated/models/incoming_log_item.rb +0 -465
  56. data/lib/sendmux_management_generated/models/incoming_log_item_cursor_list_response.rb +0 -251
  57. data/lib/sendmux_management_generated/models/incoming_log_item_response.rb +0 -223
  58. data/lib/sendmux_management_generated/models/mailbox.rb +0 -284
  59. data/lib/sendmux_management_generated/models/mailbox_app_password_result.rb +0 -164
  60. data/lib/sendmux_management_generated/models/mailbox_app_password_result_response.rb +0 -223
  61. data/lib/sendmux_management_generated/models/mailbox_availability_reason.rb +0 -45
  62. data/lib/sendmux_management_generated/models/mailbox_availability_response.rb +0 -223
  63. data/lib/sendmux_management_generated/models/mailbox_availability_result.rb +0 -240
  64. data/lib/sendmux_management_generated/models/mailbox_create_result.rb +0 -190
  65. data/lib/sendmux_management_generated/models/mailbox_create_result_response.rb +0 -223
  66. data/lib/sendmux_management_generated/models/mailbox_credential.rb +0 -352
  67. data/lib/sendmux_management_generated/models/mailbox_deleted_response.rb +0 -223
  68. data/lib/sendmux_management_generated/models/mailbox_domain.rb +0 -452
  69. data/lib/sendmux_management_generated/models/mailbox_domain_dns_records.rb +0 -303
  70. data/lib/sendmux_management_generated/models/mailbox_domain_mail_from_records.rb +0 -191
  71. data/lib/sendmux_management_generated/models/mailbox_domain_mx_record.rb +0 -190
  72. data/lib/sendmux_management_generated/models/mailbox_domain_name_value_record.rb +0 -191
  73. data/lib/sendmux_management_generated/models/mailbox_domain_named_mx_record.rb +0 -217
  74. data/lib/sendmux_management_generated/models/mailbox_domain_verify_checks.rb +0 -300
  75. data/lib/sendmux_management_generated/models/mailbox_domain_verify_result.rb +0 -377
  76. data/lib/sendmux_management_generated/models/mailbox_item_cursor_list_response.rb +0 -251
  77. data/lib/sendmux_management_generated/models/mailbox_item_response.rb +0 -223
  78. data/lib/sendmux_management_generated/models/mailbox_key_deleted_response.rb +0 -223
  79. data/lib/sendmux_management_generated/models/mailbox_send_scope.rb +0 -213
  80. data/lib/sendmux_management_generated/models/management_create_domain_request.rb +0 -209
  81. data/lib/sendmux_management_generated/models/management_create_mailbox_key_request.rb +0 -183
  82. data/lib/sendmux_management_generated/models/management_create_mailbox_request.rb +0 -270
  83. data/lib/sendmux_management_generated/models/management_create_mailbox_request_send_scope.rb +0 -214
  84. data/lib/sendmux_management_generated/models/management_test_webhook200_response.rb +0 -223
  85. data/lib/sendmux_management_generated/models/management_update_domain_request.rb +0 -189
  86. data/lib/sendmux_management_generated/models/provider_allowed_actions.rb +0 -294
  87. data/lib/sendmux_management_generated/models/provider_create_body.rb +0 -611
  88. data/lib/sendmux_management_generated/models/provider_create_body_quotas.rb +0 -174
  89. data/lib/sendmux_management_generated/models/provider_create_body_quotas_per_day.rb +0 -104
  90. data/lib/sendmux_management_generated/models/provider_deleted.rb +0 -190
  91. data/lib/sendmux_management_generated/models/provider_deleted_response.rb +0 -223
  92. data/lib/sendmux_management_generated/models/provider_item.rb +0 -733
  93. data/lib/sendmux_management_generated/models/provider_item_cursor_list_response.rb +0 -251
  94. data/lib/sendmux_management_generated/models/provider_item_response.rb +0 -223
  95. data/lib/sendmux_management_generated/models/provider_limits.rb +0 -190
  96. data/lib/sendmux_management_generated/models/provider_limits_response.rb +0 -223
  97. data/lib/sendmux_management_generated/models/provider_list_item.rb +0 -695
  98. data/lib/sendmux_management_generated/models/provider_quota_range.rb +0 -208
  99. data/lib/sendmux_management_generated/models/provider_quotas.rb +0 -186
  100. data/lib/sendmux_management_generated/models/provider_stats.rb +0 -325
  101. data/lib/sendmux_management_generated/models/provider_stats_response.rb +0 -223
  102. data/lib/sendmux_management_generated/models/provider_status_counts.rb +0 -242
  103. data/lib/sendmux_management_generated/models/provider_test_result.rb +0 -251
  104. data/lib/sendmux_management_generated/models/provider_test_result_response.rb +0 -223
  105. data/lib/sendmux_management_generated/models/provider_type_counts.rb +0 -246
  106. data/lib/sendmux_management_generated/models/provider_update_body.rb +0 -569
  107. data/lib/sendmux_management_generated/models/provider_usage.rb +0 -216
  108. data/lib/sendmux_management_generated/models/provider_usage_item.rb +0 -374
  109. data/lib/sendmux_management_generated/models/provider_usage_response.rb +0 -223
  110. data/lib/sendmux_management_generated/models/resource_limit_snapshot.rb +0 -420
  111. data/lib/sendmux_management_generated/models/response_meta.rb +0 -164
  112. data/lib/sendmux_management_generated/models/sending_account_limit_request.rb +0 -190
  113. data/lib/sendmux_management_generated/models/sending_account_limit_request_response.rb +0 -223
  114. data/lib/sendmux_management_generated/models/set_filter_state_body.rb +0 -226
  115. data/lib/sendmux_management_generated/models/shared_amazon_ses_limit.rb +0 -315
  116. data/lib/sendmux_management_generated/models/shared_amazon_ses_limit_request.rb +0 -361
  117. data/lib/sendmux_management_generated/models/shared_amazon_ses_limit_request_cancel.rb +0 -190
  118. data/lib/sendmux_management_generated/models/shared_amazon_ses_limit_request_cancel_response.rb +0 -223
  119. data/lib/sendmux_management_generated/models/shared_amazon_ses_limit_request_create.rb +0 -190
  120. data/lib/sendmux_management_generated/models/shared_amazon_ses_limit_request_create_response.rb +0 -223
  121. data/lib/sendmux_management_generated/models/shared_amazon_ses_limit_request_page.rb +0 -176
  122. data/lib/sendmux_management_generated/models/shared_amazon_ses_limit_request_page_response.rb +0 -223
  123. data/lib/sendmux_management_generated/models/spend_summary.rb +0 -292
  124. data/lib/sendmux_management_generated/models/spend_summary_response.rb +0 -223
  125. data/lib/sendmux_management_generated/models/success_envelope.rb +0 -192
  126. data/lib/sendmux_management_generated/models/transaction.rb +0 -332
  127. data/lib/sendmux_management_generated/models/transaction_cursor_list_response.rb +0 -251
  128. data/lib/sendmux_management_generated/models/update_mailbox_body.rb +0 -211
  129. data/lib/sendmux_management_generated/models/update_mailbox_body_send_scope.rb +0 -214
  130. data/lib/sendmux_management_generated/models/webhook_create_body.rb +0 -269
  131. data/lib/sendmux_management_generated/models/webhook_deleted_response.rb +0 -223
  132. data/lib/sendmux_management_generated/models/webhook_delivery_attempt.rb +0 -562
  133. data/lib/sendmux_management_generated/models/webhook_delivery_attempt_cursor_list_response.rb +0 -251
  134. data/lib/sendmux_management_generated/models/webhook_delivery_payload.rb +0 -359
  135. data/lib/sendmux_management_generated/models/webhook_delivery_payload_response.rb +0 -223
  136. data/lib/sendmux_management_generated/models/webhook_event_data.rb +0 -395
  137. data/lib/sendmux_management_generated/models/webhook_event_payload.rb +0 -297
  138. data/lib/sendmux_management_generated/models/webhook_filters.rb +0 -168
  139. data/lib/sendmux_management_generated/models/webhook_subscription.rb +0 -380
  140. data/lib/sendmux_management_generated/models/webhook_subscription_cursor_list_response.rb +0 -251
  141. data/lib/sendmux_management_generated/models/webhook_subscription_response.rb +0 -223
  142. data/lib/sendmux_management_generated/models/webhook_subscription_with_secret.rb +0 -407
  143. data/lib/sendmux_management_generated/models/webhook_subscription_with_secret_response.rb +0 -223
  144. data/lib/sendmux_management_generated/models/webhook_test_response.rb +0 -165
  145. data/lib/sendmux_management_generated/models/webhook_update_body.rb +0 -233
  146. data/lib/sendmux_management_generated/version.rb +0 -15
  147. data/lib/sendmux_management_generated.rb +0 -181
@@ -1,1009 +0,0 @@
1
- =begin
2
- #Sendmux API
3
-
4
- #Programmatic access to your Sendmux 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 Sendmux::Management::Generated
16
- class SendingAccountsApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
- # Activate a sending account
23
- # Enables a sending account. OAuth accounts without an active connection are moved to pending until reconnected in the dashboard. The shared Amazon SES account can be activated.
24
- # @param public_id [String]
25
- # @param [Hash] opts the optional parameters
26
- # @option opts [String] :idempotency_key
27
- # @return [ProviderItemResponse]
28
- def management_activate_provider(public_id, opts = {})
29
- data, _status_code, _headers = management_activate_provider_with_http_info(public_id, opts)
30
- data
31
- end
32
-
33
- # Activate a sending account
34
- # Enables a sending account. OAuth accounts without an active connection are moved to pending until reconnected in the dashboard. The shared Amazon SES account can be activated.
35
- # @param public_id [String]
36
- # @param [Hash] opts the optional parameters
37
- # @option opts [String] :idempotency_key
38
- # @return [Array<(ProviderItemResponse, Integer, Hash)>] ProviderItemResponse data, response status code and response headers
39
- def management_activate_provider_with_http_info(public_id, opts = {})
40
- if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_activate_provider ...'
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 SendingAccountsApi.management_activate_provider"
46
- end
47
- if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
48
- fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendingAccountsApi.management_activate_provider, the character length must be smaller than or equal to 255.'
49
- end
50
-
51
- # resource path
52
- local_var_path = '/providers/{public_id}/activate'.sub('{public_id}', CGI.escape(public_id.to_s))
53
-
54
- # query parameters
55
- query_params = opts[:query_params] || {}
56
-
57
- # header parameters
58
- header_params = opts[:header_params] || {}
59
- # HTTP header 'Accept' (if needed)
60
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
61
- header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
62
-
63
- # form parameters
64
- form_params = opts[:form_params] || {}
65
-
66
- # http body (model)
67
- post_body = opts[:debug_body]
68
-
69
- # return_type
70
- return_type = opts[:debug_return_type] || 'ProviderItemResponse'
71
-
72
- # auth_names
73
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
74
-
75
- new_options = opts.merge(
76
- :operation => :"SendingAccountsApi.management_activate_provider",
77
- :header_params => header_params,
78
- :query_params => query_params,
79
- :form_params => form_params,
80
- :body => post_body,
81
- :auth_names => auth_names,
82
- :return_type => return_type
83
- )
84
-
85
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
86
- if @api_client.config.debugging
87
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_activate_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
- end
89
- return data, status_code, headers
90
- end
91
-
92
- # Cancel a shared Amazon SES daily limit request
93
- # Cancels a pending shared Amazon SES daily limit increase request for the caller's team. Approved or denied requests cannot be cancelled.
94
- # @param request_id [String]
95
- # @param [Hash] opts the optional parameters
96
- # @return [SharedAmazonSesLimitRequestCancelResponse]
97
- def management_cancel_shared_amazon_ses_limit_request(request_id, opts = {})
98
- data, _status_code, _headers = management_cancel_shared_amazon_ses_limit_request_with_http_info(request_id, opts)
99
- data
100
- end
101
-
102
- # Cancel a shared Amazon SES daily limit request
103
- # Cancels a pending shared Amazon SES daily limit increase request for the caller&#39;s team. Approved or denied requests cannot be cancelled.
104
- # @param request_id [String]
105
- # @param [Hash] opts the optional parameters
106
- # @return [Array<(SharedAmazonSesLimitRequestCancelResponse, Integer, Hash)>] SharedAmazonSesLimitRequestCancelResponse data, response status code and response headers
107
- def management_cancel_shared_amazon_ses_limit_request_with_http_info(request_id, opts = {})
108
- if @api_client.config.debugging
109
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_cancel_shared_amazon_ses_limit_request ...'
110
- end
111
- # verify the required parameter 'request_id' is set
112
- if @api_client.config.client_side_validation && request_id.nil?
113
- fail ArgumentError, "Missing the required parameter 'request_id' when calling SendingAccountsApi.management_cancel_shared_amazon_ses_limit_request"
114
- end
115
- # resource path
116
- local_var_path = '/providers/shared-amazon-ses-limit-request/{request_id}'.sub('{request_id}', CGI.escape(request_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
-
126
- # form parameters
127
- form_params = opts[:form_params] || {}
128
-
129
- # http body (model)
130
- post_body = opts[:debug_body]
131
-
132
- # return_type
133
- return_type = opts[:debug_return_type] || 'SharedAmazonSesLimitRequestCancelResponse'
134
-
135
- # auth_names
136
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
137
-
138
- new_options = opts.merge(
139
- :operation => :"SendingAccountsApi.management_cancel_shared_amazon_ses_limit_request",
140
- :header_params => header_params,
141
- :query_params => query_params,
142
- :form_params => form_params,
143
- :body => post_body,
144
- :auth_names => auth_names,
145
- :return_type => return_type
146
- )
147
-
148
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
149
- if @api_client.config.debugging
150
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_cancel_shared_amazon_ses_limit_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
151
- end
152
- return data, status_code, headers
153
- end
154
-
155
- # Create an SMTP sending account
156
- # Creates a custom SMTP sending account. Supply an `Idempotency-Key` header to safely retry on network errors. The SMTP password is stored securely and is never returned.
157
- # @param [Hash] opts the optional parameters
158
- # @option opts [String] :idempotency_key
159
- # @option opts [ProviderCreateBody] :provider_create_body
160
- # @return [ProviderItemResponse]
161
- def management_create_provider(opts = {})
162
- data, _status_code, _headers = management_create_provider_with_http_info(opts)
163
- data
164
- end
165
-
166
- # Create an SMTP sending account
167
- # Creates a custom SMTP sending account. Supply an &#x60;Idempotency-Key&#x60; header to safely retry on network errors. The SMTP password is stored securely and is never returned.
168
- # @param [Hash] opts the optional parameters
169
- # @option opts [String] :idempotency_key
170
- # @option opts [ProviderCreateBody] :provider_create_body
171
- # @return [Array<(ProviderItemResponse, Integer, Hash)>] ProviderItemResponse data, response status code and response headers
172
- def management_create_provider_with_http_info(opts = {})
173
- if @api_client.config.debugging
174
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_create_provider ...'
175
- end
176
- if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
177
- fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendingAccountsApi.management_create_provider, the character length must be smaller than or equal to 255.'
178
- end
179
-
180
- # resource path
181
- local_var_path = '/providers'
182
-
183
- # query parameters
184
- query_params = opts[:query_params] || {}
185
-
186
- # header parameters
187
- header_params = opts[:header_params] || {}
188
- # HTTP header 'Accept' (if needed)
189
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
190
- # HTTP header 'Content-Type'
191
- content_type = @api_client.select_header_content_type(['application/json'])
192
- if !content_type.nil?
193
- header_params['Content-Type'] = content_type
194
- end
195
- header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
196
-
197
- # form parameters
198
- form_params = opts[:form_params] || {}
199
-
200
- # http body (model)
201
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'provider_create_body'])
202
-
203
- # return_type
204
- return_type = opts[:debug_return_type] || 'ProviderItemResponse'
205
-
206
- # auth_names
207
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
208
-
209
- new_options = opts.merge(
210
- :operation => :"SendingAccountsApi.management_create_provider",
211
- :header_params => header_params,
212
- :query_params => query_params,
213
- :form_params => form_params,
214
- :body => post_body,
215
- :auth_names => auth_names,
216
- :return_type => return_type
217
- )
218
-
219
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
220
- if @api_client.config.debugging
221
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_create_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
222
- end
223
- return data, status_code, headers
224
- end
225
-
226
- # Request a shared Amazon SES daily limit increase
227
- # Creates a review request for the shared Amazon SES daily sending limit. This does not modify the limit directly.
228
- # @param [Hash] opts the optional parameters
229
- # @option opts [String] :idempotency_key
230
- # @return [SharedAmazonSesLimitRequestCreateResponse]
231
- def management_create_shared_amazon_ses_limit_request(opts = {})
232
- data, _status_code, _headers = management_create_shared_amazon_ses_limit_request_with_http_info(opts)
233
- data
234
- end
235
-
236
- # Request a shared Amazon SES daily limit increase
237
- # Creates a review request for the shared Amazon SES daily sending limit. This does not modify the limit directly.
238
- # @param [Hash] opts the optional parameters
239
- # @option opts [String] :idempotency_key
240
- # @return [Array<(SharedAmazonSesLimitRequestCreateResponse, Integer, Hash)>] SharedAmazonSesLimitRequestCreateResponse data, response status code and response headers
241
- def management_create_shared_amazon_ses_limit_request_with_http_info(opts = {})
242
- if @api_client.config.debugging
243
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_create_shared_amazon_ses_limit_request ...'
244
- end
245
- if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
246
- fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendingAccountsApi.management_create_shared_amazon_ses_limit_request, the character length must be smaller than or equal to 255.'
247
- end
248
-
249
- # resource path
250
- local_var_path = '/providers/shared-amazon-ses-limit-request'
251
-
252
- # query parameters
253
- query_params = opts[:query_params] || {}
254
-
255
- # header parameters
256
- header_params = opts[:header_params] || {}
257
- # HTTP header 'Accept' (if needed)
258
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
259
- header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
260
-
261
- # form parameters
262
- form_params = opts[:form_params] || {}
263
-
264
- # http body (model)
265
- post_body = opts[:debug_body]
266
-
267
- # return_type
268
- return_type = opts[:debug_return_type] || 'SharedAmazonSesLimitRequestCreateResponse'
269
-
270
- # auth_names
271
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
272
-
273
- new_options = opts.merge(
274
- :operation => :"SendingAccountsApi.management_create_shared_amazon_ses_limit_request",
275
- :header_params => header_params,
276
- :query_params => query_params,
277
- :form_params => form_params,
278
- :body => post_body,
279
- :auth_names => auth_names,
280
- :return_type => return_type
281
- )
282
-
283
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
284
- if @api_client.config.debugging
285
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_create_shared_amazon_ses_limit_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
286
- end
287
- return data, status_code, headers
288
- end
289
-
290
- # Deactivate a sending account
291
- # Disables a sending account. The shared Amazon SES account can be deactivated.
292
- # @param public_id [String]
293
- # @param [Hash] opts the optional parameters
294
- # @option opts [String] :idempotency_key
295
- # @return [ProviderItemResponse]
296
- def management_deactivate_provider(public_id, opts = {})
297
- data, _status_code, _headers = management_deactivate_provider_with_http_info(public_id, opts)
298
- data
299
- end
300
-
301
- # Deactivate a sending account
302
- # Disables a sending account. The shared Amazon SES account can be deactivated.
303
- # @param public_id [String]
304
- # @param [Hash] opts the optional parameters
305
- # @option opts [String] :idempotency_key
306
- # @return [Array<(ProviderItemResponse, Integer, Hash)>] ProviderItemResponse data, response status code and response headers
307
- def management_deactivate_provider_with_http_info(public_id, opts = {})
308
- if @api_client.config.debugging
309
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_deactivate_provider ...'
310
- end
311
- # verify the required parameter 'public_id' is set
312
- if @api_client.config.client_side_validation && public_id.nil?
313
- fail ArgumentError, "Missing the required parameter 'public_id' when calling SendingAccountsApi.management_deactivate_provider"
314
- end
315
- if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
316
- fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendingAccountsApi.management_deactivate_provider, the character length must be smaller than or equal to 255.'
317
- end
318
-
319
- # resource path
320
- local_var_path = '/providers/{public_id}/deactivate'.sub('{public_id}', CGI.escape(public_id.to_s))
321
-
322
- # query parameters
323
- query_params = opts[:query_params] || {}
324
-
325
- # header parameters
326
- header_params = opts[:header_params] || {}
327
- # HTTP header 'Accept' (if needed)
328
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
329
- header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
330
-
331
- # form parameters
332
- form_params = opts[:form_params] || {}
333
-
334
- # http body (model)
335
- post_body = opts[:debug_body]
336
-
337
- # return_type
338
- return_type = opts[:debug_return_type] || 'ProviderItemResponse'
339
-
340
- # auth_names
341
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
342
-
343
- new_options = opts.merge(
344
- :operation => :"SendingAccountsApi.management_deactivate_provider",
345
- :header_params => header_params,
346
- :query_params => query_params,
347
- :form_params => form_params,
348
- :body => post_body,
349
- :auth_names => auth_names,
350
- :return_type => return_type
351
- )
352
-
353
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
354
- if @api_client.config.debugging
355
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_deactivate_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
356
- end
357
- return data, status_code, headers
358
- end
359
-
360
- # Delete a sending account
361
- # Deletes a custom or connected sending account. The shared Amazon SES account cannot be deleted.
362
- # @param public_id [String]
363
- # @param [Hash] opts the optional parameters
364
- # @return [ProviderDeletedResponse]
365
- def management_delete_provider(public_id, opts = {})
366
- data, _status_code, _headers = management_delete_provider_with_http_info(public_id, opts)
367
- data
368
- end
369
-
370
- # Delete a sending account
371
- # Deletes a custom or connected sending account. The shared Amazon SES account cannot be deleted.
372
- # @param public_id [String]
373
- # @param [Hash] opts the optional parameters
374
- # @return [Array<(ProviderDeletedResponse, Integer, Hash)>] ProviderDeletedResponse data, response status code and response headers
375
- def management_delete_provider_with_http_info(public_id, opts = {})
376
- if @api_client.config.debugging
377
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_delete_provider ...'
378
- end
379
- # verify the required parameter 'public_id' is set
380
- if @api_client.config.client_side_validation && public_id.nil?
381
- fail ArgumentError, "Missing the required parameter 'public_id' when calling SendingAccountsApi.management_delete_provider"
382
- end
383
- # resource path
384
- local_var_path = '/providers/{public_id}'.sub('{public_id}', CGI.escape(public_id.to_s))
385
-
386
- # query parameters
387
- query_params = opts[:query_params] || {}
388
-
389
- # header parameters
390
- header_params = opts[:header_params] || {}
391
- # HTTP header 'Accept' (if needed)
392
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
393
-
394
- # form parameters
395
- form_params = opts[:form_params] || {}
396
-
397
- # http body (model)
398
- post_body = opts[:debug_body]
399
-
400
- # return_type
401
- return_type = opts[:debug_return_type] || 'ProviderDeletedResponse'
402
-
403
- # auth_names
404
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
405
-
406
- new_options = opts.merge(
407
- :operation => :"SendingAccountsApi.management_delete_provider",
408
- :header_params => header_params,
409
- :query_params => query_params,
410
- :form_params => form_params,
411
- :body => post_body,
412
- :auth_names => auth_names,
413
- :return_type => return_type
414
- )
415
-
416
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
417
- if @api_client.config.debugging
418
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_delete_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
419
- end
420
- return data, status_code, headers
421
- end
422
-
423
- # Get a sending account
424
- # Returns one sending account. Responses include an ETag for conditional GET and optimistic PATCH.
425
- # @param public_id [String]
426
- # @param [Hash] opts the optional parameters
427
- # @option opts [String] :if_none_match
428
- # @return [ProviderItemResponse]
429
- def management_get_provider(public_id, opts = {})
430
- data, _status_code, _headers = management_get_provider_with_http_info(public_id, opts)
431
- data
432
- end
433
-
434
- # Get a sending account
435
- # Returns one sending account. Responses include an ETag for conditional GET and optimistic PATCH.
436
- # @param public_id [String]
437
- # @param [Hash] opts the optional parameters
438
- # @option opts [String] :if_none_match
439
- # @return [Array<(ProviderItemResponse, Integer, Hash)>] ProviderItemResponse data, response status code and response headers
440
- def management_get_provider_with_http_info(public_id, opts = {})
441
- if @api_client.config.debugging
442
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_get_provider ...'
443
- end
444
- # verify the required parameter 'public_id' is set
445
- if @api_client.config.client_side_validation && public_id.nil?
446
- fail ArgumentError, "Missing the required parameter 'public_id' when calling SendingAccountsApi.management_get_provider"
447
- end
448
- # resource path
449
- local_var_path = '/providers/{public_id}'.sub('{public_id}', CGI.escape(public_id.to_s))
450
-
451
- # query parameters
452
- query_params = opts[:query_params] || {}
453
-
454
- # header parameters
455
- header_params = opts[:header_params] || {}
456
- # HTTP header 'Accept' (if needed)
457
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
458
- header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
459
-
460
- # form parameters
461
- form_params = opts[:form_params] || {}
462
-
463
- # http body (model)
464
- post_body = opts[:debug_body]
465
-
466
- # return_type
467
- return_type = opts[:debug_return_type] || 'ProviderItemResponse'
468
-
469
- # auth_names
470
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
471
-
472
- new_options = opts.merge(
473
- :operation => :"SendingAccountsApi.management_get_provider",
474
- :header_params => header_params,
475
- :query_params => query_params,
476
- :form_params => form_params,
477
- :body => post_body,
478
- :auth_names => auth_names,
479
- :return_type => return_type
480
- )
481
-
482
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
483
- if @api_client.config.debugging
484
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_get_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
485
- end
486
- return data, status_code, headers
487
- end
488
-
489
- # Get sending account limits
490
- # Returns custom-account capacity and shared Amazon SES daily sending limit state.
491
- # @param [Hash] opts the optional parameters
492
- # @return [ProviderLimitsResponse]
493
- def management_get_provider_limits(opts = {})
494
- data, _status_code, _headers = management_get_provider_limits_with_http_info(opts)
495
- data
496
- end
497
-
498
- # Get sending account limits
499
- # Returns custom-account capacity and shared Amazon SES daily sending limit state.
500
- # @param [Hash] opts the optional parameters
501
- # @return [Array<(ProviderLimitsResponse, Integer, Hash)>] ProviderLimitsResponse data, response status code and response headers
502
- def management_get_provider_limits_with_http_info(opts = {})
503
- if @api_client.config.debugging
504
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_get_provider_limits ...'
505
- end
506
- # resource path
507
- local_var_path = '/providers/limits'
508
-
509
- # query parameters
510
- query_params = opts[:query_params] || {}
511
-
512
- # header parameters
513
- header_params = opts[:header_params] || {}
514
- # HTTP header 'Accept' (if needed)
515
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
516
-
517
- # form parameters
518
- form_params = opts[:form_params] || {}
519
-
520
- # http body (model)
521
- post_body = opts[:debug_body]
522
-
523
- # return_type
524
- return_type = opts[:debug_return_type] || 'ProviderLimitsResponse'
525
-
526
- # auth_names
527
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
528
-
529
- new_options = opts.merge(
530
- :operation => :"SendingAccountsApi.management_get_provider_limits",
531
- :header_params => header_params,
532
- :query_params => query_params,
533
- :form_params => form_params,
534
- :body => post_body,
535
- :auth_names => auth_names,
536
- :return_type => return_type
537
- )
538
-
539
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
540
- if @api_client.config.debugging
541
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_get_provider_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
542
- end
543
- return data, status_code, headers
544
- end
545
-
546
- # Get sending account statistics
547
- # Returns aggregate counts of configured sending accounts with breakdowns by type and status.
548
- # @param [Hash] opts the optional parameters
549
- # @return [ProviderStatsResponse]
550
- def management_get_provider_stats(opts = {})
551
- data, _status_code, _headers = management_get_provider_stats_with_http_info(opts)
552
- data
553
- end
554
-
555
- # Get sending account statistics
556
- # Returns aggregate counts of configured sending accounts with breakdowns by type and status.
557
- # @param [Hash] opts the optional parameters
558
- # @return [Array<(ProviderStatsResponse, Integer, Hash)>] ProviderStatsResponse data, response status code and response headers
559
- def management_get_provider_stats_with_http_info(opts = {})
560
- if @api_client.config.debugging
561
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_get_provider_stats ...'
562
- end
563
- # resource path
564
- local_var_path = '/providers/stats'
565
-
566
- # query parameters
567
- query_params = opts[:query_params] || {}
568
-
569
- # header parameters
570
- header_params = opts[:header_params] || {}
571
- # HTTP header 'Accept' (if needed)
572
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
573
-
574
- # form parameters
575
- form_params = opts[:form_params] || {}
576
-
577
- # http body (model)
578
- post_body = opts[:debug_body]
579
-
580
- # return_type
581
- return_type = opts[:debug_return_type] || 'ProviderStatsResponse'
582
-
583
- # auth_names
584
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
585
-
586
- new_options = opts.merge(
587
- :operation => :"SendingAccountsApi.management_get_provider_stats",
588
- :header_params => header_params,
589
- :query_params => query_params,
590
- :form_params => form_params,
591
- :body => post_body,
592
- :auth_names => auth_names,
593
- :return_type => return_type
594
- )
595
-
596
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
597
- if @api_client.config.debugging
598
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_get_provider_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
599
- end
600
- return data, status_code, headers
601
- end
602
-
603
- # Get sending account usage
604
- # Returns per-account delivery-log counts for today and the trailing 7-day window.
605
- # @param [Hash] opts the optional parameters
606
- # @return [ProviderUsageResponse]
607
- def management_get_provider_usage(opts = {})
608
- data, _status_code, _headers = management_get_provider_usage_with_http_info(opts)
609
- data
610
- end
611
-
612
- # Get sending account usage
613
- # Returns per-account delivery-log counts for today and the trailing 7-day window.
614
- # @param [Hash] opts the optional parameters
615
- # @return [Array<(ProviderUsageResponse, Integer, Hash)>] ProviderUsageResponse data, response status code and response headers
616
- def management_get_provider_usage_with_http_info(opts = {})
617
- if @api_client.config.debugging
618
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_get_provider_usage ...'
619
- end
620
- # resource path
621
- local_var_path = '/providers/usage'
622
-
623
- # query parameters
624
- query_params = opts[:query_params] || {}
625
-
626
- # header parameters
627
- header_params = opts[:header_params] || {}
628
- # HTTP header 'Accept' (if needed)
629
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
630
-
631
- # form parameters
632
- form_params = opts[:form_params] || {}
633
-
634
- # http body (model)
635
- post_body = opts[:debug_body]
636
-
637
- # return_type
638
- return_type = opts[:debug_return_type] || 'ProviderUsageResponse'
639
-
640
- # auth_names
641
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
642
-
643
- new_options = opts.merge(
644
- :operation => :"SendingAccountsApi.management_get_provider_usage",
645
- :header_params => header_params,
646
- :query_params => query_params,
647
- :form_params => form_params,
648
- :body => post_body,
649
- :auth_names => auth_names,
650
- :return_type => return_type
651
- )
652
-
653
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
654
- if @api_client.config.debugging
655
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_get_provider_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
656
- end
657
- return data, status_code, headers
658
- end
659
-
660
- # Get shared Amazon SES limit request state
661
- # Returns the shared Amazon SES daily limit state and any pending increase request.
662
- # @param [Hash] opts the optional parameters
663
- # @return [SharedAmazonSesLimitRequestPageResponse]
664
- def management_get_shared_amazon_ses_limit_request(opts = {})
665
- data, _status_code, _headers = management_get_shared_amazon_ses_limit_request_with_http_info(opts)
666
- data
667
- end
668
-
669
- # Get shared Amazon SES limit request state
670
- # Returns the shared Amazon SES daily limit state and any pending increase request.
671
- # @param [Hash] opts the optional parameters
672
- # @return [Array<(SharedAmazonSesLimitRequestPageResponse, Integer, Hash)>] SharedAmazonSesLimitRequestPageResponse data, response status code and response headers
673
- def management_get_shared_amazon_ses_limit_request_with_http_info(opts = {})
674
- if @api_client.config.debugging
675
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_get_shared_amazon_ses_limit_request ...'
676
- end
677
- # resource path
678
- local_var_path = '/providers/shared-amazon-ses-limit-request'
679
-
680
- # query parameters
681
- query_params = opts[:query_params] || {}
682
-
683
- # header parameters
684
- header_params = opts[:header_params] || {}
685
- # HTTP header 'Accept' (if needed)
686
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
687
-
688
- # form parameters
689
- form_params = opts[:form_params] || {}
690
-
691
- # http body (model)
692
- post_body = opts[:debug_body]
693
-
694
- # return_type
695
- return_type = opts[:debug_return_type] || 'SharedAmazonSesLimitRequestPageResponse'
696
-
697
- # auth_names
698
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
699
-
700
- new_options = opts.merge(
701
- :operation => :"SendingAccountsApi.management_get_shared_amazon_ses_limit_request",
702
- :header_params => header_params,
703
- :query_params => query_params,
704
- :form_params => form_params,
705
- :body => post_body,
706
- :auth_names => auth_names,
707
- :return_type => return_type
708
- )
709
-
710
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
711
- if @api_client.config.debugging
712
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_get_shared_amazon_ses_limit_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
713
- end
714
- return data, status_code, headers
715
- end
716
-
717
- # List sending accounts
718
- # Returns a cursor-paginated list of sending accounts. Credentials are never returned. The shared Amazon SES account is included and marked with `is_shared: true`.
719
- # @param [Hash] opts the optional parameters
720
- # @option opts [String] :cursor
721
- # @option opts [String] :status
722
- # @option opts [String] :type
723
- # @option opts [Integer] :limit
724
- # @return [ProviderItemCursorListResponse]
725
- def management_list_providers(opts = {})
726
- data, _status_code, _headers = management_list_providers_with_http_info(opts)
727
- data
728
- end
729
-
730
- # List sending accounts
731
- # Returns a cursor-paginated list of sending accounts. Credentials are never returned. The shared Amazon SES account is included and marked with &#x60;is_shared: true&#x60;.
732
- # @param [Hash] opts the optional parameters
733
- # @option opts [String] :cursor
734
- # @option opts [String] :status
735
- # @option opts [String] :type
736
- # @option opts [Integer] :limit
737
- # @return [Array<(ProviderItemCursorListResponse, Integer, Hash)>] ProviderItemCursorListResponse data, response status code and response headers
738
- def management_list_providers_with_http_info(opts = {})
739
- if @api_client.config.debugging
740
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_list_providers ...'
741
- end
742
- allowable_values = ["active", "inactive", "error", "pending", "unknown_default_open_api"]
743
- if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
744
- fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
745
- end
746
- allowable_values = ["smtp", "gmail_api", "outlook_api", "amazon_ses", "unknown_default_open_api"]
747
- if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
748
- fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
749
- end
750
- if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
751
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SendingAccountsApi.management_list_providers, must be smaller than or equal to 100.'
752
- end
753
-
754
- if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
755
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SendingAccountsApi.management_list_providers, must be greater than or equal to 1.'
756
- end
757
-
758
- # resource path
759
- local_var_path = '/providers'
760
-
761
- # query parameters
762
- query_params = opts[:query_params] || {}
763
- query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
764
- query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
765
- query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
766
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
767
-
768
- # header parameters
769
- header_params = opts[:header_params] || {}
770
- # HTTP header 'Accept' (if needed)
771
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
772
-
773
- # form parameters
774
- form_params = opts[:form_params] || {}
775
-
776
- # http body (model)
777
- post_body = opts[:debug_body]
778
-
779
- # return_type
780
- return_type = opts[:debug_return_type] || 'ProviderItemCursorListResponse'
781
-
782
- # auth_names
783
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
784
-
785
- new_options = opts.merge(
786
- :operation => :"SendingAccountsApi.management_list_providers",
787
- :header_params => header_params,
788
- :query_params => query_params,
789
- :form_params => form_params,
790
- :body => post_body,
791
- :auth_names => auth_names,
792
- :return_type => return_type
793
- )
794
-
795
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
796
- if @api_client.config.debugging
797
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_list_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
798
- end
799
- return data, status_code, headers
800
- end
801
-
802
- # Request a sending account limit increase
803
- # Creates a request to increase the number of custom or connected sending accounts allowed for the team.
804
- # @param [Hash] opts the optional parameters
805
- # @option opts [String] :idempotency_key
806
- # @return [SendingAccountLimitRequestResponse]
807
- def management_request_sending_account_limit_increase(opts = {})
808
- data, _status_code, _headers = management_request_sending_account_limit_increase_with_http_info(opts)
809
- data
810
- end
811
-
812
- # Request a sending account limit increase
813
- # Creates a request to increase the number of custom or connected sending accounts allowed for the team.
814
- # @param [Hash] opts the optional parameters
815
- # @option opts [String] :idempotency_key
816
- # @return [Array<(SendingAccountLimitRequestResponse, Integer, Hash)>] SendingAccountLimitRequestResponse data, response status code and response headers
817
- def management_request_sending_account_limit_increase_with_http_info(opts = {})
818
- if @api_client.config.debugging
819
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_request_sending_account_limit_increase ...'
820
- end
821
- if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
822
- fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendingAccountsApi.management_request_sending_account_limit_increase, the character length must be smaller than or equal to 255.'
823
- end
824
-
825
- # resource path
826
- local_var_path = '/providers/limits/sending-accounts/request-increase'
827
-
828
- # query parameters
829
- query_params = opts[:query_params] || {}
830
-
831
- # header parameters
832
- header_params = opts[:header_params] || {}
833
- # HTTP header 'Accept' (if needed)
834
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
835
- header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
836
-
837
- # form parameters
838
- form_params = opts[:form_params] || {}
839
-
840
- # http body (model)
841
- post_body = opts[:debug_body]
842
-
843
- # return_type
844
- return_type = opts[:debug_return_type] || 'SendingAccountLimitRequestResponse'
845
-
846
- # auth_names
847
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
848
-
849
- new_options = opts.merge(
850
- :operation => :"SendingAccountsApi.management_request_sending_account_limit_increase",
851
- :header_params => header_params,
852
- :query_params => query_params,
853
- :form_params => form_params,
854
- :body => post_body,
855
- :auth_names => auth_names,
856
- :return_type => return_type
857
- )
858
-
859
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
860
- if @api_client.config.debugging
861
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_request_sending_account_limit_increase\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
862
- end
863
- return data, status_code, headers
864
- end
865
-
866
- # Test an SMTP sending account
867
- # Runs a connection test for a custom SMTP account. The shared Amazon SES account and OAuth accounts cannot be tested through this endpoint.
868
- # @param public_id [String]
869
- # @param [Hash] opts the optional parameters
870
- # @option opts [String] :idempotency_key
871
- # @return [ProviderTestResultResponse]
872
- def management_test_provider(public_id, opts = {})
873
- data, _status_code, _headers = management_test_provider_with_http_info(public_id, opts)
874
- data
875
- end
876
-
877
- # Test an SMTP sending account
878
- # Runs a connection test for a custom SMTP account. The shared Amazon SES account and OAuth accounts cannot be tested through this endpoint.
879
- # @param public_id [String]
880
- # @param [Hash] opts the optional parameters
881
- # @option opts [String] :idempotency_key
882
- # @return [Array<(ProviderTestResultResponse, Integer, Hash)>] ProviderTestResultResponse data, response status code and response headers
883
- def management_test_provider_with_http_info(public_id, opts = {})
884
- if @api_client.config.debugging
885
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_test_provider ...'
886
- end
887
- # verify the required parameter 'public_id' is set
888
- if @api_client.config.client_side_validation && public_id.nil?
889
- fail ArgumentError, "Missing the required parameter 'public_id' when calling SendingAccountsApi.management_test_provider"
890
- end
891
- if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
892
- fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendingAccountsApi.management_test_provider, the character length must be smaller than or equal to 255.'
893
- end
894
-
895
- # resource path
896
- local_var_path = '/providers/{public_id}/test'.sub('{public_id}', CGI.escape(public_id.to_s))
897
-
898
- # query parameters
899
- query_params = opts[:query_params] || {}
900
-
901
- # header parameters
902
- header_params = opts[:header_params] || {}
903
- # HTTP header 'Accept' (if needed)
904
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
905
- header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
906
-
907
- # form parameters
908
- form_params = opts[:form_params] || {}
909
-
910
- # http body (model)
911
- post_body = opts[:debug_body]
912
-
913
- # return_type
914
- return_type = opts[:debug_return_type] || 'ProviderTestResultResponse'
915
-
916
- # auth_names
917
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
918
-
919
- new_options = opts.merge(
920
- :operation => :"SendingAccountsApi.management_test_provider",
921
- :header_params => header_params,
922
- :query_params => query_params,
923
- :form_params => form_params,
924
- :body => post_body,
925
- :auth_names => auth_names,
926
- :return_type => return_type
927
- )
928
-
929
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
930
- if @api_client.config.debugging
931
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_test_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
932
- end
933
- return data, status_code, headers
934
- end
935
-
936
- # Update a sending account
937
- # Updates a custom sending account or replaces variables on the shared Amazon SES account. Shared-account connection settings cannot be edited; use activate/deactivate and the limit-request endpoint for its other allowed actions.
938
- # @param public_id [String]
939
- # @param [Hash] opts the optional parameters
940
- # @option opts [String] :if_match
941
- # @option opts [ProviderUpdateBody] :provider_update_body
942
- # @return [ProviderItemResponse]
943
- def management_update_provider(public_id, opts = {})
944
- data, _status_code, _headers = management_update_provider_with_http_info(public_id, opts)
945
- data
946
- end
947
-
948
- # Update a sending account
949
- # Updates a custom sending account or replaces variables on the shared Amazon SES account. Shared-account connection settings cannot be edited; use activate/deactivate and the limit-request endpoint for its other allowed actions.
950
- # @param public_id [String]
951
- # @param [Hash] opts the optional parameters
952
- # @option opts [String] :if_match
953
- # @option opts [ProviderUpdateBody] :provider_update_body
954
- # @return [Array<(ProviderItemResponse, Integer, Hash)>] ProviderItemResponse data, response status code and response headers
955
- def management_update_provider_with_http_info(public_id, opts = {})
956
- if @api_client.config.debugging
957
- @api_client.config.logger.debug 'Calling API: SendingAccountsApi.management_update_provider ...'
958
- end
959
- # verify the required parameter 'public_id' is set
960
- if @api_client.config.client_side_validation && public_id.nil?
961
- fail ArgumentError, "Missing the required parameter 'public_id' when calling SendingAccountsApi.management_update_provider"
962
- end
963
- # resource path
964
- local_var_path = '/providers/{public_id}'.sub('{public_id}', CGI.escape(public_id.to_s))
965
-
966
- # query parameters
967
- query_params = opts[:query_params] || {}
968
-
969
- # header parameters
970
- header_params = opts[:header_params] || {}
971
- # HTTP header 'Accept' (if needed)
972
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
973
- # HTTP header 'Content-Type'
974
- content_type = @api_client.select_header_content_type(['application/json'])
975
- if !content_type.nil?
976
- header_params['Content-Type'] = content_type
977
- end
978
- header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
979
-
980
- # form parameters
981
- form_params = opts[:form_params] || {}
982
-
983
- # http body (model)
984
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'provider_update_body'])
985
-
986
- # return_type
987
- return_type = opts[:debug_return_type] || 'ProviderItemResponse'
988
-
989
- # auth_names
990
- auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
991
-
992
- new_options = opts.merge(
993
- :operation => :"SendingAccountsApi.management_update_provider",
994
- :header_params => header_params,
995
- :query_params => query_params,
996
- :form_params => form_params,
997
- :body => post_body,
998
- :auth_names => auth_names,
999
- :return_type => return_type
1000
- )
1001
-
1002
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1003
- if @api_client.config.debugging
1004
- @api_client.config.logger.debug "API called: SendingAccountsApi#management_update_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1005
- end
1006
- return data, status_code, headers
1007
- end
1008
- end
1009
- end