class SwaggerClient::GetClientServicesRequest

Attributes

class_id[RW]

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

client_associated_sites_offset[RW]

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

client_id[RW]

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.

cross_regional_lookup[RW]

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

end_date[RW]

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

limit[RW]

Number of results to include, defaults to 100

location_ids[RW]

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

offset[RW]

Page offset, defaults to 0.

program_ids[RW]

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

session_type_id[RW]

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.

show_active_only[RW]

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

start_date[RW]

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

visit_count[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/swagger_client/models/get_client_services_request.rb, line 199
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/swagger_client/models/get_client_services_request.rb, line 279
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/swagger_client/models/get_client_services_request.rb, line 273
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/swagger_client/models/get_client_services_request.rb, line 172
def valid?
  return false if @client_id.nil?
  true
end