class PureCloud::BuIntradayResponse
Attributes
The categories to which this data corresponds
The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The aggregation period in minutes, which determines the interval duration of the returned data
Intraday data grouped by a single media type and set of planning group IDs
If not null, the reason there was no data for the request
Schedule
reference
Short term forecast reference
The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 46 def self.attribute_map { :'start_date' => :'startDate', :'end_date' => :'endDate', :'interval_length_minutes' => :'intervalLengthMinutes', :'no_data_reason' => :'noDataReason', :'categories' => :'categories', :'short_term_forecast' => :'shortTermForecast', :'schedule' => :'schedule', :'intraday_data_groupings' => :'intradayDataGroupings' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 93 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?(:'startDate') self.start_date = attributes[:'startDate'] end if attributes.has_key?(:'endDate') self.end_date = attributes[:'endDate'] end if attributes.has_key?(:'intervalLengthMinutes') self.interval_length_minutes = attributes[:'intervalLengthMinutes'] end if attributes.has_key?(:'noDataReason') self.no_data_reason = attributes[:'noDataReason'] end if attributes.has_key?(:'categories') if (value = attributes[:'categories']).is_a?(Array) self.categories = value end end if attributes.has_key?(:'shortTermForecast') self.short_term_forecast = attributes[:'shortTermForecast'] end if attributes.has_key?(:'schedule') self.schedule = attributes[:'schedule'] end if attributes.has_key?(:'intradayDataGroupings') if (value = attributes[:'intradayDataGroupings']).is_a?(Array) self.intraday_data_groupings = value end end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 69 def self.swagger_types { :'start_date' => :'DateTime', :'end_date' => :'DateTime', :'interval_length_minutes' => :'Integer', :'no_data_reason' => :'String', :'categories' => :'Array<String>', :'short_term_forecast' => :'BuShortTermForecastReference', :'schedule' => :'BuScheduleReference', :'intraday_data_groupings' => :'Array<BuIntradayDataGroup>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 282 def ==(o) return true if self.equal?(o) self.class == o.class && start_date == o.start_date && end_date == o.end_date && interval_length_minutes == o.interval_length_minutes && no_data_reason == o.no_data_reason && categories == o.categories && short_term_forecast == o.short_term_forecast && schedule == o.schedule && intraday_data_groupings == o.intraday_data_groupings end
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 327 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 387 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 the object from hash
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 308 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 297 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 303 def hash [start_date, end_date, interval_length_minutes, no_data_reason, categories, short_term_forecast, schedule, intraday_data_groupings].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 180 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] no_data_reason
Object to be assigned
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 249 def no_data_reason=(no_data_reason) allowed_values = ["NoPublishedSchedule", "NoSourceForecast"] if no_data_reason && !allowed_values.include?(no_data_reason) fail ArgumentError, "invalid value for 'no_data_reason', must be one of #{allowed_values}." end @no_data_reason = no_data_reason end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 375 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
# File lib/purecloudplatformclientv2/models/bu_intraday_response.rb, line 365 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/purecloudplatformclientv2/models/bu_intraday_response.rb, line 189 def valid? allowed_values = ["NoPublishedSchedule", "NoSourceForecast"] if @no_data_reason && !allowed_values.include?(@no_data_reason) return false end end