Class: SwaggerClient::GetClientServicesRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetClientServicesRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 96

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?(:'ClassId')
    self.class_id = attributes[:'ClassId']
  end

  if attributes.has_key?(:'ProgramIds')
    if (value = attributes[:'ProgramIds']).is_a?(Array)
      self.program_ids = value
    end
  end

  if attributes.has_key?(:'SessionTypeId')
    self.session_type_id = attributes[:'SessionTypeId']
  end

  if attributes.has_key?(:'LocationIds')
    if (value = attributes[:'LocationIds']).is_a?(Array)
      self.location_ids = value
    end
  end

  if attributes.has_key?(:'VisitCount')
    self.visit_count = attributes[:'VisitCount']
  end

  if attributes.has_key?(:'StartDate')
    self.start_date = attributes[:'StartDate']
  end

  if attributes.has_key?(:'EndDate')
    self.end_date = attributes[:'EndDate']
  end

  if attributes.has_key?(:'ShowActiveOnly')
    self.show_active_only = attributes[:'ShowActiveOnly']
  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

#class_id ⇒ Object

Filters results to only those pricing options that can be used to pay for this class.



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

def class_id
  @class_id
end

#client_associated_sites_offset ⇒ Object

Used to retrieve a client’s pricing options from multiple sites within an organization when the client is associated with more than ten sites. To change which ten sites are searched, change this offset value. A value of 0 means that no sites are skipped and the first ten sites are returned. You can use the ‘CrossRegionalClientAssociations` value from `GET CrossRegionalClientAssociations` to determine how many sites the client is associated with. Note that you must always have `CrossRegionalLookup` set to `true` to use this parameter.<br /> Default: 0 For example, if a client is associated with 25 sites, you need to call `GetClientServices` three times, as follows: * Use `GET CrossRegionalClientAssociations` to determine how many sites a client is associated with, which tells you how many additional calls you need to make. * Either omit `ClientAssociatedSitesOffset` or set it to 0 to return the client’s services (pricing options) from sites 1-10. * Set `ClientAssociatedSitesOffset` to 10 to return the client pricing options from sites 11-20 * Set `ClientAssociatedSitesOffset` to 20 to return the client pricing options from sites 21-25



48
49
50
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 48

def client_associated_sites_offset
  @client_associated_sites_offset
end

#client_id ⇒ Object

The ID of the client to query. The results are a list of pricing options that the client has purchased. Note that “service” and “pricing option” are synonymous in this section of the documentation.



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

def client_id
  @client_id
end

#cross_regional_lookup ⇒ Object

Used to retrieve a client’s pricing options from multiple sites within an organization. When included and set to ‘true`, it searches a maximum of ten sites with which this client is associated. When a client is associated with more than ten sites, use `ClientAssociatedSitesOffset` as many times as needed to search the additional sites with which the client is associated. You can use the `CrossRegionalClientAssociations` value from `GET CrossRegionalClientAssociations` to determine how many sites the client is associated with. Note that a `SiteID` is returned and populated in the `ClientServices` response when `CrossRegionalLookup` is set to `true`. Default: false



45
46
47
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 45

def cross_regional_lookup
  @cross_regional_lookup
end

#end_date ⇒ Object

Filters results to pricing options that are valid on or before this date.



39
40
41
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 39

def end_date
  @end_date
end

#limit ⇒ Object

Number of results to include, defaults to 100



51
52
53
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 51

def limit
  @limit
end

#location_ids ⇒ Object

Filters results to pricing options that can be used at the listed location IDs.



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

def location_ids
  @location_ids
end

#offset ⇒ Object

Page offset, defaults to 0.



54
55
56
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 54

def offset
  @offset
end

#program_ids ⇒ Object

Filters results to pricing options that belong to one of the given program IDs.



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

def program_ids
  @program_ids
end

#session_type_id ⇒ Object

Filters results to pricing options that will pay for the given session type ID. Use this to find pricing options that will pay for a specific appointment type.



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

def session_type_id
  @session_type_id
end

#show_active_only ⇒ Object

When ‘true`, includes active services only. Default: false



42
43
44
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 42

def show_active_only
  @show_active_only
end

#start_date ⇒ Object

Filters results to pricing options that are valid on or after this date.



36
37
38
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 36

def start_date
  @start_date
end

#visit_count ⇒ Object

A filter on the minimum number of visits a service can pay for.



33
34
35
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 33

def visit_count
  @visit_count
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 57

def self.attribute_map
  {
    :'client_id' => :'ClientId',
    :'class_id' => :'ClassId',
    :'program_ids' => :'ProgramIds',
    :'session_type_id' => :'SessionTypeId',
    :'location_ids' => :'LocationIds',
    :'visit_count' => :'VisitCount',
    :'start_date' => :'StartDate',
    :'end_date' => :'EndDate',
    :'show_active_only' => :'ShowActiveOnly',
    :'cross_regional_lookup' => :'CrossRegionalLookup',
    :'client_associated_sites_offset' => :'ClientAssociatedSitesOffset',
    :'limit' => :'Limit',
    :'offset' => :'Offset'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 76

def self.swagger_types
  {
    :'client_id' => :'String',
    :'class_id' => :'Integer',
    :'program_ids' => :'Array<Integer>',
    :'session_type_id' => :'Integer',
    :'location_ids' => :'Array<Integer>',
    :'visit_count' => :'Integer',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'show_active_only' => :'BOOLEAN',
    :'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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      class_id == o.class_id &&
      program_ids == o.program_ids &&
      session_type_id == o.session_type_id &&
      location_ids == o.location_ids &&
      visit_count == o.visit_count &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      show_active_only == o.show_active_only &&
      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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 233

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 299

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



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

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


199
200
201
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



205
206
207
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 205

def hash
  [client_id, class_id, program_ids, session_type_id, location_ids, visit_count, start_date, end_date, show_active_only, 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



161
162
163
164
165
166
167
168
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 161

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



279
280
281
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 279

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



285
286
287
288
289
290
291
292
293
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 285

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



273
274
275
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 273

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



172
173
174
175
 
# File 'lib/swagger_client/models/get_client_services_request.rb', line 172

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