class SwaggerClient::GetServicesRequest

Attributes

class_id[RW]

Filters to the pricing options for the specified class ID.

class_schedule_id[RW]

Filters to the pricing options for the specified class schedule ID.

limit[RW]

Number of results to include, defaults to 100

location_id[RW]

When specified, for each returned pricing option, `TaxRate` and `TaxIncluded` are calculated according to the specified location. Note that this does not filter results to only services provided at the given location, and for locations where Value-Added Tax (VAT) rules apply, the `TaxRate` is set to zero.

offset[RW]

Page offset, defaults to 0.

program_ids[RW]

Filters to pricing options with the specified program IDs.

sell_online[RW]

When `true`, filters to the pricing options that can be sold online.<br /> Default: false

service_ids[RW]

Filters to the pricing options with the specified IDs. In this context, service and pricing option are used interchangeably.

session_type_ids[RW]

Filters to the pricing options with the specified session types IDs.

staff_id[RW]

Sets `Price` and `OnlinePrice` to the particular pricing of a specific staff member, if allowed by the business.

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_services_request.rb, line 51
def self.attribute_map
  {
    :'program_ids' => :'ProgramIds',
    :'session_type_ids' => :'SessionTypeIds',
    :'service_ids' => :'ServiceIds',
    :'class_id' => :'ClassId',
    :'class_schedule_id' => :'ClassScheduleId',
    :'sell_online' => :'SellOnline',
    :'location_id' => :'LocationId',
    :'hide_related_programs' => :'HideRelatedPrograms',
    :'staff_id' => :'StaffId',
    :'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_services_request.rb, line 86
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?(:'ProgramIds')
    if (value = attributes[:'ProgramIds']).is_a?(Array)
      self.program_ids = value
    end
  end

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

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

  if attributes.has_key?(:'ClassId')
    self.class_id = attributes[:'ClassId']
  end

  if attributes.has_key?(:'ClassScheduleId')
    self.class_schedule_id = attributes[:'ClassScheduleId']
  end

  if attributes.has_key?(:'SellOnline')
    self.sell_online = attributes[:'SellOnline']
  end

  if attributes.has_key?(:'LocationId')
    self.location_id = attributes[:'LocationId']
  end

  if attributes.has_key?(:'HideRelatedPrograms')
    self.hide_related_programs = attributes[:'HideRelatedPrograms']
  end

  if attributes.has_key?(:'StaffId')
    self.staff_id = attributes[:'StaffId']
  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_services_request.rb, line 68
def self.swagger_types
  {
    :'program_ids' => :'Array<Integer>',
    :'session_type_ids' => :'Array<Integer>',
    :'service_ids' => :'Array<String>',
    :'class_id' => :'Integer',
    :'class_schedule_id' => :'Integer',
    :'sell_online' => :'BOOLEAN',
    :'location_id' => :'Integer',
    :'hide_related_programs' => :'BOOLEAN',
    :'staff_id' => :'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_services_request.rb, line 158
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      program_ids == o.program_ids &&
      session_type_ids == o.session_type_ids &&
      service_ids == o.service_ids &&
      class_id == o.class_id &&
      class_schedule_id == o.class_schedule_id &&
      sell_online == o.sell_online &&
      location_id == o.location_id &&
      hide_related_programs == o.hide_related_programs &&
      staff_id == o.staff_id &&
      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_services_request.rb, line 210
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_services_request.rb, line 276
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_services_request.rb, line 189
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_services_request.rb, line 176
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_services_request.rb, line 182
def hash
  [program_ids, session_type_ids, service_ids, class_id, class_schedule_id, sell_online, location_id, hide_related_programs, staff_id, 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_services_request.rb, line 145
def list_invalid_properties
  invalid_properties = Array.new
  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_services_request.rb, line 256
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_services_request.rb, line 262
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_services_request.rb, line 250
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_services_request.rb, line 152
def valid?
  true
end