card-management-sdk 1.4.0 → 2.0.0

data/lib/shell_card_management_ap_is/models/payer_res.rb

@@ -0,0 +1,158 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellCardManagementApIs
+  # PayerRes Model.
+  class PayerRes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the request. This will be played back in the
+    # response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Status of the request
+    # @return [Array[PayerDetails]]
+    attr_accessor :data
+
+    # Current Page
+    # @return [Integer]
+    attr_accessor :page
+
+    # Total row count matched for the given input criteria
+    # @return [Integer]
+    attr_accessor :total_records
+
+    # 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
+
+    # Page Size – Number of records to show on current page.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A list of Warning entity. 
+    # This entity will hold the details of the scheduled System Outages of any
+    # dependent applications of this service.
+    # Note: If there is no scheduled outage information available, in the
+    # configuration in AMS, for this service, this parameter won’t be present in
+    # output.
+    # @return [Array[Warning]]
+    attr_accessor :warnings
+
+    # 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['page'] = 'Page'
+      @_hash['total_records'] = 'TotalRecords'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['page_size'] = 'PageSize'
+      @_hash['warnings'] = 'Warnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        page
+        total_records
+        total_pages
+        page_size
+        warnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP, status = SKIP, data = SKIP, page = SKIP,
+                   total_records = SKIP, total_pages = SKIP, page_size = SKIP,
+                   warnings = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == SKIP
+      @page = page unless page == SKIP
+      @total_records = total_records unless total_records == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @warnings = warnings unless warnings == 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 << (PayerDetails.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      page = hash.key?('Page') ? hash['Page'] : SKIP
+      total_records = hash.key?('TotalRecords') ? hash['TotalRecords'] : SKIP
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      warnings = nil
+      unless hash['Warnings'].nil?
+        warnings = []
+        hash['Warnings'].each do |structure|
+          warnings << (Warning.from_hash(structure) if structure)
+        end
+      end
+
+      warnings = SKIP unless hash.key?('Warnings')
+
+      # Create object from extracted values.
+      PayerRes.new(request_id,
+                   status,
+                   data,
+                   page,
+                   total_records,
+                   total_pages,
+                   page_size,
+                   warnings)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id}, status: #{@status}, data: #{@data}, page:"\
+      " #{@page}, total_records: #{@total_records}, total_pages: #{@total_pages}, page_size:"\
+      " #{@page_size}, warnings: #{@warnings}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect}, data:"\
+      " #{@data.inspect}, page: #{@page.inspect}, total_records: #{@total_records.inspect},"\
+      " total_pages: #{@total_pages.inspect}, page_size: #{@page_size.inspect}, warnings:"\
+      " #{@warnings.inspect}>"
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/payers.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # Payers Model.

data/lib/shell_card_management_ap_is/models/pin_advice_types.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # PINAdviceTypes Model.

data/lib/shell_card_management_ap_is/models/pin_contact.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # PINContact Model.

data/lib/shell_card_management_ap_is/models/pin_deliver_to.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # PINDeliverTo Model.

data/lib/shell_card_management_ap_is/models/pin_delivery_address.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # PINDeliveryAddress Model.

data/lib/shell_card_management_ap_is/models/pin_reminder_card_details.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # Request entity object for PINReminderCardDetails
@@ -42,6 +42,9 @@ module ShellCardManagementApIs
     #    1.    Paper
     #    2.    Email
     #    3.    SMS
+    #    4.    None
+    #    Note: - Paper delivery not applicable for selfselctedPIN type and
+    # FleetPIN enabled Accounts
     # @return [Integer]
     attr_accessor :pin_advice_type
 
@@ -52,7 +55,7 @@ module ShellCardManagementApIs
     # 2.    Use Card Delivery contact details stored previously for this card
     # 3.    Use default PIN Delivery contact details stored for this customer
     # 4.    Use new specific contact for PIN Reminder only
-    # Note: - PINContactType “3” is only allowed for Paper delivery
+    # Note: - PINContactType “1,2,3” is only allowed for Paper delivery
     # @return [Integer]
     attr_accessor :pin_contact_type
 
@@ -63,7 +66,7 @@ module ShellCardManagementApIs
     # 2.    Use Card Delivery contact details stored previously for this card
     # 3.    Use default PIN Delivery contact details stored for this customer
     # 4.    Use new specific contact for PIN Reminder only
-    # Note: - PINContactType “3” is only allowed for Paper delivery
+    # Note: - PINContactType “1,2,3” is only allowed for Paper delivery
     # @return [PINDeliverTo]
     attr_accessor :pin_deliver_to
 

data/lib/shell_card_management_ap_is/models/pin_reminder_reference.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # This class holds the PIN Reminder References

data/lib/shell_card_management_ap_is/models/pin_reminder_response.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # PINReminderResponse Model.

data/lib/shell_card_management_ap_is/models/product_all_of0.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # ProductAllOf0 Model.

data/lib/shell_card_management_ap_is/models/product_group.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # ProductGroup Model.

data/lib/shell_card_management_ap_is/models/product_restriction_card.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # ProductRestrictionCard Model.

data/lib/shell_card_management_ap_is/models/purchase_categories.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # PurchaseCategories Model.

data/lib/shell_card_management_ap_is/models/purchase_category1_all_of0.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # PurchaseCategory1AllOf0 Model.
@@ -39,8 +39,8 @@ module ShellCardManagementApIs
     # 6.    Essentials and LNG
     # 7.    Extra and LNG
     # 8.    Premium and LNG
-    # Note: Purchase Category name (GFN) is returned when Title does not exist
-    # for the given language Code and default language code (en-GB).
+    # Note: Purchase Category name is returned when Title does not exist for the
+    # given language Code and default language code (en-GB).
     # @return [String]
     attr_accessor :title
 
@@ -54,8 +54,8 @@ module ShellCardManagementApIs
     # 1 - All Fuel Products + LNG and TMF
     # 2 - All Fuels Products + LNG, Car related items and TMF
     # 3 - No Restriction + LNG 
-    # Note: Purchase Category name (GFN) is returned when Title does not exist
-    # for the given language Code and default language code (en-GB).
+    # Note: Purchase Category name is returned when Title does not exist for the
+    # given language Code and default language code (en-GB).
     # @return [String]
     attr_accessor :description
 

data/lib/shell_card_management_ap_is/models/purchase_category_req.rb

@@ -0,0 +1,62 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellCardManagementApIs
+  # PurchaseCategoryReq Model.
+  class PurchaseCategoryReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PurchaseCategoryRequest]
+    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 = PurchaseCategoryRequest.from_hash(hash['Filters']) if hash['Filters']
+
+      # Create object from extracted values.
+      PurchaseCategoryReq.new(filters)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters.inspect}>"
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/purchase_category_request.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # PurchaseCategoryRequest Model.

data/lib/shell_card_management_ap_is/models/purchase_category_res.rb

@@ -0,0 +1,91 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellCardManagementApIs
+  # PurchaseCategoryRes Model.
+  class PurchaseCategoryRes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the request. This will be played back in the
+    # response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Status of the request
+    # @return [Array[PurchaseCategoryResponse]]
+    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 << (PurchaseCategoryResponse.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      PurchaseCategoryRes.new(request_id,
+                              status,
+                              data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id}, status: #{@status}, data: #{@data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect}, data:"\
+      " #{@data.inspect}>"
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/purchase_category_response.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # PurchaseCategoryResponse Model.
@@ -13,15 +13,10 @@ module ShellCardManagementApIs
     # @return [Array[PurchaseCategory1AllOf0]]
     attr_accessor :purchase_categories
 
-    # TODO: Write general description for this method
-    # @return [ErrorStatus]
-    attr_accessor :error
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['purchase_categories'] = 'PurchaseCategories'
-      @_hash['error'] = 'Error'
       @_hash
     end
 
@@ -29,7 +24,6 @@ module ShellCardManagementApIs
     def self.optionals
       %w[
         purchase_categories
-        error
       ]
     end
 
@@ -38,9 +32,8 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(purchase_categories = SKIP, error = SKIP)
+    def initialize(purchase_categories = SKIP)
       @purchase_categories = purchase_categories unless purchase_categories == SKIP
-      @error = error unless error == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -58,24 +51,21 @@ module ShellCardManagementApIs
       end
 
       purchase_categories = SKIP unless hash.key?('PurchaseCategories')
-      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
 
       # Create object from extracted values.
-      PurchaseCategoryResponse.new(purchase_categories,
-                                   error)
+      PurchaseCategoryResponse.new(purchase_categories)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} purchase_categories: #{@purchase_categories}, error: #{@error}>"
+      "<#{class_name} purchase_categories: #{@purchase_categories}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} purchase_categories: #{@purchase_categories.inspect}, error:"\
-      " #{@error.inspect}>"
+      "<#{class_name} purchase_categories: #{@purchase_categories.inspect}>"
     end
   end
 end