card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/card_details_response_local_pos_language_id_enum.rb

@@ -0,0 +1,118 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # POS language identifier. Language Id:   * `1` - German   * `2` - French   *
+  # `3` - Bulgarian   * `4` - Croatian   * `5` - Czech   * `6` - Danish   * `7`
+  # - Finnish   * `8` - English   * `9` - Greek   * `10` - Chinese   * `11` -
+  # Hungarian   * `12` - Italian   * `13` - Luxembourgish   * `14` - Malay   *
+  # `15` - Dutch   * `16` - Norwegian, Bokmal   * `17` - Urdu   * `18` - Polish
+  #  * `19` - Portuguese   * `20` - Romanian   * `21` - Russian   * `22` -
+  # Slovak   * `23` - Slovenian   * `24` - Spanish   * `25` - Swedish   * `26` -
+  # Turkish   * `27` - Thai   * `28` - Filipino   * `29` - Estonian   * `30` -
+  # Latvian   * `31` - Lithuanian
+  class CardDetailsResponseLocalPOSLanguageIDEnum
+    CARD_DETAILS_RESPONSE_LOCAL_POS_LANGUAGE_ID_ENUM = [
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = 2,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = 3,
+
+      # TODO: Write general description for ENUM_4
+      ENUM_4 = 4,
+
+      # TODO: Write general description for ENUM_5
+      ENUM_5 = 5,
+
+      # TODO: Write general description for ENUM_6
+      ENUM_6 = 6,
+
+      # TODO: Write general description for ENUM_7
+      ENUM_7 = 7,
+
+      # TODO: Write general description for ENUM_8
+      ENUM_8 = 8,
+
+      # TODO: Write general description for ENUM_9
+      ENUM_9 = 9,
+
+      # TODO: Write general description for ENUM_10
+      ENUM_10 = 10,
+
+      # TODO: Write general description for ENUM_11
+      ENUM_11 = 11,
+
+      # TODO: Write general description for ENUM_12
+      ENUM_12 = 12,
+
+      # TODO: Write general description for ENUM_13
+      ENUM_13 = 13,
+
+      # TODO: Write general description for ENUM_14
+      ENUM_14 = 14,
+
+      # TODO: Write general description for ENUM_15
+      ENUM_15 = 15,
+
+      # TODO: Write general description for ENUM_16
+      ENUM_16 = 16,
+
+      # TODO: Write general description for ENUM_17
+      ENUM_17 = 17,
+
+      # TODO: Write general description for ENUM_18
+      ENUM_18 = 18,
+
+      # TODO: Write general description for ENUM_19
+      ENUM_19 = 19,
+
+      # TODO: Write general description for ENUM_20
+      ENUM_20 = 20,
+
+      # TODO: Write general description for ENUM_21
+      ENUM_21 = 21,
+
+      # TODO: Write general description for ENUM_22
+      ENUM_22 = 22,
+
+      # TODO: Write general description for ENUM_23
+      ENUM_23 = 23,
+
+      # TODO: Write general description for ENUM_24
+      ENUM_24 = 24,
+
+      # TODO: Write general description for ENUM_25
+      ENUM_25 = 25,
+
+      # TODO: Write general description for ENUM_26
+      ENUM_26 = 26,
+
+      # TODO: Write general description for ENUM_27
+      ENUM_27 = 27,
+
+      # TODO: Write general description for ENUM_28
+      ENUM_28 = 28,
+
+      # TODO: Write general description for ENUM_29
+      ENUM_29 = 29,
+
+      # TODO: Write general description for ENUM_30
+      ENUM_30 = 30,
+
+      # TODO: Write general description for ENUM_31
+      ENUM_31 = 31
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_DETAILS_RESPONSE_LOCAL_POS_LANGUAGE_ID_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_details_response_non_fuel_sets_items.rb

@@ -0,0 +1,58 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Product restriction
+  class CardDetailsResponseNonFuelSetsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # product restriction identifier
+    # @return [Integer]
+    attr_accessor :product_restriction_id
+
+    # product set description.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_restriction_id'] = 'ProductRestrictionId'
+      @_hash['description'] = 'Description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_restriction_id = nil,
+                   description = nil)
+      @product_restriction_id = product_restriction_id
+      @description = description
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      product_restriction_id =
+        hash.key?('ProductRestrictionId') ? hash['ProductRestrictionId'] : nil
+      description = hash.key?('Description') ? hash['Description'] : nil
+
+      # Create object from extracted values.
+      CardDetailsResponseNonFuelSetsItems.new(product_restriction_id,
+                                              description)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_details_response_pin_delivery_address.rb

@@ -0,0 +1,231 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Delivery address.
+  class CardDetailsResponsePINDeliveryAddress < 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[
+        contact_fore_name
+        contact_middle_name
+        contact_last_name
+        contact_title
+        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.
+      CardDetailsResponsePINDeliveryAddress.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_details_response_pin_type_enum.rb

@@ -0,0 +1,23 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PIN type:   * `Card` - Card PIN   * `Fleet` - Fleet PIN
+  class CardDetailsResponsePINTypeEnum
+    CARD_DETAILS_RESPONSE_PIN_TYPE_ENUM = [
+      # TODO: Write general description for CARD
+      CARD = 'Card'.freeze,
+
+      # TODO: Write general description for FLEET
+      FLEET = 'Fleet'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_DETAILS_RESPONSE_PIN_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_details_response_reissue_setting_enum.rb

@@ -0,0 +1,26 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Reissue setting of the card. If the card is superseded (i.e. a
+  # replacement/new card is issued) then reissue setting of the latest card
+  # issued. Reissue setting:   * `True` - Card will be Reissued when nearing its
+  # expiry date   * `False` - Card will not be Reissued
+  class CardDetailsResponseReissueSettingEnum
+    CARD_DETAILS_RESPONSE_REISSUE_SETTING_ENUM = [
+      # TODO: Write general description for TRUE
+      TRUE = 'True'.freeze,
+
+      # TODO: Write general description for FALSE
+      FALSE = 'False'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_DETAILS_RESPONSE_REISSUE_SETTING_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_details_response_renewed_card_reissue_setting_enum.rb

@@ -0,0 +1,25 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Reissue setting of the renewed new card. Reissue Setting:   * `True` - Card
+  # will be sent to production   * `False` - Parent Card is Dormant or the Card
+  # is not to be produced
+  class CardDetailsResponseRenewedCardReissueSettingEnum
+    CARD_DETAILS_RESPONSE_RENEWED_CARD_REISSUE_SETTING_ENUM = [
+      # TODO: Write general description for TRUE
+      TRUE = 'True'.freeze,
+
+      # TODO: Write general description for FALSE
+      FALSE = 'False'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_DETAILS_RESPONSE_RENEWED_CARD_REISSUE_SETTING_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/card_details_response_status_id_enum.rb

@@ -0,0 +1,83 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Possible Id’s and description: * 1  Active * 7  Blocked Card * 8  Expired *
+  # 9  Cancelled * 10  New * 23  Pending Renewal * 31  Replaced * 41  Temporary
+  # Block (Customer) * 42  Temporary Block (Shell) * 43  Fraud * 101 Active
+  # (Block in progress) * * 102 Blocked Card (Unblock in progress) * * 103
+  # Active (Cancel in progress) * * 104 Active (Marked as damaged) * * 105 New
+  # (Cancel as damaged) * * 106 Active(Scheduled for block) ”# * 107 Blocked
+  # Card(Scheduled for unblock)*# * 108 Blocked Card (Cancel in progress) * >
+  # Note: •  Items marked with * are intermediate statuses  to indicate that
+  # there are pending requests in progress. , The response can contain these
+  # intermediate statuses only if the IncludeIntermediateStatus flag is true. •
+  # The placeholder “<Shell Card Platform Status>” in the items marked with #
+  # will be replaced with the Shell Card Platform status description. E.g.,
+  # “Active (Scheduled for block)”
+  class CardDetailsResponseStatusIdEnum
+    CARD_DETAILS_RESPONSE_STATUS_ID_ENUM = [
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1,
+
+      # TODO: Write general description for ENUM_7
+      ENUM_7 = 7,
+
+      # TODO: Write general description for ENUM_8
+      ENUM_8 = 8,
+
+      # TODO: Write general description for ENUM_9
+      ENUM_9 = 9,
+
+      # TODO: Write general description for ENUM_10
+      ENUM_10 = 10,
+
+      # TODO: Write general description for ENUM_23
+      ENUM_23 = 23,
+
+      # TODO: Write general description for ENUM_31
+      ENUM_31 = 31,
+
+      # TODO: Write general description for ENUM_41
+      ENUM_41 = 41,
+
+      # TODO: Write general description for ENUM_42
+      ENUM_42 = 42,
+
+      # TODO: Write general description for ENUM_43
+      ENUM_43 = 43,
+
+      # TODO: Write general description for ENUM_101
+      ENUM_101 = 101,
+
+      # TODO: Write general description for ENUM_102
+      ENUM_102 = 102,
+
+      # TODO: Write general description for ENUM_103
+      ENUM_103 = 103,
+
+      # TODO: Write general description for ENUM_104
+      ENUM_104 = 104,
+
+      # TODO: Write general description for ENUM_105
+      ENUM_105 = 105,
+
+      # TODO: Write general description for ENUM_106
+      ENUM_106 = 106,
+
+      # TODO: Write general description for ENUM_107
+      ENUM_107 = 107,
+
+      # TODO: Write general description for ENUM_108
+      ENUM_108 = 108
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_DETAILS_RESPONSE_STATUS_ID_ENUM.include?(value)
+    end
+  end
+end