card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/account_restriction_request.rb

@@ -0,0 +1,131 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # AccountRestrictionRequest Model.
+  class AccountRestrictionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Id of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Collecting Company Code (Shell Code) of the selected payer. 
+    # Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia,
+    # Ukraine etc. It is optional for other countries if ColCoID is provided.
+    # Example:
+    # 86 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Id of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Account Number of the customer on which the restrictions will be applied.
+    # Optional if AccountId is passed, else Mandatory.
+    # @return [String]
+    attr_accessor :account_number
+
+    # If true, the usage restrictions applied on the account will be removed.
+    # Optional
+    # Default: False
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_usage_restrictions
+
+    # If true, the usage restrictions applied on the account will be removed.
+    # Optional
+    # Default: False
+    # @return [UsageRestrictions]
+    attr_accessor :usage_restrictions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['reset_usage_restrictions'] = 'ResetUsageRestrictions'
+      @_hash['usage_restrictions'] = 'UsageRestrictions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        account_number
+        reset_usage_restrictions
+        usage_restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payer_id
+      ]
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   account_number = SKIP,
+                   reset_usage_restrictions = false,
+                   usage_restrictions = SKIP)
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @reset_usage_restrictions = reset_usage_restrictions unless reset_usage_restrictions == SKIP
+      @usage_restrictions = usage_restrictions unless usage_restrictions == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      reset_usage_restrictions = hash['ResetUsageRestrictions'] ||= false
+      usage_restrictions = UsageRestrictions.from_hash(hash['UsageRestrictions']) if
+        hash['UsageRestrictions']
+
+      # Create object from extracted values.
+      AccountRestrictionRequest.new(col_co_id,
+                                    col_co_code,
+                                    payer_id,
+                                    payer_number,
+                                    account_number,
+                                    reset_usage_restrictions,
+                                    usage_restrictions)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/account_restriction_response.rb

@@ -0,0 +1,60 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # AccountRestrictionResponse Model.
+  class AccountRestrictionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # API Request Id
+    # @return [String]
+    attr_accessor :request_id
+
+    # API Response Status
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['status'] = 'Status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+
+      # Create object from extracted values.
+      AccountRestrictionResponse.new(request_id,
+                                     status)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/account_velocity_limit.rb

@@ -0,0 +1,145 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # AccountVelocityLimit Model.
+  class AccountVelocityLimit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of velocity (COUNT type is not present for limits of PERTRX period
+    # Possible Values: VALUE, VOLUME, COUNT
+    # @return [String]
+    attr_accessor :type
+
+    # Duration of the velocity or threshold alert.
+    # Possible Values: DAILY, WEEKLY, MONTHLY, ANNUAL, LIFETIME, PERTRX
+    # @return [String]
+    attr_accessor :period
+
+    # The limit associated with this velocity with the correct number of digits
+    # after the decimal point according to the minor denomination of the
+    # currency of the card issuer (except for COUNT type velocity).
+    # @return [Float]
+    attr_accessor :limit
+
+    # The transaction accumulation during the current period with the correct
+    # number of digits after the decimal point according to the minor
+    # denomination of the currency of the card issuer (except for COUNT type
+    # velocity). Not present for PERTRX period.
+    # @return [Float]
+    attr_accessor :accumulation
+
+    # The remaining/available balance at this point in time with the correct
+    # number of digits after the decimal point according to the minor
+    # denomination of the currency of the card issuer (except for COUNT type
+    # velocity). Not present for PERTRX period.
+    # @return [Float]
+    attr_accessor :balance
+
+    # Indicate if the limit is overridden or default. (false for default).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :override
+
+    # The reference group name for product differentiated velocities. This field
+    # cannot be used with Volume type velocity.
+    # Example: RoadSvc
+    # This is an optional output field.
+    # @return [String]
+    attr_accessor :product_group
+
+    # The limit to trigger an alert if the balance after a transaction reaches
+    # it or below. 0 indicates no alerts will be sent. Not present if not set
+    # (issuer value threshold limit applies if available). Not present for COUNT
+    # type velocity.
+    # @return [Float]
+    attr_accessor :threshold
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'Type'
+      @_hash['period'] = 'Period'
+      @_hash['limit'] = 'Limit'
+      @_hash['accumulation'] = 'Accumulation'
+      @_hash['balance'] = 'Balance'
+      @_hash['override'] = 'Override'
+      @_hash['product_group'] = 'ProductGroup'
+      @_hash['threshold'] = 'Threshold'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        period
+        limit
+        accumulation
+        balance
+        override
+        product_group
+        threshold
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+        period
+        limit
+        accumulation
+        balance
+        override
+        product_group
+        threshold
+      ]
+    end
+
+    def initialize(type = SKIP,
+                   period = SKIP,
+                   limit = SKIP,
+                   accumulation = SKIP,
+                   balance = SKIP,
+                   override = SKIP,
+                   product_group = SKIP,
+                   threshold = SKIP)
+      @type = type unless type == SKIP
+      @period = period unless period == SKIP
+      @limit = limit unless limit == SKIP
+      @accumulation = accumulation unless accumulation == SKIP
+      @balance = balance unless balance == SKIP
+      @override = override unless override == SKIP
+      @product_group = product_group unless product_group == SKIP
+      @threshold = threshold unless threshold == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      period = hash.key?('Period') ? hash['Period'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      accumulation = hash.key?('Accumulation') ? hash['Accumulation'] : SKIP
+      balance = hash.key?('Balance') ? hash['Balance'] : SKIP
+      override = hash.key?('Override') ? hash['Override'] : SKIP
+      product_group = hash.key?('ProductGroup') ? hash['ProductGroup'] : SKIP
+      threshold = hash.key?('Threshold') ? hash['Threshold'] : SKIP
+
+      # Create object from extracted values.
+      AccountVelocityLimit.new(type,
+                               period,
+                               limit,
+                               accumulation,
+                               balance,
+                               override,
+                               product_group,
+                               threshold)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/accounts.rb

@@ -0,0 +1,65 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Accounts Model.
+  class Accounts < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Id of the customer.
+    # Optional, if AccountNumber is passed, else mandatory.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.
+    # Optional, if AccountId is passed, else mandatory.
+    # @return [String]
+    attr_accessor :account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_id
+        account_number
+      ]
+    end
+
+    def initialize(account_id = SKIP,
+                   account_number = SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+    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_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+
+      # Create object from extracted values.
+      Accounts.new(account_id,
+                   account_number)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/address.rb

@@ -0,0 +1,174 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Address Model.
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address Id in cards platform.
+    # @return [Integer]
+    attr_accessor :address_id
+
+    # Address line1
+    # @return [String]
+    attr_accessor :address_line1
+
+    # Address line2
+    # @return [String]
+    attr_accessor :address_line2
+
+    # AddressLine3
+    # @return [String]
+    attr_accessor :address_line3
+
+    # ZipCode
+    # @return [String]
+    attr_accessor :zip_code
+
+    # City
+    # @return [String]
+    attr_accessor :city
+
+    # Region Id of the address.
+    # @return [Integer]
+    attr_accessor :region_id
+
+    # Country ISO code of the address
+    # @return [String]
+    attr_accessor :country_iso_code
+
+    # Country for the address
+    # @return [String]
+    attr_accessor :country
+
+    # Telephone number of the address contact
+    # @return [String]
+    attr_accessor :telephone
+
+    # Email address of the address contact
+    # @return [String]
+    attr_accessor :email_address
+
+    # Fax number of the address contact
+    # @return [String]
+    attr_accessor :fax
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_id'] = 'AddressId'
+      @_hash['address_line1'] = 'AddressLine1'
+      @_hash['address_line2'] = 'AddressLine2'
+      @_hash['address_line3'] = 'AddressLine3'
+      @_hash['zip_code'] = 'ZipCode'
+      @_hash['city'] = 'City'
+      @_hash['region_id'] = 'RegionId'
+      @_hash['country_iso_code'] = 'CountryISOCode'
+      @_hash['country'] = 'Country'
+      @_hash['telephone'] = 'Telephone'
+      @_hash['email_address'] = 'EmailAddress'
+      @_hash['fax'] = 'Fax'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_id
+        address_line1
+        address_line2
+        address_line3
+        zip_code
+        city
+        region_id
+        country_iso_code
+        country
+        telephone
+        email_address
+        fax
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        address_id
+        address_line1
+        address_line2
+        address_line3
+        zip_code
+        city
+        region_id
+        country_iso_code
+        country
+        telephone
+        email_address
+        fax
+      ]
+    end
+
+    def initialize(address_id = SKIP,
+                   address_line1 = SKIP,
+                   address_line2 = SKIP,
+                   address_line3 = SKIP,
+                   zip_code = SKIP,
+                   city = SKIP,
+                   region_id = SKIP,
+                   country_iso_code = SKIP,
+                   country = SKIP,
+                   telephone = SKIP,
+                   email_address = SKIP,
+                   fax = SKIP)
+      @address_id = address_id unless address_id == SKIP
+      @address_line1 = address_line1 unless address_line1 == SKIP
+      @address_line2 = address_line2 unless address_line2 == SKIP
+      @address_line3 = address_line3 unless address_line3 == SKIP
+      @zip_code = zip_code unless zip_code == SKIP
+      @city = city unless city == SKIP
+      @region_id = region_id unless region_id == SKIP
+      @country_iso_code = country_iso_code unless country_iso_code == SKIP
+      @country = country unless country == SKIP
+      @telephone = telephone unless telephone == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @fax = fax unless fax == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      address_id = hash.key?('AddressId') ? hash['AddressId'] : SKIP
+      address_line1 = hash.key?('AddressLine1') ? hash['AddressLine1'] : SKIP
+      address_line2 = hash.key?('AddressLine2') ? hash['AddressLine2'] : SKIP
+      address_line3 = hash.key?('AddressLine3') ? hash['AddressLine3'] : SKIP
+      zip_code = hash.key?('ZipCode') ? hash['ZipCode'] : SKIP
+      city = hash.key?('City') ? hash['City'] : SKIP
+      region_id = hash.key?('RegionId') ? hash['RegionId'] : SKIP
+      country_iso_code =
+        hash.key?('CountryISOCode') ? hash['CountryISOCode'] : SKIP
+      country = hash.key?('Country') ? hash['Country'] : SKIP
+      telephone = hash.key?('Telephone') ? hash['Telephone'] : SKIP
+      email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
+      fax = hash.key?('Fax') ? hash['Fax'] : SKIP
+
+      # Create object from extracted values.
+      Address.new(address_id,
+                  address_line1,
+                  address_line2,
+                  address_line3,
+                  zip_code,
+                  city,
+                  region_id,
+                  country_iso_code,
+                  country,
+                  telephone,
+                  email_address,
+                  fax)
+    end
+  end
+end