qubrics-mailbox 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 (168) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +108 -0
  3. data/LICENSE +21 -0
  4. data/README.md +183 -0
  5. data/lib/qubrics/mailbox/client.rb +63 -0
  6. data/lib/qubrics/mailbox/version.rb +7 -0
  7. data/lib/qubrics/mailbox.rb +12 -0
  8. data/lib/qubrics_mailbox_generated/api/mailbox_api_api.rb +4371 -0
  9. data/lib/qubrics_mailbox_generated/api_client.rb +447 -0
  10. data/lib/qubrics_mailbox_generated/api_error.rb +58 -0
  11. data/lib/qubrics_mailbox_generated/api_model_base.rb +95 -0
  12. data/lib/qubrics_mailbox_generated/configuration.rb +400 -0
  13. data/lib/qubrics_mailbox_generated/models/api_error_detail.rb +219 -0
  14. data/lib/qubrics_mailbox_generated/models/api_error_error.rb +275 -0
  15. data/lib/qubrics_mailbox_generated/models/api_error_meta.rb +164 -0
  16. data/lib/qubrics_mailbox_generated/models/api_error_response.rb +216 -0
  17. data/lib/qubrics_mailbox_generated/models/batch_delete_mailbox_messages_body.rb +205 -0
  18. data/lib/qubrics_mailbox_generated/models/batch_update_mailbox_messages_body.rb +227 -0
  19. data/lib/qubrics_mailbox_generated/models/connection.rb +273 -0
  20. data/lib/qubrics_mailbox_generated/models/connection_credential.rb +226 -0
  21. data/lib/qubrics_mailbox_generated/models/connection_mailboxes_inner.rb +190 -0
  22. data/lib/qubrics_mailbox_generated/models/connection_response.rb +223 -0
  23. data/lib/qubrics_mailbox_generated/models/connection_team.rb +190 -0
  24. data/lib/qubrics_mailbox_generated/models/control_mailbox_draft_schedule.rb +232 -0
  25. data/lib/qubrics_mailbox_generated/models/create_mailbox_draft.rb +448 -0
  26. data/lib/qubrics_mailbox_generated/models/create_mailbox_draft_attachments_inner.rb +400 -0
  27. data/lib/qubrics_mailbox_generated/models/create_mailbox_draft_bcc_inner.rb +200 -0
  28. data/lib/qubrics_mailbox_generated/models/create_mailbox_draft_from.rb +201 -0
  29. data/lib/qubrics_mailbox_generated/models/create_mailbox_draft_source.rb +235 -0
  30. data/lib/qubrics_mailbox_generated/models/create_mailbox_folder_body.rb +183 -0
  31. data/lib/qubrics_mailbox_generated/models/cursor_pagination.rb +173 -0
  32. data/lib/qubrics_mailbox_generated/models/granted_mailbox.rb +192 -0
  33. data/lib/qubrics_mailbox_generated/models/granted_mailbox_list_response.rb +251 -0
  34. data/lib/qubrics_mailbox_generated/models/mailbox_address.rb +176 -0
  35. data/lib/qubrics_mailbox_generated/models/mailbox_attachment.rb +250 -0
  36. data/lib/qubrics_mailbox_generated/models/mailbox_attachment_text.rb +337 -0
  37. data/lib/qubrics_mailbox_generated/models/mailbox_attachment_text_response.rb +223 -0
  38. data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_intent_body.rb +228 -0
  39. data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_intent_result.rb +323 -0
  40. data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_intent_result_headers.rb +191 -0
  41. data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_intent_result_response.rb +223 -0
  42. data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_result.rb +243 -0
  43. data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_result_response.rb +223 -0
  44. data/lib/qubrics_mailbox_generated/models/mailbox_batch_delete_messages_result.rb +248 -0
  45. data/lib/qubrics_mailbox_generated/models/mailbox_batch_delete_messages_result_response.rb +223 -0
  46. data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_body.rb +373 -0
  47. data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_item.rb +188 -0
  48. data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_result.rb +220 -0
  49. data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_result_response.rb +223 -0
  50. data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_result_states.rb +150 -0
  51. data/lib/qubrics_mailbox_generated/models/mailbox_batch_message_failure.rb +216 -0
  52. data/lib/qubrics_mailbox_generated/models/mailbox_batch_message_states.rb +162 -0
  53. data/lib/qubrics_mailbox_generated/models/mailbox_batch_update_messages_result.rb +248 -0
  54. data/lib/qubrics_mailbox_generated/models/mailbox_batch_update_messages_result_response.rb +223 -0
  55. data/lib/qubrics_mailbox_generated/models/mailbox_changes.rb +307 -0
  56. data/lib/qubrics_mailbox_generated/models/mailbox_changes_response.rb +223 -0
  57. data/lib/qubrics_mailbox_generated/models/mailbox_content_headers.rb +214 -0
  58. data/lib/qubrics_mailbox_generated/models/mailbox_content_headers_full_inner.rb +190 -0
  59. data/lib/qubrics_mailbox_generated/models/mailbox_content_headers_selected.rb +234 -0
  60. data/lib/qubrics_mailbox_generated/models/mailbox_draft.rb +670 -0
  61. data/lib/qubrics_mailbox_generated/models/mailbox_draft_delete_response.rb +223 -0
  62. data/lib/qubrics_mailbox_generated/models/mailbox_draft_delete_response_all_of_data.rb +190 -0
  63. data/lib/qubrics_mailbox_generated/models/mailbox_draft_list_response.rb +251 -0
  64. data/lib/qubrics_mailbox_generated/models/mailbox_draft_response.rb +223 -0
  65. data/lib/qubrics_mailbox_generated/models/mailbox_folder.rb +307 -0
  66. data/lib/qubrics_mailbox_generated/models/mailbox_folder_cursor_list_response.rb +251 -0
  67. data/lib/qubrics_mailbox_generated/models/mailbox_folder_deleted_response.rb +223 -0
  68. data/lib/qubrics_mailbox_generated/models/mailbox_folder_query_changes.rb +270 -0
  69. data/lib/qubrics_mailbox_generated/models/mailbox_folder_query_changes_added_inner.rb +190 -0
  70. data/lib/qubrics_mailbox_generated/models/mailbox_folder_query_changes_response.rb +223 -0
  71. data/lib/qubrics_mailbox_generated/models/mailbox_folder_response.rb +223 -0
  72. data/lib/qubrics_mailbox_generated/models/mailbox_get_changes200_response.rb +103 -0
  73. data/lib/qubrics_mailbox_generated/models/mailbox_identity.rb +352 -0
  74. data/lib/qubrics_mailbox_generated/models/mailbox_identity_cursor_list_response.rb +251 -0
  75. data/lib/qubrics_mailbox_generated/models/mailbox_identity_list_meta.rb +173 -0
  76. data/lib/qubrics_mailbox_generated/models/mailbox_identity_response.rb +223 -0
  77. data/lib/qubrics_mailbox_generated/models/mailbox_me.rb +294 -0
  78. data/lib/qubrics_mailbox_generated/models/mailbox_me_item_response.rb +223 -0
  79. data/lib/qubrics_mailbox_generated/models/mailbox_message.rb +594 -0
  80. data/lib/qubrics_mailbox_generated/models/mailbox_message_content.rb +348 -0
  81. data/lib/qubrics_mailbox_generated/models/mailbox_message_content_body.rb +352 -0
  82. data/lib/qubrics_mailbox_generated/models/mailbox_message_content_body_html_cleaning.rb +241 -0
  83. data/lib/qubrics_mailbox_generated/models/mailbox_message_content_dates.rb +162 -0
  84. data/lib/qubrics_mailbox_generated/models/mailbox_message_content_participants.rb +262 -0
  85. data/lib/qubrics_mailbox_generated/models/mailbox_message_content_response.rb +223 -0
  86. data/lib/qubrics_mailbox_generated/models/mailbox_message_content_states.rb +176 -0
  87. data/lib/qubrics_mailbox_generated/models/mailbox_message_count.rb +176 -0
  88. data/lib/qubrics_mailbox_generated/models/mailbox_message_count_response.rb +223 -0
  89. data/lib/qubrics_mailbox_generated/models/mailbox_message_deleted_response.rb +223 -0
  90. data/lib/qubrics_mailbox_generated/models/mailbox_message_detail_response.rb +223 -0
  91. data/lib/qubrics_mailbox_generated/models/mailbox_message_flags.rb +242 -0
  92. data/lib/qubrics_mailbox_generated/models/mailbox_message_query_changes.rb +270 -0
  93. data/lib/qubrics_mailbox_generated/models/mailbox_message_query_changes_response.rb +223 -0
  94. data/lib/qubrics_mailbox_generated/models/mailbox_message_summary.rb +454 -0
  95. data/lib/qubrics_mailbox_generated/models/mailbox_message_summary_cursor_list_response.rb +251 -0
  96. data/lib/qubrics_mailbox_generated/models/mailbox_query_meta.rb +173 -0
  97. data/lib/qubrics_mailbox_generated/models/mailbox_quota.rb +359 -0
  98. data/lib/qubrics_mailbox_generated/models/mailbox_quota_cursor_list_response.rb +251 -0
  99. data/lib/qubrics_mailbox_generated/models/mailbox_raw_body.rb +279 -0
  100. data/lib/qubrics_mailbox_generated/models/mailbox_raw_body_body.rb +200 -0
  101. data/lib/qubrics_mailbox_generated/models/mailbox_raw_body_response.rb +223 -0
  102. data/lib/qubrics_mailbox_generated/models/mailbox_realtime_event.rb +366 -0
  103. data/lib/qubrics_mailbox_generated/models/mailbox_realtime_message.rb +492 -0
  104. data/lib/qubrics_mailbox_generated/models/mailbox_realtime_message_body.rb +214 -0
  105. data/lib/qubrics_mailbox_generated/models/mailbox_search_snippet.rb +190 -0
  106. data/lib/qubrics_mailbox_generated/models/mailbox_search_snippets_result.rb +206 -0
  107. data/lib/qubrics_mailbox_generated/models/mailbox_search_snippets_result_response.rb +223 -0
  108. data/lib/qubrics_mailbox_generated/models/mailbox_send_result_response.rb +223 -0
  109. data/lib/qubrics_mailbox_generated/models/mailbox_send_scope.rb +213 -0
  110. data/lib/qubrics_mailbox_generated/models/mailbox_sender_choices.rb +217 -0
  111. data/lib/qubrics_mailbox_generated/models/mailbox_sender_choices_from.rb +213 -0
  112. data/lib/qubrics_mailbox_generated/models/mailbox_sender_choices_reply_to.rb +213 -0
  113. data/lib/qubrics_mailbox_generated/models/mailbox_sender_choices_response.rb +223 -0
  114. data/lib/qubrics_mailbox_generated/models/mailbox_session.rb +294 -0
  115. data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities.rb +346 -0
  116. data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_attachments.rb +294 -0
  117. data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_folders.rb +320 -0
  118. data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_identities.rb +268 -0
  119. data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_messages.rb +516 -0
  120. data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_quotas.rb +242 -0
  121. data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_submissions.rb +242 -0
  122. data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_sync.rb +222 -0
  123. data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_threads.rb +268 -0
  124. data/lib/qubrics_mailbox_generated/models/mailbox_session_endpoints.rb +334 -0
  125. data/lib/qubrics_mailbox_generated/models/mailbox_session_gated.rb +451 -0
  126. data/lib/qubrics_mailbox_generated/models/mailbox_session_limits.rb +448 -0
  127. data/lib/qubrics_mailbox_generated/models/mailbox_session_mailbox.rb +203 -0
  128. data/lib/qubrics_mailbox_generated/models/mailbox_session_response.rb +223 -0
  129. data/lib/qubrics_mailbox_generated/models/mailbox_session_states.rb +294 -0
  130. data/lib/qubrics_mailbox_generated/models/mailbox_submission.rb +321 -0
  131. data/lib/qubrics_mailbox_generated/models/mailbox_submission_cursor_list_response.rb +251 -0
  132. data/lib/qubrics_mailbox_generated/models/mailbox_submission_delivery_status.rb +200 -0
  133. data/lib/qubrics_mailbox_generated/models/mailbox_submission_envelope.rb +178 -0
  134. data/lib/qubrics_mailbox_generated/models/mailbox_submission_envelope_address.rb +178 -0
  135. data/lib/qubrics_mailbox_generated/models/mailbox_submission_response.rb +223 -0
  136. data/lib/qubrics_mailbox_generated/models/mailbox_sync_meta.rb +173 -0
  137. data/lib/qubrics_mailbox_generated/models/mailbox_thread.rb +377 -0
  138. data/lib/qubrics_mailbox_generated/models/mailbox_thread_content_meta.rb +244 -0
  139. data/lib/qubrics_mailbox_generated/models/mailbox_thread_content_meta_states.rb +188 -0
  140. data/lib/qubrics_mailbox_generated/models/mailbox_thread_content_response.rb +251 -0
  141. data/lib/qubrics_mailbox_generated/models/mailbox_thread_detail_response.rb +223 -0
  142. data/lib/qubrics_mailbox_generated/models/mailbox_thread_message_summary_cursor_list_response.rb +251 -0
  143. data/lib/qubrics_mailbox_generated/models/mailbox_thread_messages_meta.rb +199 -0
  144. data/lib/qubrics_mailbox_generated/models/mailbox_thread_summary.rb +349 -0
  145. data/lib/qubrics_mailbox_generated/models/mailbox_thread_summary_cursor_list_response.rb +251 -0
  146. data/lib/qubrics_mailbox_generated/models/mailbox_thread_summary_states.rb +162 -0
  147. data/lib/qubrics_mailbox_generated/models/mailbox_typed_changes.rb +164 -0
  148. data/lib/qubrics_mailbox_generated/models/mailbox_typed_changes_response.rb +223 -0
  149. data/lib/qubrics_mailbox_generated/models/mailbox_typed_changes_types.rb +192 -0
  150. data/lib/qubrics_mailbox_generated/models/mailbox_usage.rb +192 -0
  151. data/lib/qubrics_mailbox_generated/models/mailbox_usage_resource.rb +408 -0
  152. data/lib/qubrics_mailbox_generated/models/mailbox_usage_response.rb +223 -0
  153. data/lib/qubrics_mailbox_generated/models/mailbox_usage_states.rb +150 -0
  154. data/lib/qubrics_mailbox_generated/models/patch_mailbox_folder_body.rb +166 -0
  155. data/lib/qubrics_mailbox_generated/models/patch_mailbox_message_body.rb +168 -0
  156. data/lib/qubrics_mailbox_generated/models/response_meta.rb +164 -0
  157. data/lib/qubrics_mailbox_generated/models/send_mailbox_draft.rb +222 -0
  158. data/lib/qubrics_mailbox_generated/models/send_mailbox_message_body.rb +326 -0
  159. data/lib/qubrics_mailbox_generated/models/send_mailbox_message_body_attachments_inner.rb +103 -0
  160. data/lib/qubrics_mailbox_generated/models/send_mailbox_message_body_attachments_inner_any_of.rb +217 -0
  161. data/lib/qubrics_mailbox_generated/models/send_mailbox_message_body_attachments_inner_any_of1.rb +217 -0
  162. data/lib/qubrics_mailbox_generated/models/send_mailbox_message_result.rb +214 -0
  163. data/lib/qubrics_mailbox_generated/models/success_envelope.rb +192 -0
  164. data/lib/qubrics_mailbox_generated/models/update_mailbox_draft.rb +437 -0
  165. data/lib/qubrics_mailbox_generated/models/update_mailbox_identity_body.rb +216 -0
  166. data/lib/qubrics_mailbox_generated/version.rb +15 -0
  167. data/lib/qubrics_mailbox_generated.rb +210 -0
  168. metadata +290 -0
@@ -0,0 +1,223 @@
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::Mailbox::Generated
17
+ class MailboxDraftResponse < ApiModelBase
18
+ attr_accessor :meta
19
+
20
+ attr_accessor :ok
21
+
22
+ attr_accessor :data
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'meta' => :'meta',
28
+ :'ok' => :'ok',
29
+ :'data' => :'data'
30
+ }
31
+ end
32
+
33
+ # Returns attribute mapping this model knows about
34
+ def self.acceptable_attribute_map
35
+ attribute_map
36
+ end
37
+
38
+ # Returns all the JSON keys this model knows about
39
+ def self.acceptable_attributes
40
+ acceptable_attribute_map.values
41
+ end
42
+
43
+ # Attribute type mapping.
44
+ def self.openapi_types
45
+ {
46
+ :'meta' => :'ResponseMeta',
47
+ :'ok' => :'Boolean',
48
+ :'data' => :'MailboxDraft'
49
+ }
50
+ end
51
+
52
+ # List of attributes with nullable: true
53
+ def self.openapi_nullable
54
+ Set.new([
55
+ ])
56
+ end
57
+
58
+ # List of class defined in allOf (OpenAPI v3)
59
+ def self.openapi_all_of
60
+ [
61
+ :'SuccessEnvelope'
62
+ ]
63
+ end
64
+
65
+ # Initializes the object
66
+ # @param [Hash] attributes Model attributes in the form of hash
67
+ def initialize(attributes = {})
68
+ if (!attributes.is_a?(Hash))
69
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Qubrics::Mailbox::Generated::MailboxDraftResponse` initialize method"
70
+ end
71
+
72
+ # check to see if the attribute exists and convert string to symbol for hash key
73
+ acceptable_attribute_map = self.class.acceptable_attribute_map
74
+ attributes = attributes.each_with_object({}) { |(k, v), h|
75
+ if (!acceptable_attribute_map.key?(k.to_sym))
76
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Qubrics::Mailbox::Generated::MailboxDraftResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
77
+ end
78
+ h[k.to_sym] = v
79
+ }
80
+
81
+ if attributes.key?(:'meta')
82
+ self.meta = attributes[:'meta']
83
+ else
84
+ self.meta = nil
85
+ end
86
+
87
+ if attributes.key?(:'ok')
88
+ self.ok = attributes[:'ok']
89
+ else
90
+ self.ok = nil
91
+ end
92
+
93
+ if attributes.key?(:'data')
94
+ self.data = attributes[:'data']
95
+ else
96
+ self.data = nil
97
+ end
98
+ end
99
+
100
+ # Show invalid properties with the reasons. Usually used together with valid?
101
+ # @return Array for valid properties with the reasons
102
+ def list_invalid_properties
103
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
104
+ invalid_properties = Array.new
105
+ if @meta.nil?
106
+ invalid_properties.push('invalid value for "meta", meta cannot be nil.')
107
+ end
108
+
109
+ if @ok.nil?
110
+ invalid_properties.push('invalid value for "ok", ok cannot be nil.')
111
+ end
112
+
113
+ if @data.nil?
114
+ invalid_properties.push('invalid value for "data", data cannot be nil.')
115
+ end
116
+
117
+ invalid_properties
118
+ end
119
+
120
+ # Check to see if the all the properties in the model are valid
121
+ # @return true if the model is valid
122
+ def valid?
123
+ warn '[DEPRECATED] the `valid?` method is obsolete'
124
+ return false if @meta.nil?
125
+ return false if @ok.nil?
126
+ return false if @data.nil?
127
+ true
128
+ end
129
+
130
+ # Custom attribute writer method with validation
131
+ # @param [Object] meta Value to be assigned
132
+ def meta=(meta)
133
+ if meta.nil?
134
+ fail ArgumentError, 'meta cannot be nil'
135
+ end
136
+
137
+ @meta = meta
138
+ end
139
+
140
+ # Custom attribute writer method with validation
141
+ # @param [Object] ok Value to be assigned
142
+ def ok=(ok)
143
+ if ok.nil?
144
+ fail ArgumentError, 'ok cannot be nil'
145
+ end
146
+
147
+ @ok = ok
148
+ end
149
+
150
+ # Custom attribute writer method with validation
151
+ # @param [Object] data Value to be assigned
152
+ def data=(data)
153
+ if data.nil?
154
+ fail ArgumentError, 'data cannot be nil'
155
+ end
156
+
157
+ @data = data
158
+ end
159
+
160
+ # Checks equality by comparing each attribute.
161
+ # @param [Object] Object to be compared
162
+ def ==(o)
163
+ return true if self.equal?(o)
164
+ self.class == o.class &&
165
+ meta == o.meta &&
166
+ ok == o.ok &&
167
+ data == o.data
168
+ end
169
+
170
+ # @see the `==` method
171
+ # @param [Object] Object to be compared
172
+ def eql?(o)
173
+ self == o
174
+ end
175
+
176
+ # Calculates hash code according to all attributes.
177
+ # @return [Integer] Hash code
178
+ def hash
179
+ [meta, ok, data].hash
180
+ end
181
+
182
+ # Builds the object from hash
183
+ # @param [Hash] attributes Model attributes in the form of hash
184
+ # @return [Object] Returns the model itself
185
+ def self.build_from_hash(attributes)
186
+ return nil unless attributes.is_a?(Hash)
187
+ attributes = attributes.transform_keys(&:to_sym)
188
+ transformed_hash = {}
189
+ openapi_types.each_pair do |key, type|
190
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
191
+ transformed_hash["#{key}"] = nil
192
+ elsif type =~ /\AArray<(.*)>/i
193
+ # check to ensure the input is an array given that the attribute
194
+ # is documented as an array but the input is not
195
+ if attributes[attribute_map[key]].is_a?(Array)
196
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
197
+ end
198
+ elsif !attributes[attribute_map[key]].nil?
199
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
200
+ end
201
+ end
202
+ new(transformed_hash)
203
+ end
204
+
205
+ # Returns the object in the form of hash
206
+ # @return [Hash] Returns the object in the form of hash
207
+ def to_hash
208
+ hash = {}
209
+ self.class.attribute_map.each_pair do |attr, param|
210
+ value = self.send(attr)
211
+ if value.nil?
212
+ is_nullable = self.class.openapi_nullable.include?(attr)
213
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
214
+ end
215
+
216
+ hash[param] = _to_hash(value)
217
+ end
218
+ hash
219
+ end
220
+
221
+ end
222
+
223
+ end
@@ -0,0 +1,307 @@
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::Mailbox::Generated
17
+ class MailboxFolder < ApiModelBase
18
+ # Whether messages can be moved into this folder.
19
+ attr_accessor :can_add_items
20
+
21
+ # Folder ID
22
+ attr_accessor :id
23
+
24
+ attr_accessor :name
25
+
26
+ attr_accessor :parent_id
27
+
28
+ # System role when the folder is a built-in folder.
29
+ attr_accessor :role
30
+
31
+ attr_accessor :sort_order
32
+
33
+ attr_accessor :total_messages
34
+
35
+ attr_accessor :unread_messages
36
+
37
+ # Attribute mapping from ruby-style variable name to JSON key.
38
+ def self.attribute_map
39
+ {
40
+ :'can_add_items' => :'can_add_items',
41
+ :'id' => :'id',
42
+ :'name' => :'name',
43
+ :'parent_id' => :'parent_id',
44
+ :'role' => :'role',
45
+ :'sort_order' => :'sort_order',
46
+ :'total_messages' => :'total_messages',
47
+ :'unread_messages' => :'unread_messages'
48
+ }
49
+ end
50
+
51
+ # Returns attribute mapping this model knows about
52
+ def self.acceptable_attribute_map
53
+ attribute_map
54
+ end
55
+
56
+ # Returns all the JSON keys this model knows about
57
+ def self.acceptable_attributes
58
+ acceptable_attribute_map.values
59
+ end
60
+
61
+ # Attribute type mapping.
62
+ def self.openapi_types
63
+ {
64
+ :'can_add_items' => :'Boolean',
65
+ :'id' => :'String',
66
+ :'name' => :'String',
67
+ :'parent_id' => :'String',
68
+ :'role' => :'String',
69
+ :'sort_order' => :'Integer',
70
+ :'total_messages' => :'Integer',
71
+ :'unread_messages' => :'Integer'
72
+ }
73
+ end
74
+
75
+ # List of attributes with nullable: true
76
+ def self.openapi_nullable
77
+ Set.new([
78
+ :'parent_id',
79
+ :'role',
80
+ :'sort_order',
81
+ ])
82
+ end
83
+
84
+ # Initializes the object
85
+ # @param [Hash] attributes Model attributes in the form of hash
86
+ def initialize(attributes = {})
87
+ if (!attributes.is_a?(Hash))
88
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Qubrics::Mailbox::Generated::MailboxFolder` initialize method"
89
+ end
90
+
91
+ # check to see if the attribute exists and convert string to symbol for hash key
92
+ acceptable_attribute_map = self.class.acceptable_attribute_map
93
+ attributes = attributes.each_with_object({}) { |(k, v), h|
94
+ if (!acceptable_attribute_map.key?(k.to_sym))
95
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Qubrics::Mailbox::Generated::MailboxFolder`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
96
+ end
97
+ h[k.to_sym] = v
98
+ }
99
+
100
+ if attributes.key?(:'can_add_items')
101
+ self.can_add_items = attributes[:'can_add_items']
102
+ else
103
+ self.can_add_items = nil
104
+ end
105
+
106
+ if attributes.key?(:'id')
107
+ self.id = attributes[:'id']
108
+ else
109
+ self.id = nil
110
+ end
111
+
112
+ if attributes.key?(:'name')
113
+ self.name = attributes[:'name']
114
+ else
115
+ self.name = nil
116
+ end
117
+
118
+ if attributes.key?(:'parent_id')
119
+ self.parent_id = attributes[:'parent_id']
120
+ else
121
+ self.parent_id = nil
122
+ end
123
+
124
+ if attributes.key?(:'role')
125
+ self.role = attributes[:'role']
126
+ else
127
+ self.role = nil
128
+ end
129
+
130
+ if attributes.key?(:'sort_order')
131
+ self.sort_order = attributes[:'sort_order']
132
+ else
133
+ self.sort_order = nil
134
+ end
135
+
136
+ if attributes.key?(:'total_messages')
137
+ self.total_messages = attributes[:'total_messages']
138
+ else
139
+ self.total_messages = nil
140
+ end
141
+
142
+ if attributes.key?(:'unread_messages')
143
+ self.unread_messages = attributes[:'unread_messages']
144
+ else
145
+ self.unread_messages = nil
146
+ end
147
+ end
148
+
149
+ # Show invalid properties with the reasons. Usually used together with valid?
150
+ # @return Array for valid properties with the reasons
151
+ def list_invalid_properties
152
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
153
+ invalid_properties = Array.new
154
+ if @can_add_items.nil?
155
+ invalid_properties.push('invalid value for "can_add_items", can_add_items cannot be nil.')
156
+ end
157
+
158
+ if @id.nil?
159
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
160
+ end
161
+
162
+ if @name.nil?
163
+ invalid_properties.push('invalid value for "name", name cannot be nil.')
164
+ end
165
+
166
+ if @total_messages.nil?
167
+ invalid_properties.push('invalid value for "total_messages", total_messages cannot be nil.')
168
+ end
169
+
170
+ if @unread_messages.nil?
171
+ invalid_properties.push('invalid value for "unread_messages", unread_messages cannot be nil.')
172
+ end
173
+
174
+ invalid_properties
175
+ end
176
+
177
+ # Check to see if the all the properties in the model are valid
178
+ # @return true if the model is valid
179
+ def valid?
180
+ warn '[DEPRECATED] the `valid?` method is obsolete'
181
+ return false if @can_add_items.nil?
182
+ return false if @id.nil?
183
+ return false if @name.nil?
184
+ return false if @total_messages.nil?
185
+ return false if @unread_messages.nil?
186
+ true
187
+ end
188
+
189
+ # Custom attribute writer method with validation
190
+ # @param [Object] can_add_items Value to be assigned
191
+ def can_add_items=(can_add_items)
192
+ if can_add_items.nil?
193
+ fail ArgumentError, 'can_add_items cannot be nil'
194
+ end
195
+
196
+ @can_add_items = can_add_items
197
+ end
198
+
199
+ # Custom attribute writer method with validation
200
+ # @param [Object] id Value to be assigned
201
+ def id=(id)
202
+ if id.nil?
203
+ fail ArgumentError, 'id cannot be nil'
204
+ end
205
+
206
+ @id = id
207
+ end
208
+
209
+ # Custom attribute writer method with validation
210
+ # @param [Object] name Value to be assigned
211
+ def name=(name)
212
+ if name.nil?
213
+ fail ArgumentError, 'name cannot be nil'
214
+ end
215
+
216
+ @name = name
217
+ end
218
+
219
+ # Custom attribute writer method with validation
220
+ # @param [Object] total_messages Value to be assigned
221
+ def total_messages=(total_messages)
222
+ if total_messages.nil?
223
+ fail ArgumentError, 'total_messages cannot be nil'
224
+ end
225
+
226
+ @total_messages = total_messages
227
+ end
228
+
229
+ # Custom attribute writer method with validation
230
+ # @param [Object] unread_messages Value to be assigned
231
+ def unread_messages=(unread_messages)
232
+ if unread_messages.nil?
233
+ fail ArgumentError, 'unread_messages cannot be nil'
234
+ end
235
+
236
+ @unread_messages = unread_messages
237
+ end
238
+
239
+ # Checks equality by comparing each attribute.
240
+ # @param [Object] Object to be compared
241
+ def ==(o)
242
+ return true if self.equal?(o)
243
+ self.class == o.class &&
244
+ can_add_items == o.can_add_items &&
245
+ id == o.id &&
246
+ name == o.name &&
247
+ parent_id == o.parent_id &&
248
+ role == o.role &&
249
+ sort_order == o.sort_order &&
250
+ total_messages == o.total_messages &&
251
+ unread_messages == o.unread_messages
252
+ end
253
+
254
+ # @see the `==` method
255
+ # @param [Object] Object to be compared
256
+ def eql?(o)
257
+ self == o
258
+ end
259
+
260
+ # Calculates hash code according to all attributes.
261
+ # @return [Integer] Hash code
262
+ def hash
263
+ [can_add_items, id, name, parent_id, role, sort_order, total_messages, unread_messages].hash
264
+ end
265
+
266
+ # Builds the object from hash
267
+ # @param [Hash] attributes Model attributes in the form of hash
268
+ # @return [Object] Returns the model itself
269
+ def self.build_from_hash(attributes)
270
+ return nil unless attributes.is_a?(Hash)
271
+ attributes = attributes.transform_keys(&:to_sym)
272
+ transformed_hash = {}
273
+ openapi_types.each_pair do |key, type|
274
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
275
+ transformed_hash["#{key}"] = nil
276
+ elsif type =~ /\AArray<(.*)>/i
277
+ # check to ensure the input is an array given that the attribute
278
+ # is documented as an array but the input is not
279
+ if attributes[attribute_map[key]].is_a?(Array)
280
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
281
+ end
282
+ elsif !attributes[attribute_map[key]].nil?
283
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
284
+ end
285
+ end
286
+ new(transformed_hash)
287
+ end
288
+
289
+ # Returns the object in the form of hash
290
+ # @return [Hash] Returns the object in the form of hash
291
+ def to_hash
292
+ hash = {}
293
+ self.class.attribute_map.each_pair do |attr, param|
294
+ value = self.send(attr)
295
+ if value.nil?
296
+ is_nullable = self.class.openapi_nullable.include?(attr)
297
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
298
+ end
299
+
300
+ hash[param] = _to_hash(value)
301
+ end
302
+ hash
303
+ end
304
+
305
+ end
306
+
307
+ end