card-management-sdk 1.0.0 → 1.1.0

data/lib/shell_card_management_ap_is/models/bundled_details_product_list.rb

@@ -0,0 +1,116 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # BundledDetailsProductList Model.
+  class BundledDetailsProductList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Purchase category Id
+    # Example: 123, 124, etc.,
+    # @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
+    # @return [String]
+    attr_accessor :purchase_category_code
+
+    # An array of 3-digit global product codes.
+    # Example: [ "033", "021", "023" ]
+    # @return [Array[String]]
+    attr_accessor :products
+
+    # An array of product group ids.
+    # Example: [ "670246404", "40557126" ]
+    # @return [Array[String]]
+    attr_accessor :product_groups
+
+    # Fuel set id that is allowed to be purchased with the card
+    # @return [String]
+    attr_accessor :fuel_set_id
+
+    # Fuel set name that is allowed to be purchased with the card
+    # @return [String]
+    attr_accessor :fuel_set_name
+
+    # Non-Fuel set name that is allowed to be purchased with the card
+    # @return [String]
+    attr_accessor :non_fuel_sets
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['purchase_category_id'] = 'PurchaseCategoryId'
+      @_hash['purchase_category_code'] = 'PurchaseCategoryCode'
+      @_hash['products'] = 'Products'
+      @_hash['product_groups'] = 'ProductGroups'
+      @_hash['fuel_set_id'] = 'FuelSetId'
+      @_hash['fuel_set_name'] = 'FuelSetName'
+      @_hash['non_fuel_sets'] = 'NonFuelSets'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        purchase_category_id
+        purchase_category_code
+        products
+        product_groups
+        fuel_set_id
+        fuel_set_name
+        non_fuel_sets
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(purchase_category_id = SKIP, purchase_category_code = SKIP,
+                   products = SKIP, product_groups = SKIP, fuel_set_id = SKIP,
+                   fuel_set_name = SKIP, non_fuel_sets = SKIP)
+      @purchase_category_id = purchase_category_id unless purchase_category_id == SKIP
+      @purchase_category_code = purchase_category_code unless purchase_category_code == SKIP
+      @products = products unless products == SKIP
+      @product_groups = product_groups unless product_groups == SKIP
+      @fuel_set_id = fuel_set_id unless fuel_set_id == SKIP
+      @fuel_set_name = fuel_set_name unless fuel_set_name == SKIP
+      @non_fuel_sets = non_fuel_sets unless non_fuel_sets == 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.
+      purchase_category_id =
+        hash.key?('PurchaseCategoryId') ? hash['PurchaseCategoryId'] : SKIP
+      purchase_category_code =
+        hash.key?('PurchaseCategoryCode') ? hash['PurchaseCategoryCode'] : SKIP
+      products = hash.key?('Products') ? hash['Products'] : SKIP
+      product_groups = hash.key?('ProductGroups') ? hash['ProductGroups'] : SKIP
+      fuel_set_id = hash.key?('FuelSetId') ? hash['FuelSetId'] : SKIP
+      fuel_set_name = hash.key?('FuelSetName') ? hash['FuelSetName'] : SKIP
+      non_fuel_sets = hash.key?('NonFuelSets') ? hash['NonFuelSets'] : SKIP
+
+      # Create object from extracted values.
+      BundledDetailsProductList.new(purchase_category_id,
+                                    purchase_category_code,
+                                    products,
+                                    product_groups,
+                                    fuel_set_id,
+                                    fuel_set_name,
+                                    non_fuel_sets)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/bundled_restrictions_list.rb

@@ -0,0 +1,88 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # BundledRestrictionsList Model.
+  class BundledRestrictionsList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Details of the usage restrictions such as day/week/month value and volume
+    # restrictions applied on the card.
+    # @return [UsageRestriction]
+    attr_accessor :usage_restrictions
+
+    # Details of the day/time restrictions such as weekdays and time range in
+    # which transactions should be allowed on the card.
+    # @return [DayTimeRestriction]
+    attr_accessor :day_time_restrictions
+
+    # Details of the day/time restrictions such as weekdays and time range in
+    # which transactions should be allowed on the card.
+    # @return [BundledDetailsProductList]
+    attr_accessor :product_restrictions
+
+    # Details of the day/time restrictions such as weekdays and time range in
+    # which transactions should be allowed on the card.
+    # @return [LocationRestriction]
+    attr_accessor :location_restrictions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['usage_restrictions'] = 'UsageRestrictions'
+      @_hash['day_time_restrictions'] = 'DayTimeRestrictions'
+      @_hash['product_restrictions'] = 'ProductRestrictions'
+      @_hash['location_restrictions'] = 'LocationRestrictions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        usage_restrictions
+        day_time_restrictions
+        product_restrictions
+        location_restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        usage_restrictions
+      ]
+    end
+
+    def initialize(usage_restrictions = SKIP, day_time_restrictions = SKIP,
+                   product_restrictions = SKIP, location_restrictions = SKIP)
+      @usage_restrictions = usage_restrictions unless usage_restrictions == SKIP
+      @day_time_restrictions = day_time_restrictions unless day_time_restrictions == SKIP
+      @product_restrictions = product_restrictions unless product_restrictions == SKIP
+      @location_restrictions = location_restrictions unless location_restrictions == 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.
+      usage_restrictions = UsageRestriction.from_hash(hash['UsageRestrictions']) if
+        hash['UsageRestrictions']
+      day_time_restrictions = DayTimeRestriction.from_hash(hash['DayTimeRestrictions']) if
+        hash['DayTimeRestrictions']
+      product_restrictions = BundledDetailsProductList.from_hash(hash['ProductRestrictions']) if
+        hash['ProductRestrictions']
+      location_restrictions = LocationRestriction.from_hash(hash['LocationRestrictions']) if
+        hash['LocationRestrictions']
+
+      # Create object from extracted values.
+      BundledRestrictionsList.new(usage_restrictions,
+                                  day_time_restrictions,
+                                  product_restrictions,
+                                  location_restrictions)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/cancel_card_request.rb

@@ -72,9 +72,7 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(cards = nil,
-                   reason_id = SKIP,
-                   reason_text = SKIP)
+    def initialize(cards = nil, reason_id = SKIP, reason_text = SKIP)
       @cards = cards
       @reason_id = reason_id unless reason_id == SKIP
       @reason_text = reason_text unless reason_text == SKIP

data/lib/shell_card_management_ap_is/models/cancel_card_response.rb

@@ -67,12 +67,9 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(request_id = SKIP,
-                   main_reference = SKIP,
-                   order_replacement_reference = SKIP,
-                   status = SKIP,
-                   data = SKIP,
-                   errors = SKIP)
+    def initialize(request_id = SKIP, main_reference = SKIP,
+                   order_replacement_reference = SKIP, status = SKIP,
+                   data = SKIP, errors = SKIP)
       @request_id = request_id unless request_id == SKIP
       @main_reference = main_reference unless main_reference == SKIP
       unless order_replacement_reference == SKIP

data/lib/shell_card_management_ap_is/models/card.rb

@@ -446,56 +446,29 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(account_id = SKIP,
-                   account_name = SKIP,
-                   account_number = SKIP,
-                   account_short_name = SKIP,
-                   bundle_id = SKIP,
-                   card_block_schedules = SKIP,
-                   card_group_id = SKIP,
-                   card_group_name = SKIP,
-                   card_id = SKIP,
-                   card_type_code = SKIP,
-                   card_type_id = SKIP,
-                   card_type_name = SKIP,
-                   col_co_country_code = SKIP,
-                   creation_date = SKIP,
-                   driver_name = SKIP,
-                   effective_date = SKIP,
-                   expiry_date = SKIP,
-                   fleet_id_input = 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,
-                   is_superseded = SKIP,
-                   is_virtual_card = SKIP,
-                   last_modified_date = SKIP,
-                   last_used_date = SKIP,
-                   local_currency_code = SKIP,
-                   local_currency_symbol = SKIP,
-                   odometer_input = SKIP,
-                   pan = SKIP,
-                   purchase_category_code = SKIP,
-                   purchase_category_id = SKIP,
-                   purchase_category_name = SKIP,
-                   reason = SKIP,
-                   reissue_setting = SKIP,
-                   status_description = SKIP,
-                   status_id = SKIP,
-                   token_type_id = SKIP,
-                   token_type_name = SKIP,
-                   vrn = SKIP,
-                   client_reference_id = SKIP,
-                   is_emv_contact = SKIP,
-                   is_emv_contactless = SKIP,
-                   is_rfid = SKIP,
-                   rfiduid = SKIP,
-                   emaid = SKIP,
-                   ev_printed_number = SKIP,
+    def initialize(account_id = SKIP, account_name = SKIP,
+                   account_number = SKIP, account_short_name = SKIP,
+                   bundle_id = SKIP, card_block_schedules = SKIP,
+                   card_group_id = SKIP, card_group_name = SKIP, card_id = SKIP,
+                   card_type_code = SKIP, card_type_id = SKIP,
+                   card_type_name = SKIP, col_co_country_code = SKIP,
+                   creation_date = SKIP, driver_name = SKIP,
+                   effective_date = SKIP, expiry_date = SKIP,
+                   fleet_id_input = 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, is_superseded = SKIP,
+                   is_virtual_card = SKIP, last_modified_date = SKIP,
+                   last_used_date = SKIP, local_currency_code = SKIP,
+                   local_currency_symbol = SKIP, odometer_input = SKIP,
+                   pan = SKIP, purchase_category_code = SKIP,
+                   purchase_category_id = SKIP, purchase_category_name = SKIP,
+                   reason = SKIP, reissue_setting = SKIP,
+                   status_description = SKIP, status_id = SKIP,
+                   token_type_id = SKIP, token_type_name = SKIP, vrn = SKIP,
+                   client_reference_id = SKIP, is_emv_contact = SKIP,
+                   is_emv_contactless = SKIP, is_rfid = SKIP, rfiduid = SKIP,
+                   emaid = SKIP, ev_printed_number = SKIP,
                    card_media_code = SKIP)
       @account_id = account_id unless account_id == SKIP
       @account_name = account_name unless account_name == SKIP

data/lib/shell_card_management_ap_is/models/card_block_schedule.rb

@@ -43,8 +43,7 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(from_date = SKIP,
-                   to_date = SKIP)
+    def initialize(from_date = SKIP, to_date = SKIP)
       @from_date = from_date unless from_date == SKIP
       @to_date = to_date unless to_date == SKIP
     end

data/lib/shell_card_management_ap_is/models/{summary_of_bundle_response_data_items_card_bundles_items.rb → card_bundle.rb}

@@ -4,12 +4,12 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # SummaryOfBundleResponseDataItemsCardBundlesItems Model.
-  class SummaryOfBundleResponseDataItemsCardBundlesItems < BaseModel
+  # CardBundle Model.
+  class CardBundle < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # Gateway assigned unique identifier for the Card Bundle.
+    # Unique identifier for the Card Bundle
     # @return [String]
     attr_accessor :bundle_id
 
@@ -17,7 +17,7 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :external_bundle_id
 
-    # Card Bundle Description.
+    # DescriptionCard Bundle Description.
     # @return [String]
     attr_accessor :description
 
@@ -47,18 +47,11 @@ module ShellCardManagementApIs
 
     # An array for nullable fields
     def self.nullables
-      %w[
-        bundle_id
-        external_bundle_id
-        description
-        total_cards
-      ]
+      []
     end
 
-    def initialize(bundle_id = SKIP,
-                   external_bundle_id = SKIP,
-                   description = SKIP,
-                   total_cards = SKIP)
+    def initialize(bundle_id = SKIP, external_bundle_id = SKIP,
+                   description = SKIP, total_cards = SKIP)
       @bundle_id = bundle_id unless bundle_id == SKIP
       @external_bundle_id = external_bundle_id unless external_bundle_id == SKIP
       @description = description unless description == SKIP
@@ -77,10 +70,10 @@ module ShellCardManagementApIs
       total_cards = hash.key?('TotalCards') ? hash['TotalCards'] : SKIP
 
       # Create object from extracted values.
-      SummaryOfBundleResponseDataItemsCardBundlesItems.new(bundle_id,
-                                                           external_bundle_id,
-                                                           description,
-                                                           total_cards)
+      CardBundle.new(bundle_id,
+                     external_bundle_id,
+                     description,
+                     total_cards)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/card_contact.rb

@@ -0,0 +1,222 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CardContact Model.
+  class CardContact < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Title of the contact person <br />
+    # Optional
+    # Max field length: 10
+    # @return [String]
+    attr_accessor :delivery_contact_title
+
+    # Name of the contact person <br />
+    # Mandatory  <br />
+    # Max field length: 50
+    # @return [String]
+    attr_accessor :delivery_contact_name
+
+    # Company name <br />
+    # Mandatory  <br />
+    # Max field length: 50
+    # @return [String]
+    attr_accessor :delivery_company_name
+
+    # Address line 1 <br />
+    # Mandatory<br />
+    # Max field length: 40
+    # @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  <br />
+    # Max field length: 10  <br />
+    # Optional
+    # @return [String]
+    attr_accessor :delivery_zip_code
+
+    # City  <br />
+    # Mandatory  <br />
+    # Max field length: 40
+    # @return [String]
+    attr_accessor :delivery_city
+
+    # Region Id  <br />
+    # Optional
+    # @return [Integer]
+    attr_accessor :delivery_region_id
+
+    # Region  <br />
+    # Optional<br />
+    # When region is passed
+    # @return [String]
+    attr_accessor :delivery_region
+
+    # The ISO code of the country.<br />
+    # @return [String]
+    attr_accessor :delivery_country
+
+    # Phone number for courier delivery.<br />
+    # Optional.<br />
+    # Max field length: 20
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Email address for courier delivery.<br />
+    # 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
+
+    # If this is specified, the contact address will be saved in cards platform
+    # for card reissue processing.<br />
+    # Optional
+    # @return [TrueClass | FalseClass]
+    attr_accessor :save_for_card_reissue
+
+    # 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_card_reissue'] = 'SaveForCardReissue'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        delivery_contact_title
+        delivery_address_line2
+        delivery_address_line3
+        delivery_region_id
+        delivery_region
+        phone_number
+        email_address
+        save_for_card_reissue
+      ]
+    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_name = nil, delivery_company_name = nil,
+                   delivery_address_line1 = nil, delivery_zip_code = nil,
+                   delivery_city = nil, delivery_country = nil,
+                   delivery_contact_title = SKIP, delivery_address_line2 = SKIP,
+                   delivery_address_line3 = SKIP, delivery_region_id = SKIP,
+                   delivery_region = SKIP, phone_number = SKIP,
+                   email_address = SKIP, save_for_card_reissue = SKIP)
+      @delivery_contact_title = delivery_contact_title unless delivery_contact_title == SKIP
+      @delivery_contact_name = delivery_contact_name
+      @delivery_company_name = delivery_company_name
+      @delivery_address_line1 = delivery_address_line1
+      @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
+      @delivery_city = delivery_city
+      @delivery_region_id = delivery_region_id unless delivery_region_id == SKIP
+      @delivery_region = delivery_region unless delivery_region == SKIP
+      @delivery_country = delivery_country
+      @phone_number = phone_number unless phone_number == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @save_for_card_reissue = save_for_card_reissue unless save_for_card_reissue == 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_name =
+        hash.key?('DeliveryContactName') ? hash['DeliveryContactName'] : nil
+      delivery_company_name =
+        hash.key?('DeliveryCompanyName') ? hash['DeliveryCompanyName'] : nil
+      delivery_address_line1 =
+        hash.key?('DeliveryAddressLine1') ? hash['DeliveryAddressLine1'] : nil
+      delivery_zip_code =
+        hash.key?('DeliveryZipCode') ? hash['DeliveryZipCode'] : nil
+      delivery_city = hash.key?('DeliveryCity') ? hash['DeliveryCity'] : nil
+      delivery_country =
+        hash.key?('DeliveryCountry') ? hash['DeliveryCountry'] : nil
+      delivery_contact_title =
+        hash.key?('DeliveryContactTitle') ? hash['DeliveryContactTitle'] : SKIP
+      delivery_address_line2 =
+        hash.key?('DeliveryAddressLine2') ? hash['DeliveryAddressLine2'] : SKIP
+      delivery_address_line3 =
+        hash.key?('DeliveryAddressLine3') ? hash['DeliveryAddressLine3'] : SKIP
+      delivery_region_id =
+        hash.key?('DeliveryRegionId') ? hash['DeliveryRegionId'] : SKIP
+      delivery_region =
+        hash.key?('DeliveryRegion') ? hash['DeliveryRegion'] : SKIP
+      phone_number = hash.key?('PhoneNumber') ? hash['PhoneNumber'] : SKIP
+      email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
+      save_for_card_reissue =
+        hash.key?('SaveForCardReissue') ? hash['SaveForCardReissue'] : SKIP
+
+      # Create object from extracted values.
+      CardContact.new(delivery_contact_name,
+                      delivery_company_name,
+                      delivery_address_line1,
+                      delivery_zip_code,
+                      delivery_city,
+                      delivery_country,
+                      delivery_contact_title,
+                      delivery_address_line2,
+                      delivery_address_line3,
+                      delivery_region_id,
+                      delivery_region,
+                      phone_number,
+                      email_address,
+                      save_for_card_reissue)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_day_time_restrictions.rb

@@ -105,15 +105,9 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(level = SKIP,
-                   monday = SKIP,
-                   tuesday = SKIP,
-                   wednesday = SKIP,
-                   thursday = SKIP,
-                   friday = SKIP,
-                   saturday = SKIP,
-                   sunday = SKIP,
-                   time_from = SKIP,
+    def initialize(level = SKIP, monday = SKIP, tuesday = SKIP,
+                   wednesday = SKIP, thursday = SKIP, friday = SKIP,
+                   saturday = SKIP, sunday = SKIP, time_from = SKIP,
                    time_to = SKIP)
       @level = level unless level == SKIP
       @monday = monday unless monday == SKIP