card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/restriction_card_request.rb

@@ -0,0 +1,115 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # RestrictionCardRequest Model.
+  class RestrictionCardRequest < 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
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # Example: GB000000123
+    # List of restrictions to be applied on the card. The details of
+    # CardRestriction entity is given below.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Payer Id of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # List of restrictions to be applied on the card. The details of
+    # CardRestriction entity is given below.
+    # @return [Array[RestrictionCardRequestCardsItems]]
+    attr_accessor :cards
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['cards'] = 'Cards'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        payer_number
+        payer_id
+        cards
+        col_co_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(col_co_id = SKIP,
+                   payer_number = SKIP,
+                   payer_id = SKIP,
+                   cards = SKIP,
+                   col_co_code = SKIP)
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @cards = cards unless cards == SKIP
+      @col_co_code = col_co_code unless col_co_code == 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
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      cards = nil
+      unless hash['Cards'].nil?
+        cards = []
+        hash['Cards'].each do |structure|
+          cards << (RestrictionCardRequestCardsItems.from_hash(structure) if structure)
+        end
+      end
+
+      cards = SKIP unless hash.key?('Cards')
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+
+      # Create object from extracted values.
+      RestrictionCardRequest.new(col_co_id,
+                                 payer_number,
+                                 payer_id,
+                                 cards,
+                                 col_co_code)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/restriction_card_request_cards_items.rb

@@ -0,0 +1,220 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # RestrictionCardRequestCardsItems Model.
+  class RestrictionCardRequestCardsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Number of the customer. 
+    # Optional if AccountId is passed, else Mandatory.
+    # This input is a search criterion, if given.
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account ID of the customer.
+    # Optional if AccountNumber is passed, else Mandatory. 
+    # This input is a search criterion, if given.
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Card PAN.
+    # Optional if CardId is given, else mandatory. 
+    # Example: 7002051006629890645 
+    # Note: 
+    # •	PAN is ignored if CardId is given.
+    # When PAN matches with multiple cards, the restriction will be applied on
+    # the latest issued card.
+    # @return [String]
+    attr_accessor :pan
+
+    # Unique Card Id
+    # Optional if PAN is given, else mandatory.
+    # Example: 275549
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # True/False.
+    # If true, the usage restrictions applied on the card in Gateway will be
+    # reset to Customer Card Type level max limits, if there are no customer
+    # level overrides available then OU card type max limits. Else, the card
+    # restrictions will be updated with the usage restrictions provided in the
+    # API.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_usage_restrictions
+
+    # True/False.
+    # If true, the Day/Time restrictions applied on the card will be deleted.
+    # Else, the card restrictions will be updated with the day/time restrictions
+    # provided in the API.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_day_time_restrictions
+
+    # True/False.
+    # If true, Default fuel/non-fuel sets configured at the purchase category
+    # level will be applied to the card. Else, the card will be applied with
+    # product restrictions provided in the API.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_product_restrictions
+
+    # True/False.
+    # If true, the location restrictions applied on the card will be deleted.
+    # Else, the card restrictions will be updated with the location restrictions
+    # provided in the API.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_location_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
+
+    # 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
+
+    # 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 [ProductRestrictions]
+    attr_accessor :product_restrictions
+
+    # 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 [UsageRestrictions]
+    attr_accessor :usage_restrictions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['pan'] = 'PAN'
+      @_hash['card_id'] = 'CardId'
+      @_hash['reset_usage_restrictions'] = 'ResetUsageRestrictions'
+      @_hash['reset_day_time_restrictions'] = 'ResetDayTimeRestrictions'
+      @_hash['reset_product_restrictions'] = 'ResetProductRestrictions'
+      @_hash['reset_location_restrictions'] = 'ResetLocationRestrictions'
+      @_hash['day_time_restrictions'] = 'DayTimeRestrictions'
+      @_hash['location_restrictions'] = 'LocationRestrictions'
+      @_hash['product_restrictions'] = 'ProductRestrictions'
+      @_hash['usage_restrictions'] = 'UsageRestrictions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        account_id
+        pan
+        card_id
+        reset_usage_restrictions
+        reset_day_time_restrictions
+        reset_product_restrictions
+        reset_location_restrictions
+        day_time_restrictions
+        location_restrictions
+        product_restrictions
+        usage_restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number = SKIP,
+                   account_id = SKIP,
+                   pan = SKIP,
+                   card_id = SKIP,
+                   reset_usage_restrictions = SKIP,
+                   reset_day_time_restrictions = SKIP,
+                   reset_product_restrictions = SKIP,
+                   reset_location_restrictions = SKIP,
+                   day_time_restrictions = SKIP,
+                   location_restrictions = SKIP,
+                   product_restrictions = SKIP,
+                   usage_restrictions = SKIP)
+      @account_number = account_number unless account_number == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @pan = pan unless pan == SKIP
+      @card_id = card_id unless card_id == SKIP
+      @reset_usage_restrictions = reset_usage_restrictions unless reset_usage_restrictions == SKIP
+      unless reset_day_time_restrictions == SKIP
+        @reset_day_time_restrictions =
+          reset_day_time_restrictions
+      end
+      unless reset_product_restrictions == SKIP
+        @reset_product_restrictions =
+          reset_product_restrictions
+      end
+      unless reset_location_restrictions == SKIP
+        @reset_location_restrictions =
+          reset_location_restrictions
+      end
+      @day_time_restrictions = day_time_restrictions unless day_time_restrictions == SKIP
+      @location_restrictions = location_restrictions unless location_restrictions == SKIP
+      @product_restrictions = product_restrictions unless product_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.
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      reset_usage_restrictions =
+        hash.key?('ResetUsageRestrictions') ? hash['ResetUsageRestrictions'] : SKIP
+      reset_day_time_restrictions =
+        hash.key?('ResetDayTimeRestrictions') ? hash['ResetDayTimeRestrictions'] : SKIP
+      reset_product_restrictions =
+        hash.key?('ResetProductRestrictions') ? hash['ResetProductRestrictions'] : SKIP
+      reset_location_restrictions =
+        hash.key?('ResetLocationRestrictions') ? hash['ResetLocationRestrictions'] : SKIP
+      day_time_restrictions = DayTimeRestrictions.from_hash(hash['DayTimeRestrictions']) if
+        hash['DayTimeRestrictions']
+      location_restrictions = LocationRestrictions.from_hash(hash['LocationRestrictions']) if
+        hash['LocationRestrictions']
+      product_restrictions = ProductRestrictions.from_hash(hash['ProductRestrictions']) if
+        hash['ProductRestrictions']
+      usage_restrictions = UsageRestrictions.from_hash(hash['UsageRestrictions']) if
+        hash['UsageRestrictions']
+
+      # Create object from extracted values.
+      RestrictionCardRequestCardsItems.new(account_number,
+                                           account_id,
+                                           pan,
+                                           card_id,
+                                           reset_usage_restrictions,
+                                           reset_day_time_restrictions,
+                                           reset_product_restrictions,
+                                           reset_location_restrictions,
+                                           day_time_restrictions,
+                                           location_restrictions,
+                                           product_restrictions,
+                                           usage_restrictions)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/restriction_card_response.rb

@@ -0,0 +1,91 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # RestrictionCardResponse Model.
+  class RestrictionCardResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Main reference number for tracking. 
+    # Example: 123455
+    # @return [Integer]
+    attr_accessor :main_reference
+
+    # API Request Id
+    # @return [String]
+    attr_accessor :request_id
+
+    # API Response Status
+    # @return [String]
+    attr_accessor :status
+
+    # List of card restriction requests validated and submitted successfully for
+    # processing.
+    # @return [Array[RestrictionCardResponseDataItems]]
+    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 << (RestrictionCardResponseDataItems.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      RestrictionCardResponse.new(main_reference,
+                                  request_id,
+                                  status,
+                                  data)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/restriction_card_response_data_items.rb

@@ -0,0 +1,240 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # RestrictionCardResponseDataItems Model.
+  class RestrictionCardResponseDataItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Id of the customer.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Unique Card Id
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # This field will have a value only when “DayTimeRestrictionStatus” is
+    # “Failed”.
+    # @return [String]
+    attr_accessor :day_time_restriction_description
+
+    # Status of the card day/time restriction submitted to API. Based on the
+    # response from API value will be set as either “Success” or “Failed”.
+    # @return [String]
+    attr_accessor :day_time_restriction_status
+
+    # This field will have a value only when “LocationRestrictionStatus” is
+    # “Failed”.
+    # @return [String]
+    attr_accessor :location_restriction_description
+
+    # Card Location restriction submitted to gateway based on gateway response
+    # value set as “Success” or “Failed”.
+    # @return [String]
+    attr_accessor :location_restriction_status
+
+    # Card PAN
+    # @return [String]
+    attr_accessor :pan
+
+    # This field will have a value only when “ProductRestrictionStatus” is
+    # “Failed”.
+    # @return [String]
+    attr_accessor :product_restriction_description
+
+    # Status of the card product restriction submitted
+    # @return [String]
+    attr_accessor :product_restriction_status
+
+    # This field will have a value only when “UsageRestrictionStatus” is
+    # “Failed”.
+    # @return [String]
+    attr_accessor :usage_restriction_description
+
+    # Status of the card usage restriction submitted
+    # @return [String]
+    attr_accessor :usage_restriction_status
+
+    # Error code for validation failure.
+    # Example error codes:
+    # 0007, 9007, 7000, 7001.
+    # @return [String]
+    attr_accessor :validation_error_code
+
+    # Description of validation failure.
+    # @return [String]
+    attr_accessor :validation_error_description
+
+    # 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['card_id'] = 'CardId'
+      @_hash['day_time_restriction_description'] =
+        'DayTimeRestrictionDescription'
+      @_hash['day_time_restriction_status'] = 'DayTimeRestrictionStatus'
+      @_hash['location_restriction_description'] =
+        'LocationRestrictionDescription'
+      @_hash['location_restriction_status'] = 'LocationRestrictionStatus'
+      @_hash['pan'] = 'PAN'
+      @_hash['product_restriction_description'] =
+        'ProductRestrictionDescription'
+      @_hash['product_restriction_status'] = 'ProductRestrictionStatus'
+      @_hash['usage_restriction_description'] = 'UsageRestrictionDescription'
+      @_hash['usage_restriction_status'] = 'UsageRestrictionStatus'
+      @_hash['validation_error_code'] = 'ValidationErrorCode'
+      @_hash['validation_error_description'] = 'ValidationErrorDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+        card_id
+        day_time_restriction_description
+        day_time_restriction_status
+        location_restriction_description
+        location_restriction_status
+        pan
+        product_restriction_description
+        product_restriction_status
+        usage_restriction_description
+        usage_restriction_status
+        validation_error_code
+        validation_error_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_id
+        account_number
+        card_id
+        day_time_restriction_description
+        day_time_restriction_status
+        location_restriction_description
+        location_restriction_status
+        pan
+        product_restriction_description
+        product_restriction_status
+        usage_restriction_description
+        usage_restriction_status
+        validation_error_code
+        validation_error_description
+      ]
+    end
+
+    def initialize(account_id = SKIP,
+                   account_number = SKIP,
+                   card_id = SKIP,
+                   day_time_restriction_description = SKIP,
+                   day_time_restriction_status = SKIP,
+                   location_restriction_description = SKIP,
+                   location_restriction_status = SKIP,
+                   pan = SKIP,
+                   product_restriction_description = SKIP,
+                   product_restriction_status = SKIP,
+                   usage_restriction_description = SKIP,
+                   usage_restriction_status = SKIP,
+                   validation_error_code = SKIP,
+                   validation_error_description = SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @card_id = card_id unless card_id == SKIP
+      unless day_time_restriction_description == SKIP
+        @day_time_restriction_description =
+          day_time_restriction_description
+      end
+      unless day_time_restriction_status == SKIP
+        @day_time_restriction_status =
+          day_time_restriction_status
+      end
+      unless location_restriction_description == SKIP
+        @location_restriction_description =
+          location_restriction_description
+      end
+      unless location_restriction_status == SKIP
+        @location_restriction_status =
+          location_restriction_status
+      end
+      @pan = pan unless pan == SKIP
+      unless product_restriction_description == SKIP
+        @product_restriction_description =
+          product_restriction_description
+      end
+      unless product_restriction_status == SKIP
+        @product_restriction_status =
+          product_restriction_status
+      end
+      unless usage_restriction_description == SKIP
+        @usage_restriction_description =
+          usage_restriction_description
+      end
+      @usage_restriction_status = usage_restriction_status unless usage_restriction_status == SKIP
+      @validation_error_code = validation_error_code unless validation_error_code == SKIP
+      unless validation_error_description == SKIP
+        @validation_error_description =
+          validation_error_description
+      end
+    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
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      day_time_restriction_description =
+        hash.key?('DayTimeRestrictionDescription') ? hash['DayTimeRestrictionDescription'] : SKIP
+      day_time_restriction_status =
+        hash.key?('DayTimeRestrictionStatus') ? hash['DayTimeRestrictionStatus'] : SKIP
+      location_restriction_description =
+        hash.key?('LocationRestrictionDescription') ? hash['LocationRestrictionDescription'] : SKIP
+      location_restriction_status =
+        hash.key?('LocationRestrictionStatus') ? hash['LocationRestrictionStatus'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      product_restriction_description =
+        hash.key?('ProductRestrictionDescription') ? hash['ProductRestrictionDescription'] : SKIP
+      product_restriction_status =
+        hash.key?('ProductRestrictionStatus') ? hash['ProductRestrictionStatus'] : SKIP
+      usage_restriction_description =
+        hash.key?('UsageRestrictionDescription') ? hash['UsageRestrictionDescription'] : SKIP
+      usage_restriction_status =
+        hash.key?('UsageRestrictionStatus') ? hash['UsageRestrictionStatus'] : SKIP
+      validation_error_code =
+        hash.key?('ValidationErrorCode') ? hash['ValidationErrorCode'] : SKIP
+      validation_error_description =
+        hash.key?('ValidationErrorDescription') ? hash['ValidationErrorDescription'] : SKIP
+
+      # Create object from extracted values.
+      RestrictionCardResponseDataItems.new(account_id,
+                                           account_number,
+                                           card_id,
+                                           day_time_restriction_description,
+                                           day_time_restriction_status,
+                                           location_restriction_description,
+                                           location_restriction_status,
+                                           pan,
+                                           product_restriction_description,
+                                           product_restriction_status,
+                                           usage_restriction_description,
+                                           usage_restriction_status,
+                                           validation_error_code,
+                                           validation_error_description)
+    end
+  end
+end