ultracart_api 4.1.231 → 4.1.232

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 (69) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +45 -2
  3. data/docs/ItemContentMultimedia.md +2 -0
  4. data/docs/SfvbApi.md +763 -39
  5. data/docs/SfvbApprovalCreateRequest.md +6 -0
  6. data/docs/SfvbCommsBranchStat.md +20 -0
  7. data/docs/SfvbCommsChange.md +22 -0
  8. data/docs/SfvbCommsClick.md +20 -0
  9. data/docs/SfvbCommsClicksResponse.md +26 -0
  10. data/docs/SfvbCommsDailyStat.md +30 -0
  11. data/docs/SfvbCommsDashboardResponse.md +24 -0
  12. data/docs/SfvbCommsDashboardRow.md +28 -0
  13. data/docs/SfvbCommsPlan.md +66 -0
  14. data/docs/SfvbCommsPlanResponse.md +20 -0
  15. data/docs/SfvbCommsProvider.md +28 -0
  16. data/docs/SfvbCommsProviderImportRequest.md +22 -0
  17. data/docs/SfvbCommsProviderImportResponse.md +26 -0
  18. data/docs/SfvbCommsProviderList.md +20 -0
  19. data/docs/SfvbCommsProvidersResponse.md +22 -0
  20. data/docs/SfvbCommsSender.md +24 -0
  21. data/docs/SfvbCommsSenderUpdate.md +22 -0
  22. data/docs/SfvbCommsSequenceStatsResponse.md +26 -0
  23. data/docs/SfvbCommsSettings.md +34 -0
  24. data/docs/SfvbCommsSettingsResponse.md +24 -0
  25. data/docs/SfvbCommsSettingsUpdateRequest.md +26 -0
  26. data/docs/SfvbCommsStat.md +54 -0
  27. data/docs/SfvbCommsStepStat.md +34 -0
  28. data/docs/SfvbCommsTemplate.md +30 -0
  29. data/docs/SfvbCommsTemplateResponse.md +24 -0
  30. data/docs/SfvbCommsTemplatesResponse.md +20 -0
  31. data/docs/SfvbCommsTestEmailRequest.md +24 -0
  32. data/docs/SfvbCommsTestPostcardRequest.md +36 -0
  33. data/docs/SfvbCommsTestSendResponse.md +32 -0
  34. data/docs/SfvbCommsTestSmsRequest.md +18 -0
  35. data/lib/ultracart_api/api/sfvb_api.rb +982 -10
  36. data/lib/ultracart_api/models/item_content_multimedia.rb +11 -1
  37. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +30 -3
  38. data/lib/ultracart_api/models/sfvb_comms_branch_stat.rb +229 -0
  39. data/lib/ultracart_api/models/sfvb_comms_change.rb +240 -0
  40. data/lib/ultracart_api/models/sfvb_comms_click.rb +230 -0
  41. data/lib/ultracart_api/models/sfvb_comms_clicks_response.rb +264 -0
  42. data/lib/ultracart_api/models/sfvb_comms_daily_stat.rb +280 -0
  43. data/lib/ultracart_api/models/sfvb_comms_dashboard_response.rb +256 -0
  44. data/lib/ultracart_api/models/sfvb_comms_dashboard_row.rb +269 -0
  45. data/lib/ultracart_api/models/sfvb_comms_plan.rb +460 -0
  46. data/lib/ultracart_api/models/sfvb_comms_plan_response.rb +231 -0
  47. data/lib/ultracart_api/models/sfvb_comms_provider.rb +272 -0
  48. data/lib/ultracart_api/models/sfvb_comms_provider_import_request.rb +242 -0
  49. data/lib/ultracart_api/models/sfvb_comms_provider_import_response.rb +264 -0
  50. data/lib/ultracart_api/models/sfvb_comms_provider_list.rb +230 -0
  51. data/lib/ultracart_api/models/sfvb_comms_providers_response.rb +244 -0
  52. data/lib/ultracart_api/models/sfvb_comms_sender.rb +250 -0
  53. data/lib/ultracart_api/models/sfvb_comms_sender_update.rb +240 -0
  54. data/lib/ultracart_api/models/sfvb_comms_sequence_stats_response.rb +263 -0
  55. data/lib/ultracart_api/models/sfvb_comms_settings.rb +297 -0
  56. data/lib/ultracart_api/models/sfvb_comms_settings_response.rb +253 -0
  57. data/lib/ultracart_api/models/sfvb_comms_settings_update_request.rb +257 -0
  58. data/lib/ultracart_api/models/sfvb_comms_stat.rb +402 -0
  59. data/lib/ultracart_api/models/sfvb_comms_step_stat.rb +301 -0
  60. data/lib/ultracart_api/models/sfvb_comms_template.rb +280 -0
  61. data/lib/ultracart_api/models/sfvb_comms_template_response.rb +251 -0
  62. data/lib/ultracart_api/models/sfvb_comms_templates_response.rb +234 -0
  63. data/lib/ultracart_api/models/sfvb_comms_test_email_request.rb +252 -0
  64. data/lib/ultracart_api/models/sfvb_comms_test_postcard_request.rb +312 -0
  65. data/lib/ultracart_api/models/sfvb_comms_test_send_response.rb +292 -0
  66. data/lib/ultracart_api/models/sfvb_comms_test_sms_request.rb +220 -0
  67. data/lib/ultracart_api/version.rb +1 -1
  68. data/lib/ultracart_api.rb +29 -0
  69. metadata +59 -1
@@ -0,0 +1,269 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ The version of the OpenAPI document: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module UltracartClient
17
+ class SfvbCommsDashboardRow
18
+ # True when it is archived.
19
+ attr_accessor :deleted
20
+
21
+ # Its name.
22
+ attr_accessor :name
23
+
24
+ attr_accessor :stats
25
+
26
+ # Its status.
27
+ attr_accessor :status
28
+
29
+ # flow or campaign.
30
+ attr_accessor :type
31
+
32
+ # The flow or campaign uuid.
33
+ attr_accessor :uuid
34
+
35
+ # Attribute mapping from ruby-style variable name to JSON key.
36
+ def self.attribute_map
37
+ {
38
+ :'deleted' => :'deleted',
39
+ :'name' => :'name',
40
+ :'stats' => :'stats',
41
+ :'status' => :'status',
42
+ :'type' => :'type',
43
+ :'uuid' => :'uuid'
44
+ }
45
+ end
46
+
47
+ # Returns all the JSON keys this model knows about
48
+ def self.acceptable_attributes
49
+ attribute_map.values
50
+ end
51
+
52
+ # Attribute type mapping.
53
+ def self.openapi_types
54
+ {
55
+ :'deleted' => :'Boolean',
56
+ :'name' => :'String',
57
+ :'stats' => :'SfvbCommsStat',
58
+ :'status' => :'String',
59
+ :'type' => :'String',
60
+ :'uuid' => :'String'
61
+ }
62
+ end
63
+
64
+ # List of attributes with nullable: true
65
+ def self.openapi_nullable
66
+ Set.new([
67
+ ])
68
+ end
69
+
70
+ # Initializes the object
71
+ # @param [Hash] attributes Model attributes in the form of hash
72
+ def initialize(attributes = {})
73
+ if (!attributes.is_a?(Hash))
74
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbCommsDashboardRow` initialize method"
75
+ end
76
+
77
+ # check to see if the attribute exists and convert string to symbol for hash key
78
+ attributes = attributes.each_with_object({}) { |(k, v), h|
79
+ if (!self.class.attribute_map.key?(k.to_sym))
80
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbCommsDashboardRow`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
81
+ end
82
+ h[k.to_sym] = v
83
+ }
84
+
85
+ if attributes.key?(:'deleted')
86
+ self.deleted = attributes[:'deleted']
87
+ end
88
+
89
+ if attributes.key?(:'name')
90
+ self.name = attributes[:'name']
91
+ end
92
+
93
+ if attributes.key?(:'stats')
94
+ self.stats = attributes[:'stats']
95
+ end
96
+
97
+ if attributes.key?(:'status')
98
+ self.status = attributes[:'status']
99
+ end
100
+
101
+ if attributes.key?(:'type')
102
+ self.type = attributes[:'type']
103
+ end
104
+
105
+ if attributes.key?(:'uuid')
106
+ self.uuid = attributes[:'uuid']
107
+ end
108
+ end
109
+
110
+ # Show invalid properties with the reasons. Usually used together with valid?
111
+ # @return Array for valid properties with the reasons
112
+ def list_invalid_properties
113
+ invalid_properties = Array.new
114
+ invalid_properties
115
+ end
116
+
117
+ # Check to see if the all the properties in the model are valid
118
+ # @return true if the model is valid
119
+ def valid?
120
+ true
121
+ end
122
+
123
+ # Checks equality by comparing each attribute.
124
+ # @param [Object] Object to be compared
125
+ def ==(o)
126
+ return true if self.equal?(o)
127
+ self.class == o.class &&
128
+ deleted == o.deleted &&
129
+ name == o.name &&
130
+ stats == o.stats &&
131
+ status == o.status &&
132
+ type == o.type &&
133
+ uuid == o.uuid
134
+ end
135
+
136
+ # @see the `==` method
137
+ # @param [Object] Object to be compared
138
+ def eql?(o)
139
+ self == o
140
+ end
141
+
142
+ # Calculates hash code according to all attributes.
143
+ # @return [Integer] Hash code
144
+ def hash
145
+ [deleted, name, stats, status, type, uuid].hash
146
+ end
147
+
148
+ # Builds the object from hash
149
+ # @param [Hash] attributes Model attributes in the form of hash
150
+ # @return [Object] Returns the model itself
151
+ def self.build_from_hash(attributes)
152
+ new.build_from_hash(attributes)
153
+ end
154
+
155
+ # Builds the object from hash
156
+ # @param [Hash] attributes Model attributes in the form of hash
157
+ # @return [Object] Returns the model itself
158
+ def build_from_hash(attributes)
159
+ return nil unless attributes.is_a?(Hash)
160
+ attributes = attributes.transform_keys(&:to_sym)
161
+ self.class.openapi_types.each_pair do |key, type|
162
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
163
+ self.send("#{key}=", nil)
164
+ elsif type =~ /\AArray<(.*)>/i
165
+ # check to ensure the input is an array given that the attribute
166
+ # is documented as an array but the input is not
167
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
168
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
169
+ end
170
+ elsif !attributes[self.class.attribute_map[key]].nil?
171
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
172
+ end
173
+ end
174
+
175
+ self
176
+ end
177
+
178
+ # Deserializes the data based on type
179
+ # @param string type Data type
180
+ # @param string value Value to be deserialized
181
+ # @return [Object] Deserialized data
182
+ def _deserialize(type, value)
183
+ case type.to_sym
184
+ when :Time
185
+ Time.parse(value)
186
+ when :Date
187
+ Date.parse(value)
188
+ when :String
189
+ value.to_s
190
+ when :Integer
191
+ value.to_i
192
+ when :Float
193
+ value.to_f
194
+ when :Boolean
195
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
196
+ true
197
+ else
198
+ false
199
+ end
200
+ when :Object
201
+ # generic object (usually a Hash), return directly
202
+ value
203
+ when /\AArray<(?<inner_type>.+)>\z/
204
+ inner_type = Regexp.last_match[:inner_type]
205
+ value.map { |v| _deserialize(inner_type, v) }
206
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
207
+ k_type = Regexp.last_match[:k_type]
208
+ v_type = Regexp.last_match[:v_type]
209
+ {}.tap do |hash|
210
+ value.each do |k, v|
211
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
212
+ end
213
+ end
214
+ else # model
215
+ # models (e.g. Pet) or oneOf
216
+ klass = UltracartClient.const_get(type)
217
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
218
+ end
219
+ end
220
+
221
+ # Returns the string representation of the object
222
+ # @return [String] String presentation of the object
223
+ def to_s
224
+ to_hash.to_s
225
+ end
226
+
227
+ # to_body is an alias to to_hash (backward compatibility)
228
+ # @return [Hash] Returns the object in the form of hash
229
+ def to_body
230
+ to_hash
231
+ end
232
+
233
+ # Returns the object in the form of hash
234
+ # @return [Hash] Returns the object in the form of hash
235
+ def to_hash
236
+ hash = {}
237
+ self.class.attribute_map.each_pair do |attr, param|
238
+ value = self.send(attr)
239
+ if value.nil?
240
+ is_nullable = self.class.openapi_nullable.include?(attr)
241
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
242
+ end
243
+
244
+ hash[param] = _to_hash(value)
245
+ end
246
+ hash
247
+ end
248
+
249
+ # Outputs non-array value in the form of hash
250
+ # For object, use to_hash. Otherwise, just return the value
251
+ # @param [Object] value Any valid value
252
+ # @return [Hash] Returns the value in the form of hash
253
+ def _to_hash(value)
254
+ if value.is_a?(Array)
255
+ value.compact.map { |v| _to_hash(v) }
256
+ elsif value.is_a?(Hash)
257
+ {}.tap do |hash|
258
+ value.each { |k, v| hash[k] = _to_hash(v) }
259
+ end
260
+ elsif value.respond_to? :to_hash
261
+ value.to_hash
262
+ else
263
+ value
264
+ end
265
+ end
266
+
267
+ end
268
+
269
+ end