card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/update_card_group_response.rb

@@ -0,0 +1,130 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # UpdateCardGroupResponse Model.
+  class UpdateCardGroupResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Reference number for tracking the overall request.
+    # The value will be null when the validation fails.
+    # @return [Integer]
+    attr_accessor :main_reference
+
+    # Reference number for tracking the execution of terminate card-group
+    # request.
+    # Reference number will be null when the validations fail or
+    # TerminateCardGroup in the request object is false.
+    # @return [Integer]
+    attr_accessor :update_card_group_reference
+
+    # Reference number for tracking the execution of new card group creation in
+    # the case when the cards in the terminating card-group have to be moved to
+    # a new card-group. 
+    # Reference number will be null when the validations fail or new card-group
+    # creation is not requested.
+    # @return [Integer]
+    attr_accessor :new_card_group_reference
+
+    # List of cards submitted successfully for processing the move to the target
+    # card-group or to change card-group to null.
+    # This list will be empty when the validations fail or there are no cards in
+    # the card-group that is getting terminated or MoveCards in the request
+    # object is false
+    # @return [Array[UpdateCardGroupResponseMoveCardReferencesItems]]
+    attr_accessor :move_card_references
+
+    # List of cards submitted successfully for processing the move to the target
+    # card-group or to change card-group to null.
+    # This list will be empty when the validations fail or there are no cards in
+    # the card-group that is getting terminated or MoveCards in the request
+    # object is false
+    # @return [ErrorStatus]
+    attr_accessor :error
+
+    # API Request ID
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['main_reference'] = 'MainReference'
+      @_hash['update_card_group_reference'] = 'UpdateCardGroupReference'
+      @_hash['new_card_group_reference'] = 'NewCardGroupReference'
+      @_hash['move_card_references'] = 'MoveCardReferences'
+      @_hash['error'] = 'Error'
+      @_hash['request_id'] = 'RequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        main_reference
+        update_card_group_reference
+        new_card_group_reference
+        move_card_references
+        error
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(main_reference = SKIP,
+                   update_card_group_reference = SKIP,
+                   new_card_group_reference = SKIP,
+                   move_card_references = SKIP,
+                   error = SKIP,
+                   request_id = SKIP)
+      @main_reference = main_reference unless main_reference == SKIP
+      unless update_card_group_reference == SKIP
+        @update_card_group_reference =
+          update_card_group_reference
+      end
+      @new_card_group_reference = new_card_group_reference unless new_card_group_reference == SKIP
+      @move_card_references = move_card_references unless move_card_references == SKIP
+      @error = error unless error == SKIP
+      @request_id = request_id unless request_id == 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
+      update_card_group_reference =
+        hash.key?('UpdateCardGroupReference') ? hash['UpdateCardGroupReference'] : SKIP
+      new_card_group_reference =
+        hash.key?('NewCardGroupReference') ? hash['NewCardGroupReference'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      move_card_references = nil
+      unless hash['MoveCardReferences'].nil?
+        move_card_references = []
+        hash['MoveCardReferences'].each do |structure|
+          move_card_references << (UpdateCardGroupResponseMoveCardReferencesItems.from_hash(structure) if structure)
+        end
+      end
+
+      move_card_references = SKIP unless hash.key?('MoveCardReferences')
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+
+      # Create object from extracted values.
+      UpdateCardGroupResponse.new(main_reference,
+                                  update_card_group_reference,
+                                  new_card_group_reference,
+                                  move_card_references,
+                                  error,
+                                  request_id)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/update_card_group_response_move_card_references_items.rb

@@ -0,0 +1,77 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # UpdateCardGroupResponseMoveCardReferencesItems Model.
+  class UpdateCardGroupResponseMoveCardReferencesItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card Id of the card.
+    # Example: 123
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # PAN of the card.
+    # Example: 7002051123456789145
+    # @return [String]
+    attr_accessor :pan
+
+    # Reference number for tracking of update status request of the specific
+    # card.
+    # @return [Integer]
+    attr_accessor :reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_id'] = 'CardId'
+      @_hash['pan'] = 'PAN'
+      @_hash['reference'] = 'Reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_id
+        pan
+        reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        card_id
+        pan
+        reference
+      ]
+    end
+
+    def initialize(card_id = SKIP,
+                   pan = SKIP,
+                   reference = SKIP)
+      @card_id = card_id unless card_id == SKIP
+      @pan = pan unless pan == SKIP
+      @reference = reference unless reference == 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.
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+
+      # Create object from extracted values.
+      UpdateCardGroupResponseMoveCardReferencesItems.new(card_id,
+                                                         pan,
+                                                         reference)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/update_card_renewal_address.rb

@@ -0,0 +1,163 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Delivery address of card. This address will be used for card reissue and PIN
+  # reminders in future. Note: Mandatory when ‘UseCustomerDefaultAddress’ is set
+  # to ‘false’. The field is ignored otherwise.
+  class UpdateCardRenewalAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contact name
+    # Note: Mandatory when ‘UseCustomerDefaultAddress’ is set to ‘false’. The
+    # field is ignored otherwise.
+    # Max Length: 50
+    # @return [String]
+    attr_accessor :contact_name
+
+    # Title
+    # Max Length: 50
+    # @return [String]
+    attr_accessor :contact_title
+
+    # Company name.
+    # Note: Mandatory when ‘UseCustomerDefaultAddress’ is set to ‘false’. The
+    # field is ignored otherwise.
+    # Max Length: 50
+    # @return [String]
+    attr_accessor :company_name
+
+    # Address line 1,2 and 3
+    # Note: Mandatory when ‘UseCustomerDefaultAddress’ is set to ‘false’. The
+    # field is ignored otherwise.
+    # Max Length: 128
+    # Note: -Each address line should be separated by “\r\n”.
+    # @return [String]
+    attr_accessor :address_line
+
+    # ZipCode
+    # Note: Mandatory when ‘UseCustomerDefaultAddress’ is set to ‘false’. The
+    # field is ignored otherwise.
+    # Max Length: 10
+    # @return [String]
+    attr_accessor :zip_code
+
+    # City
+    # Note: Mandatory when ‘UseCustomerDefaultAddress’ is set to ‘false’. The
+    # field is ignored otherwise.
+    # Max Length: 40
+    # @return [String]
+    attr_accessor :city
+
+    # Region id of card.
+    # @return [Integer]
+    attr_accessor :region_id
+
+    # Country ID
+    # Note: Mandatory when ‘UseCustomerDefaultAddress’ is set to ‘false’. The
+    # field is ignored otherwise.
+    # @return [Integer]
+    attr_accessor :country_id
+
+    # Email Address
+    # Max Length: 90
+    # Note: -
+    # Based on the international standard that there can be 
+    # •	Max Length 64 before the @ (the 'Local part’) =64(minimum of 1)
+    # •	Max Lenth after the (the domain) = 88 (Minimum of 2)
+    # @return [String]
+    attr_accessor :email_address
+
+    # Phone number
+    # Optional
+    # Max Length: 16
+    # @return [String]
+    attr_accessor :phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_name'] = 'ContactName'
+      @_hash['contact_title'] = 'ContactTitle'
+      @_hash['company_name'] = 'CompanyName'
+      @_hash['address_line'] = 'AddressLine'
+      @_hash['zip_code'] = 'ZipCode'
+      @_hash['city'] = 'City'
+      @_hash['region_id'] = 'RegionID'
+      @_hash['country_id'] = 'CountryID'
+      @_hash['email_address'] = 'EmailAddress'
+      @_hash['phone_number'] = 'PhoneNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_title
+        city
+        region_id
+        email_address
+        phone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contact_name = nil,
+                   company_name = nil,
+                   address_line = nil,
+                   zip_code = nil,
+                   country_id = nil,
+                   contact_title = SKIP,
+                   city = SKIP,
+                   region_id = SKIP,
+                   email_address = SKIP,
+                   phone_number = SKIP)
+      @contact_name = contact_name
+      @contact_title = contact_title unless contact_title == SKIP
+      @company_name = company_name
+      @address_line = address_line
+      @zip_code = zip_code
+      @city = city unless city == SKIP
+      @region_id = region_id unless region_id == SKIP
+      @country_id = country_id
+      @email_address = email_address unless email_address == SKIP
+      @phone_number = phone_number unless phone_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.
+      contact_name = hash.key?('ContactName') ? hash['ContactName'] : nil
+      company_name = hash.key?('CompanyName') ? hash['CompanyName'] : nil
+      address_line = hash.key?('AddressLine') ? hash['AddressLine'] : nil
+      zip_code = hash.key?('ZipCode') ? hash['ZipCode'] : nil
+      country_id = hash.key?('CountryID') ? hash['CountryID'] : nil
+      contact_title = hash.key?('ContactTitle') ? hash['ContactTitle'] : SKIP
+      city = hash.key?('City') ? hash['City'] : SKIP
+      region_id = hash.key?('RegionID') ? hash['RegionID'] : SKIP
+      email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
+      phone_number = hash.key?('PhoneNumber') ? hash['PhoneNumber'] : SKIP
+
+      # Create object from extracted values.
+      UpdateCardRenewalAddress.new(contact_name,
+                                   company_name,
+                                   address_line,
+                                   zip_code,
+                                   country_id,
+                                   contact_title,
+                                   city,
+                                   region_id,
+                                   email_address,
+                                   phone_number)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/update_card_status_request.rb

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

data/lib/shell_card_management_ap_is/models/update_card_status_response.rb

@@ -0,0 +1,133 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # UpdateCardStatusResponse Model.
+  class UpdateCardStatusResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique request identifier passed from end user. This identifier helps in
+    # tracing a transaction
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request. Allowed values: SUCCESS, FAILED,
+    # PARTIAL_SUCCESS
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request. Allowed values: SUCCESS, FAILED,
+    # PARTIAL_SUCCESS
+    # @return [Array[SubmittedCard]]
+    attr_accessor :data
+
+    # Update status reference number for tracking the execution of the request.
+    # <br>Note: Reference will be empty for status 9006 and 9012 i.e., request
+    # for all the cards failed.
+    # @return [Integer]
+    attr_accessor :main_reference
+
+    # Order replacement reference number for tracking the execution of the order
+    # replacement cards request. <br/>Note: Reference will be empty for status
+    # 9006 and 9012 i.e., request for all the cards failed or if there were no
+    # order replacement requested in the input.
+    # @return [Integer]
+    attr_accessor :order_replacement_reference
+
+    # Order replacement reference number for tracking the execution of the order
+    # replacement cards request. <br/>Note: Reference will be empty for status
+    # 9006 and 9012 i.e., request for all the cards failed or if there were no
+    # order replacement requested in the input.
+    # @return [Array[ErrorDetails]]
+    attr_accessor :errors
+
+    # 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['data'] = 'Data'
+      @_hash['main_reference'] = 'MainReference'
+      @_hash['order_replacement_reference'] = 'OrderReplacementReference'
+      @_hash['errors'] = 'Errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        main_reference
+        order_replacement_reference
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   data = SKIP,
+                   main_reference = SKIP,
+                   order_replacement_reference = SKIP,
+                   errors = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == SKIP
+      @main_reference = main_reference unless main_reference == SKIP
+      unless order_replacement_reference == SKIP
+        @order_replacement_reference =
+          order_replacement_reference
+      end
+      @errors = errors unless errors == 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
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['Data'].nil?
+        data = []
+        hash['Data'].each do |structure|
+          data << (SubmittedCard.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      main_reference = hash.key?('MainReference') ? hash['MainReference'] : SKIP
+      order_replacement_reference =
+        hash.key?('OrderReplacementReference') ? hash['OrderReplacementReference'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      errors = nil
+      unless hash['Errors'].nil?
+        errors = []
+        hash['Errors'].each do |structure|
+          errors << (ErrorDetails.from_hash(structure) if structure)
+        end
+      end
+
+      errors = SKIP unless hash.key?('Errors')
+
+      # Create object from extracted values.
+      UpdateCardStatusResponse.new(request_id,
+                                   status,
+                                   data,
+                                   main_reference,
+                                   order_replacement_reference,
+                                   errors)
+    end
+  end
+end