Class: SwaggerClient::GetClientContractsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/models/get_client_contracts_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetClientContractsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 56

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'ClientId')
    self.client_id = attributes[:'ClientId']
  end

  if attributes.has_key?(:'CrossRegionalLookup')
    self.cross_regional_lookup = attributes[:'CrossRegionalLookup']
  end

  if attributes.has_key?(:'ClientAssociatedSitesOffset')
    self.client_associated_sites_offset = attributes[:'ClientAssociatedSitesOffset']
  end

  if attributes.has_key?(:'Limit')
    self.limit = attributes[:'Limit']
  end

  if attributes.has_key?(:'Offset')
    self.offset = attributes[:'Offset']
  end
end

Instance Attribute Details

#client_associated_sites_offset ⇒ Object

Determines how many sites are skipped over when retrieving a client’s cross regional contracts. Used when a client ID is linked to more than ten sites in an organization. Only a maximum of ten site databases are queried when this call is made and ‘CrossRegionalLookup` is set to `true`. To change which sites are queried, change this offset value. Default: 0



24
25
26
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 24

def client_associated_sites_offset
  @client_associated_sites_offset
end

#client_id ⇒ Object

The ID of the client.



18
19
20
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 18

def client_id
  @client_id
end

#cross_regional_lookup ⇒ Object

When ‘true`, indicates that the requesting client’s cross regional contracts are returned, if any.<br /> When `false`, indicates that cross regional contracts are not returned.



21
22
23
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 21

def cross_regional_lookup
  @cross_regional_lookup
end

#limit ⇒ Object

Number of results to include, defaults to 100



27
28
29
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 27

def limit
  @limit
end

#offset ⇒ Object

Page offset, defaults to 0.



30
31
32
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 30

def offset
  @offset
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 33

def self.attribute_map
  {
    :'client_id' => :'ClientId',
    :'cross_regional_lookup' => :'CrossRegionalLookup',
    :'client_associated_sites_offset' => :'ClientAssociatedSitesOffset',
    :'limit' => :'Limit',
    :'offset' => :'Offset'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 44

def self.swagger_types
  {
    :'client_id' => :'String',
    :'cross_regional_lookup' => :'BOOLEAN',
    :'client_associated_sites_offset' => :'Integer',
    :'limit' => :'Integer',
    :'offset' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



103
104
105
106
107
108
109
110
111
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 103

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      cross_regional_lookup == o.cross_regional_lookup &&
      client_associated_sites_offset == o.client_associated_sites_offset &&
      limit == o.limit &&
      offset == o.offset
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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 149

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = SwaggerClient.const_get(type).new
    temp_model.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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 215

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 128

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


115
116
117
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 115

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 121

def hash
  [client_id, cross_regional_lookup, client_associated_sites_offset, limit, offset].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



85
86
87
88
89
90
91
92
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 85

def list_invalid_properties
  invalid_properties = Array.new
  if @client_id.nil?
    invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
  end

  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



195
196
197
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 195

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



201
202
203
204
205
206
207
208
209
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 201

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



189
190
191
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 189

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



96
97
98
99
 
# File 'lib/swagger_client/models/get_client_contracts_request.rb', line 96

def valid?
  return false if @client_id.nil?
  true
end