card-management-sdk 1.0.0 → 1.2.0

data/lib/shell_card_management_ap_is/models/card_management_v1_cancel_request.rb

@@ -0,0 +1,104 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CardManagementV1CancelRequest Model.
+  class CardManagementV1CancelRequest < 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.
+      CardManagementV1CancelRequest.new(cards,
+                                        reason_id,
+                                        reason_text)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_management_v1_ordercard_request.rb

@@ -0,0 +1,59 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CardManagementV1OrdercardRequest Model.
+  class CardManagementV1OrdercardRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of CardOrder entity. The fields in this entity are described below.
+    # @return [Array[CardDetail]]
+    attr_accessor :card_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_details'] = 'CardDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_details = SKIP)
+      @card_details = card_details unless card_details == 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
+      card_details = nil
+      unless hash['CardDetails'].nil?
+        card_details = []
+        hash['CardDetails'].each do |structure|
+          card_details << (CardDetail.from_hash(structure) if structure)
+        end
+      end
+
+      card_details = SKIP unless hash.key?('CardDetails')
+
+      # Create object from extracted values.
+      CardManagementV1OrdercardRequest.new(card_details)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_management_v1_pinreminder_request.rb

@@ -0,0 +1,130 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CardManagementV1PinreminderRequest Model.
+  class CardManagementV1PinreminderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Id of the customer.<br />
+    # Optional if AccountNumber is passed, else Mandatory.<br />
+    # This input is a search criterion, if given.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.<br />
+    # Optional if AccountId is passed, else Mandatory.<br />
+    # This input is a search criterion, if given.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Collecting Company Code (Shell Code) of the selected payer. <br />
+    # Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia,
+    # Ukraine etc. <br />
+    # It is optional for other countries if ColCoID is provided.
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Collecting Company Id of the selected payer<br />
+    # Optional if ColCoCode is passed else Mandatory.
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Payer Id (i.e. Customer Id of the Payment Customer of the selected
+    # payer.<br />
+    # Optional if PayerNumber is passed else Mandatory
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number (Ex: GB000000123) of the selected payer.<br />
+    # Optional if PayerId is passed else Mandatory
+    # @return [String]
+    attr_accessor :payer_number
+
+    # List of PINReminderCardDetails entity. The fields of this entity are
+    # described below.
+    # @return [Array[PINReminderCardDetails]]
+    attr_accessor :pin_reminder_card_details
+
+    # 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['col_co_code'] = 'ColCoCode'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['pin_reminder_card_details'] = 'PINReminderCardDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+        col_co_code
+        col_co_id
+        payer_id
+        payer_number
+        pin_reminder_card_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = SKIP, account_number = SKIP, col_co_code = SKIP,
+                   col_co_id = SKIP, payer_id = SKIP, payer_number = SKIP,
+                   pin_reminder_card_details = SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      unless pin_reminder_card_details == SKIP
+        @pin_reminder_card_details =
+          pin_reminder_card_details
+      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
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      pin_reminder_card_details = nil
+      unless hash['PINReminderCardDetails'].nil?
+        pin_reminder_card_details = []
+        hash['PINReminderCardDetails'].each do |structure|
+          pin_reminder_card_details << (PINReminderCardDetails.from_hash(structure) if structure)
+        end
+      end
+
+      pin_reminder_card_details = SKIP unless hash.key?('PINReminderCardDetails')
+
+      # Create object from extracted values.
+      CardManagementV1PinreminderRequest.new(account_id,
+                                             account_number,
+                                             col_co_code,
+                                             col_co_id,
+                                             payer_id,
+                                             payer_number,
+                                             pin_reminder_card_details)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_management_v1_updatestatus_request.rb

@@ -0,0 +1,122 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CardManagementV1UpdatestatusRequest Model.
+  class CardManagementV1UpdatestatusRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of UpdateCardRequest entity. Each card in the list will be updated to
+    # the given target status. The details of the entity are given below.
+    # @return [Array[UpdateCard]]
+    attr_accessor :cards
+
+    # Reason id for updating the card status.<br />
+    # Optional<br />
+    # Either Reason ID or Text is madatory when TargetStatus is ‘Block’ or
+    # ‘Damaged’. Else ignored.<br />
+    # Possible values:<br />
+    # -Lost <br />
+    # -Stolen <br />
+    # -Card no longer required<br />
+    # When passed, the reason Id will be validated with the allowed reason ids
+    # configured for the card type of the card.<br />
+    # . If the given reason Id is not allowed for certain card types, then the
+    # request will be rejected as invalid ResonId.
+    # @return [Integer]
+    attr_accessor :reason_id
+
+    # Reason text for updating the card status.<br />
+    # Optional Either Reason ID or Text is madatory when TargetStatus is ‘Block’
+    # or ‘Damaged’. Else ignored.<br />
+    # Possible values:<br />
+    # -Lost <br />
+    # -Stolen <br />
+    # -Card no longer required <br />
+    #  Optional – However, either Reason ID or Text is madatory when
+    # TargetStatus is ‘Block’ or ‘Damaged’.<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.<br />
+    #  If the text is not allowed, request will be rejected as invaid
+    # ResonText.<br />
+    #  Note:<br />
+    #  Customer blocked’ will be used as the reason for ‘Temporary Block’.
+    # @return [String]
+    attr_accessor :reason_text
+
+    # The list of cards passed in Cards parameter will be updated to this
+    # status.<br />
+    # Mandatory<br />
+    # Allowed values:<br />
+    # -TemporaryBlock<br />
+    # -Unblock<br />
+    # -Block<br />
+    # -Damaged<br />
+    # @return [String]
+    attr_accessor :target_status
+
+    # 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['target_status'] = 'TargetStatus'
+      @_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, target_status = 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
+      @target_status = target_status
+    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')
+      target_status = hash.key?('TargetStatus') ? hash['TargetStatus'] : nil
+      reason_id = hash.key?('ReasonId') ? hash['ReasonId'] : SKIP
+      reason_text = hash.key?('ReasonText') ? hash['ReasonText'] : SKIP
+
+      # Create object from extracted values.
+      CardManagementV1UpdatestatusRequest.new(cards,
+                                              target_status,
+                                              reason_id,
+                                              reason_text)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_move_request.rb

@@ -92,15 +92,10 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(col_co_code = SKIP,
-                   col_co_id = SKIP,
-                   col_co_country_code = SKIP,
-                   payer_number = SKIP,
-                   payer_id = SKIP,
-                   cards = SKIP,
-                   target_account_id = SKIP,
-                   target_account_number = SKIP,
-                   target_card_group_id = SKIP,
+    def initialize(col_co_code = SKIP, col_co_id = SKIP,
+                   col_co_country_code = SKIP, payer_number = SKIP,
+                   payer_id = SKIP, cards = SKIP, target_account_id = SKIP,
+                   target_account_number = SKIP, target_card_group_id = SKIP,
                    target_new_card_group_name = SKIP)
       @col_co_code = col_co_code unless col_co_code == SKIP
       @col_co_id = col_co_id unless col_co_id == SKIP

data/lib/shell_card_management_ap_is/models/card_move_request_cards_items.rb

@@ -50,9 +50,7 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(account_number = SKIP,
-                   account_id = SKIP,
-                   pan = SKIP,
+    def initialize(account_number = SKIP, account_id = SKIP, pan = SKIP,
                    card_id = SKIP)
       @account_number = account_number unless account_number == SKIP
       @account_id = account_id unless account_id == SKIP

data/lib/shell_card_management_ap_is/models/card_move_response.rb

@@ -57,10 +57,8 @@ module ShellCardManagementApIs
     end
 
     def initialize(move_card_request_reference = SKIP,
-                   successful_requests = SKIP,
-                   error_cards = SKIP,
-                   request_id = SKIP,
-                   error = SKIP)
+                   successful_requests = SKIP, error_cards = SKIP,
+                   request_id = SKIP, error = SKIP)
       unless move_card_request_reference == SKIP
         @move_card_request_reference =
           move_card_request_reference

data/lib/shell_card_management_ap_is/models/card_move_response_error_cards_items.rb

@@ -69,11 +69,8 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(account_number = SKIP,
-                   account_id = SKIP,
-                   pan = SKIP,
-                   card_id = SKIP,
-                   validation_error_code = SKIP,
+    def initialize(account_number = SKIP, account_id = SKIP, pan = SKIP,
+                   card_id = SKIP, validation_error_code = SKIP,
                    validation_error_description = SKIP)
       @account_number = account_number unless account_number == SKIP
       @account_id = account_id unless account_id == SKIP

data/lib/shell_card_management_ap_is/models/card_move_response_successful_requests_items.rb

@@ -62,11 +62,8 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(account_number = SKIP,
-                   account_id = SKIP,
-                   pan = SKIP,
-                   card_id = SKIP,
-                   move_card_reference = SKIP)
+    def initialize(account_number = SKIP, account_id = SKIP, pan = SKIP,
+                   card_id = SKIP, move_card_reference = SKIP)
       @account_number = account_number unless account_number == SKIP
       @account_id = account_id unless account_id == SKIP
       @pan = pan unless pan == SKIP

data/lib/shell_card_management_ap_is/models/{restriction_card_request.rb → card_restriction_req.rb}

@@ -4,8 +4,8 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # RestrictionCardRequest Model.
-  class RestrictionCardRequest < BaseModel
+  # CardRestrictionReq Model.
+  class CardRestrictionReq < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -17,13 +17,14 @@ module ShellCardManagementApIs
     # @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
+    # Collecting Company 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
@@ -31,28 +32,26 @@ module ShellCardManagementApIs
     # @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
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
 
-    # 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 Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # Example: GB000000123
+    # @return [RestrictionCardsList]
+    attr_accessor :cards
 
     # 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['col_co_code'] = 'ColCoCode'
       @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
       @_hash['cards'] = 'Cards'
-      @_hash['col_co_code'] = 'ColCoCode'
       @_hash
     end
 
@@ -60,28 +59,30 @@ module ShellCardManagementApIs
     def self.optionals
       %w[
         col_co_id
-        payer_number
+        col_co_code
         payer_id
+        payer_number
         cards
-        col_co_code
       ]
     end
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+      ]
     end
 
-    def initialize(col_co_id = SKIP,
-                   payer_number = SKIP,
-                   payer_id = SKIP,
-                   cards = SKIP,
-                   col_co_code = SKIP)
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, cards = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
-      @payer_number = payer_number unless payer_number == 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
       @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.
@@ -90,26 +91,17 @@ module ShellCardManagementApIs
 
       # 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
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      cards = RestrictionCardsList.from_hash(hash['Cards']) if hash['Cards']
 
       # Create object from extracted values.
-      RestrictionCardRequest.new(col_co_id,
-                                 payer_number,
-                                 payer_id,
-                                 cards,
-                                 col_co_code)
+      CardRestrictionReq.new(col_co_id,
+                             col_co_code,
+                             payer_id,
+                             payer_number,
+                             cards)
     end
   end
 end