class CyberSource::CreateAdhocReportRequest
Attributes
Specifies the group name
Valid CyberSource
Organization Id
End time of the report
List of fields which needs to get included in a report
List of filters to apply
'Format of the report' Valid values: - application/xml - text/csv
Name of the report
Start time of the report
Timezone of the report
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 49 def self.attribute_map { :'organization_id' => :'organizationId', :'report_definition_name' => :'reportDefinitionName', :'report_fields' => :'reportFields', :'report_mime_type' => :'reportMimeType', :'report_name' => :'reportName', :'timezone' => :'timezone', :'report_start_time' => :'reportStartTime', :'report_end_time' => :'reportEndTime', :'report_filters' => :'reportFilters', :'report_preferences' => :'reportPreferences', :'group_name' => :'groupName' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 84 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?(:'organizationId') self.organization_id = attributes[:'organizationId'] end if attributes.has_key?(:'reportDefinitionName') self.report_definition_name = attributes[:'reportDefinitionName'] end if attributes.has_key?(:'reportFields') if (value = attributes[:'reportFields']).is_a?(Array) self.report_fields = value end end if attributes.has_key?(:'reportMimeType') self.report_mime_type = attributes[:'reportMimeType'] end if attributes.has_key?(:'reportName') self.report_name = attributes[:'reportName'] end if attributes.has_key?(:'timezone') self.timezone = attributes[:'timezone'] end if attributes.has_key?(:'reportStartTime') self.report_start_time = attributes[:'reportStartTime'] end if attributes.has_key?(:'reportEndTime') self.report_end_time = attributes[:'reportEndTime'] end if attributes.has_key?(:'reportFilters') if (value = attributes[:'reportFilters']).is_a?(Hash) self.report_filters = value end end if attributes.has_key?(:'reportPreferences') self.report_preferences = attributes[:'reportPreferences'] end if attributes.has_key?(:'groupName') self.group_name = attributes[:'groupName'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 66 def self.swagger_types { :'organization_id' => :'String', :'report_definition_name' => :'String', :'report_fields' => :'Array<String>', :'report_mime_type' => :'String', :'report_name' => :'String', :'timezone' => :'String', :'report_start_time' => :'DateTime', :'report_end_time' => :'DateTime', :'report_filters' => :'Hash<String, Array<String>>', :'report_preferences' => :'Reportingv3reportsReportPreferences', :'group_name' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 214 def ==(o) return true if self.equal?(o) self.class == o.class && organization_id == o.organization_id && report_definition_name == o.report_definition_name && report_fields == o.report_fields && report_mime_type == o.report_mime_type && report_name == o.report_name && timezone == o.timezone && report_start_time == o.report_start_time && report_end_time == o.report_end_time && report_filters == o.report_filters && report_preferences == o.report_preferences && group_name == o.group_name 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/cybersource_rest_client/models/create_adhoc_report_request.rb, line 266 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 = CyberSource.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/cybersource_rest_client/models/create_adhoc_report_request.rb, line 332 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/cybersource_rest_client/models/create_adhoc_report_request.rb, line 245 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/cybersource_rest_client/models/create_adhoc_report_request.rb, line 232 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] group_name
Value to be assigned
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 204 def group_name=(group_name) #if !group_name.nil? && group_name !~ Regexp.new(/[0-9]*/) #fail ArgumentError, 'invalid value for "group_name", must conform to the pattern /[0-9]*/.' #end @group_name = group_name end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 238 def hash [organization_id, report_definition_name, report_fields, report_mime_type, report_name, timezone, report_start_time, report_end_time, report_filters, report_preferences, group_name].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 141 def list_invalid_properties invalid_properties = Array.new #if !@organization_id.nil? && @organization_id !~ Regexp.new(/[a-zA-Z0-9-_]+/) #invalid_properties.push('invalid value for "organization_id", must conform to the pattern /[a-zA-Z0-9-_]+/.') #end #if !@report_definition_name.nil? && @report_definition_name !~ Regexp.new(/[a-zA-Z0-9-]+/) #invalid_properties.push('invalid value for "report_definition_name", must conform to the pattern /[a-zA-Z0-9-]+/.') #end #if !@report_name.nil? && @report_name !~ Regexp.new(/[a-zA-Z0-9-_ ]+/) #invalid_properties.push('invalid value for "report_name", must conform to the pattern /[a-zA-Z0-9-_ ]+/.') #end #if !@group_name.nil? && @group_name !~ Regexp.new(/[0-9]*/) #invalid_properties.push('invalid value for "group_name", must conform to the pattern /[0-9]*/.') #end invalid_properties end
Custom attribute writer method with validation @param [Object] organization_id
Value to be assigned
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 174 def organization_id=(organization_id) #if !organization_id.nil? && organization_id !~ Regexp.new(/[a-zA-Z0-9-_]+/) #fail ArgumentError, 'invalid value for "organization_id", must conform to the pattern /[a-zA-Z0-9-_]+/.' #end @organization_id = organization_id end
Custom attribute writer method with validation @param [Object] report_definition_name
Value to be assigned
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 184 def report_definition_name=(report_definition_name) #if !report_definition_name.nil? && report_definition_name !~ Regexp.new(/[a-zA-Z0-9-]+/) #fail ArgumentError, 'invalid value for "report_definition_name", must conform to the pattern /[a-zA-Z0-9-]+/.' #end @report_definition_name = report_definition_name end
Custom attribute writer method with validation @param [Object] report_name
Value to be assigned
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 194 def report_name=(report_name) #if !report_name.nil? && report_name !~ Regexp.new(/[a-zA-Z0-9-_ ]+/) #fail ArgumentError, 'invalid value for "report_name", must conform to the pattern /[a-zA-Z0-9-_ ]+/.' #end @report_name = report_name end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cybersource_rest_client/models/create_adhoc_report_request.rb, line 318 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/cybersource_rest_client/models/create_adhoc_report_request.rb, line 306 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/cybersource_rest_client/models/create_adhoc_report_request.rb, line 164 def valid? #return false if !@organization_id.nil? && @organization_id !~ Regexp.new(/[a-zA-Z0-9-_]+/) #return false if !@report_definition_name.nil? && @report_definition_name !~ Regexp.new(/[a-zA-Z0-9-]+/) #return false if !@report_name.nil? && @report_name !~ Regexp.new(/[a-zA-Z0-9-_ ]+/) #return false if !@group_name.nil? && @group_name !~ Regexp.new(/[0-9]*/) true end