card-management-sdk 1.1.0 → 1.2.0

data/lib/shell_card_management_ap_is/models/card_details_response.rb

@@ -52,8 +52,32 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :pan
 
-    # Card PAN. In the response body the PAN will be masked if the option is
-    # enabled in the Shell Card Platform.
+    # 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)”
     # @return [CardDetailsResponseStatusIdEnum]
     attr_accessor :status_id
 
@@ -94,7 +118,9 @@ module ShellCardManagementApIs
     # @return [TrueClass | FalseClass]
     attr_accessor :fleet_id_prompt
 
-    # True if fleet id input is enabled, else false
+    # PIN type:
+    #   * `Card` - Card PIN
+    #   * `Fleet` - Fleet PIN
     # @return [CardDetailsResponsePINTypeEnum]
     attr_accessor :pin_type
 
@@ -126,19 +152,143 @@ module ShellCardManagementApIs
     # @return [Object]
     attr_accessor :reissue_setting
 
-    # Issue number of the card
+    # 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
     # @return [CardDetailsResponseInternationalPOSLanguageIDEnum]
     attr_accessor :international_pos_language_id
 
-    # Issue number of the card
+    # POS language code. Language code:
+    #   * `deu` - German
+    #   * `fra` - French
+    #   * `bul` - Bulgarian
+    #   * `hrv` - Croatian
+    #   * `ces` - Czech
+    #   * `dan` - Danish
+    #   * `fin` - Finnish
+    #   * `eng` - English
+    #   * `ell` - Greek
+    #   * `zho` - Chinese
+    #   * `hun` - Hungarian
+    #   * `ita` - Italian
+    #   * `ltz` - Luxembourgish
+    #   * `msa` - Malay
+    #   * `nld` - Dutch
+    #   * `nob` - Norwegian, Bokmal
+    #   * `urd` - Urdu
+    #   * `pol` - Polish
+    #   * `por` - Portuguese
+    #   * `ron` - Romanian
+    #   * `rus` - Russian
+    #   * `slk` - Slovak
+    #   * `slv` - Slovenian
+    #   * `spa` - Spanish
+    #   * `swe` - Swedish
+    #   * `tur` - Turkish
+    #   * `tha` - Thai
+    #   * `fil` - Filipino
+    #   * `est` - Estonian
+    #   * `lav` - Latvian
+    #   * `lit` - Lithuanian
     # @return [CardDetailsResponseInternationalPOSLanguageCodeEnum]
     attr_accessor :international_pos_language_code
 
-    # Issue number of the card
+    # 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
     # @return [CardDetailsResponseInternationalPOSLanguageIDEnum]
     attr_accessor :local_pos_language_id
 
-    # Issue number of the card
+    # POS language code. Language code:
+    #   * `deu` - German
+    #   * `fra` - French
+    #   * `bul` - Bulgarian
+    #   * `hrv` - Croatian
+    #   * `ces` - Czech
+    #   * `dan` - Danish
+    #   * `fin` - Finnish
+    #   * `eng` - English
+    #   * `ell` - Greek
+    #   * `zho` - Chinese
+    #   * `hun` - Hungarian
+    #   * `ita` - Italian
+    #   * `ltz` - Luxembourgish
+    #   * `msa` - Malay
+    #   * `nld` - Dutch
+    #   * `nob` - Norwegian, Bokmal
+    #   * `urd` - Urdu
+    #   * `pol` - Polish
+    #   * `por` - Portuguese
+    #   * `ron` - Romanian
+    #   * `rus` - Russian
+    #   * `slk` - Slovak
+    #   * `slv` - Slovenian
+    #   * `spa` - Spanish
+    #   * `swe` - Swedish
+    #   * `tur` - Turkish
+    #   * `tha` - Thai
+    #   * `fil` - Filipino
+    #   * `est` - Estonian
+    #   * `lav` - Latvian
+    #   * `lit` - Lithuanian
     # @return [CardDetailsResponseInternationalPOSLanguageCodeEnum]
     attr_accessor :local_pos_language_code
 
@@ -291,7 +441,9 @@ module ShellCardManagementApIs
     # @return [Integer]
     attr_accessor :renewed_card_issue_number
 
-    # Renewed card issue number.
+    # 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
     # @return [CardDetailsResponseRenewedCardReissueSettingEnum]
     attr_accessor :renewed_card_reissue_setting
 

data/lib/shell_card_management_ap_is/models/card_group_request.rb

@@ -57,9 +57,9 @@ module ShellCardManagementApIs
     # Card Group Status
     # Mandatory
     # Allowed values:
-    # •	ALL
-    # •	TERMINATED
-    # •	ACTIVE
+    # •    ALL
+    # •    TERMINATED
+    # •    ACTIVE
     # @return [String]
     attr_accessor :status
 

data/lib/shell_card_management_ap_is/models/card_settings.rb

@@ -58,9 +58,9 @@ module ShellCardManagementApIs
     # Card delivery type.<br />
     # Mandatory <br />
     # Allowed Value: <br />
-    # 1.	Customer Address(Default) <br />
-    # 2.	New Delivery Address <br />
-    # 3.	Old Card Address
+    # 1.    Customer Address(Default) <br />
+    # 2.    New Delivery Address <br />
+    # 3.    Old Card Address
     # @return [Integer]
     attr_accessor :card_delivery_type
 
@@ -153,19 +153,19 @@ module ShellCardManagementApIs
     # PIN delivery address type selection.<br />
     # Optional<br />
     # Allowed Values:<br />
-    # 1.	Customer Address(Default)<br />
-    # 2.	Card Address<br />
-    # 3.	New Delivery Address
+    # 1.    Customer Address(Default)<br />
+    # 2.    Card Address<br />
+    # 3.    New Delivery Address
     # @return [Integer]
     attr_accessor :pin_delivery_address_type
 
     # PIN delivery method.<br />
     # Mandatory when OrderReplacement Is true.<br />
     # Allowed Values:<br />
-    # 1.	Paper<br />
-    # 2.	Email<br />
-    # 3.	SMS<br />
-    # 4.	None
+    # 1.    Paper<br />
+    # 2.    Email<br />
+    # 3.    SMS<br />
+    # 4.    None
     # @return [Integer]
     attr_accessor :pin_advice_type
 

data/lib/shell_card_management_ap_is/models/create_bundle_request.rb

@@ -73,7 +73,7 @@ module ShellCardManagementApIs
     # Example: 7002051006629890645
     # When PAN matches with multiple cards, the restriction will be applied on
     # the latest issued card.
-    # @return [BundleRestriction]
+    # @return [Object]
     attr_accessor :restrictions
 
     # A mapping from model property names to API property names.
@@ -117,7 +117,6 @@ module ShellCardManagementApIs
         account_id
         account_number
         external_bundle_id
-        restrictions
       ]
     end
 
@@ -152,7 +151,7 @@ module ShellCardManagementApIs
         hash.key?('ExternalBundleId') ? hash['ExternalBundleId'] : SKIP
       description = hash.key?('Description') ? hash['Description'] : SKIP
       cards = hash.key?('Cards') ? hash['Cards'] : SKIP
-      restrictions = BundleRestriction.from_hash(hash['Restrictions']) if hash['Restrictions']
+      restrictions = hash.key?('Restrictions') ? hash['Restrictions'] : SKIP
 
       # Create object from extracted values.
       CreateBundleRequest.new(col_co_id,

data/lib/shell_card_management_ap_is/models/customer_detail_response.rb

@@ -54,20 +54,20 @@ module ShellCardManagementApIs
     attr_accessor :billing_address
 
     # Card group position at –
-    # •	Payer – Payer level
-    # •	Account – Account level
+    # •    Payer – Payer level
+    # •    Account – Account level
     # @return [String]
     attr_accessor :card_group_position
 
     # Card group position at –
-    # •	Payer – Payer level
-    # •	Account – Account level
+    # •    Payer – Payer level
+    # •    Account – Account level
     # @return [Address]
     attr_accessor :correspondence_address
 
     # Card group position at –
-    # •	Payer – Payer level
-    # •	Account – Account level
+    # •    Payer – Payer level
+    # •    Account – Account level
     # @return [Array[DeliveryAddresses]]
     attr_accessor :delivery_addresses
 
@@ -132,28 +132,28 @@ module ShellCardManagementApIs
 
     # Default PIN AdviceType of the customer.
     # Possible Values:
-    # 1.	Paper
-    # 2.	Email
-    # 3.	SMS
-    # 4.	None
+    # 1.    Paper
+    # 2.    Email
+    # 3.    SMS
+    # 4.    None
     # @return [Integer]
     attr_accessor :default_pin_advice_type
 
     # Default PIN AdviceType of the customer.
     # Possible Values:
-    # 1.	Paper
-    # 2.	Email
-    # 3.	SMS
-    # 4.	None
+    # 1.    Paper
+    # 2.    Email
+    # 3.    SMS
+    # 4.    None
     # @return [Array[PINAdviceTypes]]
     attr_accessor :pin_advice_types
 
     # Default PIN AdviceType of the customer.
     # Possible Values:
-    # 1.	Paper
-    # 2.	Email
-    # 3.	SMS
-    # 4.	None
+    # 1.    Paper
+    # 2.    Email
+    # 3.    SMS
+    # 4.    None
     # @return [ErrorStatus]
     attr_accessor :error
 

data/lib/shell_card_management_ap_is/models/day_time_restriction.rb

@@ -41,7 +41,7 @@ module ShellCardManagementApIs
     # Card could be used from this time in a day.
     # Format: HH:mm (24-hour format)
     # Note: 
-    # 1.	Clients to convert this to appropriate DateTime or TimeSpan type.
+    # 1.    Clients to convert this to appropriate DateTime or TimeSpan type.
     # “00:00” is the lowest time value and “23:59” is the highest time value.
     # @return [String]
     attr_accessor :time_from
@@ -49,7 +49,7 @@ module ShellCardManagementApIs
     # Card could be used up to this time in a day. 
     # Format: HH:mm (24-hour format)
     # Note: 
-    # 1.	Clients to convert this to appropriate DateTime or TimeSpan type. 
+    # 1.    Clients to convert this to appropriate DateTime or TimeSpan type. 
     # “00:00” is the lowest time value and “23:59” is the highest time value.
     # @return [String]
     attr_accessor :time_to

data/lib/shell_card_management_ap_is/models/day_time_restrictions.rb

@@ -0,0 +1,132 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # DayTimeRestrictions Model.
+  class DayTimeRestrictions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # True if card could be used on a Monday, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :monday
+
+    # True if card could be used on a Tuesday, else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tuesday
+
+    # True if card could be used on a Wednesday, else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :wednesday
+
+    # True if card could be used on a Thursday, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :thursday
+
+    # True if card could be used on a Friday, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :friday
+
+    # True if card could be used on a Saturday, else false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :saturday
+
+    # True if card could be used on a Sunday, else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :sunday
+
+    # Card could be used from this time in a day.
+    # Format: HH:mm (24-hour format)
+    # Note: 
+    # 1.    Clients to convert this to appropriate DateTime or TimeSpan type.
+    # “00:00” is the lowest time value and “23:59” is the highest time value.
+    # @return [String]
+    attr_accessor :time_from
+
+    # Card could be used up to this time in a day. 
+    # Format: HH:mm (24-hour format)
+    # Note: 
+    # 1.    Clients to convert this to appropriate DateTime or TimeSpan type. 
+    # “00:00” is the lowest time value and “23:59” is the highest time value.
+    # @return [String]
+    attr_accessor :time_to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['monday'] = 'Monday'
+      @_hash['tuesday'] = 'Tuesday'
+      @_hash['wednesday'] = 'Wednesday'
+      @_hash['thursday'] = 'Thursday'
+      @_hash['friday'] = 'Friday'
+      @_hash['saturday'] = 'Saturday'
+      @_hash['sunday'] = 'Sunday'
+      @_hash['time_from'] = 'TimeFrom'
+      @_hash['time_to'] = 'TimeTo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        monday
+        tuesday
+        wednesday
+        thursday
+        friday
+        saturday
+        sunday
+        time_from
+        time_to
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(monday = SKIP, tuesday = SKIP, wednesday = SKIP,
+                   thursday = SKIP, friday = SKIP, saturday = SKIP,
+                   sunday = SKIP, time_from = SKIP, time_to = SKIP)
+      @monday = monday unless monday == SKIP
+      @tuesday = tuesday unless tuesday == SKIP
+      @wednesday = wednesday unless wednesday == SKIP
+      @thursday = thursday unless thursday == SKIP
+      @friday = friday unless friday == SKIP
+      @saturday = saturday unless saturday == SKIP
+      @sunday = sunday unless sunday == SKIP
+      @time_from = time_from unless time_from == SKIP
+      @time_to = time_to unless time_to == 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.
+      monday = hash.key?('Monday') ? hash['Monday'] : SKIP
+      tuesday = hash.key?('Tuesday') ? hash['Tuesday'] : SKIP
+      wednesday = hash.key?('Wednesday') ? hash['Wednesday'] : SKIP
+      thursday = hash.key?('Thursday') ? hash['Thursday'] : SKIP
+      friday = hash.key?('Friday') ? hash['Friday'] : SKIP
+      saturday = hash.key?('Saturday') ? hash['Saturday'] : SKIP
+      sunday = hash.key?('Sunday') ? hash['Sunday'] : SKIP
+      time_from = hash.key?('TimeFrom') ? hash['TimeFrom'] : SKIP
+      time_to = hash.key?('TimeTo') ? hash['TimeTo'] : SKIP
+
+      # Create object from extracted values.
+      DayTimeRestrictions.new(monday,
+                              tuesday,
+                              wednesday,
+                              thursday,
+                              friday,
+                              saturday,
+                              sunday,
+                              time_from,
+                              time_to)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/filters.rb

@@ -334,9 +334,9 @@ module ShellCardManagementApIs
     # If ‘ALL’, API will return cards with ReIssueSetting value True & False
     # both.<br />
     # Allowed Values:<br />
-    # 1.	All<br />
-    # 2.	True<br />
-    # 3.	False
+    # 1.    All<br />
+    # 2.    True<br />
+    # 3.    False
     # @return [String]
     attr_accessor :reissue_setting
 
@@ -351,9 +351,9 @@ module ShellCardManagementApIs
     # If ‘ALL’, API will return cards with ReIssueSetting value True &amp; False
     # both.<br />
     # Allowed Values:<br />
-    # 1.	All<br />
-    # 2.	True<br />
-    # 3.	False
+    # 1.    All<br />
+    # 2.    True<br />
+    # 3.    False
     # @return [String]
     attr_accessor :request_id
 

data/lib/shell_card_management_ap_is/models/filters1.rb

@@ -270,9 +270,9 @@ module ShellCardManagementApIs
     # If ‘ALL’, API will return cards with ReIssueSetting value True & False
     # both.<br />
     # Allowed Values:<br />
-    # 1.	All<br />
-    # 2.	True<br />
-    # 3.	False
+    # 1.    All<br />
+    # 2.    True<br />
+    # 3.    False
     # @return [String]
     attr_accessor :reissue_setting
 
@@ -287,9 +287,9 @@ module ShellCardManagementApIs
     # If ‘ALL’, API will return cards with ReIssueSetting value True &amp; False
     # both.<br />
     # Allowed Values:<br />
-    # 1.	All<br />
-    # 2.	True<br />
-    # 3.	False
+    # 1.    All<br />
+    # 2.    True<br />
+    # 3.    False
     # @return [String]
     attr_accessor :request_id
 

data/lib/shell_card_management_ap_is/models/filters2.rb

@@ -53,9 +53,15 @@ module ShellCardManagementApIs
     # @return [Integer]
     attr_accessor :reference_number
 
-    # Reference number of the Card Order/ Bulk Card Order/ Order Card
-    # Request.<br />
-    # Mandatory when ColCo and Payer fields are not provided. Else, optional.
+    # Type of the reference number provided.<br />
+    # Mandatory if ReferenceNumber is provided. Else optional.<br />
+    # Allowed Values:<br />
+    # 1=Main Reference(Main Order Reference Number returned in the output of
+    # Card/OrderCard service. <br />
+    # 2=Order Card Reference (Reference number for each individual card in the
+    # order submitted via Card/OrderCard service. <br />
+    # 3=Bulk Order Card Reference (Reference number returned in the response of
+    # bulkcardinterface /UploadOrderCardTemplate. )
     # @return [OrderCardEnquiryReqReferenceTypeEnum]
     attr_accessor :reference_type
 

data/lib/shell_card_management_ap_is/models/fleetmanagement_v1_customer_payers400_error1.rb

@@ -0,0 +1,50 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # FleetmanagementV1CustomerPayers400Error1 Model.
+  class FleetmanagementV1CustomerPayers400Error1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Fault]
+    attr_accessor :fault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fault'] = 'fault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fault = SKIP)
+      @fault = fault unless fault == 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.
+      fault = Fault.from_hash(hash['fault']) if hash['fault']
+
+      # Create object from extracted values.
+      FleetmanagementV1CustomerPayers400Error1.new(fault)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/fleetmanagement_v1_customer_payers404_error1.rb

@@ -0,0 +1,50 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # FleetmanagementV1CustomerPayers404Error1 Model.
+  class FleetmanagementV1CustomerPayers404Error1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Fault]
+    attr_accessor :fault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fault'] = 'fault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fault = SKIP)
+      @fault = fault unless fault == 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.
+      fault = Fault.from_hash(hash['fault']) if hash['fault']
+
+      # Create object from extracted values.
+      FleetmanagementV1CustomerPayers404Error1.new(fault)
+    end
+  end
+end