card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/restriction_search_card_response_data_items.rb

@@ -0,0 +1,514 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # RestrictionSearchCardResponseDataItems Model.
+  class RestrictionSearchCardResponseDataItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Bundle Id associated with card
+    # @return [Integer]
+    attr_accessor :bundle_id
+
+    # Bundle Id associated with card
+    # @return [SearchCardResponseRestrictions]
+    attr_accessor :restrictions
+
+    # ISO currency code of the country.
+    # @return [String]
+    attr_accessor :restriction_currency_code
+
+    # Currency symbol of the country.
+    # @return [String]
+    attr_accessor :restriction_currency_symbol
+
+    # Account ID
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Name
+    # @return [String]
+    attr_accessor :account_name
+
+    # Account Number
+    # @return [String]
+    attr_accessor :account_number
+
+    # AccountShortName
+    # @return [String]
+    attr_accessor :account_short_name
+
+    # Unique Card
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # ISO code of the card i.e. first 7 digits of the PAN
+    # @return [String]
+    attr_accessor :card_type_code
+
+    # Card Type ID
+    # Example Id & Description:
+    # 1 - Philippines CRT 7077861
+    # 2- Philippines Fleet 7002861
+    # 5-SHELL FLEET- HONG KONG 7002821
+    # 6-SHELL NHF- HONG KONG 7002821
+    # 7-SHELL CRT- HONG KONG 7077821
+    # @return [Integer]
+    attr_accessor :card_type_id
+
+    # Card Type Name
+    # Example Id & Description:
+    # 1 - Philippines CRT 7077861
+    # 2- Philippines Fleet 7002861
+    # 5-SHELL FLEET- HONG KONG 7002821
+    # 6-SHELL NHF- HONG KONG 7002821
+    # 7-SHELL CRT- HONG KONG 7077821
+    # @return [String]
+    attr_accessor :card_type_name
+
+    # ISO currency code of the country
+    # @return [String]
+    attr_accessor :col_co_currency_code
+
+    # Currency symbol of the country
+    # @return [String]
+    attr_accessor :col_co_currency_symbol
+
+    # ISO currency code of the Customer Currency
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Currency symbol of the Customer Currency Code
+    # @return [String]
+    attr_accessor :currency_symbol
+
+    # Driver name
+    # @return [String]
+    attr_accessor :driver_name
+
+    # Expiry date of the card 
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :expiry_date
+
+    # True if it is a CRT type card, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_crt
+
+    # True if it is a Fleet type card, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_fleet
+
+    # True if it is an international card, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_international
+
+    # True if it is a national card, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_national
+
+    # True if it is allowed at all partner sites, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_partner_sites_included
+
+    # True if it is only allowed at Shell sites, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_shell_sites_only
+
+    # Issue date
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :issue_date
+
+    # Issue Number
+    # @return [Integer]
+    attr_accessor :issue_number
+
+    # True if a new card is issued with the same PAN, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_superseded
+
+    # True if it is a virtual card, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_virtual_card
+
+    # Card PAN
+    # @return [String]
+    attr_accessor :pan
+
+    # Purchase category code 
+    # Example: 
+    # 0 - All Fuels (without VP) and Lubricants
+    # 1 - FuelSave only
+    # 2 - FuelSave and Lubricants
+    # 3 - No Restrictions
+    # 4 - VP and FuelSave
+    # 5 - Diesel ONLY
+    # 6 - Diesel and Lubricants
+    # 7 - VP and Lubricants
+    # 8 - VP and FuelSave and Lubricants
+    # @return [String]
+    attr_accessor :purchase_category_code
+
+    # Purchase category Id
+    # @return [Integer]
+    attr_accessor :purchase_category_id
+
+    # Purchase category name 
+    # Example: 
+    # 0 - All Fuels (without VP) and Lubricants
+    # 1 - FuelSave only
+    # 2 - FuelSave and Lubricants
+    # 3 - No Restrictions
+    # 4 - VP and FuelSave
+    # 5 - Diesel ONLY
+    # 6 - Diesel and Lubricants
+    # 7 - VP and Lubricants
+    # 8 - VP and FuelSave and Lubricants
+    # @return [String]
+    attr_accessor :purchase_category_name
+
+    # Status Description (Active, Temporarily Blocked, etc.,)
+    # @return [String]
+    attr_accessor :status_description
+
+    # Card Status id
+    # @return [Integer]
+    attr_accessor :status_id
+
+    # Vehicle registration number
+    # @return [String]
+    attr_accessor :vrn
+
+    # Id of the medium type identifier.
+    # Example: 1,2,4
+    # Full list below:
+    # 1 - Fuel Card
+    # 2 - Fuel Card with EV
+    # 4 - Fuel Card and Key fob Card
+    # 5 - Key fob
+    # 6 - Virtual Card
+    # 7 - NPII Token
+    # 8 – Smartpay
+    # @return [Integer]
+    attr_accessor :medium_type_id
+
+    # Name of the medium type identifier.
+    # Example: Fuel Card, Fuel Card with EV, Key fob  
+    # Full list below:
+    # 1 - Fuel Card
+    # 2 - Fuel Card with EV
+    # 4 - Fuel Card and Key fob Card
+    # 5 - Key fob
+    # 6 - Virtual Card
+    # 7 - NPII Token
+    # 8 - Smartpay
+    # @return [String]
+    attr_accessor :medium_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bundle_id'] = 'BundleId'
+      @_hash['restrictions'] = 'Restrictions'
+      @_hash['restriction_currency_code'] = 'RestrictionCurrencyCode'
+      @_hash['restriction_currency_symbol'] = 'RestrictionCurrencySymbol'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_name'] = 'AccountName'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['account_short_name'] = 'AccountShortName'
+      @_hash['card_id'] = 'CardId'
+      @_hash['card_type_code'] = 'CardTypeCode'
+      @_hash['card_type_id'] = 'CardTypeId'
+      @_hash['card_type_name'] = 'CardTypeName'
+      @_hash['col_co_currency_code'] = 'ColCoCurrencyCode'
+      @_hash['col_co_currency_symbol'] = 'ColCoCurrencySymbol'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_symbol'] = 'CurrencySymbol'
+      @_hash['driver_name'] = 'DriverName'
+      @_hash['expiry_date'] = 'ExpiryDate'
+      @_hash['is_crt'] = 'IsCRT'
+      @_hash['is_fleet'] = 'IsFleet'
+      @_hash['is_international'] = 'IsInternational'
+      @_hash['is_national'] = 'IsNational'
+      @_hash['is_partner_sites_included'] = 'IsPartnerSitesIncluded'
+      @_hash['is_shell_sites_only'] = 'IsShellSitesOnly'
+      @_hash['issue_date'] = 'IssueDate'
+      @_hash['issue_number'] = 'IssueNumber'
+      @_hash['is_superseded'] = 'IsSuperseded'
+      @_hash['is_virtual_card'] = 'IsVirtualCard'
+      @_hash['pan'] = 'PAN'
+      @_hash['purchase_category_code'] = 'PurchaseCategoryCode'
+      @_hash['purchase_category_id'] = 'PurchaseCategoryId'
+      @_hash['purchase_category_name'] = 'PurchaseCategoryName'
+      @_hash['status_description'] = 'StatusDescription'
+      @_hash['status_id'] = 'StatusId'
+      @_hash['vrn'] = 'VRN'
+      @_hash['medium_type_id'] = 'MediumTypeID'
+      @_hash['medium_type'] = 'MediumType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bundle_id
+        restrictions
+        restriction_currency_code
+        restriction_currency_symbol
+        account_id
+        account_name
+        account_number
+        account_short_name
+        card_id
+        card_type_code
+        card_type_id
+        card_type_name
+        col_co_currency_code
+        col_co_currency_symbol
+        currency_code
+        currency_symbol
+        driver_name
+        expiry_date
+        is_crt
+        is_fleet
+        is_international
+        is_national
+        is_partner_sites_included
+        is_shell_sites_only
+        issue_date
+        issue_number
+        is_superseded
+        is_virtual_card
+        pan
+        purchase_category_code
+        purchase_category_id
+        purchase_category_name
+        status_description
+        status_id
+        vrn
+        medium_type_id
+        medium_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        restriction_currency_code
+        restriction_currency_symbol
+        account_id
+        account_name
+        account_number
+        account_short_name
+        card_id
+        card_type_code
+        card_type_id
+        card_type_name
+        col_co_currency_code
+        col_co_currency_symbol
+        currency_code
+        currency_symbol
+        driver_name
+        expiry_date
+        issue_date
+        issue_number
+        pan
+        purchase_category_code
+        purchase_category_id
+        purchase_category_name
+        status_description
+        status_id
+        vrn
+        medium_type_id
+        medium_type
+      ]
+    end
+
+    def initialize(bundle_id = SKIP,
+                   restrictions = SKIP,
+                   restriction_currency_code = SKIP,
+                   restriction_currency_symbol = SKIP,
+                   account_id = SKIP,
+                   account_name = SKIP,
+                   account_number = SKIP,
+                   account_short_name = SKIP,
+                   card_id = SKIP,
+                   card_type_code = SKIP,
+                   card_type_id = SKIP,
+                   card_type_name = SKIP,
+                   col_co_currency_code = SKIP,
+                   col_co_currency_symbol = SKIP,
+                   currency_code = SKIP,
+                   currency_symbol = SKIP,
+                   driver_name = SKIP,
+                   expiry_date = SKIP,
+                   is_crt = SKIP,
+                   is_fleet = SKIP,
+                   is_international = SKIP,
+                   is_national = SKIP,
+                   is_partner_sites_included = SKIP,
+                   is_shell_sites_only = SKIP,
+                   issue_date = SKIP,
+                   issue_number = SKIP,
+                   is_superseded = SKIP,
+                   is_virtual_card = SKIP,
+                   pan = SKIP,
+                   purchase_category_code = SKIP,
+                   purchase_category_id = SKIP,
+                   purchase_category_name = SKIP,
+                   status_description = SKIP,
+                   status_id = SKIP,
+                   vrn = SKIP,
+                   medium_type_id = SKIP,
+                   medium_type = SKIP)
+      @bundle_id = bundle_id unless bundle_id == SKIP
+      @restrictions = restrictions unless restrictions == SKIP
+      unless restriction_currency_code == SKIP
+        @restriction_currency_code =
+          restriction_currency_code
+      end
+      unless restriction_currency_symbol == SKIP
+        @restriction_currency_symbol =
+          restriction_currency_symbol
+      end
+      @account_id = account_id unless account_id == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_short_name = account_short_name unless account_short_name == SKIP
+      @card_id = card_id unless card_id == SKIP
+      @card_type_code = card_type_code unless card_type_code == SKIP
+      @card_type_id = card_type_id unless card_type_id == SKIP
+      @card_type_name = card_type_name unless card_type_name == SKIP
+      @col_co_currency_code = col_co_currency_code unless col_co_currency_code == SKIP
+      @col_co_currency_symbol = col_co_currency_symbol unless col_co_currency_symbol == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_symbol = currency_symbol unless currency_symbol == SKIP
+      @driver_name = driver_name unless driver_name == SKIP
+      @expiry_date = expiry_date unless expiry_date == SKIP
+      @is_crt = is_crt unless is_crt == SKIP
+      @is_fleet = is_fleet unless is_fleet == SKIP
+      @is_international = is_international unless is_international == SKIP
+      @is_national = is_national unless is_national == SKIP
+      unless is_partner_sites_included == SKIP
+        @is_partner_sites_included =
+          is_partner_sites_included
+      end
+      @is_shell_sites_only = is_shell_sites_only unless is_shell_sites_only == SKIP
+      @issue_date = issue_date unless issue_date == SKIP
+      @issue_number = issue_number unless issue_number == SKIP
+      @is_superseded = is_superseded unless is_superseded == SKIP
+      @is_virtual_card = is_virtual_card unless is_virtual_card == SKIP
+      @pan = pan unless pan == SKIP
+      @purchase_category_code = purchase_category_code unless purchase_category_code == SKIP
+      @purchase_category_id = purchase_category_id unless purchase_category_id == SKIP
+      @purchase_category_name = purchase_category_name unless purchase_category_name == SKIP
+      @status_description = status_description unless status_description == SKIP
+      @status_id = status_id unless status_id == SKIP
+      @vrn = vrn unless vrn == SKIP
+      @medium_type_id = medium_type_id unless medium_type_id == SKIP
+      @medium_type = medium_type unless medium_type == 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.
+      bundle_id = hash.key?('BundleId') ? hash['BundleId'] : SKIP
+      restrictions = SearchCardResponseRestrictions.from_hash(hash['Restrictions']) if
+        hash['Restrictions']
+      restriction_currency_code =
+        hash.key?('RestrictionCurrencyCode') ? hash['RestrictionCurrencyCode'] : SKIP
+      restriction_currency_symbol =
+        hash.key?('RestrictionCurrencySymbol') ? hash['RestrictionCurrencySymbol'] : SKIP
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_name = hash.key?('AccountName') ? hash['AccountName'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      account_short_name =
+        hash.key?('AccountShortName') ? hash['AccountShortName'] : SKIP
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      card_type_code = hash.key?('CardTypeCode') ? hash['CardTypeCode'] : SKIP
+      card_type_id = hash.key?('CardTypeId') ? hash['CardTypeId'] : SKIP
+      card_type_name = hash.key?('CardTypeName') ? hash['CardTypeName'] : SKIP
+      col_co_currency_code =
+        hash.key?('ColCoCurrencyCode') ? hash['ColCoCurrencyCode'] : SKIP
+      col_co_currency_symbol =
+        hash.key?('ColCoCurrencySymbol') ? hash['ColCoCurrencySymbol'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_symbol =
+        hash.key?('CurrencySymbol') ? hash['CurrencySymbol'] : SKIP
+      driver_name = hash.key?('DriverName') ? hash['DriverName'] : SKIP
+      expiry_date = hash.key?('ExpiryDate') ? hash['ExpiryDate'] : SKIP
+      is_crt = hash.key?('IsCRT') ? hash['IsCRT'] : SKIP
+      is_fleet = hash.key?('IsFleet') ? hash['IsFleet'] : SKIP
+      is_international =
+        hash.key?('IsInternational') ? hash['IsInternational'] : SKIP
+      is_national = hash.key?('IsNational') ? hash['IsNational'] : SKIP
+      is_partner_sites_included =
+        hash.key?('IsPartnerSitesIncluded') ? hash['IsPartnerSitesIncluded'] : SKIP
+      is_shell_sites_only =
+        hash.key?('IsShellSitesOnly') ? hash['IsShellSitesOnly'] : SKIP
+      issue_date = hash.key?('IssueDate') ? hash['IssueDate'] : SKIP
+      issue_number = hash.key?('IssueNumber') ? hash['IssueNumber'] : SKIP
+      is_superseded = hash.key?('IsSuperseded') ? hash['IsSuperseded'] : SKIP
+      is_virtual_card =
+        hash.key?('IsVirtualCard') ? hash['IsVirtualCard'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      purchase_category_code =
+        hash.key?('PurchaseCategoryCode') ? hash['PurchaseCategoryCode'] : SKIP
+      purchase_category_id =
+        hash.key?('PurchaseCategoryId') ? hash['PurchaseCategoryId'] : SKIP
+      purchase_category_name =
+        hash.key?('PurchaseCategoryName') ? hash['PurchaseCategoryName'] : SKIP
+      status_description =
+        hash.key?('StatusDescription') ? hash['StatusDescription'] : SKIP
+      status_id = hash.key?('StatusId') ? hash['StatusId'] : SKIP
+      vrn = hash.key?('VRN') ? hash['VRN'] : SKIP
+      medium_type_id = hash.key?('MediumTypeID') ? hash['MediumTypeID'] : SKIP
+      medium_type = hash.key?('MediumType') ? hash['MediumType'] : SKIP
+
+      # Create object from extracted values.
+      RestrictionSearchCardResponseDataItems.new(bundle_id,
+                                                 restrictions,
+                                                 restriction_currency_code,
+                                                 restriction_currency_symbol,
+                                                 account_id,
+                                                 account_name,
+                                                 account_number,
+                                                 account_short_name,
+                                                 card_id,
+                                                 card_type_code,
+                                                 card_type_id,
+                                                 card_type_name,
+                                                 col_co_currency_code,
+                                                 col_co_currency_symbol,
+                                                 currency_code,
+                                                 currency_symbol,
+                                                 driver_name,
+                                                 expiry_date,
+                                                 is_crt,
+                                                 is_fleet,
+                                                 is_international,
+                                                 is_national,
+                                                 is_partner_sites_included,
+                                                 is_shell_sites_only,
+                                                 issue_date,
+                                                 issue_number,
+                                                 is_superseded,
+                                                 is_virtual_card,
+                                                 pan,
+                                                 purchase_category_code,
+                                                 purchase_category_id,
+                                                 purchase_category_name,
+                                                 status_description,
+                                                 status_id,
+                                                 vrn,
+                                                 medium_type_id,
+                                                 medium_type)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/role.rb

@@ -0,0 +1,102 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Role Model.
+  class Role < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Role Name of the user
+    # @return [String]
+    attr_accessor :role_name
+
+    # Whether the role is an administrator.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_customer_admin
+
+    # Whether the role is a customer user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_customer_user
+
+    # True if the role is Shell user, else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_shell_admin
+
+    # True/False.
+    # True if the role is Service accounts, else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_service_account
+
+    # True/False.
+    # True, if the role allows user administration, else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_user_admin
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['role_name'] = 'RoleName'
+      @_hash['is_customer_admin'] = 'IsCustomerAdmin'
+      @_hash['is_customer_user'] = 'IsCustomerUser'
+      @_hash['is_shell_admin'] = 'IsShellAdmin'
+      @_hash['is_service_account'] = 'IsServiceAccount'
+      @_hash['is_user_admin'] = 'IsUserAdmin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        role_name
+        is_customer_admin
+        is_customer_user
+        is_shell_admin
+        is_service_account
+        is_user_admin
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(role_name = SKIP,
+                   is_customer_admin = true,
+                   is_customer_user = false,
+                   is_shell_admin = false,
+                   is_service_account = false,
+                   is_user_admin = true)
+      @role_name = role_name unless role_name == SKIP
+      @is_customer_admin = is_customer_admin unless is_customer_admin == SKIP
+      @is_customer_user = is_customer_user unless is_customer_user == SKIP
+      @is_shell_admin = is_shell_admin unless is_shell_admin == SKIP
+      @is_service_account = is_service_account unless is_service_account == SKIP
+      @is_user_admin = is_user_admin unless is_user_admin == 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.
+      role_name = hash.key?('RoleName') ? hash['RoleName'] : SKIP
+      is_customer_admin = hash['IsCustomerAdmin'] ||= true
+      is_customer_user = hash['IsCustomerUser'] ||= false
+      is_shell_admin = hash['IsShellAdmin'] ||= false
+      is_service_account = hash['IsServiceAccount'] ||= false
+      is_user_admin = hash['IsUserAdmin'] ||= true
+
+      # Create object from extracted values.
+      Role.new(role_name,
+               is_customer_admin,
+               is_customer_user,
+               is_shell_admin,
+               is_service_account,
+               is_user_admin)
+    end
+  end
+end