card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/product_group.rb

@@ -0,0 +1,116 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ProductGroup Model.
+  class ProductGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Referenced Purchase Category Id
+    # Example: 123, 124
+    # @return [Integer]
+    attr_accessor :reference_id
+
+    # Product group ID
+    # @return [String]
+    attr_accessor :product_group_id
+
+    # Product group name
+    # @return [String]
+    attr_accessor :name
+
+    # Indicates whether this is a default Product Group at ColCo level or not.
+    # Note: The Customer level default settings are not considered here.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_default
+
+    # Identifies the type of Product group.
+    # true - if it is a Fuel type Product group 
+    # false - if it is Non-Fuel type
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_fuel_type
+
+    # Identifies the type of Product group.
+    # true - if it is a Fuel type Product group 
+    # false - if it is Non-Fuel type
+    # @return [Array[ProductAllOf0]]
+    attr_accessor :products
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_id'] = 'ReferenceId'
+      @_hash['product_group_id'] = 'ProductGroupId'
+      @_hash['name'] = 'Name'
+      @_hash['is_default'] = 'IsDefault'
+      @_hash['is_fuel_type'] = 'IsFuelType'
+      @_hash['products'] = 'Products'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reference_id
+        product_group_id
+        name
+        is_default
+        is_fuel_type
+        products
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reference_id = SKIP,
+                   product_group_id = SKIP,
+                   name = SKIP,
+                   is_default = SKIP,
+                   is_fuel_type = SKIP,
+                   products = SKIP)
+      @reference_id = reference_id unless reference_id == SKIP
+      @product_group_id = product_group_id unless product_group_id == SKIP
+      @name = name unless name == SKIP
+      @is_default = is_default unless is_default == SKIP
+      @is_fuel_type = is_fuel_type unless is_fuel_type == SKIP
+      @products = products unless products == 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.
+      reference_id = hash.key?('ReferenceId') ? hash['ReferenceId'] : SKIP
+      product_group_id =
+        hash.key?('ProductGroupId') ? hash['ProductGroupId'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      is_default = hash.key?('IsDefault') ? hash['IsDefault'] : SKIP
+      is_fuel_type = hash.key?('IsFuelType') ? hash['IsFuelType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      products = nil
+      unless hash['Products'].nil?
+        products = []
+        hash['Products'].each do |structure|
+          products << (ProductAllOf0.from_hash(structure) if structure)
+        end
+      end
+
+      products = SKIP unless hash.key?('Products')
+
+      # Create object from extracted values.
+      ProductGroup.new(reference_id,
+                       product_group_id,
+                       name,
+                       is_default,
+                       is_fuel_type,
+                       products)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/product_restrictions.rb

@@ -0,0 +1,66 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ProductRestrictions Model.
+  class ProductRestrictions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of 3-digit global product codes.
+    # Optional. However, this field is mandatory when the Product restrictions
+    # are migrated to Gateway and Product Groups are not provided.
+    # Example: [ "033", "021", "023" ]
+    # @return [Array[String]]
+    attr_accessor :products
+
+    # An array of product group ids.
+    # Optional. However, this field is mandatory when the Product restrictions
+    # are migrated to Gateway and Products are not provided.
+    # Example: [ "670246404", "40557126" ]
+    # @return [Array[String]]
+    attr_accessor :product_groups
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['products'] = 'Products'
+      @_hash['product_groups'] = 'ProductGroups'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        products
+        product_groups
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(products = SKIP,
+                   product_groups = SKIP)
+      @products = products unless products == SKIP
+      @product_groups = product_groups unless product_groups == 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.
+      products = hash.key?('Products') ? hash['Products'] : SKIP
+      product_groups = hash.key?('ProductGroups') ? hash['ProductGroups'] : SKIP
+
+      # Create object from extracted values.
+      ProductRestrictions.new(products,
+                              product_groups)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/purchase_categories.rb

@@ -0,0 +1,114 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PurchaseCategories Model.
+  class PurchaseCategories < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Purchase category Id
+    # @return [Integer]
+    attr_accessor :id
+
+    # Purchase category code
+    # Example: 0,1, 2 etc.
+    # Full list below:
+    # 0 - All Fuels (without VP) and Lubricants
+    # 1 - Fuel Save only
+    # 2 - Fuel Save and Lubricants
+    # 3 - No Restrictions
+    # 4 - VP and Fuel Save
+    # 5 - Diesel ONLY
+    # 6 - Diesel and Lubricants
+    # 7 - VP and Lubricants
+    # 8 - VP and Fuel Save and Lubricants
+    # @return [String]
+    attr_accessor :code
+
+    # Purchase category name 
+    # Example: Fuel Save Only
+    # Full list below:
+    # 0 - All Fuels (without VP) and Lubricants
+    # 1 - Fuel Save only
+    # 2 - Fuel Save and Lubricants
+    # 3 - No Restrictions
+    # 4 - VP and Fuel Save
+    # 5 - Diesel ONLY
+    # 6 - Diesel and Lubricants
+    # 7 - VP and Lubricants
+    # 8 - VP and Fuel Save and Lubricants
+    # @return [String]
+    attr_accessor :name
+
+    # If True then PurchaseCategory can be used while submitting new order cards
+    # requests.
+    # If false this PurchaseCategory will not be used for Ordering Cards.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_visible
+
+    # List of Default product groups
+    # @return [String]
+    attr_accessor :product_groups
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['code'] = 'Code'
+      @_hash['name'] = 'Name'
+      @_hash['is_visible'] = 'IsVisible'
+      @_hash['product_groups'] = 'ProductGroups'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        code
+        name
+        is_visible
+        product_groups
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   code = SKIP,
+                   name = SKIP,
+                   is_visible = SKIP,
+                   product_groups = SKIP)
+      @id = id unless id == SKIP
+      @code = code unless code == SKIP
+      @name = name unless name == SKIP
+      @is_visible = is_visible unless is_visible == SKIP
+      @product_groups = product_groups unless product_groups == 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.
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      is_visible = hash.key?('IsVisible') ? hash['IsVisible'] : SKIP
+      product_groups = hash.key?('ProductGroups') ? hash['ProductGroups'] : SKIP
+
+      # Create object from extracted values.
+      PurchaseCategories.new(id,
+                             code,
+                             name,
+                             is_visible,
+                             product_groups)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/purchase_category1_all_of0.rb

@@ -0,0 +1,140 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PurchaseCategory1AllOf0 Model.
+  class PurchaseCategory1AllOf0 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Purchase category ID
+    # @return [Integer]
+    attr_accessor :id
+
+    # Purchase category code
+    # @return [String]
+    attr_accessor :code
+
+    # Name of Purchase category .
+    # @return [String]
+    attr_accessor :name
+
+    # PurchaseCategory can be used while submitting new order cards requests if
+    # true else will not be used for ordering cards.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_visible
+
+    # List of product sets
+    # @return [Array[ProductGroup]]
+    attr_accessor :product_groups
+
+    # Purchase category Title by given language code.
+    # 1.	Basic 
+    # 2.	Essentials
+    # 3.	Extra 
+    # 4.	Premium
+    # 5.	Basic and LNG
+    # 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).
+    # @return [String]
+    attr_accessor :title
+
+    # Purchase category description by given language code.
+    # Example: 
+    # 0 - Diesel Products and TMF
+    # 1 - All Fuel Products and TMF
+    # 2 - All Fuels Products, Car related items and TMF
+    # 3 - No Restriction
+    # 0 - Diesel Products + LNG and TMF
+    # 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).
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['code'] = 'Code'
+      @_hash['name'] = 'Name'
+      @_hash['is_visible'] = 'IsVisible'
+      @_hash['product_groups'] = 'ProductGroups'
+      @_hash['title'] = 'Title'
+      @_hash['description'] = 'Description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        title
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        id
+        code
+        name
+      ]
+    end
+
+    def initialize(id = nil,
+                   code = nil,
+                   name = nil,
+                   is_visible = nil,
+                   product_groups = nil,
+                   title = SKIP,
+                   description = SKIP)
+      @id = id
+      @code = code
+      @name = name
+      @is_visible = is_visible
+      @product_groups = product_groups
+      @title = title unless title == SKIP
+      @description = description unless description == 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.
+      id = hash.key?('Id') ? hash['Id'] : nil
+      code = hash.key?('Code') ? hash['Code'] : nil
+      name = hash.key?('Name') ? hash['Name'] : nil
+      is_visible = hash.key?('IsVisible') ? hash['IsVisible'] : nil
+      # Parameter is an array, so we need to iterate through it
+      product_groups = nil
+      unless hash['ProductGroups'].nil?
+        product_groups = []
+        hash['ProductGroups'].each do |structure|
+          product_groups << (ProductGroup.from_hash(structure) if structure)
+        end
+      end
+
+      product_groups = nil unless hash.key?('ProductGroups')
+      title = hash.key?('Title') ? hash['Title'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+
+      # Create object from extracted values.
+      PurchaseCategory1AllOf0.new(id,
+                                  code,
+                                  name,
+                                  is_visible,
+                                  product_groups,
+                                  title,
+                                  description)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/purchase_category_request.rb

@@ -0,0 +1,114 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PurchaseCategoryRequest Model.
+  class PurchaseCategoryRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mandatory UUID (according to RFC 4122 standards) for requests and
+    # responses. This will be played back in the response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Collecting Company Code (Shell Code).
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Collecting Company Id (in Shell Cards Platform).
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Card type Id
+    # @return [Integer]
+    attr_accessor :card_type_id
+
+    # Purchase category Id
+    # Optional.
+    # Example: 123, 124, etc.,
+    # @return [Integer]
+    attr_accessor :purchase_category_id
+
+    # Language code for the Title and Description.
+    # Language codes should be same as SFH supported language 
+    # Optional.
+    # Default: en-GB
+    # Example:
+    # en-GB – English (UK)
+    # nl-NL – Dutch (Netherlands)
+    # @return [String]
+    attr_accessor :language_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['card_type_id'] = 'CardTypeId'
+      @_hash['purchase_category_id'] = 'PurchaseCategoryId'
+      @_hash['language_code'] = 'LanguageCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        col_co_code
+        col_co_id
+        card_type_id
+        purchase_category_id
+        language_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_code
+        col_co_id
+        card_type_id
+      ]
+    end
+
+    def initialize(request_id = SKIP,
+                   col_co_code = SKIP,
+                   col_co_id = SKIP,
+                   card_type_id = SKIP,
+                   purchase_category_id = SKIP,
+                   language_code = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @card_type_id = card_type_id unless card_type_id == SKIP
+      @purchase_category_id = purchase_category_id unless purchase_category_id == SKIP
+      @language_code = language_code unless language_code == 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
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      card_type_id = hash.key?('CardTypeId') ? hash['CardTypeId'] : SKIP
+      purchase_category_id =
+        hash.key?('PurchaseCategoryId') ? hash['PurchaseCategoryId'] : SKIP
+      language_code = hash.key?('LanguageCode') ? hash['LanguageCode'] : SKIP
+
+      # Create object from extracted values.
+      PurchaseCategoryRequest.new(request_id,
+                                  col_co_code,
+                                  col_co_id,
+                                  card_type_id,
+                                  purchase_category_id,
+                                  language_code)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/purchase_category_response.rb

@@ -0,0 +1,69 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PurchaseCategoryResponse Model.
+  class PurchaseCategoryResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @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
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        purchase_categories
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(purchase_categories = SKIP,
+                   error = SKIP)
+      @purchase_categories = purchase_categories unless purchase_categories == 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.
+      # Parameter is an array, so we need to iterate through it
+      purchase_categories = nil
+      unless hash['PurchaseCategories'].nil?
+        purchase_categories = []
+        hash['PurchaseCategories'].each do |structure|
+          purchase_categories << (PurchaseCategory1AllOf0.from_hash(structure) if structure)
+        end
+      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)
+    end
+  end
+end