class CyberSource::PredefinedSubscriptionRequestBean
Attributes
Valid Report Definition Name
'The frequency for which subscription is created. For Standard we can have DAILY, WEEKLY and MONTHLY. But for Classic we will have only DAILY.' **NOTE: Do not document USER_DEFINED Frequency field in developer center** Valid Values: - 'DAILY' - 'WEEKLY' - 'MONTHLY' - 'USER_DEFINED'
If the reportFrequency is User-defined, reportInterval should be in **ISO 8601 time format** Please refer the following link to know more about ISO 8601 format.[Rfc Time Format](en.wikipedia.org/wiki/ISO_8601#Durations) **Example time format for 2 hours and 30 Mins:** - PT2H30M **NOTE: Do not document reportInterval field in developer center**
Report Format Valid Values: - application/xml - text/csv
This is the start day if the frequency is WEEKLY or MONTHLY. The value varies from 1-7 for WEEKLY and 1-31 for MONTHLY. For WEEKLY 1 means Sunday and 7 means Saturday. By default the value is 1.
The hour at which the report generation should start. It should be in hhmm format. By Default it will be 0000. The format is 24 hours format.
The status for subscription which is either created or updated. By default it is ACTIVE. Valid Values: - ACTIVE - INACTIVE
The subscription type for which report definition is required. Valid values are CLASSIC and STANDARD. Valid Values: - CLASSIC - STANDARD
By Default the timezone for Standard subscription is PST. And for Classic subscription it will be GMT. If user provides any other time zone apart from PST for Standard subscription api should error out.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb, line 47 def self.attribute_map { :'report_definition_name' => :'reportDefinitionName', :'subscription_type' => :'subscriptionType', :'report_name' => :'reportName', :'report_mime_type' => :'reportMimeType', :'report_frequency' => :'reportFrequency', :'report_interval' => :'reportInterval', :'timezone' => :'timezone', :'start_time' => :'startTime', :'start_day' => :'startDay', :'subscription_status' => :'subscriptionStatus' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb, line 80 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?(:'reportDefinitionName') self.report_definition_name = attributes[:'reportDefinitionName'] end if attributes.has_key?(:'subscriptionType') self.subscription_type = attributes[:'subscriptionType'] end if attributes.has_key?(:'reportName') self.report_name = attributes[:'reportName'] end if attributes.has_key?(:'reportMimeType') self.report_mime_type = attributes[:'reportMimeType'] end if attributes.has_key?(:'reportFrequency') self.report_frequency = attributes[:'reportFrequency'] end if attributes.has_key?(:'reportInterval') self.report_interval = attributes[:'reportInterval'] end if attributes.has_key?(:'timezone') self.timezone = attributes[:'timezone'] end if attributes.has_key?(:'startTime') self.start_time = attributes[:'startTime'] end if attributes.has_key?(:'startDay') self.start_day = attributes[:'startDay'] end if attributes.has_key?(:'subscriptionStatus') self.subscription_status = attributes[:'subscriptionStatus'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb, line 63 def self.swagger_types { :'report_definition_name' => :'String', :'subscription_type' => :'String', :'report_name' => :'String', :'report_mime_type' => :'String', :'report_frequency' => :'String', :'report_interval' => :'String', :'timezone' => :'String', :'start_time' => :'String', :'start_day' => :'Integer', :'subscription_status' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb, line 225 def ==(o) return true if self.equal?(o) self.class == o.class && report_definition_name == o.report_definition_name && subscription_type == o.subscription_type && report_name == o.report_name && report_mime_type == o.report_mime_type && report_frequency == o.report_frequency && report_interval == o.report_interval && timezone == o.timezone && start_time == o.start_time && start_day == o.start_day && subscription_status == o.subscription_status 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/predefined_subscription_request_bean.rb, line 276 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/predefined_subscription_request_bean.rb, line 342 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/predefined_subscription_request_bean.rb, line 255 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/predefined_subscription_request_bean.rb, line 242 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb, line 248 def hash [report_definition_name, subscription_type, report_name, report_mime_type, report_frequency, report_interval, timezone, start_time, start_day, subscription_status].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/predefined_subscription_request_bean.rb, line 129 def list_invalid_properties invalid_properties = Array.new if @report_definition_name.nil? invalid_properties.push('invalid value for "report_definition_name", report_definition_name cannot be nil.') end #if @report_definition_name !~ Regexp.new(/[a-zA-Z]+/) #invalid_properties.push('invalid value for "report_definition_name", must conform to the pattern /[a-zA-Z]+/.') #end if @subscription_type.nil? invalid_properties.push('invalid value for "subscription_type", subscription_type cannot be nil.') 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 !@report_interval.nil? && @report_interval !~ Regexp.new(/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/) #invalid_properties.push('invalid value for "report_interval", must conform to the pattern /^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/.') #end if !@start_day.nil? && @start_day > 31 invalid_properties.push('invalid value for "start_day", must be smaller than or equal to 31.') end if !@start_day.nil? && @start_day < 1 invalid_properties.push('invalid value for "start_day", must be greater than or equal to 1.') end invalid_properties end
Custom attribute writer method with validation @param [Object] report_definition_name
Value to be assigned
# File lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb, line 177 def report_definition_name=(report_definition_name) if report_definition_name.nil? fail ArgumentError, 'report_definition_name cannot be nil' end #if report_definition_name !~ Regexp.new(/[a-zA-Z]+/) #fail ArgumentError, 'invalid value for "report_definition_name", must conform to the pattern /[a-zA-Z]+/.' #end @report_definition_name = report_definition_name end
Custom attribute writer method with validation @param [Object] report_interval
Value to be assigned
# File lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb, line 201 def report_interval=(report_interval) #if !report_interval.nil? && report_interval !~ Regexp.new(/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/) #fail ArgumentError, 'invalid value for "report_interval", must conform to the pattern /^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/.' #end @report_interval = report_interval end
Custom attribute writer method with validation @param [Object] report_name
Value to be assigned
# File lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb, line 191 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
Custom attribute writer method with validation @param [Object] start_day
Value to be assigned
# File lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb, line 211 def start_day=(start_day) if !start_day.nil? && start_day > 31 fail ArgumentError, 'invalid value for "start_day", must be smaller than or equal to 31.' end if !start_day.nil? && start_day < 1 fail ArgumentError, 'invalid value for "start_day", must be greater than or equal to 1.' end @start_day = start_day 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/predefined_subscription_request_bean.rb, line 328 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/predefined_subscription_request_bean.rb, line 316 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/predefined_subscription_request_bean.rb, line 164 def valid? return false if @report_definition_name.nil? #return false if @report_definition_name !~ Regexp.new(/[a-zA-Z]+/) return false if @subscription_type.nil? #return false if !@report_name.nil? && @report_name !~ Regexp.new(/[a-zA-Z0-9-_ ]+/) #return false if !@report_interval.nil? && @report_interval !~ Regexp.new(/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/) return false if !@start_day.nil? && @start_day > 31 return false if !@start_day.nil? && @start_day < 1 true end