tangocard-raas 1.1.2 → 2.2.1

data/lib/raas/models/get_orders_response_model.rb

@@ -1,22 +1,22 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # Represents the response from the get orders call
   class GetOrdersResponseModel < BaseModel
     # Pagination information
     # @return [PageModel]
     attr_accessor :page
 
     # An array of orders
-    # @return [List of OrderModel]
+    # @return [List of OrderSummaryModel]
     attr_accessor :orders
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["page"] = "page"
-        @_hash["orders"] = "orders"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['orders'] = 'orders'
       @_hash
     end
 
@@ -26,20 +26,22 @@ module Raas
       @orders = orders
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       page = PageModel.from_hash(hash['page']) if hash['page']
       # Parameter is an array, so we need to iterate through it
       orders = nil
-      if hash['orders'] != nil
-        orders = Array.new
-        hash['orders'].each{|structure| orders << (OrderModel.from_hash(structure) if structure)}
+      unless hash['orders'].nil?
+        orders = []
+        hash['orders'].each do |structure|
+          orders << (OrderSummaryModel.from_hash(structure) if structure)
+        end
       end
 
-      # Create object from extracted values
+      # Create object from extracted values.
       GetOrdersResponseModel.new(page,
                                  orders)
     end

data/lib/raas/models/item_model.rb

@@ -1,73 +1,73 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 require 'date'
 module Raas
+  # Represents an item
   class ItemModel < BaseModel
-    # UTID
+    # The UTID
     # @return [String]
     attr_accessor :utid
 
-    # Reward Name
+    # The reward name
     # @return [String]
     attr_accessor :reward_name
 
-    # Currency Code
+    # The currency code
     # @return [String]
     attr_accessor :currency_code
 
-    # Status
+    # The item's status
     # @return [String]
     attr_accessor :status
 
-    # Value Type (fixed/variable)
+    # The item's value type (VARIABLE_VALUE or FIXED_VALUE)
     # @return [String]
     attr_accessor :value_type
 
-    # Reward Type
+    # The reward type
     # @return [String]
     attr_accessor :reward_type
 
-    # Date Created
+    # The date the item was created
     # @return [DateTime]
     attr_accessor :created_date
 
-    # Last Updated
+    # The date the item was last updated
     # @return [DateTime]
     attr_accessor :last_update_date
 
-    # Countries
+    # The countries this item is valid in
     # @return [List of String]
     attr_accessor :countries
 
-    # Minimum Value (for variable value items)
+    # The minimum orderable value (for variable value items)
     # @return [Float]
     attr_accessor :min_value
 
-    # Maximum Value (for variable value items)
+    # The maximum orderable value (for variable value items)
     # @return [Float]
     attr_accessor :max_value
 
-    # Face Value
+    # The face value of the gift card
     # @return [Float]
     attr_accessor :face_value
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["utid"] = "utid"
-        @_hash["reward_name"] = "rewardName"
-        @_hash["currency_code"] = "currencyCode"
-        @_hash["status"] = "status"
-        @_hash["value_type"] = "valueType"
-        @_hash["reward_type"] = "rewardType"
-        @_hash["created_date"] = "createdDate"
-        @_hash["last_update_date"] = "lastUpdateDate"
-        @_hash["countries"] = "countries"
-        @_hash["min_value"] = "minValue"
-        @_hash["max_value"] = "maxValue"
-        @_hash["face_value"] = "faceValue"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['utid'] = 'utid'
+      @_hash['reward_name'] = 'rewardName'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['status'] = 'status'
+      @_hash['value_type'] = 'valueType'
+      @_hash['reward_type'] = 'rewardType'
+      @_hash['created_date'] = 'createdDate'
+      @_hash['last_update_date'] = 'lastUpdateDate'
+      @_hash['countries'] = 'countries'
+      @_hash['min_value'] = 'minValue'
+      @_hash['max_value'] = 'maxValue'
+      @_hash['face_value'] = 'faceValue'
       @_hash
     end
 
@@ -97,25 +97,27 @@ module Raas
       @face_value = face_value
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       utid = hash['utid']
       reward_name = hash['rewardName']
       currency_code = hash['currencyCode']
       status = hash['status']
       value_type = hash['valueType']
       reward_type = hash['rewardType']
-      created_date = DateTime.rfc3339(hash['createdDate']) if hash['createdDate']
-      last_update_date = DateTime.rfc3339(hash['lastUpdateDate']) if hash['lastUpdateDate']
+      created_date = APIHelper.rfc3339(hash['createdDate']) if
+        hash['createdDate']
+      last_update_date = APIHelper.rfc3339(hash['lastUpdateDate']) if
+        hash['lastUpdateDate']
       countries = hash['countries']
       min_value = hash['minValue']
       max_value = hash['maxValue']
       face_value = hash['faceValue']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       ItemModel.new(utid,
                     reward_name,
                     currency_code,

data/lib/raas/models/name_email_model.rb

@@ -1,27 +1,27 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # Represents a name and an email address
   class NameEmailModel < BaseModel
-    # Email Address
+    # An email address
     # @return [String]
     attr_accessor :email
 
-    # First Name
+    # A first name
     # @return [String]
     attr_accessor :first_name
 
-    # Last Name
+    # A last name
     # @return [String]
     attr_accessor :last_name
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["email"] = "email"
-        @_hash["first_name"] = "firstName"
-        @_hash["last_name"] = "lastName"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['first_name'] = 'firstName'
+      @_hash['last_name'] = 'lastName'
       @_hash
     end
 
@@ -33,16 +33,16 @@ module Raas
       @last_name = last_name
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       email = hash['email']
       first_name = hash['firstName']
       last_name = hash['lastName']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       NameEmailModel.new(email,
                          first_name,
                          last_name)

data/lib/raas/models/new_credit_card_model.rb

@@ -0,0 +1,51 @@
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Raas
+  # Represents the credit card information required to register a credit card
+  class NewCreditCardModel < BaseModel
+    # The credit card number
+    # @return [String]
+    attr_accessor :number
+
+    # The credit card expiration date in YYYY-MM format
+    # @return [String]
+    attr_accessor :expiration
+
+    # The 3 or 4 digit card security code on the back of card
+    # @return [String]
+    attr_accessor :verification_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['expiration'] = 'expiration'
+      @_hash['verification_number'] = 'verificationNumber'
+      @_hash
+    end
+
+    def initialize(number = nil,
+                   expiration = nil,
+                   verification_number = nil)
+      @number = number
+      @expiration = expiration
+      @verification_number = verification_number
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      number = hash['number']
+      expiration = hash['expiration']
+      verification_number = hash['verificationNumber']
+
+      # Create object from extracted values.
+      NewCreditCardModel.new(number,
+                             expiration,
+                             verification_number)
+    end
+  end
+end

data/lib/raas/models/order_model.rb

@@ -1,187 +1,219 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 require 'date'
 module Raas
+  # Represents the response from a get order call
   class OrderModel < BaseModel
-    # Account Identifier
+    # The reference order id
     # @return [String]
-    attr_accessor :account_identifier
+    attr_accessor :reference_order_id
 
-    # Amount Charged
-    # @return [CurrencyBreakdownModel]
-    attr_accessor :amount_charged
+    # The customer identifier
+    # @return [String]
+    attr_accessor :customer_identifier
 
-    # Created At
-    # @return [DateTime]
-    attr_accessor :created_at
+    # The account identifier
+    # @return [String]
+    attr_accessor :account_identifier
 
-    # Customer Identifier
+    # The account number
     # @return [String]
-    attr_accessor :customer_identifier
+    attr_accessor :account_number
 
-    # Denomination
+    # The order's amount information
+    # @return [CurrencyBreakdownModel]
+    attr_accessor :amount_charged
+
+    # Information about the gift card amount
     # @return [CurrencyBreakdownModel]
     attr_accessor :denomination
 
-    # Reference Order ID
+    # The UTID
     # @return [String]
-    attr_accessor :reference_order_id
-
-    # Reward
-    # @return [RewardModel]
-    attr_accessor :reward
+    attr_accessor :utid
 
-    # Reward Name
+    # The reward name
     # @return [String]
     attr_accessor :reward_name
 
-    # Send Email
+    # Indicates if an email was sent to the recipient
     # @return [Boolean]
     attr_accessor :send_email
 
-    # Status
+    # The order's status
     # @return [String]
     attr_accessor :status
 
-    # UTID
+    # When the order was placed
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Contains the reward credentials
+    # @return [RewardModel]
+    attr_accessor :reward
+
+    # The sender data
+    # @return [NameEmailModel]
+    attr_accessor :sender
+
+    # The recipient data
+    # @return [NameEmailModel]
+    attr_accessor :recipient
+
+    # The email template id
     # @return [String]
-    attr_accessor :utid
+    attr_accessor :etid
 
-    # Campaign
+    # An optional campaign identifier
     # @return [String]
     attr_accessor :campaign
 
-    # Email Subject
+    # The subject of the email
     # @return [String]
     attr_accessor :email_subject
 
-    # External Reference ID
+    # An external reference id
     # @return [String]
     attr_accessor :external_ref_id
 
-    # Message
+    # A message included with the email
     # @return [String]
     attr_accessor :message
 
-    # Notes
+    # Optional customer notes
     # @return [String]
     attr_accessor :notes
 
-    # Recipient
-    # @return [NameEmailModel]
-    attr_accessor :recipient
-
-    # Sender
-    # @return [NameEmailModel]
-    attr_accessor :sender
+    # Margin share information
+    # @return [CurrencyBreakdownModel]
+    attr_accessor :margin_share
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["account_identifier"] = "accountIdentifier"
-        @_hash["amount_charged"] = "amountCharged"
-        @_hash["created_at"] = "createdAt"
-        @_hash["customer_identifier"] = "customerIdentifier"
-        @_hash["denomination"] = "denomination"
-        @_hash["reference_order_id"] = "referenceOrderID"
-        @_hash["reward"] = "reward"
-        @_hash["reward_name"] = "rewardName"
-        @_hash["send_email"] = "sendEmail"
-        @_hash["status"] = "status"
-        @_hash["utid"] = "utid"
-        @_hash["campaign"] = "campaign"
-        @_hash["email_subject"] = "emailSubject"
-        @_hash["external_ref_id"] = "externalRefID"
-        @_hash["message"] = "message"
-        @_hash["notes"] = "notes"
-        @_hash["recipient"] = "recipient"
-        @_hash["sender"] = "sender"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_order_id'] = 'referenceOrderID'
+      @_hash['customer_identifier'] = 'customerIdentifier'
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['amount_charged'] = 'amountCharged'
+      @_hash['denomination'] = 'denomination'
+      @_hash['utid'] = 'utid'
+      @_hash['reward_name'] = 'rewardName'
+      @_hash['send_email'] = 'sendEmail'
+      @_hash['status'] = 'status'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['reward'] = 'reward'
+      @_hash['sender'] = 'sender'
+      @_hash['recipient'] = 'recipient'
+      @_hash['etid'] = 'etid'
+      @_hash['campaign'] = 'campaign'
+      @_hash['email_subject'] = 'emailSubject'
+      @_hash['external_ref_id'] = 'externalRefID'
+      @_hash['message'] = 'message'
+      @_hash['notes'] = 'notes'
+      @_hash['margin_share'] = 'marginShare'
       @_hash
     end
 
-    def initialize(account_identifier = nil,
-                   amount_charged = nil,
-                   created_at = nil,
+    def initialize(reference_order_id = nil,
                    customer_identifier = nil,
+                   account_identifier = nil,
+                   account_number = nil,
+                   amount_charged = nil,
                    denomination = nil,
-                   reference_order_id = nil,
-                   reward = nil,
+                   utid = nil,
                    reward_name = nil,
                    send_email = nil,
                    status = nil,
-                   utid = nil,
+                   created_at = nil,
+                   reward = nil,
+                   sender = nil,
+                   recipient = nil,
+                   etid = nil,
                    campaign = nil,
                    email_subject = nil,
                    external_ref_id = nil,
                    message = nil,
                    notes = nil,
-                   recipient = nil,
-                   sender = nil)
+                   margin_share = nil)
+      @reference_order_id = reference_order_id
+      @customer_identifier = customer_identifier
       @account_identifier = account_identifier
+      @account_number = account_number
       @amount_charged = amount_charged
-      @created_at = created_at
-      @customer_identifier = customer_identifier
       @denomination = denomination
-      @reference_order_id = reference_order_id
-      @reward = reward
+      @utid = utid
       @reward_name = reward_name
       @send_email = send_email
       @status = status
-      @utid = utid
+      @created_at = created_at
+      @reward = reward
+      @sender = sender
+      @recipient = recipient
+      @etid = etid
       @campaign = campaign
       @email_subject = email_subject
       @external_ref_id = external_ref_id
       @message = message
       @notes = notes
-      @recipient = recipient
-      @sender = sender
+      @margin_share = margin_share
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
-      account_identifier = hash['accountIdentifier']
-      amount_charged = CurrencyBreakdownModel.from_hash(hash['amountCharged']) if hash['amountCharged']
-      created_at = DateTime.rfc3339(hash['createdAt']) if hash['createdAt']
-      customer_identifier = hash['customerIdentifier']
-      denomination = CurrencyBreakdownModel.from_hash(hash['denomination']) if hash['denomination']
+      # Extract variables from the hash.
       reference_order_id = hash['referenceOrderID']
-      reward = RewardModel.from_hash(hash['reward']) if hash['reward']
+      customer_identifier = hash['customerIdentifier']
+      account_identifier = hash['accountIdentifier']
+      account_number = hash['accountNumber']
+      if hash['amountCharged']
+        amount_charged = CurrencyBreakdownModel.from_hash(hash['amountCharged'])
+      end
+      denomination = CurrencyBreakdownModel.from_hash(hash['denomination']) if
+        hash['denomination']
+      utid = hash['utid']
       reward_name = hash['rewardName']
       send_email = hash['sendEmail']
       status = hash['status']
-      utid = hash['utid']
+      created_at = APIHelper.rfc3339(hash['createdAt']) if hash['createdAt']
+      reward = RewardModel.from_hash(hash['reward']) if hash['reward']
+      sender = NameEmailModel.from_hash(hash['sender']) if hash['sender']
+      recipient = NameEmailModel.from_hash(hash['recipient']) if
+        hash['recipient']
+      etid = hash['etid']
       campaign = hash['campaign']
       email_subject = hash['emailSubject']
       external_ref_id = hash['externalRefID']
       message = hash['message']
       notes = hash['notes']
-      recipient = NameEmailModel.from_hash(hash['recipient']) if hash['recipient']
-      sender = NameEmailModel.from_hash(hash['sender']) if hash['sender']
+      margin_share = CurrencyBreakdownModel.from_hash(hash['marginShare']) if
+        hash['marginShare']
 
-      # Create object from extracted values
-      OrderModel.new(account_identifier,
-                     amount_charged,
-                     created_at,
+      # Create object from extracted values.
+      OrderModel.new(reference_order_id,
                      customer_identifier,
+                     account_identifier,
+                     account_number,
+                     amount_charged,
                      denomination,
-                     reference_order_id,
-                     reward,
+                     utid,
                      reward_name,
                      send_email,
                      status,
-                     utid,
+                     created_at,
+                     reward,
+                     sender,
+                     recipient,
+                     etid,
                      campaign,
                      email_subject,
                      external_ref_id,
                      message,
                      notes,
-                     recipient,
-                     sender)
+                     margin_share)
     end
   end
 end