class SwaggerClient::GetBookableItemsRequest
Attributes
If provided, filters out the appointment with this ID.
The end date of the requested date range. <br />Default: StartDate
When `true`, availabilities that are non-default return, for example, a 30-minute availability with a 60-minute default session length.<br /> When `false`, only availabilities that have the default session length return.
Number of results to include, defaults to 100
A list of the requested location IDs.
Page offset, defaults to 0.
A list of the requested session type IDs.
A list of the requested staff IDs.
The start date of the requested date range. <br />Default: **today’s date**
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/swagger_client/models/get_bookable_items_request.rb, line 45 def self.attribute_map { :'session_type_ids' => :'SessionTypeIds', :'location_ids' => :'LocationIds', :'staff_ids' => :'StaffIds', :'start_date' => :'StartDate', :'end_date' => :'EndDate', :'appointment_id' => :'AppointmentId', :'ignore_default_session_length' => :'IgnoreDefaultSessionLength', :'limit' => :'Limit', :'offset' => :'Offset' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/swagger_client/models/get_bookable_items_request.rb, line 76 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?(:'SessionTypeIds') if (value = attributes[:'SessionTypeIds']).is_a?(Array) self.session_type_ids = value end end if attributes.has_key?(:'LocationIds') if (value = attributes[:'LocationIds']).is_a?(Array) self.location_ids = value end end if attributes.has_key?(:'StaffIds') if (value = attributes[:'StaffIds']).is_a?(Array) self.staff_ids = value end 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?(:'AppointmentId') self.appointment_id = attributes[:'AppointmentId'] end if attributes.has_key?(:'IgnoreDefaultSessionLength') self.ignore_default_session_length = attributes[:'IgnoreDefaultSessionLength'] end if attributes.has_key?(:'Limit') self.limit = attributes[:'Limit'] end if attributes.has_key?(:'Offset') self.offset = attributes[:'Offset'] end end
Attribute type mapping.
# File lib/swagger_client/models/get_bookable_items_request.rb, line 60 def self.swagger_types { :'session_type_ids' => :'Array<Integer>', :'location_ids' => :'Array<Integer>', :'staff_ids' => :'Array<Integer>', :'start_date' => :'DateTime', :'end_date' => :'DateTime', :'appointment_id' => :'Integer', :'ignore_default_session_length' => :'BOOLEAN', :'limit' => :'Integer', :'offset' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/swagger_client/models/get_bookable_items_request.rb, line 145 def ==(o) return true if self.equal?(o) self.class == o.class && session_type_ids == o.session_type_ids && location_ids == o.location_ids && staff_ids == o.staff_ids && start_date == o.start_date && end_date == o.end_date && appointment_id == o.appointment_id && ignore_default_session_length == o.ignore_default_session_length && limit == o.limit && offset == o.offset end
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_bookable_items_request.rb, line 195 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
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_bookable_items_request.rb, line 261 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
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_bookable_items_request.rb, line 174 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
@see the `==` method @param [Object] Object to be compared
# File lib/swagger_client/models/get_bookable_items_request.rb, line 161 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/swagger_client/models/get_bookable_items_request.rb, line 167 def hash [session_type_ids, location_ids, staff_ids, start_date, end_date, appointment_id, ignore_default_session_length, limit, offset].hash end
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_bookable_items_request.rb, line 127 def list_invalid_properties invalid_properties = Array.new if @session_type_ids.nil? invalid_properties.push('invalid value for "session_type_ids", session_type_ids cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/swagger_client/models/get_bookable_items_request.rb, line 247 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/swagger_client/models/get_bookable_items_request.rb, line 235 def to_s to_hash.to_s end
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_bookable_items_request.rb, line 138 def valid? return false if @session_type_ids.nil? true end