card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/payer_request.rb

@@ -0,0 +1,126 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PayerRequest Model.
+  class PayerRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of Payer entity.
+    # Optional.
+    # Note:
+    # •	Max number of payers allowed in the input is 10, if it exceeds in the
+    # input it will throw an error.
+    # •	This value is configurable. Initial configuration will be 1000 and will
+    # change to 10 once SFH changes are integrated.
+    # @return [Array[Payers]]
+    attr_accessor :payers
+
+    # Returns only the high-level basic details of payers. Set this field to
+    # ‘true’ when only the basic details are required to get the result quicker.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :return_basic_details_only
+
+    # Include address related fields on the response. Set this field to ‘False’
+    # when Address fields are not required to get the result quicker.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_addresses
+
+    # Include the Finance Currency, used for Finance Widget, in the response
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_bonus_parameters
+
+    # Page Number
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # Page Size – Number of records to show on a page
+    # Default value 50
+    # Return 250 rows only in the response if -1 is supplied as page size.
+    # Note: 
+    # •	Max page size is 250, if the user provided value is more than 250 then
+    # it will throw error.
+    # •	This value is configurable.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payers'] = 'Payers'
+      @_hash['return_basic_details_only'] = 'ReturnBasicDetailsOnly'
+      @_hash['include_addresses'] = 'IncludeAddresses'
+      @_hash['include_bonus_parameters'] = 'IncludeBonusParameters'
+      @_hash['current_page'] = 'CurrentPage'
+      @_hash['page_size'] = 'PageSize'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payers
+        return_basic_details_only
+        include_addresses
+        include_bonus_parameters
+        current_page
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payers = SKIP,
+                   return_basic_details_only = false,
+                   include_addresses = false,
+                   include_bonus_parameters = false,
+                   current_page = SKIP,
+                   page_size = SKIP)
+      @payers = payers unless payers == SKIP
+      unless return_basic_details_only == SKIP
+        @return_basic_details_only =
+          return_basic_details_only
+      end
+      @include_addresses = include_addresses unless include_addresses == SKIP
+      @include_bonus_parameters = include_bonus_parameters unless include_bonus_parameters == SKIP
+      @current_page = current_page unless current_page == SKIP
+      @page_size = page_size unless page_size == 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
+      payers = nil
+      unless hash['Payers'].nil?
+        payers = []
+        hash['Payers'].each do |structure|
+          payers << (Payers.from_hash(structure) if structure)
+        end
+      end
+
+      payers = SKIP unless hash.key?('Payers')
+      return_basic_details_only = hash['ReturnBasicDetailsOnly'] ||= false
+      include_addresses = hash['IncludeAddresses'] ||= false
+      include_bonus_parameters = hash['IncludeBonusParameters'] ||= false
+      current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+
+      # Create object from extracted values.
+      PayerRequest.new(payers,
+                       return_basic_details_only,
+                       include_addresses,
+                       include_bonus_parameters,
+                       current_page,
+                       page_size)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/payer_response.rb

@@ -0,0 +1,115 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PayerResponse Model.
+  class PayerResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Request Id of the API call
+    # @return [String]
+    attr_accessor :request_id
+
+    # Request Id of the API call
+    # @return [Array[PayerDetails]]
+    attr_accessor :payers
+
+    # Current Page
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # Total row count matched for the given input criteria
+    # @return [Integer]
+    attr_accessor :row_count
+
+    # Calculated page count based on page size from the incoming API request and
+    # total number of rows matched for the given input criteria. Return 1 if the
+    # page size is -1 as all records are returned
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Calculated page count based on page size from the incoming API request and
+    # total number of rows matched for the given input criteria. Return 1 if the
+    # page size is -1 as all records are returned
+    # @return [ErrorStatus]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['payers'] = 'Payers'
+      @_hash['current_page'] = 'CurrentPage'
+      @_hash['row_count'] = 'RowCount'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['error'] = 'Error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        payers
+        current_page
+        row_count
+        total_pages
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        request_id
+      ]
+    end
+
+    def initialize(request_id = SKIP,
+                   payers = SKIP,
+                   current_page = SKIP,
+                   row_count = SKIP,
+                   total_pages = SKIP,
+                   error = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @payers = payers unless payers == SKIP
+      @current_page = current_page unless current_page == SKIP
+      @row_count = row_count unless row_count == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @error = error unless error == 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
+      # Parameter is an array, so we need to iterate through it
+      payers = nil
+      unless hash['Payers'].nil?
+        payers = []
+        hash['Payers'].each do |structure|
+          payers << (PayerDetails.from_hash(structure) if structure)
+        end
+      end
+
+      payers = SKIP unless hash.key?('Payers')
+      current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
+      row_count = hash.key?('RowCount') ? hash['RowCount'] : SKIP
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+
+      # Create object from extracted values.
+      PayerResponse.new(request_id,
+                        payers,
+                        current_page,
+                        row_count,
+                        total_pages,
+                        error)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/payers.rb

@@ -0,0 +1,109 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Payers Model.
+  class Payers < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Id of the payer
+    # @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.
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer id of the customer.
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the customer.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Payer Name of the customer.
+    # @return [String]
+    attr_accessor :payer_name
+
+    # Payer Group identifier of the customer
+    # @return [Integer]
+    attr_accessor :payer_group_id
+
+    # 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['payer_name'] = 'PayerName'
+      @_hash['payer_group_id'] = 'PayerGroupId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        payer_name
+        payer_group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        payer_name
+        payer_group_id
+      ]
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   payer_name = SKIP,
+                   payer_group_id = 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
+      @payer_name = payer_name unless payer_name == SKIP
+      @payer_group_id = payer_group_id unless payer_group_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.
+      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
+      payer_name = hash.key?('PayerName') ? hash['PayerName'] : SKIP
+      payer_group_id = hash.key?('PayerGroupId') ? hash['PayerGroupId'] : SKIP
+
+      # Create object from extracted values.
+      Payers.new(col_co_id,
+                 col_co_code,
+                 payer_id,
+                 payer_number,
+                 payer_name,
+                 payer_group_id)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/pin_advice_types.rb

@@ -0,0 +1,80 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PINAdviceTypes Model.
+  class PINAdviceTypes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Id of of PIN advice type.
+    # Possible Values:
+    # 1.	Paper
+    # 2.	Email
+    # 3.	SMS
+    # 4.	None
+    # @return [Integer]
+    attr_accessor :pin_advice_type_id
+
+    # Whether the PIN advice type is available for card ordering
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_card_order_option
+
+    # Whether the PIN advice type is available for PIN Reminder
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_pin_reminder_option
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pin_advice_type_id'] = 'PINAdviceTypeID'
+      @_hash['is_card_order_option'] = 'IsCardOrderOption'
+      @_hash['is_pin_reminder_option'] = 'IsPINReminderOption'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pin_advice_type_id
+        is_card_order_option
+        is_pin_reminder_option
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        pin_advice_type_id
+      ]
+    end
+
+    def initialize(pin_advice_type_id = SKIP,
+                   is_card_order_option = SKIP,
+                   is_pin_reminder_option = SKIP)
+      @pin_advice_type_id = pin_advice_type_id unless pin_advice_type_id == SKIP
+      @is_card_order_option = is_card_order_option unless is_card_order_option == SKIP
+      @is_pin_reminder_option = is_pin_reminder_option unless is_pin_reminder_option == 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.
+      pin_advice_type_id =
+        hash.key?('PINAdviceTypeID') ? hash['PINAdviceTypeID'] : SKIP
+      is_card_order_option =
+        hash.key?('IsCardOrderOption') ? hash['IsCardOrderOption'] : SKIP
+      is_pin_reminder_option =
+        hash.key?('IsPINReminderOption') ? hash['IsPINReminderOption'] : SKIP
+
+      # Create object from extracted values.
+      PINAdviceTypes.new(pin_advice_type_id,
+                         is_card_order_option,
+                         is_pin_reminder_option)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/pin_delivery_contact.rb

@@ -0,0 +1,242 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Request entity object for PINDeliveryContact Mandatory when
+  # PINDeliveryAddressType is ‘3’ (New delivery address). Else, ignored.
+  class PINDeliveryContact < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Title of the contact person <br />
+    # Optional
+    # @return [String]
+    attr_accessor :delivery_contact_title
+
+    # Name of the contact person <br />
+    # Mandatory - If PINAdviceType is paper else optional. <br />
+    # Max field length: 50  <br />
+    # Optional
+    # @return [String]
+    attr_accessor :delivery_contact_name
+
+    # Company name <br />
+    # Mandatory - If PINAdviceType is paper else optional. <br />
+    # Max field length: 50  <br />
+    # Optional
+    # @return [String]
+    attr_accessor :delivery_company_name
+
+    # Address line 1 <br />
+    # Mandatory - if PINAdviceType is paper else optional.<br />
+    # Max field length: 40  <br />
+    # Optional
+    # @return [String]
+    attr_accessor :delivery_address_line1
+
+    # Address line 2 <br />
+    # Optional <br />
+    # Max field length: 40  <br />
+    # Optional
+    # @return [String]
+    attr_accessor :delivery_address_line2
+
+    # Address line 3 <br />
+    # Optional <br />
+    # Max field length: 40  <br />
+    # Optional
+    # @return [String]
+    attr_accessor :delivery_address_line3
+
+    # ZIP code <br />
+    # Mandatory - if PINAdviceType is paper else optional. <br />
+    # Max field length: 10  <br />
+    # Optional
+    # @return [String]
+    attr_accessor :delivery_zip_code
+
+    # City  <br />
+    # Mandatory - If PINAdviceType is paper else optional. <br />
+    # Max field length: 40  <br />
+    # Optional
+    # @return [String]
+    attr_accessor :delivery_city
+
+    # Region Id  <br />
+    # Optional
+    # @return [Integer]
+    attr_accessor :delivery_region_id
+
+    # Region  <br />
+    # Optional<br />
+    # @return [String]
+    attr_accessor :delivery_region
+
+    # The ISO code of the country.<br />
+    # Mandatory if PINAdviceType is paper else optional.
+    # @return [String]
+    attr_accessor :delivery_country
+
+    # Phone number for to send SMS of the PIN in case PINAdviceType is SMS.<br
+    # />
+    # Mandatory if PINAdviceType is SMS else optional.<br />
+    # Max field length: 20
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Email address for to send email of the PIN in case PINAdviceType is
+    # Email.<br />
+    # Mandatory if PINAdviceType is email else optional.<br />
+    # Max field length: 90. <br/>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
+
+    # The given address will be used for sending PIN reminders in future when
+    # requested.<br />
+    # Only allowed for paper delivery<br />
+    # Optional
+    # @return [TrueClass | FalseClass]
+    attr_accessor :save_for_pin_reminder
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['delivery_contact_title'] = 'DeliveryContactTitle'
+      @_hash['delivery_contact_name'] = 'DeliveryContactName'
+      @_hash['delivery_company_name'] = 'DeliveryCompanyName'
+      @_hash['delivery_address_line1'] = 'DeliveryAddressLine1'
+      @_hash['delivery_address_line2'] = 'DeliveryAddressLine2'
+      @_hash['delivery_address_line3'] = 'DeliveryAddressLine3'
+      @_hash['delivery_zip_code'] = 'DeliveryZipCode'
+      @_hash['delivery_city'] = 'DeliveryCity'
+      @_hash['delivery_region_id'] = 'DeliveryRegionId'
+      @_hash['delivery_region'] = 'DeliveryRegion'
+      @_hash['delivery_country'] = 'DeliveryCountry'
+      @_hash['phone_number'] = 'PhoneNumber'
+      @_hash['email_address'] = 'EmailAddress'
+      @_hash['save_for_pin_reminder'] = 'SaveForPINReminder'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        delivery_contact_title
+        delivery_contact_name
+        delivery_company_name
+        delivery_address_line1
+        delivery_address_line2
+        delivery_address_line3
+        delivery_zip_code
+        delivery_city
+        delivery_region_id
+        delivery_region
+        delivery_country
+        phone_number
+        email_address
+        save_for_pin_reminder
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        delivery_contact_title
+        delivery_contact_name
+        delivery_company_name
+        delivery_address_line1
+        delivery_address_line2
+        delivery_address_line3
+        delivery_zip_code
+        delivery_city
+        delivery_region_id
+        delivery_region
+        delivery_country
+        phone_number
+        email_address
+      ]
+    end
+
+    def initialize(delivery_contact_title = SKIP,
+                   delivery_contact_name = SKIP,
+                   delivery_company_name = SKIP,
+                   delivery_address_line1 = SKIP,
+                   delivery_address_line2 = SKIP,
+                   delivery_address_line3 = SKIP,
+                   delivery_zip_code = SKIP,
+                   delivery_city = SKIP,
+                   delivery_region_id = SKIP,
+                   delivery_region = SKIP,
+                   delivery_country = SKIP,
+                   phone_number = SKIP,
+                   email_address = SKIP,
+                   save_for_pin_reminder = SKIP)
+      @delivery_contact_title = delivery_contact_title unless delivery_contact_title == SKIP
+      @delivery_contact_name = delivery_contact_name unless delivery_contact_name == SKIP
+      @delivery_company_name = delivery_company_name unless delivery_company_name == SKIP
+      @delivery_address_line1 = delivery_address_line1 unless delivery_address_line1 == SKIP
+      @delivery_address_line2 = delivery_address_line2 unless delivery_address_line2 == SKIP
+      @delivery_address_line3 = delivery_address_line3 unless delivery_address_line3 == SKIP
+      @delivery_zip_code = delivery_zip_code unless delivery_zip_code == SKIP
+      @delivery_city = delivery_city unless delivery_city == SKIP
+      @delivery_region_id = delivery_region_id unless delivery_region_id == SKIP
+      @delivery_region = delivery_region unless delivery_region == SKIP
+      @delivery_country = delivery_country unless delivery_country == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @save_for_pin_reminder = save_for_pin_reminder unless save_for_pin_reminder == 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.
+      delivery_contact_title =
+        hash.key?('DeliveryContactTitle') ? hash['DeliveryContactTitle'] : SKIP
+      delivery_contact_name =
+        hash.key?('DeliveryContactName') ? hash['DeliveryContactName'] : SKIP
+      delivery_company_name =
+        hash.key?('DeliveryCompanyName') ? hash['DeliveryCompanyName'] : SKIP
+      delivery_address_line1 =
+        hash.key?('DeliveryAddressLine1') ? hash['DeliveryAddressLine1'] : SKIP
+      delivery_address_line2 =
+        hash.key?('DeliveryAddressLine2') ? hash['DeliveryAddressLine2'] : SKIP
+      delivery_address_line3 =
+        hash.key?('DeliveryAddressLine3') ? hash['DeliveryAddressLine3'] : SKIP
+      delivery_zip_code =
+        hash.key?('DeliveryZipCode') ? hash['DeliveryZipCode'] : SKIP
+      delivery_city = hash.key?('DeliveryCity') ? hash['DeliveryCity'] : SKIP
+      delivery_region_id =
+        hash.key?('DeliveryRegionId') ? hash['DeliveryRegionId'] : SKIP
+      delivery_region =
+        hash.key?('DeliveryRegion') ? hash['DeliveryRegion'] : SKIP
+      delivery_country =
+        hash.key?('DeliveryCountry') ? hash['DeliveryCountry'] : SKIP
+      phone_number = hash.key?('PhoneNumber') ? hash['PhoneNumber'] : SKIP
+      email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
+      save_for_pin_reminder =
+        hash.key?('SaveForPINReminder') ? hash['SaveForPINReminder'] : SKIP
+
+      # Create object from extracted values.
+      PINDeliveryContact.new(delivery_contact_title,
+                             delivery_contact_name,
+                             delivery_company_name,
+                             delivery_address_line1,
+                             delivery_address_line2,
+                             delivery_address_line3,
+                             delivery_zip_code,
+                             delivery_city,
+                             delivery_region_id,
+                             delivery_region,
+                             delivery_country,
+                             phone_number,
+                             email_address,
+                             save_for_pin_reminder)
+    end
+  end
+end