card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/create_bundle_response.rb

@@ -0,0 +1,98 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CreateBundleResponse Model.
+  class CreateBundleResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Request Id
+    # @return [String]
+    attr_accessor :request_id
+
+    # Response status
+    # @return [String]
+    attr_accessor :status
+
+    # Response status
+    # @return [Array[CreateBundleResponseDataItems]]
+    attr_accessor :data
+
+    # Response status
+    # @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['errors'] = 'Errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   data = SKIP,
+                   errors = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == SKIP
+      @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 << (CreateBundleResponseDataItems.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      # 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.
+      CreateBundleResponse.new(request_id,
+                               status,
+                               data,
+                               errors)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/create_bundle_response_data_items.rb

@@ -0,0 +1,125 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CreateBundleResponseDataItems Model.
+  class CreateBundleResponseDataItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the newly created bundle in Gateway.
+    # @return [String]
+    attr_accessor :bundle_id
+
+    # List of product restriction requests validated and submitted successfully
+    # for each card.
+    # @return [Array[CreateBundleResponseDataItemsCardsItems]]
+    attr_accessor :cards
+
+    # Identifier of the day/time restriction profile created for the bundle in
+    # Gateway.
+    # This will be null if respective action is passed as “Default”.
+    # @return [String]
+    attr_accessor :day_time_restriction_profile_id
+
+    # Identifier of the location restriction profile created for the bundle in
+    # Gateway.
+    # This will be null if respective action is passed as “Default”.
+    # @return [String]
+    attr_accessor :location_restriction_profile_id
+
+    # Identifier of the location restriction profile created for the bundle in
+    # Gateway.
+    # This will be null if respective action is passed as “Default”.
+    # @return [String]
+    attr_accessor :product_restriction_profile_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bundle_id'] = 'BundleId'
+      @_hash['cards'] = 'Cards'
+      @_hash['day_time_restriction_profile_id'] =
+        'DayTimeRestrictionProfileId'
+      @_hash['location_restriction_profile_id'] =
+        'LocationRestrictionProfileId'
+      @_hash['product_restriction_profile_id'] = 'ProductRestrictionProfileId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bundle_id
+        cards
+        day_time_restriction_profile_id
+        location_restriction_profile_id
+        product_restriction_profile_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cards
+        day_time_restriction_profile_id
+        location_restriction_profile_id
+        product_restriction_profile_id
+      ]
+    end
+
+    def initialize(bundle_id = SKIP,
+                   cards = SKIP,
+                   day_time_restriction_profile_id = SKIP,
+                   location_restriction_profile_id = SKIP,
+                   product_restriction_profile_id = SKIP)
+      @bundle_id = bundle_id unless bundle_id == SKIP
+      @cards = cards unless cards == SKIP
+      unless day_time_restriction_profile_id == SKIP
+        @day_time_restriction_profile_id =
+          day_time_restriction_profile_id
+      end
+      unless location_restriction_profile_id == SKIP
+        @location_restriction_profile_id =
+          location_restriction_profile_id
+      end
+      unless product_restriction_profile_id == SKIP
+        @product_restriction_profile_id =
+          product_restriction_profile_id
+      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.
+      bundle_id = hash.key?('BundleId') ? hash['BundleId'] : 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 << (CreateBundleResponseDataItemsCardsItems.from_hash(structure) if structure)
+        end
+      end
+
+      cards = SKIP unless hash.key?('Cards')
+      day_time_restriction_profile_id =
+        hash.key?('DayTimeRestrictionProfileId') ? hash['DayTimeRestrictionProfileId'] : SKIP
+      location_restriction_profile_id =
+        hash.key?('LocationRestrictionProfileId') ? hash['LocationRestrictionProfileId'] : SKIP
+      product_restriction_profile_id =
+        hash.key?('ProductRestrictionProfileId') ? hash['ProductRestrictionProfileId'] : SKIP
+
+      # Create object from extracted values.
+      CreateBundleResponseDataItems.new(bundle_id,
+                                        cards,
+                                        day_time_restriction_profile_id,
+                                        location_restriction_profile_id,
+                                        product_restriction_profile_id)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/create_bundle_response_data_items_cards_items.rb

@@ -0,0 +1,50 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CreateBundleResponseDataItemsCardsItems Model.
+  class CreateBundleResponseDataItemsCardsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card PAN.
+    # @return [String]
+    attr_accessor :pan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pan'] = 'PAN'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pan = SKIP)
+      @pan = pan unless 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.
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+
+      # Create object from extracted values.
+      CreateBundleResponseDataItemsCardsItems.new(pan)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/create_card_group_request.rb

@@ -0,0 +1,161 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CreateCardGroupRequest Model.
+  class CreateCardGroupRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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-Philippines
+    # 5-UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Collecting Company Id  of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1-Philippines
+    # 5-UK
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Payer Id (i.e., Customer Id of the Payment Customer in H3 Cards Platform)
+    # of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Account ID of the customer.
+    # Optional if AccountNumber is passed else Mandatory.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.
+    # Optional if AccountId is passed else Mandatory.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Whether card group name to be embossed on the cards or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :print_on_card
+
+    # Whether card group name to be embossed on the cards or not.
+    # @return [String]
+    attr_accessor :card_group_name
+
+    # List of cards to be moved to the new card group. This list is optional –
+    # no card will be moved to the new card group when the list is empty.
+    # The fields of Card entity are described in the below rows.
+    # The maximum number of cards allowed to be moved in a request is 500
+    # (configurable). The whole request including the card group creation will
+    # be rejected when the limit is exceeded.
+    # @return [Array[CreateCardGroupRequestCardsItems]]
+    attr_accessor :cards
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['print_on_card'] = 'PrintOnCard'
+      @_hash['card_group_name'] = 'CardGroupName'
+      @_hash['cards'] = 'Cards'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_code
+        col_co_id
+        payer_number
+        payer_id
+        account_id
+        account_number
+        print_on_card
+        card_group_name
+        cards
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        card_group_name
+      ]
+    end
+
+    def initialize(col_co_code = SKIP,
+                   col_co_id = SKIP,
+                   payer_number = SKIP,
+                   payer_id = SKIP,
+                   account_id = SKIP,
+                   account_number = SKIP,
+                   print_on_card = SKIP,
+                   card_group_name = SKIP,
+                   cards = SKIP)
+      @col_co_code = col_co_code unless 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
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @print_on_card = print_on_card unless print_on_card == SKIP
+      @card_group_name = card_group_name unless card_group_name == SKIP
+      @cards = cards unless cards == 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_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      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
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      print_on_card = hash.key?('PrintOnCard') ? hash['PrintOnCard'] : SKIP
+      card_group_name =
+        hash.key?('CardGroupName') ? hash['CardGroupName'] : 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 << (CreateCardGroupRequestCardsItems.from_hash(structure) if structure)
+        end
+      end
+
+      cards = SKIP unless hash.key?('Cards')
+
+      # Create object from extracted values.
+      CreateCardGroupRequest.new(col_co_code,
+                                 col_co_id,
+                                 payer_number,
+                                 payer_id,
+                                 account_id,
+                                 account_number,
+                                 print_on_card,
+                                 card_group_name,
+                                 cards)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/create_card_group_request_cards_items.rb

@@ -0,0 +1,84 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CreateCardGroupRequestCardsItems Model.
+  class CreateCardGroupRequestCardsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Id of the account of the card.
+    # Optional if AccountNumber is passed, else Mandatory.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the account of the card.
+    # Optional if AccountId is passed, else Mandatory.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Card Id of the card.
+    # Optional if PAN is passed, else Mandatory.
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # PAN of the card.
+    # Optional if CardId is passed, else Mandatory.
+    # @return [String]
+    attr_accessor :pan
+
+    # 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['pan'] = 'PAN'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+        card_id
+        pan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = SKIP,
+                   account_number = SKIP,
+                   card_id = SKIP,
+                   pan = 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
+      @pan = pan unless 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.
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+
+      # Create object from extracted values.
+      CreateCardGroupRequestCardsItems.new(account_id,
+                                           account_number,
+                                           card_id,
+                                           pan)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/create_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
+  # CreateCardGroupResponse Model.
+  class CreateCardGroupResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Reference number for tracking the execution of the requests – new Card
+    # Group creation and to move the cards to the new card group.
+    # Reference number will be null when the validations of new card group
+    # parameters fail.
+    # @return [Integer]
+    attr_accessor :main_reference
+
+    # Reference number for tracking the execution of card group creation. 
+    # Reference number will be null when the validations of new card group
+    # parameters fail.
+    # @return [Integer]
+    attr_accessor :new_card_group_reference
+
+    # List of cards validated and submitted successfully for processing.
+    # @return [Array[CreateCardGroupResponseSuccessfulRequestsItems]]
+    attr_accessor :successful_requests
+
+    # List of cards that failed validation and not submitted for processing.
+    # Entity: FailedCardReference
+    # This list will be empty when the validations of new card group parameters
+    # fail.
+    # @return [Array[CreateCardGroupResponseErrorCardsItems]]
+    attr_accessor :error_cards
+
+    # List of cards that failed validation and not submitted for processing.
+    # Entity: FailedCardReference
+    # This list will be empty when the validations of new card group parameters
+    # fail.
+    # @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['new_card_group_reference'] = 'NewCardGroupReference'
+      @_hash['successful_requests'] = 'SuccessfulRequests'
+      @_hash['error_cards'] = 'ErrorCards'
+      @_hash['error'] = 'Error'
+      @_hash['request_id'] = 'RequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        main_reference
+        new_card_group_reference
+        successful_requests
+        error_cards
+        error
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(main_reference = SKIP,
+                   new_card_group_reference = SKIP,
+                   successful_requests = SKIP,
+                   error_cards = SKIP,
+                   error = SKIP,
+                   request_id = SKIP)
+      @main_reference = main_reference unless main_reference == SKIP
+      @new_card_group_reference = new_card_group_reference unless new_card_group_reference == SKIP
+      @successful_requests = successful_requests unless successful_requests == SKIP
+      @error_cards = error_cards unless error_cards == 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
+      new_card_group_reference =
+        hash.key?('NewCardGroupReference') ? hash['NewCardGroupReference'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      successful_requests = nil
+      unless hash['SuccessfulRequests'].nil?
+        successful_requests = []
+        hash['SuccessfulRequests'].each do |structure|
+          successful_requests << (CreateCardGroupResponseSuccessfulRequestsItems.from_hash(structure) if structure)
+        end
+      end
+
+      successful_requests = SKIP unless hash.key?('SuccessfulRequests')
+      # Parameter is an array, so we need to iterate through it
+      error_cards = nil
+      unless hash['ErrorCards'].nil?
+        error_cards = []
+        hash['ErrorCards'].each do |structure|
+          error_cards << (CreateCardGroupResponseErrorCardsItems.from_hash(structure) if structure)
+        end
+      end
+
+      error_cards = SKIP unless hash.key?('ErrorCards')
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+
+      # Create object from extracted values.
+      CreateCardGroupResponse.new(main_reference,
+                                  new_card_group_reference,
+                                  successful_requests,
+                                  error_cards,
+                                  error,
+                                  request_id)
+    end
+  end
+end