tangocard-raas 1.1.2 → 2.2.1

data/lib/raas/models/order_summary_model.rb

@@ -0,0 +1,155 @@
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Raas
+  # Represents an Order Summary
+  class OrderSummaryModel < BaseModel
+    # The reference order id
+    # @return [String]
+    attr_accessor :reference_order_id
+
+    # The customer identifier
+    # @return [String]
+    attr_accessor :customer_identifier
+
+    # The account identifier
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # The account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # The order amount information
+    # @return [CurrencyBreakdownModel]
+    attr_accessor :amount_charged
+
+    # The margin share information
+    # @return [CurrencyBreakdownModel]
+    attr_accessor :margin_share
+
+    # The UTID
+    # @return [String]
+    attr_accessor :utid
+
+    # The reward's name
+    # @return [String]
+    attr_accessor :reward_name
+
+    # The sender's information
+    # @return [NameEmailModel]
+    attr_accessor :sender
+
+    # The recipient's information
+    # @return [NameEmailModel]
+    attr_accessor :recipient
+
+    # Indicates if an an email was sent to the recipient
+    # @return [Boolean]
+    attr_accessor :send_email
+
+    # The order's status
+    # @return [String]
+    attr_accessor :status
+
+    # The date the order was placed
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The order's email template id
+    # @return [String]
+    attr_accessor :etid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_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['margin_share'] = 'marginShare'
+      @_hash['utid'] = 'utid'
+      @_hash['reward_name'] = 'rewardName'
+      @_hash['sender'] = 'sender'
+      @_hash['recipient'] = 'recipient'
+      @_hash['send_email'] = 'sendEmail'
+      @_hash['status'] = 'status'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['etid'] = 'etid'
+      @_hash
+    end
+
+    def initialize(reference_order_id = nil,
+                   customer_identifier = nil,
+                   account_identifier = nil,
+                   account_number = nil,
+                   amount_charged = nil,
+                   margin_share = nil,
+                   utid = nil,
+                   reward_name = nil,
+                   sender = nil,
+                   recipient = nil,
+                   send_email = nil,
+                   status = nil,
+                   created_at = nil,
+                   etid = nil)
+      @reference_order_id = reference_order_id
+      @customer_identifier = customer_identifier
+      @account_identifier = account_identifier
+      @account_number = account_number
+      @amount_charged = amount_charged
+      @margin_share = margin_share
+      @utid = utid
+      @reward_name = reward_name
+      @sender = sender
+      @recipient = recipient
+      @send_email = send_email
+      @status = status
+      @created_at = created_at
+      @etid = etid
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reference_order_id = hash['referenceOrderID']
+      customer_identifier = hash['customerIdentifier']
+      account_identifier = hash['accountIdentifier']
+      account_number = hash['accountNumber']
+      if hash['amountCharged']
+        amount_charged = CurrencyBreakdownModel.from_hash(hash['amountCharged'])
+      end
+      margin_share = CurrencyBreakdownModel.from_hash(hash['marginShare']) if
+        hash['marginShare']
+      utid = hash['utid']
+      reward_name = hash['rewardName']
+      sender = NameEmailModel.from_hash(hash['sender']) if hash['sender']
+      recipient = NameEmailModel.from_hash(hash['recipient']) if
+        hash['recipient']
+      send_email = hash['sendEmail']
+      status = hash['status']
+      created_at = APIHelper.rfc3339(hash['createdAt']) if hash['createdAt']
+      etid = hash['etid']
+
+      # Create object from extracted values.
+      OrderSummaryModel.new(reference_order_id,
+                            customer_identifier,
+                            account_identifier,
+                            account_number,
+                            amount_charged,
+                            margin_share,
+                            utid,
+                            reward_name,
+                            sender,
+                            recipient,
+                            send_email,
+                            status,
+                            created_at,
+                            etid)
+    end
+  end
+end

data/lib/raas/models/page_model.rb

@@ -1,32 +1,32 @@
-# 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 pagination information returned in a paginated API call
   class PageModel < BaseModel
-    # Page Number
+    # The page number
     # @return [Integer]
     attr_accessor :number
 
-    # Elements per page
+    # The number of elements per page
     # @return [Integer]
     attr_accessor :elements_per_block
 
-    # Result Count
+    # The number of results returned
     # @return [Integer]
     attr_accessor :result_count
 
-    # Total Count
+    # The total number of results
     # @return [Integer]
     attr_accessor :total_count
 
-    # 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["number"] = "number"
-        @_hash["elements_per_block"] = "elementsPerBlock"
-        @_hash["result_count"] = "resultCount"
-        @_hash["total_count"] = "totalCount"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['elements_per_block'] = 'elementsPerBlock'
+      @_hash['result_count'] = 'resultCount'
+      @_hash['total_count'] = 'totalCount'
       @_hash
     end
 
@@ -40,17 +40,17 @@ module Raas
       @total_count = total_count
     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.
       number = hash['number']
       elements_per_block = hash['elementsPerBlock']
       result_count = hash['resultCount']
       total_count = hash['totalCount']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       PageModel.new(number,
                     elements_per_block,
                     result_count,

data/lib/raas/models/raas_client_error_model.rb

@@ -1,32 +1,32 @@
-# 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 RaaS 4xx Error
   class RaasClientErrorModel < BaseModel
-    # Error Path
+    # The path to the invalid value
     # @return [String]
     attr_accessor :path
 
-    # Error Message
+    # The error message
     # @return [String]
     attr_accessor :message
 
-    # Constraint
+    # The constraint validated
     # @return [String]
     attr_accessor :constraint
 
-    # Invalid Value
+    # The value that was invalid
     # @return [String]
     attr_accessor :invalid_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["path"] = "path"
-        @_hash["message"] = "message"
-        @_hash["constraint"] = "constraint"
-        @_hash["invalid_value"] = "invalidValue"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['path'] = 'path'
+      @_hash['message'] = 'message'
+      @_hash['constraint'] = 'constraint'
+      @_hash['invalid_value'] = 'invalidValue'
       @_hash
     end
 
@@ -40,17 +40,17 @@ module Raas
       @invalid_value = invalid_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.
       path = hash['path']
       message = hash['message']
       constraint = hash['constraint']
       invalid_value = hash['invalidValue']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       RaasClientErrorModel.new(path,
                                message,
                                constraint,

data/lib/raas/models/raas_server_error_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 a RaaS 5xx Error
   class RaasServerErrorModel < BaseModel
-    # Error Message
+    # The error message
     # @return [String]
     attr_accessor :message
 
-    # Error Code
+    # The RaaS error code
     # @return [Integer]
     attr_accessor :code
 
-    # 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["message"] = "message"
-        @_hash["code"] = "code"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['code'] = 'code'
       @_hash
     end
 
@@ -26,15 +26,15 @@ module Raas
       @code = code
     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.
       message = hash['message']
       code = hash['code']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       RaasServerErrorModel.new(message,
                                code)
     end

data/lib/raas/models/resend_order_response_model.rb

@@ -1,7 +1,9 @@
-# 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 returned from a resend order request
   class ResendOrderResponseModel < BaseModel
     # When the resend request was created
     # @return [DateTime]
@@ -11,13 +13,11 @@ module Raas
     # @return [Integer]
     attr_accessor :id
 
-    # 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["created_at"] = "createdAt"
-        @_hash["id"] = "id"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'createdAt'
+      @_hash['id'] = 'id'
       @_hash
     end
 
@@ -27,15 +27,15 @@ module Raas
       @id = id
     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
-      created_at = DateTime.rfc3339(hash['createdAt']) if hash['createdAt']
+      # Extract variables from the hash.
+      created_at = APIHelper.rfc3339(hash['createdAt']) if hash['createdAt']
       id = hash['id']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       ResendOrderResponseModel.new(created_at,
                                    id)
     end

data/lib/raas/models/reward_credential_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 Reward Credential
   class RewardCredentialModel < BaseModel
-    # Credential Label
+    # The label of the credential
     # @return [String]
     attr_accessor :label
 
-    # Credential Value
+    # The actual credential
     # @return [String]
     attr_accessor :value
 
-    # Credential Type
+    # The type of the credential
     # @return [String]
     attr_accessor :type
 
-    # 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["label"] = "label"
-        @_hash["value"] = "value"
-        @_hash["type"] = "type"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['label'] = 'label'
+      @_hash['value'] = 'value'
+      @_hash['type'] = 'type'
       @_hash
     end
 
@@ -33,16 +33,16 @@ module Raas
       @type = type
     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.
       label = hash['label']
       value = hash['value']
       type = hash['type']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       RewardCredentialModel.new(label,
                                 value,
                                 type)

data/lib/raas/models/reward_model.rb

@@ -1,6 +1,8 @@
-# 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 Reward
   class RewardModel < BaseModel
     # A map of reward credentials
     # @return [Array<String, String>]
@@ -14,14 +16,12 @@ module Raas
     # @return [String]
     attr_accessor :redemption_instructions
 
-    # 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["credentials"] = "credentials"
-        @_hash["credential_list"] = "credentialList"
-        @_hash["redemption_instructions"] = "redemptionInstructions"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['credentials'] = 'credentials'
+      @_hash['credential_list'] = 'credentialList'
+      @_hash['redemption_instructions'] = 'redemptionInstructions'
       @_hash
     end
 
@@ -33,21 +33,23 @@ module Raas
       @redemption_instructions = redemption_instructions
     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.
       credentials = hash['credentials']
       # Parameter is an array, so we need to iterate through it
       credential_list = nil
-      if hash['credentialList'] != nil
-        credential_list = Array.new
-        hash['credentialList'].each{|structure| credential_list << (RewardCredentialModel.from_hash(structure) if structure)}
+      unless hash['credentialList'].nil?
+        credential_list = []
+        hash['credentialList'].each do |structure|
+          credential_list << (RewardCredentialModel.from_hash(structure) if structure)
+        end
       end
       redemption_instructions = hash['redemptionInstructions']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       RewardModel.new(credentials,
                       credential_list,
                       redemption_instructions)