paypal-server-sdk 2.1.0 → 2.3.0

data/lib/paypal_server_sdk/models/ideal_payment_request.rb

@@ -13,11 +13,12 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :name
 
-    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
-    # that identifies the country or region. Note: The country code for Great
-    # Britain is GB and not UK as used in the top-level domain names for that
-    # country. Use the `C2` country code for China worldwide for comparable
-    # uncontrolled price (CUP) method, bank card, and cross-border transactions.
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) that
+    # identifies the country or region. Note: The country code for Great Britain
+    # is GB and not UK as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.
     # @return [String]
     attr_accessor :country_code
 

data/lib/paypal_server_sdk/models/link_description.rb

@@ -4,7 +4,12 @@
 # ( https://www.apimatic.io ).
 
 module PaypalServerSdk
-  # The request-related [HATEOAS link](/api/rest/responses/#hateoas-links)
+  # The request-related [HATEOAS
+  # link](https://developer.paypal.com/api/rest/responses/#hateoas-links)
+  # information., The request-related [HATEOAS
+  # link](/api/rest/responses/#hateoas-links) information., The request-related
+  # [HATEOAS
+  # link](https://developer.paypal.com/api/rest/responses/#hateoas-links)
   # information.
   class LinkDescription < BaseModel
     SKIP = Object.new

data/lib/paypal_server_sdk/models/money.rb

@@ -11,7 +11,8 @@ module PaypalServerSdk
     private_constant :SKIP
 
     # The [three-character ISO-4217 currency
-    # code](/api/rest/reference/currency-codes/) that identifies the currency.
+    # code](https://developer.paypal.com/api/rest/reference/currency-codes/)
+    # that identifies the currency.
     # @return [String]
     attr_accessor :currency_code
 
@@ -19,7 +20,7 @@ module PaypalServerSdk
     # not typically fractional. A decimal fraction for currencies like `TND`
     # that are subdivided into thousandths. For the required number of decimal
     # places for a currency code, see [Currency
-    # Codes](/api/rest/reference/currency-codes/).
+    # Codes](https://developer.paypal.com/api/rest/reference/currency-codes/).
     # @return [String]
     attr_accessor :value
 

data/lib/paypal_server_sdk/models/mybank_payment_object.rb

@@ -13,11 +13,12 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :name
 
-    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
-    # that identifies the country or region. Note: The country code for Great
-    # Britain is GB and not UK as used in the top-level domain names for that
-    # country. Use the `C2` country code for China worldwide for comparable
-    # uncontrolled price (CUP) method, bank card, and cross-border transactions.
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) that
+    # identifies the country or region. Note: The country code for Great Britain
+    # is GB and not UK as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.
     # @return [String]
     attr_accessor :country_code
 

data/lib/paypal_server_sdk/models/mybank_payment_request.rb

@@ -13,11 +13,12 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :name
 
-    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
-    # that identifies the country or region. Note: The country code for Great
-    # Britain is GB and not UK as used in the top-level domain names for that
-    # country. Use the `C2` country code for China worldwide for comparable
-    # uncontrolled price (CUP) method, bank card, and cross-border transactions.
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) that
+    # identifies the country or region. Note: The country code for Great Britain
+    # is GB and not UK as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.
     # @return [String]
     attr_accessor :country_code
 

data/lib/paypal_server_sdk/models/order.rb

@@ -36,6 +36,10 @@ module PaypalServerSdk
     # @return [CheckoutPaymentIntent]
     attr_accessor :intent
 
+    # The instruction to process an order.
+    # @return [ProcessingInstruction]
+    attr_accessor :processing_instruction
+
     # DEPRECATED. The customer is also known as the payer. The Payer object was
     # intended to only be used with the `payment_source.paypal` object. In order
     # to make this design more clear, the details in the `payer` object are now
@@ -77,6 +81,7 @@ module PaypalServerSdk
       @_hash['id'] = 'id'
       @_hash['payment_source'] = 'payment_source'
       @_hash['intent'] = 'intent'
+      @_hash['processing_instruction'] = 'processing_instruction'
       @_hash['payer'] = 'payer'
       @_hash['purchase_units'] = 'purchase_units'
       @_hash['status'] = 'status'
@@ -92,6 +97,7 @@ module PaypalServerSdk
         id
         payment_source
         intent
+        processing_instruction
         payer
         purchase_units
         status
@@ -105,13 +111,15 @@ module PaypalServerSdk
     end
 
     def initialize(create_time: SKIP, update_time: SKIP, id: SKIP,
-                   payment_source: SKIP, intent: SKIP, payer: SKIP,
+                   payment_source: SKIP, intent: SKIP,
+                   processing_instruction: SKIP, payer: SKIP,
                    purchase_units: SKIP, status: SKIP, links: SKIP)
       @create_time = create_time unless create_time == SKIP
       @update_time = update_time unless update_time == SKIP
       @id = id unless id == SKIP
       @payment_source = payment_source unless payment_source == SKIP
       @intent = intent unless intent == SKIP
+      @processing_instruction = processing_instruction unless processing_instruction == SKIP
       @payer = payer unless payer == SKIP
       @purchase_units = purchase_units unless purchase_units == SKIP
       @status = status unless status == SKIP
@@ -129,6 +137,8 @@ module PaypalServerSdk
       payment_source = PaymentSourceResponse.from_hash(hash['payment_source']) if
         hash['payment_source']
       intent = hash.key?('intent') ? hash['intent'] : SKIP
+      processing_instruction =
+        hash.key?('processing_instruction') ? hash['processing_instruction'] : SKIP
       payer = Payer.from_hash(hash['payer']) if hash['payer']
       # Parameter is an array, so we need to iterate through it
       purchase_units = nil
@@ -158,6 +168,7 @@ module PaypalServerSdk
                 id: id,
                 payment_source: payment_source,
                 intent: intent,
+                processing_instruction: processing_instruction,
                 payer: payer,
                 purchase_units: purchase_units,
                 status: status,
@@ -168,8 +179,9 @@ module PaypalServerSdk
     def to_s
       class_name = self.class.name.split('::').last
       "<#{class_name} create_time: #{@create_time}, update_time: #{@update_time}, id: #{@id},"\
-      " payment_source: #{@payment_source}, intent: #{@intent}, payer: #{@payer}, purchase_units:"\
-      " #{@purchase_units}, status: #{@status}, links: #{@links}>"
+      " payment_source: #{@payment_source}, intent: #{@intent}, processing_instruction:"\
+      " #{@processing_instruction}, payer: #{@payer}, purchase_units: #{@purchase_units}, status:"\
+      " #{@status}, links: #{@links}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -177,8 +189,9 @@ module PaypalServerSdk
       class_name = self.class.name.split('::').last
       "<#{class_name} create_time: #{@create_time.inspect}, update_time: #{@update_time.inspect},"\
       " id: #{@id.inspect}, payment_source: #{@payment_source.inspect}, intent:"\
-      " #{@intent.inspect}, payer: #{@payer.inspect}, purchase_units: #{@purchase_units.inspect},"\
-      " status: #{@status.inspect}, links: #{@links.inspect}>"
+      " #{@intent.inspect}, processing_instruction: #{@processing_instruction.inspect}, payer:"\
+      " #{@payer.inspect}, purchase_units: #{@purchase_units.inspect}, status: #{@status.inspect},"\
+      " links: #{@links.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/order_authorize_response.rb

@@ -36,6 +36,10 @@ module PaypalServerSdk
     # @return [CheckoutPaymentIntent]
     attr_accessor :intent
 
+    # The instruction to process an order.
+    # @return [ProcessingInstruction]
+    attr_accessor :processing_instruction
+
     # The customer who approves and pays for the order. The customer is also
     # known as the payer.
     # @return [Payer]
@@ -74,6 +78,7 @@ module PaypalServerSdk
       @_hash['id'] = 'id'
       @_hash['payment_source'] = 'payment_source'
       @_hash['intent'] = 'intent'
+      @_hash['processing_instruction'] = 'processing_instruction'
       @_hash['payer'] = 'payer'
       @_hash['purchase_units'] = 'purchase_units'
       @_hash['status'] = 'status'
@@ -89,6 +94,7 @@ module PaypalServerSdk
         id
         payment_source
         intent
+        processing_instruction
         payer
         purchase_units
         status
@@ -102,13 +108,15 @@ module PaypalServerSdk
     end
 
     def initialize(create_time: SKIP, update_time: SKIP, id: SKIP,
-                   payment_source: SKIP, intent: SKIP, payer: SKIP,
+                   payment_source: SKIP, intent: SKIP,
+                   processing_instruction: SKIP, payer: SKIP,
                    purchase_units: SKIP, status: SKIP, links: SKIP)
       @create_time = create_time unless create_time == SKIP
       @update_time = update_time unless update_time == SKIP
       @id = id unless id == SKIP
       @payment_source = payment_source unless payment_source == SKIP
       @intent = intent unless intent == SKIP
+      @processing_instruction = processing_instruction unless processing_instruction == SKIP
       @payer = payer unless payer == SKIP
       @purchase_units = purchase_units unless purchase_units == SKIP
       @status = status unless status == SKIP
@@ -126,6 +134,8 @@ module PaypalServerSdk
       payment_source = OrderAuthorizeResponsePaymentSource.from_hash(hash['payment_source']) if
         hash['payment_source']
       intent = hash.key?('intent') ? hash['intent'] : SKIP
+      processing_instruction =
+        hash.key?('processing_instruction') ? hash['processing_instruction'] : SKIP
       payer = Payer.from_hash(hash['payer']) if hash['payer']
       # Parameter is an array, so we need to iterate through it
       purchase_units = nil
@@ -155,6 +165,7 @@ module PaypalServerSdk
                                  id: id,
                                  payment_source: payment_source,
                                  intent: intent,
+                                 processing_instruction: processing_instruction,
                                  payer: payer,
                                  purchase_units: purchase_units,
                                  status: status,
@@ -165,8 +176,9 @@ module PaypalServerSdk
     def to_s
       class_name = self.class.name.split('::').last
       "<#{class_name} create_time: #{@create_time}, update_time: #{@update_time}, id: #{@id},"\
-      " payment_source: #{@payment_source}, intent: #{@intent}, payer: #{@payer}, purchase_units:"\
-      " #{@purchase_units}, status: #{@status}, links: #{@links}>"
+      " payment_source: #{@payment_source}, intent: #{@intent}, processing_instruction:"\
+      " #{@processing_instruction}, payer: #{@payer}, purchase_units: #{@purchase_units}, status:"\
+      " #{@status}, links: #{@links}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -174,8 +186,9 @@ module PaypalServerSdk
       class_name = self.class.name.split('::').last
       "<#{class_name} create_time: #{@create_time.inspect}, update_time: #{@update_time.inspect},"\
       " id: #{@id.inspect}, payment_source: #{@payment_source.inspect}, intent:"\
-      " #{@intent.inspect}, payer: #{@payer.inspect}, purchase_units: #{@purchase_units.inspect},"\
-      " status: #{@status.inspect}, links: #{@links.inspect}>"
+      " #{@intent.inspect}, processing_instruction: #{@processing_instruction.inspect}, payer:"\
+      " #{@payer.inspect}, purchase_units: #{@purchase_units.inspect}, status: #{@status.inspect},"\
+      " links: #{@links.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/order_confirm_application_context.rb

@@ -20,8 +20,9 @@ module PaypalServerSdk
     # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
     # the optional [ISO-15924 script
     # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
-    # alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region
-    # code](https://unstats.un.org/unsd/methodology/m49/).
+    # alpha-2 country
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) or
+    # [M49 region code](https://unstats.un.org/unsd/methodology/m49/).
     # @return [String]
     attr_accessor :locale
 

data/lib/paypal_server_sdk/models/order_request.rb

@@ -14,6 +14,10 @@ module PaypalServerSdk
     # @return [CheckoutPaymentIntent]
     attr_accessor :intent
 
+    # The instruction to process an order.
+    # @return [ProcessingInstruction]
+    attr_accessor :processing_instruction
+
     # DEPRECATED. The customer is also known as the payer. The Payer object was
     # intended to only be used with the `payment_source.paypal` object. In order
     # to make this design more clear, the details in the `payer` object are now
@@ -43,6 +47,7 @@ module PaypalServerSdk
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['intent'] = 'intent'
+      @_hash['processing_instruction'] = 'processing_instruction'
       @_hash['payer'] = 'payer'
       @_hash['purchase_units'] = 'purchase_units'
       @_hash['payment_source'] = 'payment_source'
@@ -53,6 +58,7 @@ module PaypalServerSdk
     # An array for optional fields
     def self.optionals
       %w[
+        processing_instruction
         payer
         payment_source
         application_context
@@ -64,9 +70,10 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(intent:, purchase_units:, payer: SKIP, payment_source: SKIP,
-                   application_context: SKIP)
+    def initialize(intent:, purchase_units:, processing_instruction: SKIP,
+                   payer: SKIP, payment_source: SKIP, application_context: SKIP)
       @intent = intent
+      @processing_instruction = processing_instruction unless processing_instruction == SKIP
       @payer = payer unless payer == SKIP
       @purchase_units = purchase_units
       @payment_source = payment_source unless payment_source == SKIP
@@ -89,6 +96,8 @@ module PaypalServerSdk
       end
 
       purchase_units = nil unless hash.key?('purchase_units')
+      processing_instruction =
+        hash.key?('processing_instruction') ? hash['processing_instruction'] : SKIP
       payer = Payer.from_hash(hash['payer']) if hash['payer']
       payment_source = PaymentSource.from_hash(hash['payment_source']) if hash['payment_source']
       application_context = OrderApplicationContext.from_hash(hash['application_context']) if
@@ -97,6 +106,7 @@ module PaypalServerSdk
       # Create object from extracted values.
       OrderRequest.new(intent: intent,
                        purchase_units: purchase_units,
+                       processing_instruction: processing_instruction,
                        payer: payer,
                        payment_source: payment_source,
                        application_context: application_context)
@@ -105,14 +115,16 @@ module PaypalServerSdk
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} intent: #{@intent}, payer: #{@payer}, purchase_units: #{@purchase_units},"\
-      " payment_source: #{@payment_source}, application_context: #{@application_context}>"
+      "<#{class_name} intent: #{@intent}, processing_instruction: #{@processing_instruction},"\
+      " payer: #{@payer}, purchase_units: #{@purchase_units}, payment_source: #{@payment_source},"\
+      " application_context: #{@application_context}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} intent: #{@intent.inspect}, payer: #{@payer.inspect}, purchase_units:"\
+      "<#{class_name} intent: #{@intent.inspect}, processing_instruction:"\
+      " #{@processing_instruction.inspect}, payer: #{@payer.inspect}, purchase_units:"\
       " #{@purchase_units.inspect}, payment_source: #{@payment_source.inspect},"\
       " application_context: #{@application_context.inspect}>"
     end

data/lib/paypal_server_sdk/models/p24_payment_object.rb

@@ -20,11 +20,12 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :email
 
-    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
-    # that identifies the country or region. Note: The country code for Great
-    # Britain is GB and not UK as used in the top-level domain names for that
-    # country. Use the `C2` country code for China worldwide for comparable
-    # uncontrolled price (CUP) method, bank card, and cross-border transactions.
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) that
+    # identifies the country or region. Note: The country code for Great Britain
+    # is GB and not UK as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.
     # @return [String]
     attr_accessor :country_code
 

data/lib/paypal_server_sdk/models/p24_payment_request.rb

@@ -20,11 +20,12 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :email
 
-    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
-    # that identifies the country or region. Note: The country code for Great
-    # Britain is GB and not UK as used in the top-level domain names for that
-    # country. Use the `C2` country code for China worldwide for comparable
-    # uncontrolled price (CUP) method, bank card, and cross-border transactions.
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) that
+    # identifies the country or region. Note: The country code for Great Britain
+    # is GB and not UK as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.
     # @return [String]
     attr_accessor :country_code
 

data/lib/paypal_server_sdk/models/payment_token_response.rb

@@ -23,7 +23,8 @@ module PaypalServerSdk
     # @return [PaymentTokenResponsePaymentSource]
     attr_accessor :payment_source
 
-    # An array of related [HATEOAS links](/api/rest/responses/#hateoas).
+    # An array of related [HATEOAS
+    # links](https://developer.paypal.com/api/rest/responses/#hateoas).
     # @return [Array[LinkDescription]]
     attr_accessor :links
 

data/lib/paypal_server_sdk/models/paypal_wallet_attributes.rb

@@ -13,8 +13,7 @@ module PaypalServerSdk
     # @return [PaypalWalletCustomerRequest]
     attr_accessor :customer
 
-    # Resource consolidating common request and response attributes for vaulting
-    # PayPal Wallet.
+    # TODO: Write general description for this method
     # @return [PaypalWalletVaultInstruction]
     attr_accessor :vault
 

data/lib/paypal_server_sdk/models/paypal_wallet_experience_context.rb

@@ -24,8 +24,9 @@ module PaypalServerSdk
     # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
     # the optional [ISO-15924 script
     # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
-    # alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region
-    # code](https://unstats.un.org/unsd/methodology/m49/).
+    # alpha-2 country
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) or
+    # [M49 region code](https://unstats.un.org/unsd/methodology/m49/).
     # @return [String]
     attr_accessor :locale
 

data/lib/paypal_server_sdk/models/paypal_wallet_vault_base.rb

@@ -0,0 +1,134 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Resource consolidating common request and response attributes for vaulting
+  # PayPal Wallet.
+  class PaypalWalletVaultBase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines how and when the payment source gets vaulted.
+    # @return [StoreInVaultInstruction]
+    attr_accessor :store_in_vault
+
+    # The description displayed to PayPal consumer on the approval flow for
+    # PayPal, as well as on the PayPal payment token management experience on
+    # PayPal.com.
+    # @return [String]
+    attr_accessor :description
+
+    # Expected business/pricing model for the billing agreement.
+    # @return [UsagePattern]
+    attr_accessor :usage_pattern
+
+    # The usage type associated with the PayPal payment token.
+    # @return [UsageType]
+    attr_accessor :usage_type
+
+    # The customer type associated with the PayPal payment token. This is to
+    # indicate whether the customer acting on the merchant / platform is either
+    # a business or a consumer.
+    # @return [PaypalPaymentTokenCustomerType]
+    attr_accessor :customer_type
+
+    # Create multiple payment tokens for the same payer, merchant/platform
+    # combination. Use this when the customer has not logged in at
+    # merchant/platform. The payment token thus generated, can then also be used
+    # to create the customer account at merchant/platform. Use this also when
+    # multiple payment tokens are required for the same payer, different
+    # customer at merchant/platform. This helps to identify customers distinctly
+    # even though they may share the same PayPal account. This only applies to
+    # PayPal payment source.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :permit_multiple_payment_tokens
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['store_in_vault'] = 'store_in_vault'
+      @_hash['description'] = 'description'
+      @_hash['usage_pattern'] = 'usage_pattern'
+      @_hash['usage_type'] = 'usage_type'
+      @_hash['customer_type'] = 'customer_type'
+      @_hash['permit_multiple_payment_tokens'] =
+        'permit_multiple_payment_tokens'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        store_in_vault
+        description
+        usage_pattern
+        usage_type
+        customer_type
+        permit_multiple_payment_tokens
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(store_in_vault: SKIP, description: SKIP, usage_pattern: SKIP,
+                   usage_type: SKIP,
+                   customer_type: PaypalPaymentTokenCustomerType::CONSUMER,
+                   permit_multiple_payment_tokens: false)
+      @store_in_vault = store_in_vault unless store_in_vault == SKIP
+      @description = description unless description == SKIP
+      @usage_pattern = usage_pattern unless usage_pattern == SKIP
+      @usage_type = usage_type unless usage_type == SKIP
+      @customer_type = customer_type unless customer_type == SKIP
+      unless permit_multiple_payment_tokens == SKIP
+        @permit_multiple_payment_tokens =
+          permit_multiple_payment_tokens
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      store_in_vault =
+        hash.key?('store_in_vault') ? hash['store_in_vault'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      usage_pattern = hash.key?('usage_pattern') ? hash['usage_pattern'] : SKIP
+      usage_type = hash.key?('usage_type') ? hash['usage_type'] : SKIP
+      customer_type =
+        hash['customer_type'] ||= PaypalPaymentTokenCustomerType::CONSUMER
+      permit_multiple_payment_tokens =
+        hash['permit_multiple_payment_tokens'] ||= false
+
+      # Create object from extracted values.
+      PaypalWalletVaultBase.new(store_in_vault: store_in_vault,
+                                description: description,
+                                usage_pattern: usage_pattern,
+                                usage_type: usage_type,
+                                customer_type: customer_type,
+                                permit_multiple_payment_tokens: permit_multiple_payment_tokens)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_in_vault: #{@store_in_vault}, description: #{@description},"\
+      " usage_pattern: #{@usage_pattern}, usage_type: #{@usage_type}, customer_type:"\
+      " #{@customer_type}, permit_multiple_payment_tokens: #{@permit_multiple_payment_tokens}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_in_vault: #{@store_in_vault.inspect}, description:"\
+      " #{@description.inspect}, usage_pattern: #{@usage_pattern.inspect}, usage_type:"\
+      " #{@usage_type.inspect}, customer_type: #{@customer_type.inspect},"\
+      " permit_multiple_payment_tokens: #{@permit_multiple_payment_tokens.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_wallet_vault_instruction.rb

@@ -4,12 +4,15 @@
 # ( https://www.apimatic.io ).
 
 module PaypalServerSdk
-  # Resource consolidating common request and response attributes for vaulting
-  # PayPal Wallet.
+  # PaypalWalletVaultInstruction Model.
   class PaypalWalletVaultInstruction < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
+    # Defines how and when the payment source gets vaulted.
+    # @return [StoreInVaultInstruction]
+    attr_accessor :store_in_vault
+
     # The description displayed to PayPal consumer on the approval flow for
     # PayPal, as well as on the PayPal payment token management experience on
     # PayPal.com.
@@ -44,6 +47,7 @@ module PaypalServerSdk
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
+      @_hash['store_in_vault'] = 'store_in_vault'
       @_hash['description'] = 'description'
       @_hash['usage_pattern'] = 'usage_pattern'
       @_hash['usage_type'] = 'usage_type'
@@ -56,6 +60,7 @@ module PaypalServerSdk
     # An array for optional fields
     def self.optionals
       %w[
+        store_in_vault
         description
         usage_pattern
         customer_type
@@ -68,9 +73,11 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(usage_type:, description: SKIP, usage_pattern: SKIP,
+    def initialize(usage_type:, store_in_vault: SKIP, description: SKIP,
+                   usage_pattern: SKIP,
                    customer_type: PaypalPaymentTokenCustomerType::CONSUMER,
                    permit_multiple_payment_tokens: false)
+      @store_in_vault = store_in_vault unless store_in_vault == SKIP
       @description = description unless description == SKIP
       @usage_pattern = usage_pattern unless usage_pattern == SKIP
       @usage_type = usage_type
@@ -87,6 +94,8 @@ module PaypalServerSdk
 
       # Extract variables from the hash.
       usage_type = hash.key?('usage_type') ? hash['usage_type'] : nil
+      store_in_vault =
+        hash.key?('store_in_vault') ? hash['store_in_vault'] : SKIP
       description = hash.key?('description') ? hash['description'] : SKIP
       usage_pattern = hash.key?('usage_pattern') ? hash['usage_pattern'] : SKIP
       customer_type =
@@ -96,6 +105,7 @@ module PaypalServerSdk
 
       # Create object from extracted values.
       PaypalWalletVaultInstruction.new(usage_type: usage_type,
+                                       store_in_vault: store_in_vault,
                                        description: description,
                                        usage_pattern: usage_pattern,
                                        customer_type: customer_type,
@@ -105,18 +115,18 @@ module PaypalServerSdk
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} description: #{@description}, usage_pattern: #{@usage_pattern}, usage_type:"\
-      " #{@usage_type}, customer_type: #{@customer_type}, permit_multiple_payment_tokens:"\
-      " #{@permit_multiple_payment_tokens}>"
+      "<#{class_name} store_in_vault: #{@store_in_vault}, description: #{@description},"\
+      " usage_pattern: #{@usage_pattern}, usage_type: #{@usage_type}, customer_type:"\
+      " #{@customer_type}, permit_multiple_payment_tokens: #{@permit_multiple_payment_tokens}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} description: #{@description.inspect}, usage_pattern:"\
-      " #{@usage_pattern.inspect}, usage_type: #{@usage_type.inspect}, customer_type:"\
-      " #{@customer_type.inspect}, permit_multiple_payment_tokens:"\
-      " #{@permit_multiple_payment_tokens.inspect}>"
+      "<#{class_name} store_in_vault: #{@store_in_vault.inspect}, description:"\
+      " #{@description.inspect}, usage_pattern: #{@usage_pattern.inspect}, usage_type:"\
+      " #{@usage_type.inspect}, customer_type: #{@customer_type.inspect},"\
+      " permit_multiple_payment_tokens: #{@permit_multiple_payment_tokens.inspect}>"
     end
   end
 end