card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/order_card_enquiry_req.rb

@@ -0,0 +1,208 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # This class holds Order Card Enquiry list based on which the Order Card
+  # Enquiry need to be filtered.
+  class OrderCardEnquiryReq < 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 />
+    # Optional – when ‘ReferenceNumber’ is provided.<br />
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Collecting Company Id (in ) of the selected payer. <br />
+    # Optional – when ‘ReferenceNumber’ is provided. Else, either ‘ColCoId’ or
+    # ‘ColCoCode’ is mandatory.<br />
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # ISO 3166 Alpha-2 Country Code for the customer and card owning country.
+    # @return [String]
+    attr_accessor :col_co_country_code
+
+    # Payer Id (i.e. Customer Id of the Payment Customer) of the selected
+    # payer.<br />
+    # Optional – when ‘ReferenceNumber’ is provided. Else, either ‘PayerId’ or
+    # ‘PayerNumber’ is mandatory.
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the selected payer.<br />
+    # Optional – when ‘ReferenceNumber’ is provided. Else, either ‘PayerId’ or
+    # ‘PayerNumber’ is mandatory.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Reference number of the Card Order/ Bulk Card Order/ Order Card
+    # Request.<br />
+    # Mandatory when ColCo and Payer fields are not provided. Else, optional.
+    # @return [Integer]
+    attr_accessor :reference_number
+
+    # Type of the reference number provided.<br />
+    # Mandatory if ReferenceNumber is provided. Else optional.<br />
+    # Allowed Values:<br />
+    # 1=Main Reference(Main Order Reference Number returned in the output of
+    # Card/OrderCard service. <br />
+    # 2=Order Card Reference (Reference number for each individual card in the
+    # order submitted via Card/OrderCard service. <br />
+    # 3=Bulk Order Card Reference (Reference number returned in the response of
+    # bulkcardinterface /UploadOrderCardTemplate. )
+    # @return [OrderCardEnquiryReqReferenceTypeEnum]
+    attr_accessor :reference_type
+
+    # Card Orders from Date/Time.<br />
+    # Optional.<br />
+    # Value should be with in last 7 days<br />
+    # This field is ignored if ReferenceNumber is provided <br />
+    # This field is optional when not provided and ReferenceNumber is null or
+    # empty then the value should be set to D-7(Where D is current date)<br />
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :from_date
+
+    # Card Order to Date/Time<br />
+    # Optional<br />
+    # Value should be with in last 7 days<br />
+    # This field is ignored if ReferenceNumber is provided <br />
+    # This field is optional when not provided and ReferenceNumber is null or
+    # empty then the value should be set to current date<br />
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :to_date
+
+    # Client provided Unique Id of the original Order Card request, the status
+    # of which is enquired by this API
+    # @return [String]
+    attr_accessor :order_request_id
+
+    # 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['col_co_country_code'] = 'ColCoCountryCode'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['reference_number'] = 'ReferenceNumber'
+      @_hash['reference_type'] = 'ReferenceType'
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash['order_request_id'] = 'OrderRequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+        col_co_code
+        col_co_id
+        col_co_country_code
+        payer_id
+        payer_number
+        reference_number
+        reference_type
+        from_date
+        to_date
+        order_request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_id
+        account_number
+        col_co_code
+        col_co_id
+        col_co_country_code
+        payer_id
+        payer_number
+        from_date
+        to_date
+        order_request_id
+      ]
+    end
+
+    def initialize(account_id = SKIP,
+                   account_number = SKIP,
+                   col_co_code = SKIP,
+                   col_co_id = SKIP,
+                   col_co_country_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   reference_number = SKIP,
+                   reference_type = SKIP,
+                   from_date = SKIP,
+                   to_date = SKIP,
+                   order_request_id = 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
+      @col_co_country_code = col_co_country_code unless col_co_country_code == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @reference_number = reference_number unless reference_number == SKIP
+      @reference_type = reference_type unless reference_type == SKIP
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == SKIP
+      @order_request_id = order_request_id unless order_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.
+      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
+      col_co_country_code =
+        hash.key?('ColCoCountryCode') ? hash['ColCoCountryCode'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      reference_number =
+        hash.key?('ReferenceNumber') ? hash['ReferenceNumber'] : SKIP
+      reference_type = hash.key?('ReferenceType') ? hash['ReferenceType'] : SKIP
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+      order_request_id =
+        hash.key?('OrderRequestId') ? hash['OrderRequestId'] : SKIP
+
+      # Create object from extracted values.
+      OrderCardEnquiryReq.new(account_id,
+                              account_number,
+                              col_co_code,
+                              col_co_id,
+                              col_co_country_code,
+                              payer_id,
+                              payer_number,
+                              reference_number,
+                              reference_type,
+                              from_date,
+                              to_date,
+                              order_request_id)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/order_card_enquiry_req_reference_type_enum.rb

@@ -0,0 +1,32 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Type of the reference number provided.<br /> Mandatory if ReferenceNumber is
+  # provided. Else optional.<br /> Allowed Values:<br /> 1=Main Reference(Main
+  # Order Reference Number returned in the output of Card/OrderCard service. <br
+  # /> 2=Order Card Reference (Reference number for each individual card in the
+  # order submitted via Card/OrderCard service. <br /> 3=Bulk Order Card
+  # Reference (Reference number returned in the response of bulkcardinterface
+  # /UploadOrderCardTemplate. )
+  class OrderCardEnquiryReqReferenceTypeEnum
+    ORDER_CARD_ENQUIRY_REQ_REFERENCE_TYPE_ENUM = [
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = 2,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = 3
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORDER_CARD_ENQUIRY_REQ_REFERENCE_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/order_card_enquiry_request.rb

@@ -0,0 +1,51 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # OrderCardEnquiryRequest Model.
+  class OrderCardEnquiryRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This class holds Order Card Enquiry list based on which the Order Card
+    # Enquiry need to be filtered.
+    # @return [OrderCardEnquiryReq]
+    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 = OrderCardEnquiryReq.from_hash(hash['Filters']) if hash['Filters']
+
+      # Create object from extracted values.
+      OrderCardEnquiryRequest.new(filters)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/order_card_enquiry_response.rb

@@ -0,0 +1,79 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # OrderCardEnquiryResponse Model.
+  class OrderCardEnquiryResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :request_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [Array[OrderCardEnquiry]]
+    attr_accessor :data
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   data = 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.
+      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 << (OrderCardEnquiry.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      OrderCardEnquiryResponse.new(request_id,
+                                   status,
+                                   data)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/order_card_request.rb

@@ -0,0 +1,60 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # This entity models the data that is sent in the http request body for this
+  # operation.
+  class OrderCardRequest < 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.
+      OrderCardRequest.new(card_details)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/order_card_response.rb

@@ -0,0 +1,90 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # OrderCardResponse Model.
+  class OrderCardResponse < 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
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request. Allowed values: SUCCESS, FAILED
+    # @return [Array[CreateCardResponse]]
+    attr_accessor :data
+
+    # Main order reference number for tracking.
+    # @return [Integer]
+    attr_accessor :main_reference
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        main_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   data = SKIP,
+                   main_reference = 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
+    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 << (CreateCardResponse.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      main_reference = hash.key?('MainReference') ? hash['MainReference'] : SKIP
+
+      # Create object from extracted values.
+      OrderCardResponse.new(request_id,
+                            status,
+                            data,
+                            main_reference)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/payer_access.rb

@@ -0,0 +1,147 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PayerAccess Model.
+  class PayerAccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether this payer is the default payer of the user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_default
+
+    # Collecting company id.
+    # @return [Integer]
+    attr_accessor :colco_id
+
+    # Collecting company code.
+    # Example:
+    # 86-Philippines
+    # 5-UK
+    # @return [Integer]
+    attr_accessor :colco_code
+
+    # The 2-character ISO Code for the customer and card owning country
+    # @return [String]
+    attr_accessor :col_co_country_code
+
+    # Payer Group Id of the payer.
+    # @return [Integer]
+    attr_accessor :payer_group_id
+
+    # Payer group of the payer. 
+    # The value of this parameter will always be null when the input parameter
+    # “IncludePayerGroup” is false.
+    # @return [String]
+    attr_accessor :payer_group
+
+    # Payer Id to which the user has access
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number to which the user has access
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Name of the Payer to which the user has access
+    # @return [String]
+    attr_accessor :payer_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['is_default'] = 'IsDefault'
+      @_hash['colco_id'] = 'ColcoId'
+      @_hash['colco_code'] = 'ColcoCode'
+      @_hash['col_co_country_code'] = 'ColCoCountryCode'
+      @_hash['payer_group_id'] = 'PayerGroupId'
+      @_hash['payer_group'] = 'PayerGroup'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['payer_name'] = 'PayerName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        is_default
+        colco_id
+        colco_code
+        col_co_country_code
+        payer_group_id
+        payer_group
+        payer_id
+        payer_number
+        payer_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        colco_id
+        colco_code
+        col_co_country_code
+        payer_group_id
+        payer_group
+        payer_id
+        payer_number
+        payer_name
+      ]
+    end
+
+    def initialize(is_default = false,
+                   colco_id = SKIP,
+                   colco_code = SKIP,
+                   col_co_country_code = SKIP,
+                   payer_group_id = SKIP,
+                   payer_group = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   payer_name = SKIP)
+      @is_default = is_default unless is_default == SKIP
+      @colco_id = colco_id unless colco_id == SKIP
+      @colco_code = colco_code unless colco_code == SKIP
+      @col_co_country_code = col_co_country_code unless col_co_country_code == SKIP
+      @payer_group_id = payer_group_id unless payer_group_id == SKIP
+      @payer_group = payer_group unless payer_group == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @payer_name = payer_name unless payer_name == 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.
+      is_default = hash['IsDefault'] ||= false
+      colco_id = hash.key?('ColcoId') ? hash['ColcoId'] : SKIP
+      colco_code = hash.key?('ColcoCode') ? hash['ColcoCode'] : SKIP
+      col_co_country_code =
+        hash.key?('ColCoCountryCode') ? hash['ColCoCountryCode'] : SKIP
+      payer_group_id = hash.key?('PayerGroupId') ? hash['PayerGroupId'] : SKIP
+      payer_group = hash.key?('PayerGroup') ? hash['PayerGroup'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      payer_name = hash.key?('PayerName') ? hash['PayerName'] : SKIP
+
+      # Create object from extracted values.
+      PayerAccess.new(is_default,
+                      colco_id,
+                      colco_code,
+                      col_co_country_code,
+                      payer_group_id,
+                      payer_group,
+                      payer_id,
+                      payer_number,
+                      payer_name)
+    end
+  end
+end