card-management-sdk 1.0.0 → 1.1.0

data/lib/shell_card_management_ap_is/models/bundle_details_response.rb

@@ -0,0 +1,181 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # BundleDetailsResponse Model.
+  class BundleDetailsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Payer Id of the bundles and cards.
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the bundles and cards.
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Account ID of the bundle.
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the bundle.
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :account_number
+
+    # unique identifier for the Card Bundle
+    # @return [String]
+    attr_accessor :bundle_id
+
+    # External system allocated Card Bundle identifier for Card Bundle.
+    # @return [String]
+    attr_accessor :external_bundle_id
+
+    # Card Bundle Description.
+    # @return [String]
+    attr_accessor :description
+
+    # List of Card Pans added to the card bundle.
+    # @return [Array[String]]
+    attr_accessor :pans
+
+    # ISO currency code of the country.
+    # Example: GBP
+    # @return [String]
+    attr_accessor :restriction_currency_code
+
+    # Currency symbol of the country.
+    # Example: £, $
+    # @return [String]
+    attr_accessor :restriction_currency_symbol
+
+    # Currency symbol of the country.
+    # Example: £, $
+    # @return [BundledRestrictionsList]
+    attr_accessor :restrictions
+
+    # Currency symbol of the country.
+    # Example: £, $
+    # @return [ErrorStatus]
+    attr_accessor :error
+
+    # API Request Id
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['bundle_id'] = 'BundleId'
+      @_hash['external_bundle_id'] = 'ExternalBundleId'
+      @_hash['description'] = 'Description'
+      @_hash['pans'] = 'Pans'
+      @_hash['restriction_currency_code'] = 'RestrictionCurrencyCode'
+      @_hash['restriction_currency_symbol'] = 'RestrictionCurrencySymbol'
+      @_hash['restrictions'] = 'Restrictions'
+      @_hash['error'] = 'Error'
+      @_hash['request_id'] = 'RequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payer_id
+        payer_number
+        account_id
+        account_number
+        bundle_id
+        external_bundle_id
+        description
+        pans
+        restriction_currency_code
+        restriction_currency_symbol
+        restrictions
+        error
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payer_id = SKIP, payer_number = SKIP, account_id = SKIP,
+                   account_number = SKIP, bundle_id = SKIP,
+                   external_bundle_id = SKIP, description = SKIP, pans = SKIP,
+                   restriction_currency_code = SKIP,
+                   restriction_currency_symbol = SKIP, restrictions = SKIP,
+                   error = SKIP, request_id = 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
+      @account_number = account_number unless account_number == 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
+      @pans = pans unless pans == 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
+      @restrictions = restrictions unless restrictions == SKIP
+      @error = error unless error == SKIP
+      @request_id = request_id unless request_id == 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.
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      bundle_id = hash.key?('BundleId') ? hash['BundleId'] : SKIP
+      external_bundle_id =
+        hash.key?('ExternalBundleId') ? hash['ExternalBundleId'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      pans = hash.key?('Pans') ? hash['Pans'] : SKIP
+      restriction_currency_code =
+        hash.key?('RestrictionCurrencyCode') ? hash['RestrictionCurrencyCode'] : SKIP
+      restriction_currency_symbol =
+        hash.key?('RestrictionCurrencySymbol') ? hash['RestrictionCurrencySymbol'] : SKIP
+      restrictions = BundledRestrictionsList.from_hash(hash['Restrictions']) if
+        hash['Restrictions']
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+
+      # Create object from extracted values.
+      BundleDetailsResponse.new(payer_id,
+                                payer_number,
+                                account_id,
+                                account_number,
+                                bundle_id,
+                                external_bundle_id,
+                                description,
+                                pans,
+                                restriction_currency_code,
+                                restriction_currency_symbol,
+                                restrictions,
+                                error,
+                                request_id)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/bundle_restriction.rb

@@ -9,77 +9,59 @@ module ShellCardManagementApIs
     SKIP = Object.new
     private_constant :SKIP
 
-    # True/False
-    # A value indicates if the day/time restriction is to be reset for card
-    # bundle.
-    # Optional
-    # Default value is False.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :reset_day_time_restriction
-
-    # True/False
-    # A value indicates if the location restriction is to be reset for card
-    # bundle.
-    # Optional
-    # Default value is False.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :reset_location_restriction
-
-    # True/False
-    # A value indicates if the product restriction is to be reset for card
-    # bundle.
-    # Optional
-    # Default value is False.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :reset_product_restriction
-
-    # True/False
-    # A value indicates if the product restriction is to be reset for card
-    # bundle.
-    # Optional
-    # Default value is False.
-    # @return [UsageRestrictions]
+    # The value indicates what actions to be performed with respect to day time
+    # restriction. 
+    # Mandatory
+    # Allowed values –
+    # •	Add: Apply the given restriction on the bundle.
+    # •	Default: No Day/Time restriction will be applied on the bundle in
+    # Gateway.
+    # @return [String]
+    attr_accessor :day_time_restriction_action
+
+    # The value indicates what actions to be performed with respect to location
+    # restriction. 
+    # Mandatory
+    # Allowed values –
+    # •	Add: Apply the given restriction on the bundle.
+    # •	Default: No location restriction will be applied on the bundle in
+    # Gateway.
+    # @return [String]
+    attr_accessor :location_restriction_action
+
+    # The value indicates what actions to be performed with respect to location
+    # restriction. 
+    # Mandatory
+    # Allowed values –
+    # •	Add: Apply the given restriction on the bundle.
+    # •	Default: No location restriction will be applied on the bundle in
+    # Gateway.
+    # @return [UsageRestrictionsCard]
     attr_accessor :usage_restrictions
 
-    # Day/time restrictions such as weekdays and time range to be applied on the
-    # bundle.
-    # Mandatory if respective action is set as “Add”.
-    # The details of DayTimeRestriction entity is given below.
-    # @return [DayTimeRestrictions]
+    # 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
 
-    # Day/time restrictions such as weekdays and time range to be applied on the
-    # bundle.
-    # Mandatory if respective action is set as “Add”.
-    # The details of DayTimeRestriction entity is given below.
-    # @return [ProductRestrictions]
-    attr_accessor :product_restriction
-
-    # Identifier of the location restriction profile to be updated for the
-    # bundle in Gateway.
-    # Optional
-    # @return [String]
-    attr_accessor :location_restriction_profile_id
+    # Details of the day/time restrictions such as weekdays and time range in
+    # which transactions should be allowed on the card.
+    # @return [ProductRestrictionCard]
+    attr_accessor :product_restrictions
 
-    # Location restrictions to be applied on the bundle which either allows or
-    # restricts using the cards, which are under the bundle, in the specified
-    # locations. 
-    # Mandatory if respective action is set as “Add”.
-    # Details of location restrictions are given below.
-    # @return [LocationRestrictions]
+    # 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['reset_day_time_restriction'] = 'ResetDayTimeRestriction'
-      @_hash['reset_location_restriction'] = 'ResetLocationRestriction'
-      @_hash['reset_product_restriction'] = 'ResetProductRestriction'
+      @_hash['day_time_restriction_action'] = 'DayTimeRestrictionAction'
+      @_hash['location_restriction_action'] = 'LocationRestrictionAction'
       @_hash['usage_restrictions'] = 'UsageRestrictions'
       @_hash['day_time_restrictions'] = 'DayTimeRestrictions'
-      @_hash['product_restriction'] = 'ProductRestriction'
-      @_hash['location_restriction_profile_id'] =
-        'LocationRestrictionProfileId'
+      @_hash['product_restrictions'] = 'ProductRestrictions'
       @_hash['location_restrictions'] = 'LocationRestrictions'
       @_hash
     end
@@ -87,49 +69,40 @@ module ShellCardManagementApIs
     # An array for optional fields
     def self.optionals
       %w[
-        reset_day_time_restriction
-        reset_location_restriction
-        reset_product_restriction
+        day_time_restriction_action
+        location_restriction_action
         usage_restrictions
         day_time_restrictions
-        product_restriction
-        location_restriction_profile_id
+        product_restrictions
         location_restrictions
       ]
     end
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        day_time_restriction_action
+        location_restriction_action
+        usage_restrictions
+        product_restrictions
+      ]
     end
 
-    def initialize(reset_day_time_restriction = false,
-                   reset_location_restriction = false,
-                   reset_product_restriction = false,
-                   usage_restrictions = SKIP,
-                   day_time_restrictions = SKIP,
-                   product_restriction = SKIP,
-                   location_restriction_profile_id = SKIP,
-                   location_restrictions = SKIP)
-      unless reset_day_time_restriction == SKIP
-        @reset_day_time_restriction =
-          reset_day_time_restriction
-      end
-      unless reset_location_restriction == SKIP
-        @reset_location_restriction =
-          reset_location_restriction
+    def initialize(day_time_restriction_action = SKIP,
+                   location_restriction_action = SKIP,
+                   usage_restrictions = SKIP, day_time_restrictions = SKIP,
+                   product_restrictions = SKIP, location_restrictions = SKIP)
+      unless day_time_restriction_action == SKIP
+        @day_time_restriction_action =
+          day_time_restriction_action
       end
-      unless reset_product_restriction == SKIP
-        @reset_product_restriction =
-          reset_product_restriction
+      unless location_restriction_action == SKIP
+        @location_restriction_action =
+          location_restriction_action
       end
       @usage_restrictions = usage_restrictions unless usage_restrictions == SKIP
       @day_time_restrictions = day_time_restrictions unless day_time_restrictions == SKIP
-      @product_restriction = product_restriction unless product_restriction == SKIP
-      unless location_restriction_profile_id == SKIP
-        @location_restriction_profile_id =
-          location_restriction_profile_id
-      end
+      @product_restrictions = product_restrictions unless product_restrictions == SKIP
       @location_restrictions = location_restrictions unless location_restrictions == SKIP
     end
 
@@ -138,28 +111,25 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      reset_day_time_restriction = hash['ResetDayTimeRestriction'] ||= false
-      reset_location_restriction = hash['ResetLocationRestriction'] ||= false
-      reset_product_restriction = hash['ResetProductRestriction'] ||= false
-      usage_restrictions = UsageRestrictions.from_hash(hash['UsageRestrictions']) if
+      day_time_restriction_action =
+        hash.key?('DayTimeRestrictionAction') ? hash['DayTimeRestrictionAction'] : SKIP
+      location_restriction_action =
+        hash.key?('LocationRestrictionAction') ? hash['LocationRestrictionAction'] : SKIP
+      usage_restrictions = UsageRestrictionsCard.from_hash(hash['UsageRestrictions']) if
         hash['UsageRestrictions']
-      day_time_restrictions = DayTimeRestrictions.from_hash(hash['DayTimeRestrictions']) if
+      day_time_restrictions = DayTimeRestriction.from_hash(hash['DayTimeRestrictions']) if
         hash['DayTimeRestrictions']
-      product_restriction = ProductRestrictions.from_hash(hash['ProductRestriction']) if
-        hash['ProductRestriction']
-      location_restriction_profile_id =
-        hash.key?('LocationRestrictionProfileId') ? hash['LocationRestrictionProfileId'] : SKIP
-      location_restrictions = LocationRestrictions.from_hash(hash['LocationRestrictions']) if
+      product_restrictions = ProductRestrictionCard.from_hash(hash['ProductRestrictions']) if
+        hash['ProductRestrictions']
+      location_restrictions = LocationRestriction.from_hash(hash['LocationRestrictions']) if
         hash['LocationRestrictions']
 
       # Create object from extracted values.
-      BundleRestriction.new(reset_day_time_restriction,
-                            reset_location_restriction,
-                            reset_product_restriction,
+      BundleRestriction.new(day_time_restriction_action,
+                            location_restriction_action,
                             usage_restrictions,
                             day_time_restrictions,
-                            product_restriction,
-                            location_restriction_profile_id,
+                            product_restrictions,
                             location_restrictions)
     end
   end

data/lib/shell_card_management_ap_is/models/bundle_restriction_update.rb

@@ -0,0 +1,187 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # BundleRestrictionUpdate Model.
+  class BundleRestrictionUpdate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # True/False
+    # A value indicates if the day/time restriction is to be reset for card
+    # bundle.
+    # Optional
+    # Default value is False.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_day_time_restriction
+
+    # True/False
+    # A value indicates if the location restriction is to be reset for card
+    # bundle.
+    # Optional
+    # Default value is False.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_location_restriction
+
+    # True/False
+    # A value indicates if the product restriction is to be reset for card
+    # bundle.
+    # Optional
+    # Default value is False.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reset_product_restriction
+
+    # True/False
+    # A value indicates if the product restriction is to be reset for card
+    # bundle.
+    # Optional
+    # Default value is False.
+    # @return [UsageRestrictionsCard]
+    attr_accessor :usage_restrictions
+
+    # Identifier of the day/time restriction profile to be updated for the
+    # bundle in Gateway.
+    # Optional
+    # @return [String]
+    attr_accessor :day_time_restriction_profile_id
+
+    # Identifier of the day/time restriction profile to be updated for the
+    # bundle in Gateway.
+    # Optional
+    # @return [CardDayTimeRestrictions]
+    attr_accessor :day_time_restrictions
+
+    # Identifier of the day/time restriction profile to be updated for the
+    # bundle in Gateway.
+    # Optional
+    # @return [ProductRestrictionCard]
+    attr_accessor :product_restrictions
+
+    # Identifier of the location restriction profile to be updated for the
+    # bundle in Gateway.
+    # Optional
+    # @return [String]
+    attr_accessor :location_restriction_profile_id
+
+    # Identifier of the location restriction profile to be updated for the
+    # bundle in Gateway.
+    # Optional
+    # @return [LocationRestriction]
+    attr_accessor :location_restrictions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reset_day_time_restriction'] = 'ResetDayTimeRestriction'
+      @_hash['reset_location_restriction'] = 'ResetLocationRestriction'
+      @_hash['reset_product_restriction'] = 'ResetProductRestriction'
+      @_hash['usage_restrictions'] = 'UsageRestrictions'
+      @_hash['day_time_restriction_profile_id'] =
+        'DayTimeRestrictionProfileId'
+      @_hash['day_time_restrictions'] = 'DayTimeRestrictions'
+      @_hash['product_restrictions'] = 'ProductRestrictions'
+      @_hash['location_restriction_profile_id'] =
+        'LocationRestrictionProfileId'
+      @_hash['location_restrictions'] = 'LocationRestrictions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reset_day_time_restriction
+        reset_location_restriction
+        reset_product_restriction
+        usage_restrictions
+        day_time_restriction_profile_id
+        day_time_restrictions
+        product_restrictions
+        location_restriction_profile_id
+        location_restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reset_day_time_restriction
+        reset_location_restriction
+        reset_product_restriction
+        usage_restrictions
+        day_time_restriction_profile_id
+        product_restrictions
+      ]
+    end
+
+    def initialize(reset_day_time_restriction = SKIP,
+                   reset_location_restriction = SKIP,
+                   reset_product_restriction = SKIP, usage_restrictions = SKIP,
+                   day_time_restriction_profile_id = SKIP,
+                   day_time_restrictions = SKIP, product_restrictions = SKIP,
+                   location_restriction_profile_id = SKIP,
+                   location_restrictions = SKIP)
+      unless reset_day_time_restriction == SKIP
+        @reset_day_time_restriction =
+          reset_day_time_restriction
+      end
+      unless reset_location_restriction == SKIP
+        @reset_location_restriction =
+          reset_location_restriction
+      end
+      unless reset_product_restriction == SKIP
+        @reset_product_restriction =
+          reset_product_restriction
+      end
+      @usage_restrictions = usage_restrictions unless usage_restrictions == SKIP
+      unless day_time_restriction_profile_id == SKIP
+        @day_time_restriction_profile_id =
+          day_time_restriction_profile_id
+      end
+      @day_time_restrictions = day_time_restrictions unless day_time_restrictions == SKIP
+      @product_restrictions = product_restrictions unless product_restrictions == SKIP
+      unless location_restriction_profile_id == SKIP
+        @location_restriction_profile_id =
+          location_restriction_profile_id
+      end
+      @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.
+      reset_day_time_restriction =
+        hash.key?('ResetDayTimeRestriction') ? hash['ResetDayTimeRestriction'] : SKIP
+      reset_location_restriction =
+        hash.key?('ResetLocationRestriction') ? hash['ResetLocationRestriction'] : SKIP
+      reset_product_restriction =
+        hash.key?('ResetProductRestriction') ? hash['ResetProductRestriction'] : SKIP
+      usage_restrictions = UsageRestrictionsCard.from_hash(hash['UsageRestrictions']) if
+        hash['UsageRestrictions']
+      day_time_restriction_profile_id =
+        hash.key?('DayTimeRestrictionProfileId') ? hash['DayTimeRestrictionProfileId'] : SKIP
+      day_time_restrictions = CardDayTimeRestrictions.from_hash(hash['DayTimeRestrictions']) if
+        hash['DayTimeRestrictions']
+      product_restrictions = ProductRestrictionCard.from_hash(hash['ProductRestrictions']) if
+        hash['ProductRestrictions']
+      location_restriction_profile_id =
+        hash.key?('LocationRestrictionProfileId') ? hash['LocationRestrictionProfileId'] : SKIP
+      location_restrictions = LocationRestriction.from_hash(hash['LocationRestrictions']) if
+        hash['LocationRestrictions']
+
+      # Create object from extracted values.
+      BundleRestrictionUpdate.new(reset_day_time_restriction,
+                                  reset_location_restriction,
+                                  reset_product_restriction,
+                                  usage_restrictions,
+                                  day_time_restriction_profile_id,
+                                  day_time_restrictions,
+                                  product_restrictions,
+                                  location_restriction_profile_id,
+                                  location_restrictions)
+    end
+  end
+end