Class: Zernio::BatchGetGoogleBusinessReviewsRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ BatchGetGoogleBusinessReviewsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 90

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

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

  if attributes.key?(:'location_names')
    if (value = attributes[:'location_names']).is_a?(Array)
      self.location_names = value
    end
  else
    self.location_names = nil
  end

  if attributes.key?(:'page_size')
    self.page_size = attributes[:'page_size']
  else
    self.page_size = 50
  end

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

  if attributes.key?(:'order_by')
    self.order_by = attributes[:'order_by']
  else
    self.order_by = 'updateTime desc'
  end
end

Instance Attribute Details

#location_names ⇒ Object

Array of full location resource names (e.g. ['accounts/123/locations/456']). Max 50 per request (Google's batchGetReviews cap); chunk larger sets into multiple requests.



19
20
21
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 19

def location_names
  @location_names
end

#order_by ⇒ Object

Sort order requested from Google. Defaults to 'updateTime desc' (newest first), which allows early-stopping pagination once results cross your date window.



28
29
30
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 28

def order_by
  @order_by
end

#page_size ⇒ Object

Number of reviews per page (max 50)



22
23
24
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 22

def page_size
  @page_size
end

#page_token ⇒ Object

Pagination token from previous response



25
26
27
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 25

def page_token
  @page_token
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



63
64
65
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 63

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 68

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 53

def self.attribute_map
  {
    :'location_names' => :'locationNames',
    :'page_size' => :'pageSize',
    :'page_token' => :'pageToken',
    :'order_by' => :'orderBy'
  }
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 262

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 73

def self.openapi_types
  {
    :'location_names' => :'Array<String>',
    :'page_size' => :'Integer',
    :'page_token' => :'String',
    :'order_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      location_names == o.location_names &&
      page_size == o.page_size &&
      page_token == o.page_token &&
      order_by == o.order_by
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


249
250
251
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 255

def hash
  [location_names, page_size, page_token, order_by].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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 131

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @location_names.nil?
    invalid_properties.push('invalid value for "location_names", location_names cannot be nil.')
  end

  if @location_names.length > 50
    invalid_properties.push('invalid value for "location_names", number of items must be less than or equal to 50.')
  end

  if @location_names.length < 1
    invalid_properties.push('invalid value for "location_names", number of items must be greater than or equal to 1.')
  end

  if !@page_size.nil? && @page_size > 50
    invalid_properties.push('invalid value for "page_size", must be smaller than or equal to 50.')
  end

  if !@page_size.nil? && @page_size < 1
    invalid_properties.push('invalid value for "page_size", must be greater than or equal to 1.')
  end

  if !@page_token.nil? && @page_token.to_s.length < 1
    invalid_properties.push('invalid value for "page_token", the character length must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 284

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/zernio-sdk/models/batch_get_google_business_reviews_request.rb', line 163

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @location_names.nil?
  return false if @location_names.length > 50
  return false if @location_names.length < 1
  return false if !@page_size.nil? && @page_size > 50
  return false if !@page_size.nil? && @page_size < 1
  return false if !@page_token.nil? && @page_token.to_s.length < 1
  order_by_validator = EnumAttributeValidator.new('String', ["updateTime desc", "rating", "rating desc"])
  return false unless order_by_validator.valid?(@order_by)
  true
end