Class: UltracartClient::CustomReportAccountConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/custom_report_account_config.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomReportAccountConfig

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::CustomReportAccountConfig` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::CustomReportAccountConfig`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'ai_budget')
    self.ai_budget = attributes[:'ai_budget']
  end

  if attributes.key?(:'ai_usage')
    self.ai_usage = attributes[:'ai_usage']
  end

  if attributes.key?(:'merchant_id')
    self.merchant_id = attributes[:'merchant_id']
  end

  if attributes.key?(:'novice_sql_comments')
    self.novice_sql_comments = attributes[:'novice_sql_comments']
  end

  if attributes.key?(:'opt_in')
    self.opt_in = attributes[:'opt_in']
  end

  if attributes.key?(:'opt_in_by_user')
    self.opt_in_by_user = attributes[:'opt_in_by_user']
  end

  if attributes.key?(:'opt_in_date')
    self.opt_in_date = attributes[:'opt_in_date']
  end

  if attributes.key?(:'read_only')
    self.read_only = attributes[:'read_only']
  end

  if attributes.key?(:'sql_budget')
    self.sql_budget = attributes[:'sql_budget']
  end

  if attributes.key?(:'sql_usage')
    self.sql_usage = attributes[:'sql_usage']
  end
end

Instance Attribute Details

#ai_budget ⇒ Object

Returns the value of attribute ai_budget.



18
19
20
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 18

def ai_budget
  @ai_budget
end

#ai_usage ⇒ Object

Current AI usage creating reports



21
22
23
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 21

def ai_usage
  @ai_usage
end

#merchant_id ⇒ Object

Current BigQuery SQL usage running reports



24
25
26
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 24

def merchant_id
  @merchant_id
end

#novice_sql_comments ⇒ Object

Returns the value of attribute novice_sql_comments.



26
27
28
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 26

def novice_sql_comments
  @novice_sql_comments
end

#opt_in ⇒ Object

True if they have opted into custom reports



29
30
31
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 29

def opt_in
  @opt_in
end

#opt_in_by_user ⇒ Object

User that opted into custom reporting



32
33
34
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 32

def opt_in_by_user
  @opt_in_by_user
end

#opt_in_date ⇒ Object

Date/time that custom reporting was opted in to



35
36
37
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 35

def opt_in_date
  @opt_in_date
end

#read_only ⇒ Object

Returns the value of attribute read_only.



37
38
39
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 37

def read_only
  @read_only
end

#sql_budget ⇒ Object

Returns the value of attribute sql_budget.



39
40
41
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 39

def sql_budget
  @sql_budget
end

#sql_usage ⇒ Object

Returns the value of attribute sql_usage.



41
42
43
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 41

def sql_usage
  @sql_usage
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 44

def self.attribute_map
  {
    :'ai_budget' => :'ai_budget',
    :'ai_usage' => :'ai_usage',
    :'merchant_id' => :'merchant_id',
    :'novice_sql_comments' => :'novice_sql_comments',
    :'opt_in' => :'opt_in',
    :'opt_in_by_user' => :'opt_in_by_user',
    :'opt_in_date' => :'opt_in_date',
    :'read_only' => :'read_only',
    :'sql_budget' => :'sql_budget',
    :'sql_usage' => :'sql_usage'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



187
188
189
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 187

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 81

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 65

def self.openapi_types
  {
    :'ai_budget' => :'Float',
    :'ai_usage' => :'Float',
    :'merchant_id' => :'String',
    :'novice_sql_comments' => :'Boolean',
    :'opt_in' => :'Boolean',
    :'opt_in_by_user' => :'String',
    :'opt_in_date' => :'String',
    :'read_only' => :'Boolean',
    :'sql_budget' => :'Float',
    :'sql_usage' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ai_budget == o.ai_budget &&
      ai_usage == o.ai_usage &&
      merchant_id == o.merchant_id &&
      novice_sql_comments == o.novice_sql_comments &&
      opt_in == o.opt_in &&
      opt_in_by_user == o.opt_in_by_user &&
      opt_in_date == o.opt_in_date &&
      read_only == o.read_only &&
      sql_budget == o.sql_budget &&
      sql_usage == o.sql_usage
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 218

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 289

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 194

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 180

def hash
  [ai_budget, ai_usage, merchant_id, novice_sql_comments, opt_in, opt_in_by_user, opt_in_date, read_only, sql_budget, sql_usage].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



144
145
146
147
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 144

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 265

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 271

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



259
260
261
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 259

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



151
152
153
 
# File 'lib/ultracart_api/models/custom_report_account_config.rb', line 151

def valid?
  true
end