card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/schedule_card_block_cards_items.rb

@@ -0,0 +1,249 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ScheduleCardBlockCardsItems Model.
+  class ScheduleCardBlockCardsItems < 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
+
+    # 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
+
+    # Payer id of the customer.
+    # Optional if PayerNumber is passed, else Mandatory. 
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # PayerNumber of the customer.
+    # Optional if PayerId is passed, else Mandatory.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Unique 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
+
+    # Expiry date of the card.
+    # Optional if CardId is passed, else Mandatory.
+    # Format: yyyyMMdd
+    # Example: 20170930
+    # @return [String]
+    attr_accessor :card_expiry_date
+
+    # Action
+    # Mandatory
+    # Possible values are:
+    # •	AddOrUpdate – adds a new request or updates any existing requests, with
+    # overlapping dates, for the card
+    # •	AddAndOverwriteAll - all the existing requests of the given card will be
+    # removed and a new request with the specified FromDate and ToDate will be
+    # added.
+    # •	Delete – deletes any existing request with the same start date and end
+    # date for the card
+    # •	DeleteAll – deletes all saved future dated requests (all block and
+    # unblock requests) of the card.
+    # @return [String]
+    attr_accessor :action
+
+    # Effective start date of Block / Unblock
+    # Allowed Formats: –
+    # •	yyyyMMdd
+    # •	yyyyMMdd HH:mm
+    # Eg: 20230512 14:30, 20230512
+    # Optional
+    # Default value: 
+    # •	 If the card status is “Active” then Current date & Time
+    # •	If the card status is “TemporaryBlock (Customer)” then null.
+    # Note:
+    # •	Time is considered only when “IsTimeSupported” is true else it will be
+    # treated as a date.
+    # •	Time will be passed in UTC time-zone.
+    # •	If the Card Status is “Temporary Block (Customer)” and FromDate is
+    # provided – The fromdate & time is considered as starting period of unblock
+    # request.
+    # @return [String]
+    attr_accessor :from_date
+
+    # Effective end date of Block / Unblock
+    # Allowed Formats: –
+    # •	yyyyMMdd
+    # •	yyyyMMdd HH:mm
+    # Eg: 20230512 14:30, 20230512
+    # Optional – When the Card status is Active else mandatory.
+    # When not provided, the card will remain blocked until manually unblocked.
+    # Note:
+    # •	Time is considered only when the “IsTimeSupported” flag is set as true,
+    # else it will be considered as only date.
+    # •	Date & Time passed in the request will be considered in UTC time-zone.
+    # •	If the card is currently in ‘Temporary Block (Customer)’ status, then
+    # this date is treated as the unblock date and is mandatory.
+    # •	If the Card Status is “Temporary Block (Customer)” and FromDate & ToDate
+    # is provided - The request will be considered as a scheduled specific
+    # period unblock request.
+    # @return [String]
+    attr_accessor :to_date
+
+    # The caller to be notified with the status of the scheduled card block /
+    # unblock request.
+    # Mandatory, if NotifyCaller is true. 
+    # Maximum field length: 20
+    # @return [String]
+    attr_accessor :caller
+
+    # True/False.
+    # Optional.
+    # Default: False
+    # If true, the caller would be notified back with the status as success or
+    # failure after the scheduled card block / unblock request is processed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :notify_caller
+
+    # 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['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['card_id'] = 'CardId'
+      @_hash['pan'] = 'PAN'
+      @_hash['card_expiry_date'] = 'CardExpiryDate'
+      @_hash['action'] = 'Action'
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash['caller'] = 'Caller'
+      @_hash['notify_caller'] = 'NotifyCaller'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_code
+        col_co_id
+        account_id
+        account_number
+        payer_id
+        payer_number
+        card_id
+        pan
+        card_expiry_date
+        from_date
+        to_date
+        caller
+        notify_caller
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        caller
+      ]
+    end
+
+    def initialize(action = nil,
+                   col_co_code = SKIP,
+                   col_co_id = SKIP,
+                   account_id = SKIP,
+                   account_number = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   card_id = SKIP,
+                   pan = SKIP,
+                   card_expiry_date = SKIP,
+                   from_date = SKIP,
+                   to_date = SKIP,
+                   caller = SKIP,
+                   notify_caller = SKIP)
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @card_id = card_id unless card_id == SKIP
+      @pan = pan unless pan == SKIP
+      @card_expiry_date = card_expiry_date unless card_expiry_date == SKIP
+      @action = action
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == SKIP
+      @caller = caller unless caller == SKIP
+      @notify_caller = notify_caller unless notify_caller == 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.
+      action = hash.key?('Action') ? hash['Action'] : nil
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      card_expiry_date =
+        hash.key?('CardExpiryDate') ? hash['CardExpiryDate'] : SKIP
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+      caller = hash.key?('Caller') ? hash['Caller'] : SKIP
+      notify_caller = hash.key?('NotifyCaller') ? hash['NotifyCaller'] : SKIP
+
+      # Create object from extracted values.
+      ScheduleCardBlockCardsItems.new(action,
+                                      col_co_code,
+                                      col_co_id,
+                                      account_id,
+                                      account_number,
+                                      payer_id,
+                                      payer_number,
+                                      card_id,
+                                      pan,
+                                      card_expiry_date,
+                                      from_date,
+                                      to_date,
+                                      caller,
+                                      notify_caller)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/schedule_card_block_request.rb

@@ -0,0 +1,77 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ScheduleCardBlockRequest Model.
+  class ScheduleCardBlockRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Default: False
+    # True – It supports both date & time.
+    # False – It supports only date. Time will be ignored if it is provided in
+    # the request.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_time_supported
+
+    # List of ScheduleCardBlockCard entity. Each card in the list will be
+    # scheduled for Block or Unblock. The details of the entity are given below.
+    # @return [Array[ScheduleCardBlockCardsItems]]
+    attr_accessor :schedule_card_block_cards
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['is_time_supported'] = 'IsTimeSupported'
+      @_hash['schedule_card_block_cards'] = 'ScheduleCardBlockCards'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        is_time_supported
+        schedule_card_block_cards
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(is_time_supported = SKIP,
+                   schedule_card_block_cards = SKIP)
+      @is_time_supported = is_time_supported unless is_time_supported == SKIP
+      unless schedule_card_block_cards == SKIP
+        @schedule_card_block_cards =
+          schedule_card_block_cards
+      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.
+      is_time_supported =
+        hash.key?('IsTimeSupported') ? hash['IsTimeSupported'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      schedule_card_block_cards = nil
+      unless hash['ScheduleCardBlockCards'].nil?
+        schedule_card_block_cards = []
+        hash['ScheduleCardBlockCards'].each do |structure|
+          schedule_card_block_cards << (ScheduleCardBlockCardsItems.from_hash(structure) if structure)
+        end
+      end
+
+      schedule_card_block_cards = SKIP unless hash.key?('ScheduleCardBlockCards')
+
+      # Create object from extracted values.
+      ScheduleCardBlockRequest.new(is_time_supported,
+                                   schedule_card_block_cards)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/schedule_card_block_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
+  # ScheduleCardBlockResponse Model.
+  class ScheduleCardBlockResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Reference number for tracking the execution of the request.
+    # Note: Reference will be empty for status 9006 and 9012 i.e., request for
+    # all the cards failed.
+    # @return [Integer]
+    attr_accessor :main_reference
+
+    # API Request ID
+    # @return [String]
+    attr_accessor :request_id
+
+    # Overall Status of the API call
+    # @return [String]
+    attr_accessor :status
+
+    # List of SubmittedScheduleCardBlockCard entity.
+    # @return [Array[ScheduleCardBlockResponseDataItems]]
+    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 << (ScheduleCardBlockResponseDataItems.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      ScheduleCardBlockResponse.new(main_reference,
+                                    request_id,
+                                    status,
+                                    data)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/schedule_card_block_response_data_items.rb

@@ -0,0 +1,89 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ScheduleCardBlockResponseDataItems Model.
+  class ScheduleCardBlockResponseDataItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Id of the card.
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # Effective start date & time of Block / Unblock as updated in the
+    # intermediate queue table.
+    # Format: yyyyMMdd HH:mm
+    # Eg: 20230512 12:30
+    # @return [String]
+    attr_accessor :from_date
+
+    # Effective end date & time of Block / Unblock as updated in the
+    # intermediate queue table.
+    # Format: yyyyMMdd HH:mm
+    # Eg: 20230512 14:30
+    # @return [String]
+    attr_accessor :to_date
+
+    # Effective end date & time of Block / Unblock as updated in the
+    # intermediate queue table.
+    # Format: yyyyMMdd HH:mm
+    # Eg: 20230512 14:30
+    # @return [Integer]
+    attr_accessor :reference_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_id'] = 'CardId'
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash['reference_id'] = 'ReferenceId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_id
+        from_date
+        to_date
+        reference_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_id = SKIP,
+                   from_date = SKIP,
+                   to_date = SKIP,
+                   reference_id = SKIP)
+      @card_id = card_id unless card_id == SKIP
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == SKIP
+      @reference_id = reference_id unless reference_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.
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+      reference_id = hash.key?('ReferenceId') ? hash['ReferenceId'] : SKIP
+
+      # Create object from extracted values.
+      ScheduleCardBlockResponseDataItems.new(card_id,
+                                             from_date,
+                                             to_date,
+                                             reference_id)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/search_account_limit_request.rb

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

data/lib/shell_card_management_ap_is/models/search_account_limit_request_filters.rb

@@ -0,0 +1,118 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # SearchAccountLimitRequestFilters Model.
+  class SearchAccountLimitRequestFilters < 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
+
+    # 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 Id  of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Optional if AccountNumber is passed else Mandatory
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.
+    # Optional if AccountId is passed else Mandatory
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        account_id
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_id
+      ]
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   account_id = SKIP,
+                   account_number = SKIP)
+      @col_co_id = col_co_id unless col_co_id == 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
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_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.
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      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
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+
+      # Create object from extracted values.
+      SearchAccountLimitRequestFilters.new(col_co_id,
+                                           col_co_code,
+                                           payer_id,
+                                           payer_number,
+                                           account_id,
+                                           account_number)
+    end
+  end
+end