tangocard-raas 1.1.2 → 2.2.1

data/lib/raas/models/create_credit_card_request_model.rb

@@ -0,0 +1,96 @@
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Raas
+  # Represents the request to register a credit card
+  class CreateCreditCardRequestModel < BaseModel
+    # The customer identifier
+    # @return [String]
+    attr_accessor :customer_identifier
+
+    # The account identifier
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # The credit card's label/nickname
+    # @return [String]
+    attr_accessor :label
+
+    # The IP address of the user registering the card
+    # @return [String]
+    attr_accessor :ip_address
+
+    # A NewCreditCard object
+    # @return [NewCreditCardModel]
+    attr_accessor :credit_card
+
+    # A BillingAddress object
+    # @return [BillingAddressModel]
+    attr_accessor :billing_address
+
+    # An optional array of FullNameEmail objects
+    # @return [List of FullNameEmailModel]
+    attr_accessor :contact_information
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_identifier'] = 'customerIdentifier'
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['label'] = 'label'
+      @_hash['ip_address'] = 'ipAddress'
+      @_hash['credit_card'] = 'creditCard'
+      @_hash['billing_address'] = 'billingAddress'
+      @_hash['contact_information'] = 'contactInformation'
+      @_hash
+    end
+
+    def initialize(customer_identifier = nil,
+                   account_identifier = nil,
+                   label = nil,
+                   ip_address = nil,
+                   credit_card = nil,
+                   billing_address = nil,
+                   contact_information = nil)
+      @customer_identifier = customer_identifier
+      @account_identifier = account_identifier
+      @label = label
+      @ip_address = ip_address
+      @credit_card = credit_card
+      @billing_address = billing_address
+      @contact_information = contact_information
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      customer_identifier = hash['customerIdentifier']
+      account_identifier = hash['accountIdentifier']
+      label = hash['label']
+      ip_address = hash['ipAddress']
+      credit_card = NewCreditCardModel.from_hash(hash['creditCard']) if
+        hash['creditCard']
+      billing_address = BillingAddressModel.from_hash(hash['billingAddress']) if
+        hash['billingAddress']
+      # Parameter is an array, so we need to iterate through it
+      contact_information = nil
+      unless hash['contactInformation'].nil?
+        contact_information = []
+        hash['contactInformation'].each do |structure|
+          contact_information << (FullNameEmailModel.from_hash(structure) if structure)
+        end
+      end
+
+      # Create object from extracted values.
+      CreateCreditCardRequestModel.new(customer_identifier,
+                                       account_identifier,
+                                       label,
+                                       ip_address,
+                                       credit_card,
+                                       billing_address,
+                                       contact_information)
+    end
+  end
+end

data/lib/raas/models/create_customer_request_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 request to create a customer
   class CreateCustomerRequestModel < BaseModel
-    # Customer Identifier
+    # The customer identifier
     # @return [String]
     attr_accessor :customer_identifier
 
-    # Display Name
+    # The display name
     # @return [String]
     attr_accessor :display_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["customer_identifier"] = "customerIdentifier"
-        @_hash["display_name"] = "displayName"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_identifier'] = 'customerIdentifier'
+      @_hash['display_name'] = 'displayName'
       @_hash
     end
 
@@ -26,15 +26,15 @@ module Raas
       @display_name = display_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.
       customer_identifier = hash['customerIdentifier']
       display_name = hash['displayName']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       CreateCustomerRequestModel.new(customer_identifier,
                                      display_name)
     end

data/lib/raas/models/create_order_request_model.rb

@@ -1,72 +1,77 @@
-# 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 request to place an order
   class CreateOrderRequestModel < BaseModel
-    # Account Identifier
+    # The account identifier
     # @return [String]
     attr_accessor :account_identifier
 
-    # Amount
+    # The order amount
     # @return [Float]
     attr_accessor :amount
 
-    # Customer Identifier
+    # The customer identifier
     # @return [String]
     attr_accessor :customer_identifier
 
-    # Send Email
+    # Indicates whether we should deliver this reward via email
     # @return [Boolean]
     attr_accessor :send_email
 
-    # UTID
+    # The UTID
     # @return [String]
     attr_accessor :utid
 
-    # Campaign
+    # An optional campaign identifier
     # @return [String]
     attr_accessor :campaign
 
-    # Email Subject
+    # The subject of the gift email
     # @return [String]
     attr_accessor :email_subject
 
-    # External Reference ID
+    # An optional external reference id
     # @return [String]
     attr_accessor :external_ref_id
 
-    # Email Message
+    # The gift message in the email
     # @return [String]
     attr_accessor :message
 
-    # Recipient
+    # The recipient's information
     # @return [NameEmailModel]
     attr_accessor :recipient
 
-    # Sender
+    # Optional sender information
     # @return [NameEmailModel]
     attr_accessor :sender
 
-    # Notes
+    # Optional notes (not displayed to customer)
     # @return [String]
     attr_accessor :notes
 
-    # A mapping from model property names to API property names
+    # The email template identifier
+    # @return [String]
+    attr_accessor :etid
+
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["account_identifier"] = "accountIdentifier"
-        @_hash["amount"] = "amount"
-        @_hash["customer_identifier"] = "customerIdentifier"
-        @_hash["send_email"] = "sendEmail"
-        @_hash["utid"] = "utid"
-        @_hash["campaign"] = "campaign"
-        @_hash["email_subject"] = "emailSubject"
-        @_hash["external_ref_id"] = "externalRefID"
-        @_hash["message"] = "message"
-        @_hash["recipient"] = "recipient"
-        @_hash["sender"] = "sender"
-        @_hash["notes"] = "notes"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['amount'] = 'amount'
+      @_hash['customer_identifier'] = 'customerIdentifier'
+      @_hash['send_email'] = 'sendEmail'
+      @_hash['utid'] = 'utid'
+      @_hash['campaign'] = 'campaign'
+      @_hash['email_subject'] = 'emailSubject'
+      @_hash['external_ref_id'] = 'externalRefID'
+      @_hash['message'] = 'message'
+      @_hash['recipient'] = 'recipient'
+      @_hash['sender'] = 'sender'
+      @_hash['notes'] = 'notes'
+      @_hash['etid'] = 'etid'
       @_hash
     end
 
@@ -81,7 +86,8 @@ module Raas
                    message = nil,
                    recipient = nil,
                    sender = nil,
-                   notes = nil)
+                   notes = nil,
+                   etid = nil)
       @account_identifier = account_identifier
       @amount = amount
       @customer_identifier = customer_identifier
@@ -94,13 +100,14 @@ module Raas
       @recipient = recipient
       @sender = sender
       @notes = notes
+      @etid = etid
     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.
       account_identifier = hash['accountIdentifier']
       amount = hash['amount']
       customer_identifier = hash['customerIdentifier']
@@ -110,11 +117,13 @@ module Raas
       email_subject = hash['emailSubject']
       external_ref_id = hash['externalRefID']
       message = hash['message']
-      recipient = NameEmailModel.from_hash(hash['recipient']) if hash['recipient']
+      recipient = NameEmailModel.from_hash(hash['recipient']) if
+        hash['recipient']
       sender = NameEmailModel.from_hash(hash['sender']) if hash['sender']
       notes = hash['notes']
+      etid = hash['etid']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       CreateOrderRequestModel.new(account_identifier,
                                   amount,
                                   customer_identifier,
@@ -126,7 +135,8 @@ module Raas
                                   message,
                                   recipient,
                                   sender,
-                                  notes)
+                                  notes,
+                                  etid)
     end
   end
 end

data/lib/raas/models/credit_card_model.rb

@@ -0,0 +1,124 @@
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Raas
+  # Represents a Credit Card
+  class CreditCardModel < BaseModel
+    # The customer identifier
+    # @return [String]
+    attr_accessor :customer_identifier
+
+    # The account identifier
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # The credit card token
+    # @return [String]
+    attr_accessor :token
+
+    # The label/nickname for the credit card
+    # @return [String]
+    attr_accessor :label
+
+    # The last four digits of the credit card number
+    # @return [String]
+    attr_accessor :last_four_digits
+
+    # The credit card's expiration date
+    # @return [String]
+    attr_accessor :expiration_date
+
+    # The status of the credit card
+    # @return [String]
+    attr_accessor :status
+
+    # The date the card was added
+    # @return [DateTime]
+    attr_accessor :created_date
+
+    # The date the card will be available for use
+    # @return [DateTime]
+    attr_accessor :activation_date
+
+    # An optional array of FullNameEmail objects
+    # @return [List of FullNameEmailModel]
+    attr_accessor :contact_information
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_identifier'] = 'customerIdentifier'
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['token'] = 'token'
+      @_hash['label'] = 'label'
+      @_hash['last_four_digits'] = 'lastFourDigits'
+      @_hash['expiration_date'] = 'expirationDate'
+      @_hash['status'] = 'status'
+      @_hash['created_date'] = 'createdDate'
+      @_hash['activation_date'] = 'activationDate'
+      @_hash['contact_information'] = 'contactInformation'
+      @_hash
+    end
+
+    def initialize(customer_identifier = nil,
+                   account_identifier = nil,
+                   token = nil,
+                   label = nil,
+                   last_four_digits = nil,
+                   expiration_date = nil,
+                   status = nil,
+                   created_date = nil,
+                   activation_date = nil,
+                   contact_information = nil)
+      @customer_identifier = customer_identifier
+      @account_identifier = account_identifier
+      @token = token
+      @label = label
+      @last_four_digits = last_four_digits
+      @expiration_date = expiration_date
+      @status = status
+      @created_date = created_date
+      @activation_date = activation_date
+      @contact_information = contact_information
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      customer_identifier = hash['customerIdentifier']
+      account_identifier = hash['accountIdentifier']
+      token = hash['token']
+      label = hash['label']
+      last_four_digits = hash['lastFourDigits']
+      expiration_date = hash['expirationDate']
+      status = hash['status']
+      created_date = APIHelper.rfc3339(hash['createdDate']) if
+        hash['createdDate']
+      activation_date = APIHelper.rfc3339(hash['activationDate']) if
+        hash['activationDate']
+      # Parameter is an array, so we need to iterate through it
+      contact_information = nil
+      unless hash['contactInformation'].nil?
+        contact_information = []
+        hash['contactInformation'].each do |structure|
+          contact_information << (FullNameEmailModel.from_hash(structure) if structure)
+        end
+      end
+
+      # Create object from extracted values.
+      CreditCardModel.new(customer_identifier,
+                          account_identifier,
+                          token,
+                          label,
+                          last_four_digits,
+                          expiration_date,
+                          status,
+                          created_date,
+                          activation_date,
+                          contact_information)
+    end
+  end
+end

data/lib/raas/models/currency_breakdown_model.rb

@@ -1,37 +1,37 @@
-# 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 breakdown of an amount and currency information
   class CurrencyBreakdownModel < BaseModel
-    # Currency Code
+    # A 3 digit currency code
     # @return [String]
     attr_accessor :currency_code
 
-    # Exchange Rate
+    # The exchange rate
     # @return [Float]
     attr_accessor :exchange_rate
 
-    # Fee
+    # The amount of the fee applied
     # @return [Float]
     attr_accessor :fee
 
-    # Total
+    # The order total
     # @return [Float]
     attr_accessor :total
 
-    # Value
+    # The value of the order
     # @return [Float]
     attr_accessor :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["currency_code"] = "currencyCode"
-        @_hash["exchange_rate"] = "exchangeRate"
-        @_hash["fee"] = "fee"
-        @_hash["total"] = "total"
-        @_hash["value"] = "value"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['exchange_rate'] = 'exchangeRate'
+      @_hash['fee'] = 'fee'
+      @_hash['total'] = 'total'
+      @_hash['value'] = 'value'
       @_hash
     end
 
@@ -47,18 +47,18 @@ module Raas
       @value = 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.
       currency_code = hash['currencyCode']
       exchange_rate = hash['exchangeRate']
       fee = hash['fee']
       total = hash['total']
       value = hash['value']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       CurrencyBreakdownModel.new(currency_code,
                                  exchange_rate,
                                  fee,