card-management-sdk 1.0.0 → 1.1.0

data/lib/shell_card_management_ap_is/models/card_delivery_address.rb

@@ -0,0 +1,218 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # CardDeliveryAddress Model.
+  class CardDeliveryAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Fore name of the contact person
+    # @return [String]
+    attr_accessor :contact_fore_name
+
+    # Middle name of the contact person
+    # @return [String]
+    attr_accessor :contact_middle_name
+
+    # Last name of the contact person
+    # @return [String]
+    attr_accessor :contact_last_name
+
+    # Title of the contact person Optional Max field length- 10 Note- If the
+    # Shell Card Platform configuration is set to clear the personal details
+    # captured on card orders, this value will be cleared from the record after
+    # processing the request.
+    # @return [String]
+    attr_accessor :contact_title
+
+    # Company name Mandatory if IsNewDeliveryAddress and OrderReplacement are
+    # passed. True, Note- If the Shell Card Platform configuration is set to
+    # clear the personal details captured on card orders, this value will be
+    # cleared from the record after processing the request.
+    # @return [String]
+    attr_accessor :company_name
+
+    # Address Id in cards platform.
+    # @return [Integer]
+    attr_accessor :address_id
+
+    # Address line 1 Mandatory if IsNewDeliveryAddress and OrderReplacement are
+    # passed True. Max field length- 40 Note- If the Shell Card Platform
+    # configuration is set to clear the personal details captured on card
+    # orders, this value will be cleared from the record after processing the
+    # request.
+    # @return [String]
+    attr_accessor :address_line1
+
+    # Address line 2 Optional Max field length- 40 Note- If the Shell Card
+    # Platform configuration is set to clear the personal details captured on
+    # card orders, this value will be cleared from the record after processing
+    # the request.
+    # @return [String]
+    attr_accessor :address_line2
+
+    # Address line Optional Max field length- 40 Note- If the Shell Card
+    # Platform configuration is set to clear the personal details captured on
+    # card orders, this value will be cleared from the record after processing
+    # the request.
+    # @return [String]
+    attr_accessor :address_line3
+
+    # ZIP code Mandatory if IsNewDeliveryAddress and OrderReplacement are
+    # passed. True, Max field length- 10 Note- If the Shell Card Platform
+    # configuration is set to clear the personal details captured on card
+    # orders, this value will be cleared from the record after processing the
+    # request.
+    # @return [String]
+    attr_accessor :zip_code
+
+    # City Max field length- 40 Note- If the Shell Card Platform configuration
+    # is set to clear the personal details captured on card orders, this value
+    # will be cleared from the record after processing the request.
+    # @return [String]
+    attr_accessor :city
+
+    # Region Id
+    # @return [Integer]
+    attr_accessor :region_id
+
+    # Region Optional When region is passed, Shell Card Platform will look up
+    # for the region id for the given region.  If the option to clear personal
+    # details is set in the Shell Card Platform, then this value will be cleared
+    # from the record after processing the request .
+    # @return [String]
+    attr_accessor :region
+
+    # Country Id in cards platform.
+    # @return [Integer]
+    attr_accessor :country_id
+
+    # The ISO code of the country. Mandatory if IsNewDeliveryAddress and
+    # OrderReplacement are passed. If the option to clear personal details is
+    # set in the Shell Card Platform, then this value will be cleared from the
+    # record after processing the request .
+    # @return [String]
+    attr_accessor :country_iso_code
+
+    # Country name.
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_fore_name'] = 'ContactForeName'
+      @_hash['contact_middle_name'] = 'ContactMiddleName'
+      @_hash['contact_last_name'] = 'ContactLastName'
+      @_hash['contact_title'] = 'ContactTitle'
+      @_hash['company_name'] = 'CompanyName'
+      @_hash['address_id'] = 'AddressId'
+      @_hash['address_line1'] = 'AddressLine1'
+      @_hash['address_line2'] = 'AddressLine2'
+      @_hash['address_line3'] = 'AddressLine3'
+      @_hash['zip_code'] = 'ZipCode'
+      @_hash['city'] = 'City'
+      @_hash['region_id'] = 'RegionId'
+      @_hash['region'] = 'Region'
+      @_hash['country_id'] = 'CountryId'
+      @_hash['country_iso_code'] = 'CountryISOCode'
+      @_hash['country'] = 'Country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_fore_name
+        contact_middle_name
+        contact_last_name
+        contact_title
+        address_line2
+        address_line3
+        city
+        region_id
+        region
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        region_id
+      ]
+    end
+
+    def initialize(company_name = nil, address_id = nil, address_line1 = nil,
+                   zip_code = nil, country_id = nil, country_iso_code = nil,
+                   country = nil, contact_fore_name = SKIP,
+                   contact_middle_name = SKIP, contact_last_name = SKIP,
+                   contact_title = SKIP, address_line2 = SKIP,
+                   address_line3 = SKIP, city = SKIP, region_id = SKIP,
+                   region = SKIP)
+      @contact_fore_name = contact_fore_name unless contact_fore_name == SKIP
+      @contact_middle_name = contact_middle_name unless contact_middle_name == SKIP
+      @contact_last_name = contact_last_name unless contact_last_name == SKIP
+      @contact_title = contact_title unless contact_title == SKIP
+      @company_name = company_name
+      @address_id = address_id
+      @address_line1 = address_line1
+      @address_line2 = address_line2 unless address_line2 == SKIP
+      @address_line3 = address_line3 unless address_line3 == SKIP
+      @zip_code = zip_code
+      @city = city unless city == SKIP
+      @region_id = region_id unless region_id == SKIP
+      @region = region unless region == SKIP
+      @country_id = country_id
+      @country_iso_code = country_iso_code
+      @country = country
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      company_name = hash.key?('CompanyName') ? hash['CompanyName'] : nil
+      address_id = hash.key?('AddressId') ? hash['AddressId'] : nil
+      address_line1 = hash.key?('AddressLine1') ? hash['AddressLine1'] : nil
+      zip_code = hash.key?('ZipCode') ? hash['ZipCode'] : nil
+      country_id = hash.key?('CountryId') ? hash['CountryId'] : nil
+      country_iso_code =
+        hash.key?('CountryISOCode') ? hash['CountryISOCode'] : nil
+      country = hash.key?('Country') ? hash['Country'] : nil
+      contact_fore_name =
+        hash.key?('ContactForeName') ? hash['ContactForeName'] : SKIP
+      contact_middle_name =
+        hash.key?('ContactMiddleName') ? hash['ContactMiddleName'] : SKIP
+      contact_last_name =
+        hash.key?('ContactLastName') ? hash['ContactLastName'] : SKIP
+      contact_title = hash.key?('ContactTitle') ? hash['ContactTitle'] : SKIP
+      address_line2 = hash.key?('AddressLine2') ? hash['AddressLine2'] : SKIP
+      address_line3 = hash.key?('AddressLine3') ? hash['AddressLine3'] : SKIP
+      city = hash.key?('City') ? hash['City'] : SKIP
+      region_id = hash.key?('RegionId') ? hash['RegionId'] : SKIP
+      region = hash.key?('Region') ? hash['Region'] : SKIP
+
+      # Create object from extracted values.
+      CardDeliveryAddress.new(company_name,
+                              address_id,
+                              address_line1,
+                              zip_code,
+                              country_id,
+                              country_iso_code,
+                              country,
+                              contact_fore_name,
+                              contact_middle_name,
+                              contact_last_name,
+                              contact_title,
+                              address_line2,
+                              address_line3,
+                              city,
+                              region_id,
+                              region)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_delivery_contact.rb

@@ -149,20 +149,13 @@ module ShellCardManagementApIs
       ]
     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)
+    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

data/lib/shell_card_management_ap_is/models/card_detail.rb

@@ -179,9 +179,12 @@ module ShellCardManagementApIs
     # @return [Integer]
     attr_accessor :card_delivery_type
 
-    # Request entity object for CardDeliveryContact
-    # Mandatory when CardDeliveryType is 2 else ignored.
-    # @return [CardDeliveryContact]
+    # Card delivery type.<br />
+    # Mandatory <br />
+    # Allowed Value: <br />
+    # 1.	Customer Address(Default) <br />
+    # 2.	New Delivery Address
+    # @return [CardContact]
     attr_accessor :card_contact
 
     # PIN delivery address type selection.<br />
@@ -204,10 +207,15 @@ module ShellCardManagementApIs
     # @return [Integer]
     attr_accessor :pin_advice_type
 
-    # Request entity object for PINDeliveryContact
-    # Mandatory when PINDeliveryAddressType is ‘3’ (New delivery address). Else,
-    # ignored.
-    # @return [PINDeliveryContact]
+    # PIN delivery method.<br />
+    # Mandatory<br />
+    # Allowed Values:<br />
+    # 1.	Paper<br />
+    # 2.	Email<br />
+    # 3.	SMS<br />
+    # 4.	None <br /> **Note:** Paper delivery not applicable for selfselctedPIN
+    # type
+    # @return [PINContact]
     attr_accessor :pin_contact
 
     # True/False.<br />
@@ -335,11 +343,9 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :client_reference_id
 
-    # Whether to reissue card automatically when nearing the expiry. 
-    # Allowed values: -
-    # 1.    As per card type setting (Default).
-    # 2.    Card will be Reissued when nearing its expiry date.
-    # 3.    Card will not be Reissued.
+    # This is the Client Reference Id of card in the order which needs to be
+    # passed by the client.This will be playback in the ordercard enquiry<br />
+    # Optional
     # @return [CardDetailAutoRenewEnum]
     attr_accessor :auto_renew
 
@@ -463,45 +469,26 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(card_delivery_type = nil,
-                   pin_advice_type = nil,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   col_co_code = SKIP,
-                   col_co_id = SKIP,
-                   card_type_id = SKIP,
-                   token_type_id = SKIP,
-                   emboss_text = SKIP,
-                   vrn = SKIP,
-                   driver_name = SKIP,
+    def initialize(card_delivery_type = nil, pin_advice_type = nil,
+                   payer_id = SKIP, payer_number = SKIP, account_id = SKIP,
+                   account_number = SKIP, col_co_code = SKIP, col_co_id = SKIP,
+                   card_type_id = SKIP, token_type_id = SKIP,
+                   emboss_text = SKIP, vrn = SKIP, driver_name = SKIP,
                    odometer_input_required = SKIP,
-                   fleet_id_input_required = SKIP,
-                   purchase_category_id = SKIP,
+                   fleet_id_input_required = SKIP, purchase_category_id = SKIP,
                    self_selected_encrypted_pin = SKIP,
                    self_selected_pin_key_id = SKIP,
-                   self_selected_pin_session_key = SKIP,
-                   card_group_id = SKIP,
-                   card_group_name = SKIP,
-                   is_new_card_group = SKIP,
-                   emboss_card_group = SKIP,
-                   card_contact = SKIP,
-                   pin_delivery_address_type = SKIP,
-                   pin_contact = SKIP,
-                   notify_caller = SKIP,
-                   caller = SKIP,
-                   notify_caller_on_sync = SKIP,
-                   validate_fleet_id = SKIP,
-                   fleet_option = SKIP,
-                   bundle_id = SKIP,
+                   self_selected_pin_session_key = SKIP, card_group_id = SKIP,
+                   card_group_name = SKIP, is_new_card_group = SKIP,
+                   emboss_card_group = SKIP, card_contact = SKIP,
+                   pin_delivery_address_type = SKIP, pin_contact = SKIP,
+                   notify_caller = SKIP, caller = SKIP,
+                   notify_caller_on_sync = SKIP, validate_fleet_id = SKIP,
+                   fleet_option = SKIP, bundle_id = SKIP,
                    usage_restriction_action = SKIP,
-                   product_restriction_action = SKIP,
-                   products = SKIP,
-                   product_groups = SKIP,
-                   expiry_date = SKIP,
-                   client_reference_id = SKIP,
-                   auto_renew = SKIP)
+                   product_restriction_action = SKIP, products = SKIP,
+                   product_groups = SKIP, expiry_date = SKIP,
+                   client_reference_id = SKIP, auto_renew = SKIP)
       @payer_id = payer_id unless payer_id == SKIP
       @payer_number = payer_number unless payer_number == SKIP
       @account_id = account_id unless account_id == SKIP
@@ -593,10 +580,10 @@ module ShellCardManagementApIs
         hash.key?('IsNewCardGroup') ? hash['IsNewCardGroup'] : SKIP
       emboss_card_group =
         hash.key?('EmbossCardGroup') ? hash['EmbossCardGroup'] : SKIP
-      card_contact = CardDeliveryContact.from_hash(hash['CardContact']) if hash['CardContact']
+      card_contact = CardContact.from_hash(hash['CardContact']) if hash['CardContact']
       pin_delivery_address_type =
         hash.key?('PINDeliveryAddressType') ? hash['PINDeliveryAddressType'] : SKIP
-      pin_contact = PINDeliveryContact.from_hash(hash['PINContact']) if hash['PINContact']
+      pin_contact = PINContact.from_hash(hash['PINContact']) if hash['PINContact']
       notify_caller = hash.key?('NotifyCaller') ? hash['NotifyCaller'] : SKIP
       caller = hash.key?('Caller') ? hash['Caller'] : SKIP
       notify_caller_on_sync =

data/lib/shell_card_management_ap_is/models/card_details_request.rb

@@ -166,20 +166,12 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(col_co_code = SKIP,
-                   col_co_id = SKIP,
-                   col_co_country_code = SKIP,
-                   client_reference_id = SKIP,
-                   payer_number = SKIP,
-                   payer_id = SKIP,
-                   account_number = SKIP,
-                   account_id = SKIP,
-                   pan = SKIP,
-                   card_id = SKIP,
-                   token_type_id = SKIP,
-                   token_type_name = SKIP,
-                   creation_date = SKIP,
-                   effective_date = SKIP,
+    def initialize(col_co_code = SKIP, col_co_id = SKIP,
+                   col_co_country_code = SKIP, client_reference_id = SKIP,
+                   payer_number = SKIP, payer_id = SKIP, account_number = SKIP,
+                   account_id = SKIP, pan = SKIP, card_id = SKIP,
+                   token_type_id = SKIP, token_type_name = SKIP,
+                   creation_date = SKIP, effective_date = SKIP,
                    include_bundle_details = SKIP,
                    include_intermediate_status = SKIP,
                    include_scheduled_card_blocks = SKIP)