card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/auto_renew_card_response.rb

@@ -0,0 +1,92 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # AutoRenewCardResponse Model.
+  class AutoRenewCardResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Main reference number for tracking. 
+    # Example: 123455
+    # @return [Integer]
+    attr_accessor :main_reference
+
+    # API
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request. Allowed values: SUCCES, FAILED,
+    # PARTIAL_SUCCESS
+    # @return [String]
+    attr_accessor :status
+
+    # List of Auto Renew reference entity. The fields of this entity are
+    # described below.
+    # @return [Array[AutoRenewCardResponseDataItems]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['main_reference'] = 'MainReference'
+      @_hash['request_id'] = 'RequestId'
+      @_hash['status'] = 'Status'
+      @_hash['data'] = 'Data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        main_reference
+        request_id
+        status
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(main_reference = SKIP,
+                   request_id = SKIP,
+                   status = SKIP,
+                   data = SKIP)
+      @main_reference = main_reference unless main_reference == SKIP
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == 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.
+      main_reference = hash.key?('MainReference') ? hash['MainReference'] : SKIP
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['Data'].nil?
+        data = []
+        hash['Data'].each do |structure|
+          data << (AutoRenewCardResponseDataItems.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      AutoRenewCardResponse.new(main_reference,
+                                request_id,
+                                status,
+                                data)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/auto_renew_card_response_data_items.rb

@@ -0,0 +1,64 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # AutoRenewCardResponseDataItems Model.
+  class AutoRenewCardResponseDataItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # CardId and PAN of the card. ;( Semicolon is used as delimiter.
+    # @return [Integer]
+    attr_accessor :auto_renew_reference_id
+
+    # Reference number for each individual auto renew card in the order.
+    # @return [String]
+    attr_accessor :card_id_and_pan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto_renew_reference_id'] = 'AutoRenewReferenceId'
+      @_hash['card_id_and_pan'] = 'CardIdAndPAN'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auto_renew_reference_id
+        card_id_and_pan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        auto_renew_reference_id
+        card_id_and_pan
+      ]
+    end
+
+    def initialize(auto_renew_reference_id = SKIP,
+                   card_id_and_pan = SKIP)
+      @auto_renew_reference_id = auto_renew_reference_id unless auto_renew_reference_id == SKIP
+      @card_id_and_pan = card_id_and_pan unless card_id_and_pan == 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.
+      auto_renew_reference_id =
+        hash.key?('AutoRenewReferenceId') ? hash['AutoRenewReferenceId'] : SKIP
+      card_id_and_pan = hash.key?('CardIdAndPAN') ? hash['CardIdAndPAN'] : SKIP
+
+      # Create object from extracted values.
+      AutoRenewCardResponseDataItems.new(auto_renew_reference_id,
+                                         card_id_and_pan)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/bank_account.rb

@@ -0,0 +1,192 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # BankAccount Model.
+  class BankAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Bank Name
+    # @return [String]
+    attr_accessor :bank_name
+
+    # Account Name
+    # @return [String]
+    attr_accessor :account_name
+
+    # Bank Account effective date for the payer
+    # @return [String]
+    attr_accessor :date_effective
+
+    # Bank Account terminated date. Default is null
+    # @return [String]
+    attr_accessor :date_terminated
+
+    # Bank Account IBAN for Payer
+    # @return [String]
+    attr_accessor :iban
+
+    # Bank Account currency ISO code.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Bank Account currency Symbol.
+    # @return [String]
+    attr_accessor :currency_symbol
+
+    # Bank Account Country ISO Code
+    # @return [String]
+    attr_accessor :country_iso_code
+
+    # Bank Account Country Name
+    # 1-Austria
+    # 2-Belgium
+    # 3-Bulgaria
+    # 4-Croatia
+    # 5-Czech Republic
+    # @return [String]
+    attr_accessor :country
+
+    # Payer bank Sort Code
+    # @return [String]
+    attr_accessor :sort_code
+
+    # Payer Bank Swift Code
+    # @return [String]
+    attr_accessor :swift_code
+
+    # Bank Type Id and Description
+    # @return [String]
+    attr_accessor :bank_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['bank_name'] = 'BankName'
+      @_hash['account_name'] = 'AccountName'
+      @_hash['date_effective'] = 'DateEffective'
+      @_hash['date_terminated'] = 'DateTerminated'
+      @_hash['iban'] = 'IBAN'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_symbol'] = 'CurrencySymbol'
+      @_hash['country_iso_code'] = 'CountryISOCode'
+      @_hash['country'] = 'Country'
+      @_hash['sort_code'] = 'SortCode'
+      @_hash['swift_code'] = 'SwiftCode'
+      @_hash['bank_type'] = 'BankType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        bank_name
+        account_name
+        date_effective
+        date_terminated
+        iban
+        currency_code
+        currency_symbol
+        country_iso_code
+        country
+        sort_code
+        swift_code
+        bank_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_number
+        bank_name
+        account_name
+        date_effective
+        date_terminated
+        iban
+        currency_code
+        currency_symbol
+        country_iso_code
+        country
+        sort_code
+        swift_code
+        bank_type
+      ]
+    end
+
+    def initialize(account_number = SKIP,
+                   bank_name = SKIP,
+                   account_name = SKIP,
+                   date_effective = SKIP,
+                   date_terminated = SKIP,
+                   iban = SKIP,
+                   currency_code = SKIP,
+                   currency_symbol = SKIP,
+                   country_iso_code = SKIP,
+                   country = SKIP,
+                   sort_code = SKIP,
+                   swift_code = SKIP,
+                   bank_type = SKIP)
+      @account_number = account_number unless account_number == SKIP
+      @bank_name = bank_name unless bank_name == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @date_effective = date_effective unless date_effective == SKIP
+      @date_terminated = date_terminated unless date_terminated == SKIP
+      @iban = iban unless iban == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_symbol = currency_symbol unless currency_symbol == SKIP
+      @country_iso_code = country_iso_code unless country_iso_code == SKIP
+      @country = country unless country == SKIP
+      @sort_code = sort_code unless sort_code == SKIP
+      @swift_code = swift_code unless swift_code == SKIP
+      @bank_type = bank_type unless bank_type == 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_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      bank_name = hash.key?('BankName') ? hash['BankName'] : SKIP
+      account_name = hash.key?('AccountName') ? hash['AccountName'] : SKIP
+      date_effective = hash.key?('DateEffective') ? hash['DateEffective'] : SKIP
+      date_terminated =
+        hash.key?('DateTerminated') ? hash['DateTerminated'] : SKIP
+      iban = hash.key?('IBAN') ? hash['IBAN'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_symbol =
+        hash.key?('CurrencySymbol') ? hash['CurrencySymbol'] : SKIP
+      country_iso_code =
+        hash.key?('CountryISOCode') ? hash['CountryISOCode'] : SKIP
+      country = hash.key?('Country') ? hash['Country'] : SKIP
+      sort_code = hash.key?('SortCode') ? hash['SortCode'] : SKIP
+      swift_code = hash.key?('SwiftCode') ? hash['SwiftCode'] : SKIP
+      bank_type = hash.key?('BankType') ? hash['BankType'] : SKIP
+
+      # Create object from extracted values.
+      BankAccount.new(account_number,
+                      bank_name,
+                      account_name,
+                      date_effective,
+                      date_terminated,
+                      iban,
+                      currency_code,
+                      currency_symbol,
+                      country_iso_code,
+                      country,
+                      sort_code,
+                      swift_code,
+                      bank_type)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/base_model.rb

@@ -0,0 +1,62 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Base model.
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        optional_fields = self.class.optionals
+        nullable_fields = self.class.nullables
+        if value.nil?
+          next unless nullable_fields.include?(name)
+
+          if !optional_fields.include?(name) && !nullable_fields.include?(name)
+            raise ArgumentError,
+                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+          end
+        end
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_custom_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_custom_#{name}", *params)
+            else
+              hash[key] = send("to_custom_#{name}")
+            end
+          elsif respond_to?("to_union_type_#{name}")
+            hash[key] = send("to_union_type_#{name}")
+          elsif value.instance_of? Array
+            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+          elsif value.instance_of? Hash
+            hash[key] = {}
+            value.each do |k, v|
+              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+            end
+          else
+            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+          end
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/bundle_restriction.rb

@@ -0,0 +1,166 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # BundleRestriction Model.
+  class BundleRestriction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # True/False
+    # A value indicates if the day/time restriction is to be reset for card
+    # bundle.
+    # Optional
+    # Default value is False.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_day_time_restriction
+
+    # True/False
+    # A value indicates if the location restriction is to be reset for card
+    # bundle.
+    # Optional
+    # Default value is False.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_location_restriction
+
+    # True/False
+    # A value indicates if the product restriction is to be reset for card
+    # bundle.
+    # Optional
+    # Default value is False.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_product_restriction
+
+    # True/False
+    # A value indicates if the product restriction is to be reset for card
+    # bundle.
+    # Optional
+    # Default value is False.
+    # @return [UsageRestrictions]
+    attr_accessor :usage_restrictions
+
+    # Day/time restrictions such as weekdays and time range to be applied on the
+    # bundle.
+    # Mandatory if respective action is set as “Add”.
+    # The details of DayTimeRestriction entity is given below.
+    # @return [DayTimeRestrictions]
+    attr_accessor :day_time_restrictions
+
+    # Day/time restrictions such as weekdays and time range to be applied on the
+    # bundle.
+    # Mandatory if respective action is set as “Add”.
+    # The details of DayTimeRestriction entity is given below.
+    # @return [ProductRestrictions]
+    attr_accessor :product_restriction
+
+    # Identifier of the location restriction profile to be updated for the
+    # bundle in Gateway.
+    # Optional
+    # @return [String]
+    attr_accessor :location_restriction_profile_id
+
+    # Location restrictions to be applied on the bundle which either allows or
+    # restricts using the cards, which are under the bundle, in the specified
+    # locations. 
+    # Mandatory if respective action is set as “Add”.
+    # Details of location restrictions are given below.
+    # @return [LocationRestrictions]
+    attr_accessor :location_restrictions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reset_day_time_restriction'] = 'ResetDayTimeRestriction'
+      @_hash['reset_location_restriction'] = 'ResetLocationRestriction'
+      @_hash['reset_product_restriction'] = 'ResetProductRestriction'
+      @_hash['usage_restrictions'] = 'UsageRestrictions'
+      @_hash['day_time_restrictions'] = 'DayTimeRestrictions'
+      @_hash['product_restriction'] = 'ProductRestriction'
+      @_hash['location_restriction_profile_id'] =
+        'LocationRestrictionProfileId'
+      @_hash['location_restrictions'] = 'LocationRestrictions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reset_day_time_restriction
+        reset_location_restriction
+        reset_product_restriction
+        usage_restrictions
+        day_time_restrictions
+        product_restriction
+        location_restriction_profile_id
+        location_restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reset_day_time_restriction = false,
+                   reset_location_restriction = false,
+                   reset_product_restriction = false,
+                   usage_restrictions = SKIP,
+                   day_time_restrictions = SKIP,
+                   product_restriction = SKIP,
+                   location_restriction_profile_id = SKIP,
+                   location_restrictions = SKIP)
+      unless reset_day_time_restriction == SKIP
+        @reset_day_time_restriction =
+          reset_day_time_restriction
+      end
+      unless reset_location_restriction == SKIP
+        @reset_location_restriction =
+          reset_location_restriction
+      end
+      unless reset_product_restriction == SKIP
+        @reset_product_restriction =
+          reset_product_restriction
+      end
+      @usage_restrictions = usage_restrictions unless usage_restrictions == SKIP
+      @day_time_restrictions = day_time_restrictions unless day_time_restrictions == SKIP
+      @product_restriction = product_restriction unless product_restriction == SKIP
+      unless location_restriction_profile_id == SKIP
+        @location_restriction_profile_id =
+          location_restriction_profile_id
+      end
+      @location_restrictions = location_restrictions unless location_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.
+      reset_day_time_restriction = hash['ResetDayTimeRestriction'] ||= false
+      reset_location_restriction = hash['ResetLocationRestriction'] ||= false
+      reset_product_restriction = hash['ResetProductRestriction'] ||= false
+      usage_restrictions = UsageRestrictions.from_hash(hash['UsageRestrictions']) if
+        hash['UsageRestrictions']
+      day_time_restrictions = DayTimeRestrictions.from_hash(hash['DayTimeRestrictions']) if
+        hash['DayTimeRestrictions']
+      product_restriction = ProductRestrictions.from_hash(hash['ProductRestriction']) if
+        hash['ProductRestriction']
+      location_restriction_profile_id =
+        hash.key?('LocationRestrictionProfileId') ? hash['LocationRestrictionProfileId'] : SKIP
+      location_restrictions = LocationRestrictions.from_hash(hash['LocationRestrictions']) if
+        hash['LocationRestrictions']
+
+      # Create object from extracted values.
+      BundleRestriction.new(reset_day_time_restriction,
+                            reset_location_restriction,
+                            reset_product_restriction,
+                            usage_restrictions,
+                            day_time_restrictions,
+                            product_restriction,
+                            location_restriction_profile_id,
+                            location_restrictions)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/cancel_card_request.rb

@@ -0,0 +1,107 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # This entity models the data that is sent in the http request body of this
+  # operation.
+  class CancelCardRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of CancelCardRequest entity. 
+    # Each card in the list will be Cancelled. 
+    # The details of the entity are given below.
+    # @return [Array[UpdateCard]]
+    attr_accessor :cards
+
+    # Reason id for cancelling the card.<br />
+    # Optional if ReasonText is passed, else mandatory<br />
+    # When passed, the reason Id will be validated with the allowed reason id’s
+    # configured for the card type of the card.<br />
+    # If the reason Id is not allowed, then it will be included on the error
+    # cards response.
+    # Possible values:
+    # 1 (Lost)
+    # 2 (Stolen)
+    # 3 (Card no longer required)
+    # @return [Integer]
+    attr_accessor :reason_id
+
+    # Reason text for cancelling the card.<br />
+    # Optional if ReasonId is passed, else mandatory<br />
+    # When Reason Id is not known to the client, the reason text can be
+    # passed.<br />
+    # When Reason Text is passed and the Target Status is either Block or
+    # Damaged, the text will be validated with the allowed list of values
+    # configured for the card type of the card.
+    # If the text is not allowed, then it will be included on the error cards
+    # response.
+    # However, if the Target status is Temporary block or Unblock then the text
+    # will be submitted 
+    # Possible Values:
+    # 1) Lost
+    # 2) Stolen
+    # 3) Card no longer required
+    # @return [String]
+    attr_accessor :reason_text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cards'] = 'Cards'
+      @_hash['reason_id'] = 'ReasonId'
+      @_hash['reason_text'] = 'ReasonText'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason_id
+        reason_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reason_id
+        reason_text
+      ]
+    end
+
+    def initialize(cards = nil,
+                   reason_id = SKIP,
+                   reason_text = SKIP)
+      @cards = cards
+      @reason_id = reason_id unless reason_id == SKIP
+      @reason_text = reason_text unless reason_text == 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.
+      # Parameter is an array, so we need to iterate through it
+      cards = nil
+      unless hash['Cards'].nil?
+        cards = []
+        hash['Cards'].each do |structure|
+          cards << (UpdateCard.from_hash(structure) if structure)
+        end
+      end
+
+      cards = nil unless hash.key?('Cards')
+      reason_id = hash.key?('ReasonId') ? hash['ReasonId'] : SKIP
+      reason_text = hash.key?('ReasonText') ? hash['ReasonText'] : SKIP
+
+      # Create object from extracted values.
+      CancelCardRequest.new(cards,
+                            reason_id,
+                            reason_text)
+    end
+  end
+end