Class: Tremendous::SingleRewardOrderWithoutLinkOrder

Inherits:

Object

• Object
• Tremendous::SingleRewardOrderWithoutLinkOrder

Defined in:

lib/tremendous/models/single_reward_order_without_link_order.rb

Overview

An order wraps around the fulfilment of one or more rewards.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary

• #campaign_id ⇒ Object

  ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.

• #channel ⇒ Object

  Name of the channel in which the order was created.

• #created_at ⇒ Object

  Date the order was created.

• #external_id ⇒ Object

  Reference for this order, supplied by the customer.

• #id ⇒ Object

  Tremendous ID of the order.

• #invoice_id ⇒ Object

  The ID for the invoice associated with this order.

• #payment ⇒ Object

  Returns the value of attribute payment.

• #rewards ⇒ Object

  Returns the value of attribute rewards.

• #status ⇒ Object

  Execution status of a given order

  Status

  Description

  CANCELED

  The order and all of its rewards were canceled. Class Method Summary ._deserialize(type, value) ⇒ Object Deserializes the data based on type. .acceptable_attribute_map ⇒ Object Returns attribute mapping this model knows about. .acceptable_attributes ⇒ Object Returns all the JSON keys this model knows about. .attribute_map ⇒ Object Attribute mapping from ruby-style variable name to JSON key. .build_from_hash(attributes) ⇒ Object Builds the object from hash. .openapi_nullable ⇒ Object List of attributes with nullable: true. .openapi_types ⇒ Object Attribute type mapping. Instance Method Summary #==(o) ⇒ Object Checks equality by comparing each attribute. #_to_hash(value) ⇒ Hash Outputs non-array value in the form of hash For object, use to_hash. #eql?(o) ⇒ Boolean #hash ⇒ Integer Calculates hash code according to all attributes. #initialize(attributes = {}) ⇒ SingleRewardOrderWithoutLinkOrder constructor Initializes the object. #list_invalid_properties ⇒ Object Show invalid properties with the reasons. #to_body ⇒ Hash to_body is an alias to to_hash (backward compatibility). #to_hash ⇒ Hash Returns the object in the form of hash. #to_s ⇒ String Returns the string representation of the object. #valid? ⇒ Boolean Check to see if the all the properties in the model are valid. Constructor Details #initialize(attributes = {}) ⇒ SingleRewardOrderWithoutLinkOrder Initializes the object Parameters: attributes (Hash) (defaults to: {}) — Model attributes in the form of hash # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 116 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::SingleRewardOrderWithoutLinkOrder` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!acceptable_attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::SingleRewardOrderWithoutLinkOrder`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'id') self.id = attributes[:'id'] else self.id = nil end if attributes.key?(:'external_id') self.external_id = attributes[:'external_id'] end if attributes.key?(:'campaign_id') self.campaign_id = attributes[:'campaign_id'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] else self.created_at = nil end if attributes.key?(:'status') self.status = attributes[:'status'] else self.status = nil end if attributes.key?(:'channel') self.channel = attributes[:'channel'] end if attributes.key?(:'payment') self.payment = attributes[:'payment'] end if attributes.key?(:'invoice_id') self.invoice_id = attributes[:'invoice_id'] end if attributes.key?(:'rewards') if (value = attributes[:'rewards']).is_a?(Array) self.rewards = value end end end Instance Attribute Details #campaign_id ⇒ Object ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 26 def campaign_id @campaign_id end #channel ⇒ Object Name of the channel in which the order was created # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 35 def channel @channel end #created_at ⇒ Object Date the order was created # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 29 def created_at @created_at end #external_id ⇒ Object Reference for this order, supplied by the customer. When set, external_id makes order idempotent. All requests that use the same external_id after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a 201 response code. These responses fail to create any further orders. It also allows for retrieving by external_id instead of id only. # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 23 def external_id @external_id end #id ⇒ Object Tremendous ID of the order # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 20 def id @id end #invoice_id ⇒ Object The ID for the invoice associated with this order # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 40 def invoice_id @invoice_id end #payment ⇒ Object Returns the value of attribute payment. # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 37 def payment @payment end #rewards ⇒ Object Returns the value of attribute rewards. # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 42 def rewards @rewards end #status ⇒ Object Execution status of a given order Status Description CANCELED The order and all of its rewards were canceled. OPEN The order has been created, but hasn't yet been processed. EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable). FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account. PENDING APPROVAL The order has been created but needs approval to be executed. PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team. PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears. # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 32 def status @status end Class Method Details ._deserialize(type, value) ⇒ Object Deserializes the data based on type Parameters: string — type Data type string — value Value to be deserialized Returns: (Object) — Deserialized data # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 332 def self._deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Tremendous.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end .acceptable_attribute_map ⇒ Object Returns attribute mapping this model knows about # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 82 def self.acceptable_attribute_map attribute_map end .acceptable_attributes ⇒ Object Returns all the JSON keys this model knows about # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 87 def self.acceptable_attributes acceptable_attribute_map.values end .attribute_map ⇒ Object Attribute mapping from ruby-style variable name to JSON key. # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 67 def self.attribute_map { :'id' => :'id', :'external_id' => :'external_id', :'campaign_id' => :'campaign_id', :'created_at' => :'created_at', :'status' => :'status', :'channel' => :'channel', :'payment' => :'payment', :'invoice_id' => :'invoice_id', :'rewards' => :'rewards' } end .build_from_hash(attributes) ⇒ Object Builds the object from hash Parameters: attributes (Hash) — Model attributes in the form of hash Returns: (Object) — Returns the model itself # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 308 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end .openapi_nullable ⇒ Object List of attributes with nullable: true # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 107 def self.openapi_nullable Set.new([ :'external_id', :'campaign_id', ]) end .openapi_types ⇒ Object Attribute type mapping. # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 92 def self.openapi_types { :'id' => :'String', :'external_id' => :'String', :'campaign_id' => :'String', :'created_at' => :'Time', :'status' => :'String', :'channel' => :'String', :'payment' => :'OrderBasePayment', :'invoice_id' => :'String', :'rewards' => :'Array<OrderWithoutLinkRewardsInner>' } end Instance Method Details #==(o) ⇒ Object Checks equality by comparing each attribute. Parameters: Object (Object) — to be compared # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 279 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && external_id == o.external_id && campaign_id == o.campaign_id && created_at == o.created_at && status == o.status && channel == o.channel && payment == o.payment && invoice_id == o.invoice_id && rewards == o.rewards end #_to_hash(value) ⇒ Hash Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value Parameters: value (Object) — Any valid value Returns: (Hash) — Returns the value in the form of hash # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 403 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 #eql?(o) ⇒ Boolean Parameters: Object (Object) — to be compared Returns: (Boolean) See Also: `==` method # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 295 def eql?(o) self == o end #hash ⇒ Integer Calculates hash code according to all attributes. Returns: (Integer) — Hash code # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 301 def hash [id, external_id, campaign_id, created_at, status, channel, payment, invoice_id, rewards].hash end #list_invalid_properties ⇒ Object Show invalid properties with the reasons. Usually used together with valid? Returns: Array for valid properties with the reasons # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 177 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end pattern = Regexp.new(/[A-Z0-9]{4,20}/) if @id !~ pattern invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.") end pattern = Regexp.new(/[A-Z0-9]{4,20}/) if !@campaign_id.nil? && @campaign_id !~ pattern invalid_properties.push("invalid value for \"campaign_id\", must conform to the pattern #{pattern}.") end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end invalid_properties end #to_body ⇒ Hash to_body is an alias to to_hash (backward compatibility) Returns: (Hash) — Returns the object in the form of hash # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 379 def to_body to_hash end #to_hash ⇒ Hash Returns the object in the form of hash Returns: (Hash) — Returns the object in the form of hash # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 385 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end #to_s ⇒ String Returns the string representation of the object Returns: (String) — String presentation of the object # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 373 def to_s to_hash.to_s end #valid? ⇒ Boolean Check to see if the all the properties in the model are valid Returns: (Boolean) — true if the model is valid # File 'lib/tremendous/models/single_reward_order_without_link_order.rb', line 207 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @id.nil? return false if @id !~ Regexp.new(/[A-Z0-9]{4,20}/) return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/[A-Z0-9]{4,20}/) return false if @created_at.nil? return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ["CANCELED", "OPEN", "EXECUTED", "FAILED", "PENDING APPROVAL", "PENDING INTERNAL PAYMENT APPROVAL", "PENDING SETTLEMENT"]) return false unless status_validator.valid?(@status) channel_validator = EnumAttributeValidator.new('String', ["UI", "API", "EMBED", "DECIPHER", "QUALTRICS", "TYPEFORM", "SURVEY MONKEY", "YOTPO"]) return false unless channel_validator.valid?(@channel) true end Generated on Tue Aug 4 18:34:17 2026 by yard 0.9.45 (ruby-4.0.2).