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,315 @@
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 'date'
14
+ require 'time'
15
+
16
+ module Qubrics::Management::Generated
17
+ class SharedAmazonSesLimit < ApiModelBase
18
+ attr_accessor :can_request_increase
19
+
20
+ attr_accessor :daily_limit
21
+
22
+ attr_accessor :is_near_limit
23
+
24
+ attr_accessor :pending_request_id
25
+
26
+ attr_accessor :provider_id
27
+
28
+ attr_accessor :sent_today
29
+
30
+ attr_accessor :threshold_usage
31
+
32
+ attr_accessor :usage_ratio
33
+
34
+ # Attribute mapping from ruby-style variable name to JSON key.
35
+ def self.attribute_map
36
+ {
37
+ :'can_request_increase' => :'can_request_increase',
38
+ :'daily_limit' => :'daily_limit',
39
+ :'is_near_limit' => :'is_near_limit',
40
+ :'pending_request_id' => :'pending_request_id',
41
+ :'provider_id' => :'provider_id',
42
+ :'sent_today' => :'sent_today',
43
+ :'threshold_usage' => :'threshold_usage',
44
+ :'usage_ratio' => :'usage_ratio'
45
+ }
46
+ end
47
+
48
+ # Returns attribute mapping this model knows about
49
+ def self.acceptable_attribute_map
50
+ attribute_map
51
+ end
52
+
53
+ # Returns all the JSON keys this model knows about
54
+ def self.acceptable_attributes
55
+ acceptable_attribute_map.values
56
+ end
57
+
58
+ # Attribute type mapping.
59
+ def self.openapi_types
60
+ {
61
+ :'can_request_increase' => :'Boolean',
62
+ :'daily_limit' => :'Integer',
63
+ :'is_near_limit' => :'Boolean',
64
+ :'pending_request_id' => :'String',
65
+ :'provider_id' => :'String',
66
+ :'sent_today' => :'Integer',
67
+ :'threshold_usage' => :'Integer',
68
+ :'usage_ratio' => :'Float'
69
+ }
70
+ end
71
+
72
+ # List of attributes with nullable: true
73
+ def self.openapi_nullable
74
+ Set.new([
75
+ :'daily_limit',
76
+ :'pending_request_id',
77
+ :'provider_id',
78
+ :'threshold_usage',
79
+ :'usage_ratio'
80
+ ])
81
+ end
82
+
83
+ # Initializes the object
84
+ # @param [Hash] attributes Model attributes in the form of hash
85
+ def initialize(attributes = {})
86
+ if (!attributes.is_a?(Hash))
87
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Qubrics::Management::Generated::SharedAmazonSesLimit` initialize method"
88
+ end
89
+
90
+ # check to see if the attribute exists and convert string to symbol for hash key
91
+ acceptable_attribute_map = self.class.acceptable_attribute_map
92
+ attributes = attributes.each_with_object({}) { |(k, v), h|
93
+ if (!acceptable_attribute_map.key?(k.to_sym))
94
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Qubrics::Management::Generated::SharedAmazonSesLimit`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
95
+ end
96
+ h[k.to_sym] = v
97
+ }
98
+
99
+ if attributes.key?(:'can_request_increase')
100
+ self.can_request_increase = attributes[:'can_request_increase']
101
+ else
102
+ self.can_request_increase = nil
103
+ end
104
+
105
+ if attributes.key?(:'daily_limit')
106
+ self.daily_limit = attributes[:'daily_limit']
107
+ else
108
+ self.daily_limit = nil
109
+ end
110
+
111
+ if attributes.key?(:'is_near_limit')
112
+ self.is_near_limit = attributes[:'is_near_limit']
113
+ else
114
+ self.is_near_limit = nil
115
+ end
116
+
117
+ if attributes.key?(:'pending_request_id')
118
+ self.pending_request_id = attributes[:'pending_request_id']
119
+ else
120
+ self.pending_request_id = nil
121
+ end
122
+
123
+ if attributes.key?(:'provider_id')
124
+ self.provider_id = attributes[:'provider_id']
125
+ else
126
+ self.provider_id = nil
127
+ end
128
+
129
+ if attributes.key?(:'sent_today')
130
+ self.sent_today = attributes[:'sent_today']
131
+ else
132
+ self.sent_today = nil
133
+ end
134
+
135
+ if attributes.key?(:'threshold_usage')
136
+ self.threshold_usage = attributes[:'threshold_usage']
137
+ else
138
+ self.threshold_usage = nil
139
+ end
140
+
141
+ if attributes.key?(:'usage_ratio')
142
+ self.usage_ratio = attributes[:'usage_ratio']
143
+ else
144
+ self.usage_ratio = nil
145
+ end
146
+ end
147
+
148
+ # Show invalid properties with the reasons. Usually used together with valid?
149
+ # @return Array for valid properties with the reasons
150
+ def list_invalid_properties
151
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
152
+ invalid_properties = Array.new
153
+ if @can_request_increase.nil?
154
+ invalid_properties.push('invalid value for "can_request_increase", can_request_increase cannot be nil.')
155
+ end
156
+
157
+ if !@daily_limit.nil? && @daily_limit < 0
158
+ invalid_properties.push('invalid value for "daily_limit", must be greater than or equal to 0.')
159
+ end
160
+
161
+ if @is_near_limit.nil?
162
+ invalid_properties.push('invalid value for "is_near_limit", is_near_limit cannot be nil.')
163
+ end
164
+
165
+ if @sent_today.nil?
166
+ invalid_properties.push('invalid value for "sent_today", sent_today cannot be nil.')
167
+ end
168
+
169
+ if @sent_today < 0
170
+ invalid_properties.push('invalid value for "sent_today", must be greater than or equal to 0.')
171
+ end
172
+
173
+ if !@threshold_usage.nil? && @threshold_usage < 0
174
+ invalid_properties.push('invalid value for "threshold_usage", must be greater than or equal to 0.')
175
+ end
176
+
177
+ invalid_properties
178
+ end
179
+
180
+ # Check to see if the all the properties in the model are valid
181
+ # @return true if the model is valid
182
+ def valid?
183
+ warn '[DEPRECATED] the `valid?` method is obsolete'
184
+ return false if @can_request_increase.nil?
185
+ return false if !@daily_limit.nil? && @daily_limit < 0
186
+ return false if @is_near_limit.nil?
187
+ return false if @sent_today.nil?
188
+ return false if @sent_today < 0
189
+ return false if !@threshold_usage.nil? && @threshold_usage < 0
190
+ true
191
+ end
192
+
193
+ # Custom attribute writer method with validation
194
+ # @param [Object] can_request_increase Value to be assigned
195
+ def can_request_increase=(can_request_increase)
196
+ if can_request_increase.nil?
197
+ fail ArgumentError, 'can_request_increase cannot be nil'
198
+ end
199
+
200
+ @can_request_increase = can_request_increase
201
+ end
202
+
203
+ # Custom attribute writer method with validation
204
+ # @param [Object] daily_limit Value to be assigned
205
+ def daily_limit=(daily_limit)
206
+ if !daily_limit.nil? && daily_limit < 0
207
+ fail ArgumentError, 'invalid value for "daily_limit", must be greater than or equal to 0.'
208
+ end
209
+
210
+ @daily_limit = daily_limit
211
+ end
212
+
213
+ # Custom attribute writer method with validation
214
+ # @param [Object] is_near_limit Value to be assigned
215
+ def is_near_limit=(is_near_limit)
216
+ if is_near_limit.nil?
217
+ fail ArgumentError, 'is_near_limit cannot be nil'
218
+ end
219
+
220
+ @is_near_limit = is_near_limit
221
+ end
222
+
223
+ # Custom attribute writer method with validation
224
+ # @param [Object] sent_today Value to be assigned
225
+ def sent_today=(sent_today)
226
+ if sent_today.nil?
227
+ fail ArgumentError, 'sent_today cannot be nil'
228
+ end
229
+
230
+ if sent_today < 0
231
+ fail ArgumentError, 'invalid value for "sent_today", must be greater than or equal to 0.'
232
+ end
233
+
234
+ @sent_today = sent_today
235
+ end
236
+
237
+ # Custom attribute writer method with validation
238
+ # @param [Object] threshold_usage Value to be assigned
239
+ def threshold_usage=(threshold_usage)
240
+ if !threshold_usage.nil? && threshold_usage < 0
241
+ fail ArgumentError, 'invalid value for "threshold_usage", must be greater than or equal to 0.'
242
+ end
243
+
244
+ @threshold_usage = threshold_usage
245
+ end
246
+
247
+ # Checks equality by comparing each attribute.
248
+ # @param [Object] Object to be compared
249
+ def ==(o)
250
+ return true if self.equal?(o)
251
+ self.class == o.class &&
252
+ can_request_increase == o.can_request_increase &&
253
+ daily_limit == o.daily_limit &&
254
+ is_near_limit == o.is_near_limit &&
255
+ pending_request_id == o.pending_request_id &&
256
+ provider_id == o.provider_id &&
257
+ sent_today == o.sent_today &&
258
+ threshold_usage == o.threshold_usage &&
259
+ usage_ratio == o.usage_ratio
260
+ end
261
+
262
+ # @see the `==` method
263
+ # @param [Object] Object to be compared
264
+ def eql?(o)
265
+ self == o
266
+ end
267
+
268
+ # Calculates hash code according to all attributes.
269
+ # @return [Integer] Hash code
270
+ def hash
271
+ [can_request_increase, daily_limit, is_near_limit, pending_request_id, provider_id, sent_today, threshold_usage, usage_ratio].hash
272
+ end
273
+
274
+ # Builds the object from hash
275
+ # @param [Hash] attributes Model attributes in the form of hash
276
+ # @return [Object] Returns the model itself
277
+ def self.build_from_hash(attributes)
278
+ return nil unless attributes.is_a?(Hash)
279
+ attributes = attributes.transform_keys(&:to_sym)
280
+ transformed_hash = {}
281
+ openapi_types.each_pair do |key, type|
282
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
283
+ transformed_hash["#{key}"] = nil
284
+ elsif type =~ /\AArray<(.*)>/i
285
+ # check to ensure the input is an array given that the attribute
286
+ # is documented as an array but the input is not
287
+ if attributes[attribute_map[key]].is_a?(Array)
288
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
289
+ end
290
+ elsif !attributes[attribute_map[key]].nil?
291
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
292
+ end
293
+ end
294
+ new(transformed_hash)
295
+ end
296
+
297
+ # Returns the object in the form of hash
298
+ # @return [Hash] Returns the object in the form of hash
299
+ def to_hash
300
+ hash = {}
301
+ self.class.attribute_map.each_pair do |attr, param|
302
+ value = self.send(attr)
303
+ if value.nil?
304
+ is_nullable = self.class.openapi_nullable.include?(attr)
305
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
306
+ end
307
+
308
+ hash[param] = _to_hash(value)
309
+ end
310
+ hash
311
+ end
312
+
313
+ end
314
+
315
+ end
@@ -0,0 +1,361 @@
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 'date'
14
+ require 'time'
15
+
16
+ module Qubrics::Management::Generated
17
+ class SharedAmazonSesLimitRequest < ApiModelBase
18
+ attr_accessor :approved_daily_limit
19
+
20
+ attr_accessor :created_at
21
+
22
+ attr_accessor :current_daily_limit
23
+
24
+ attr_accessor :current_daily_sent
25
+
26
+ attr_accessor :decided_at
27
+
28
+ attr_accessor :decision_note
29
+
30
+ attr_accessor :id
31
+
32
+ attr_accessor :status
33
+
34
+ class EnumAttributeValidator
35
+ attr_reader :datatype
36
+ attr_reader :allowable_values
37
+
38
+ def initialize(datatype, allowable_values)
39
+ @allowable_values = allowable_values.map do |value|
40
+ case datatype.to_s
41
+ when /Integer/i
42
+ value.to_i
43
+ when /Float/i
44
+ value.to_f
45
+ else
46
+ value
47
+ end
48
+ end
49
+ end
50
+
51
+ def valid?(value)
52
+ !value || allowable_values.include?(value)
53
+ end
54
+ end
55
+
56
+ # Attribute mapping from ruby-style variable name to JSON key.
57
+ def self.attribute_map
58
+ {
59
+ :'approved_daily_limit' => :'approved_daily_limit',
60
+ :'created_at' => :'created_at',
61
+ :'current_daily_limit' => :'current_daily_limit',
62
+ :'current_daily_sent' => :'current_daily_sent',
63
+ :'decided_at' => :'decided_at',
64
+ :'decision_note' => :'decision_note',
65
+ :'id' => :'id',
66
+ :'status' => :'status'
67
+ }
68
+ end
69
+
70
+ # Returns attribute mapping this model knows about
71
+ def self.acceptable_attribute_map
72
+ attribute_map
73
+ end
74
+
75
+ # Returns all the JSON keys this model knows about
76
+ def self.acceptable_attributes
77
+ acceptable_attribute_map.values
78
+ end
79
+
80
+ # Attribute type mapping.
81
+ def self.openapi_types
82
+ {
83
+ :'approved_daily_limit' => :'Integer',
84
+ :'created_at' => :'String',
85
+ :'current_daily_limit' => :'Integer',
86
+ :'current_daily_sent' => :'Integer',
87
+ :'decided_at' => :'String',
88
+ :'decision_note' => :'String',
89
+ :'id' => :'String',
90
+ :'status' => :'String'
91
+ }
92
+ end
93
+
94
+ # List of attributes with nullable: true
95
+ def self.openapi_nullable
96
+ Set.new([
97
+ :'approved_daily_limit',
98
+ :'decided_at',
99
+ :'decision_note',
100
+ ])
101
+ end
102
+
103
+ # Initializes the object
104
+ # @param [Hash] attributes Model attributes in the form of hash
105
+ def initialize(attributes = {})
106
+ if (!attributes.is_a?(Hash))
107
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Qubrics::Management::Generated::SharedAmazonSesLimitRequest` initialize method"
108
+ end
109
+
110
+ # check to see if the attribute exists and convert string to symbol for hash key
111
+ acceptable_attribute_map = self.class.acceptable_attribute_map
112
+ attributes = attributes.each_with_object({}) { |(k, v), h|
113
+ if (!acceptable_attribute_map.key?(k.to_sym))
114
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Qubrics::Management::Generated::SharedAmazonSesLimitRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
115
+ end
116
+ h[k.to_sym] = v
117
+ }
118
+
119
+ if attributes.key?(:'approved_daily_limit')
120
+ self.approved_daily_limit = attributes[:'approved_daily_limit']
121
+ else
122
+ self.approved_daily_limit = nil
123
+ end
124
+
125
+ if attributes.key?(:'created_at')
126
+ self.created_at = attributes[:'created_at']
127
+ else
128
+ self.created_at = nil
129
+ end
130
+
131
+ if attributes.key?(:'current_daily_limit')
132
+ self.current_daily_limit = attributes[:'current_daily_limit']
133
+ else
134
+ self.current_daily_limit = nil
135
+ end
136
+
137
+ if attributes.key?(:'current_daily_sent')
138
+ self.current_daily_sent = attributes[:'current_daily_sent']
139
+ else
140
+ self.current_daily_sent = nil
141
+ end
142
+
143
+ if attributes.key?(:'decided_at')
144
+ self.decided_at = attributes[:'decided_at']
145
+ else
146
+ self.decided_at = nil
147
+ end
148
+
149
+ if attributes.key?(:'decision_note')
150
+ self.decision_note = attributes[:'decision_note']
151
+ else
152
+ self.decision_note = nil
153
+ end
154
+
155
+ if attributes.key?(:'id')
156
+ self.id = attributes[:'id']
157
+ else
158
+ self.id = nil
159
+ end
160
+
161
+ if attributes.key?(:'status')
162
+ self.status = attributes[:'status']
163
+ else
164
+ self.status = nil
165
+ end
166
+ end
167
+
168
+ # Show invalid properties with the reasons. Usually used together with valid?
169
+ # @return Array for valid properties with the reasons
170
+ def list_invalid_properties
171
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
172
+ invalid_properties = Array.new
173
+ if !@approved_daily_limit.nil? && @approved_daily_limit <= 0
174
+ invalid_properties.push('invalid value for "approved_daily_limit", must be greater than 0.')
175
+ end
176
+
177
+ if @created_at.nil?
178
+ invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
179
+ end
180
+
181
+ if @current_daily_limit.nil?
182
+ invalid_properties.push('invalid value for "current_daily_limit", current_daily_limit cannot be nil.')
183
+ end
184
+
185
+ if @current_daily_limit < 0
186
+ invalid_properties.push('invalid value for "current_daily_limit", must be greater than or equal to 0.')
187
+ end
188
+
189
+ if @current_daily_sent.nil?
190
+ invalid_properties.push('invalid value for "current_daily_sent", current_daily_sent cannot be nil.')
191
+ end
192
+
193
+ if @current_daily_sent < 0
194
+ invalid_properties.push('invalid value for "current_daily_sent", must be greater than or equal to 0.')
195
+ end
196
+
197
+ if @id.nil?
198
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
199
+ end
200
+
201
+ if @status.nil?
202
+ invalid_properties.push('invalid value for "status", status cannot be nil.')
203
+ end
204
+
205
+ invalid_properties
206
+ end
207
+
208
+ # Check to see if the all the properties in the model are valid
209
+ # @return true if the model is valid
210
+ def valid?
211
+ warn '[DEPRECATED] the `valid?` method is obsolete'
212
+ return false if !@approved_daily_limit.nil? && @approved_daily_limit <= 0
213
+ return false if @created_at.nil?
214
+ return false if @current_daily_limit.nil?
215
+ return false if @current_daily_limit < 0
216
+ return false if @current_daily_sent.nil?
217
+ return false if @current_daily_sent < 0
218
+ return false if @id.nil?
219
+ return false if @status.nil?
220
+ status_validator = EnumAttributeValidator.new('String', ["pending", "approved", "denied", "cancelled", "unknown_default_open_api"])
221
+ return false unless status_validator.valid?(@status)
222
+ true
223
+ end
224
+
225
+ # Custom attribute writer method with validation
226
+ # @param [Object] approved_daily_limit Value to be assigned
227
+ def approved_daily_limit=(approved_daily_limit)
228
+ if !approved_daily_limit.nil? && approved_daily_limit <= 0
229
+ fail ArgumentError, 'invalid value for "approved_daily_limit", must be greater than 0.'
230
+ end
231
+
232
+ @approved_daily_limit = approved_daily_limit
233
+ end
234
+
235
+ # Custom attribute writer method with validation
236
+ # @param [Object] created_at Value to be assigned
237
+ def created_at=(created_at)
238
+ if created_at.nil?
239
+ fail ArgumentError, 'created_at cannot be nil'
240
+ end
241
+
242
+ @created_at = created_at
243
+ end
244
+
245
+ # Custom attribute writer method with validation
246
+ # @param [Object] current_daily_limit Value to be assigned
247
+ def current_daily_limit=(current_daily_limit)
248
+ if current_daily_limit.nil?
249
+ fail ArgumentError, 'current_daily_limit cannot be nil'
250
+ end
251
+
252
+ if current_daily_limit < 0
253
+ fail ArgumentError, 'invalid value for "current_daily_limit", must be greater than or equal to 0.'
254
+ end
255
+
256
+ @current_daily_limit = current_daily_limit
257
+ end
258
+
259
+ # Custom attribute writer method with validation
260
+ # @param [Object] current_daily_sent Value to be assigned
261
+ def current_daily_sent=(current_daily_sent)
262
+ if current_daily_sent.nil?
263
+ fail ArgumentError, 'current_daily_sent cannot be nil'
264
+ end
265
+
266
+ if current_daily_sent < 0
267
+ fail ArgumentError, 'invalid value for "current_daily_sent", must be greater than or equal to 0.'
268
+ end
269
+
270
+ @current_daily_sent = current_daily_sent
271
+ end
272
+
273
+ # Custom attribute writer method with validation
274
+ # @param [Object] id Value to be assigned
275
+ def id=(id)
276
+ if id.nil?
277
+ fail ArgumentError, 'id cannot be nil'
278
+ end
279
+
280
+ @id = id
281
+ end
282
+
283
+ # Custom attribute writer method checking allowed values (enum).
284
+ # @param [Object] status Object to be assigned
285
+ def status=(status)
286
+ validator = EnumAttributeValidator.new('String', ["pending", "approved", "denied", "cancelled", "unknown_default_open_api"])
287
+ unless validator.valid?(status)
288
+ fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
289
+ end
290
+ @status = status
291
+ end
292
+
293
+ # Checks equality by comparing each attribute.
294
+ # @param [Object] Object to be compared
295
+ def ==(o)
296
+ return true if self.equal?(o)
297
+ self.class == o.class &&
298
+ approved_daily_limit == o.approved_daily_limit &&
299
+ created_at == o.created_at &&
300
+ current_daily_limit == o.current_daily_limit &&
301
+ current_daily_sent == o.current_daily_sent &&
302
+ decided_at == o.decided_at &&
303
+ decision_note == o.decision_note &&
304
+ id == o.id &&
305
+ status == o.status
306
+ end
307
+
308
+ # @see the `==` method
309
+ # @param [Object] Object to be compared
310
+ def eql?(o)
311
+ self == o
312
+ end
313
+
314
+ # Calculates hash code according to all attributes.
315
+ # @return [Integer] Hash code
316
+ def hash
317
+ [approved_daily_limit, created_at, current_daily_limit, current_daily_sent, decided_at, decision_note, id, status].hash
318
+ end
319
+
320
+ # Builds the object from hash
321
+ # @param [Hash] attributes Model attributes in the form of hash
322
+ # @return [Object] Returns the model itself
323
+ def self.build_from_hash(attributes)
324
+ return nil unless attributes.is_a?(Hash)
325
+ attributes = attributes.transform_keys(&:to_sym)
326
+ transformed_hash = {}
327
+ openapi_types.each_pair do |key, type|
328
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
329
+ transformed_hash["#{key}"] = nil
330
+ elsif type =~ /\AArray<(.*)>/i
331
+ # check to ensure the input is an array given that the attribute
332
+ # is documented as an array but the input is not
333
+ if attributes[attribute_map[key]].is_a?(Array)
334
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
335
+ end
336
+ elsif !attributes[attribute_map[key]].nil?
337
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
338
+ end
339
+ end
340
+ new(transformed_hash)
341
+ end
342
+
343
+ # Returns the object in the form of hash
344
+ # @return [Hash] Returns the object in the form of hash
345
+ def to_hash
346
+ hash = {}
347
+ self.class.attribute_map.each_pair do |attr, param|
348
+ value = self.send(attr)
349
+ if value.nil?
350
+ is_nullable = self.class.openapi_nullable.include?(attr)
351
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
352
+ end
353
+
354
+ hash[param] = _to_hash(value)
355
+ end
356
+ hash
357
+ end
358
+
359
+ end
360
+
361
+ end