apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/reward.rb

@@ -0,0 +1,187 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # Reward Model.
+  class Reward < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # The unique identifier for the member. Defined by MX.
+    # @return [String]
+    attr_accessor :member_guid
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # The type of balance associated with the reward, for example,
+    # `BALANCE_TO_LEVEL`, or `TOTAL_BALANCE`.
+    # @return [String]
+    attr_accessor :balance_type
+
+    # The current balance of the account.
+    # `PENDING` transactions are typically not taken into account with the
+    # current balance, but this may not always be the case.
+    #     
+    # The balance will usually be a positive value for all account types.
+    # Asset-type accounts (`CHECKING`, `SAVINGS`, `INVESTMENT`) may have a
+    # negative balance if they are in overdraft.
+    # Debt-type accounts (`CREDIT_CARD`, `LOAN`, `LINE_OF_CREDIT`, `MORTGAGE`)
+    # may have a negative balance if they are overpaid.
+    # @return [Float]
+    attr_accessor :balance
+
+    # The date and time the resource was created, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The description for the reward as given by the data provider.
+    # @return [String]
+    attr_accessor :description
+
+    # The date on which the balance expires.
+    # @return [String]
+    attr_accessor :expires_on
+
+    # The unique identifier for the reward. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The units in which the balance is given, for example, `MILES` or `POINTS`.
+    # @return [String]
+    attr_accessor :unit_type
+
+    # The date and time at which the account was last updated.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guid'] = 'account_guid'
+      @_hash['member_guid'] = 'member_guid'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash['balance_type'] = 'balance_type'
+      @_hash['balance'] = 'balance'
+      @_hash['created_at'] = 'created_at'
+      @_hash['description'] = 'description'
+      @_hash['expires_on'] = 'expires_on'
+      @_hash['guid'] = 'guid'
+      @_hash['unit_type'] = 'unit_type'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        member_guid
+        user_guid
+        balance_type
+        balance
+        created_at
+        description
+        expires_on
+        guid
+        unit_type
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_guid: SKIP, member_guid: SKIP, user_guid: SKIP,
+                   balance_type: SKIP, balance: SKIP, created_at: SKIP,
+                   description: SKIP, expires_on: SKIP, guid: SKIP,
+                   unit_type: SKIP, updated_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid unless account_guid == SKIP
+      @member_guid = member_guid unless member_guid == SKIP
+      @user_guid = user_guid unless user_guid == SKIP
+      @balance_type = balance_type unless balance_type == SKIP
+      @balance = balance unless balance == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @description = description unless description == SKIP
+      @expires_on = expires_on unless expires_on == SKIP
+      @guid = guid unless guid == SKIP
+      @unit_type = unit_type unless unit_type == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      member_guid = hash.key?('member_guid') ? hash['member_guid'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : SKIP
+      balance_type = hash.key?('balance_type') ? hash['balance_type'] : SKIP
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      expires_on = hash.key?('expires_on') ? hash['expires_on'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      unit_type = hash.key?('unit_type') ? hash['unit_type'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Reward.new(account_guid: account_guid,
+                 member_guid: member_guid,
+                 user_guid: user_guid,
+                 balance_type: balance_type,
+                 balance: balance,
+                 created_at: created_at,
+                 description: description,
+                 expires_on: expires_on,
+                 guid: guid,
+                 unit_type: unit_type,
+                 updated_at: updated_at,
+                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_guid: #{@account_guid}, member_guid: #{@member_guid}, user_guid:"\
+      " #{@user_guid}, balance_type: #{@balance_type}, balance: #{@balance}, created_at:"\
+      " #{@created_at}, description: #{@description}, expires_on: #{@expires_on}, guid: #{@guid},"\
+      " unit_type: #{@unit_type}, updated_at: #{@updated_at}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_guid: #{@account_guid.inspect}, member_guid:"\
+      " #{@member_guid.inspect}, user_guid: #{@user_guid.inspect}, balance_type:"\
+      " #{@balance_type.inspect}, balance: #{@balance.inspect}, created_at:"\
+      " #{@created_at.inspect}, description: #{@description.inspect}, expires_on:"\
+      " #{@expires_on.inspect}, guid: #{@guid.inspect}, unit_type: #{@unit_type.inspect},"\
+      " updated_at: #{@updated_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/reward_elements.rb

@@ -0,0 +1,156 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # RewardElements Model.
+  class RewardElements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of balance associated with the reward, for example,
+    # `BALANCE_TO_LEVEL`, or `TOTAL_BALANCE`.
+    # @return [String]
+    attr_accessor :balance_type
+
+    # The current balance of the account.
+    # `PENDING` transactions are typically not taken into account with the
+    # current balance, but this may not always be the case.
+    #     
+    # The balance will usually be a positive value for all account types.
+    # Asset-type accounts (`CHECKING`, `SAVINGS`, `INVESTMENT`) may have a
+    # negative balance if they are in overdraft.
+    # Debt-type accounts (`CREDIT_CARD`, `LOAN`, `LINE_OF_CREDIT`, `MORTGAGE`)
+    # may have a negative balance if they are overpaid.
+    # @return [Float]
+    attr_accessor :balance
+
+    # The date and time the resource was created, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The description for the reward as given by the data provider.
+    # @return [String]
+    attr_accessor :description
+
+    # The date on which the balance expires.
+    # @return [String]
+    attr_accessor :expires_on
+
+    # The unique identifier for the reward. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The units in which the balance is given, for example, `MILES` or `POINTS`.
+    # @return [String]
+    attr_accessor :unit_type
+
+    # The date and time at which the account was last updated.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['balance_type'] = 'balance_type'
+      @_hash['balance'] = 'balance'
+      @_hash['created_at'] = 'created_at'
+      @_hash['description'] = 'description'
+      @_hash['expires_on'] = 'expires_on'
+      @_hash['guid'] = 'guid'
+      @_hash['unit_type'] = 'unit_type'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        balance_type
+        balance
+        created_at
+        description
+        expires_on
+        guid
+        unit_type
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(balance_type: SKIP, balance: SKIP, created_at: SKIP,
+                   description: SKIP, expires_on: SKIP, guid: SKIP,
+                   unit_type: SKIP, updated_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @balance_type = balance_type unless balance_type == SKIP
+      @balance = balance unless balance == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @description = description unless description == SKIP
+      @expires_on = expires_on unless expires_on == SKIP
+      @guid = guid unless guid == SKIP
+      @unit_type = unit_type unless unit_type == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      balance_type = hash.key?('balance_type') ? hash['balance_type'] : SKIP
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      expires_on = hash.key?('expires_on') ? hash['expires_on'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      unit_type = hash.key?('unit_type') ? hash['unit_type'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RewardElements.new(balance_type: balance_type,
+                         balance: balance,
+                         created_at: created_at,
+                         description: description,
+                         expires_on: expires_on,
+                         guid: guid,
+                         unit_type: unit_type,
+                         updated_at: updated_at,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} balance_type: #{@balance_type}, balance: #{@balance}, created_at:"\
+      " #{@created_at}, description: #{@description}, expires_on: #{@expires_on}, guid: #{@guid},"\
+      " unit_type: #{@unit_type}, updated_at: #{@updated_at}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} balance_type: #{@balance_type.inspect}, balance: #{@balance.inspect},"\
+      " created_at: #{@created_at.inspect}, description: #{@description.inspect}, expires_on:"\
+      " #{@expires_on.inspect}, guid: #{@guid.inspect}, unit_type: #{@unit_type.inspect},"\
+      " updated_at: #{@updated_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/reward_response_body.rb

@@ -0,0 +1,75 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # RewardResponseBody Model.
+  class RewardResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Reward]
+    attr_accessor :reward
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reward'] = 'reward'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reward
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reward: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reward = reward unless reward == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reward = Reward.from_hash(hash['reward']) if hash['reward']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RewardResponseBody.new(reward: reward,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reward: #{@reward}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reward: #{@reward.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/rewards_response_body.rb

@@ -0,0 +1,94 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # RewardsResponseBody Model.
+  class RewardsResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Reward]]
+    attr_accessor :rewards
+
+    # TODO: Write general description for this method
+    # @return [PaginationResponse]
+    attr_accessor :pagination
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rewards'] = 'rewards'
+      @_hash['pagination'] = 'pagination'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        rewards
+        pagination
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(rewards: SKIP, pagination: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @rewards = rewards unless rewards == SKIP
+      @pagination = pagination unless pagination == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      rewards = nil
+      unless hash['rewards'].nil?
+        rewards = []
+        hash['rewards'].each do |structure|
+          rewards << (Reward.from_hash(structure) if structure)
+        end
+      end
+
+      rewards = SKIP unless hash.key?('rewards')
+      pagination = PaginationResponse.from_hash(hash['pagination']) if hash['pagination']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RewardsResponseBody.new(rewards: rewards,
+                              pagination: pagination,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rewards: #{@rewards}, pagination: #{@pagination}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rewards: #{@rewards.inspect}, pagination: #{@pagination.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end