paypal-server-sdk 1.0.0 → 2.0.0

data/lib/paypal_server_sdk/models/vault_experience_context.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Customizes the Vault creation flow experience for your customers.
@@ -39,14 +39,23 @@ module PaypalServerSdk
     attr_accessor :cancel_url
 
     # The shipping preference. This only applies to PayPal payment source.
-    # @return [OrderApplicationContextShippingPreference]
+    # @return [ExperienceContextShippingPreference]
     attr_accessor :shipping_preference
 
-    # Vault Instruction on action to be performed after a successful payer
-    # approval.
+    # DEPRECATED. Vault Instruction on action to be performed after a successful
+    # payer approval.
     # @return [VaultInstructionAction]
     attr_accessor :vault_instruction
 
+    # Merchant provided details of the native app or mobile web browser to
+    # facilitate buyer's app switch to the PayPal consumer app.
+    # @return [AppSwitchContext]
+    attr_accessor :app_switch_context
+
+    # User Action on action to be performed after a successful payer approval.
+    # @return [VaultUserAction]
+    attr_accessor :user_action
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -56,6 +65,8 @@ module PaypalServerSdk
       @_hash['cancel_url'] = 'cancel_url'
       @_hash['shipping_preference'] = 'shipping_preference'
       @_hash['vault_instruction'] = 'vault_instruction'
+      @_hash['app_switch_context'] = 'app_switch_context'
+      @_hash['user_action'] = 'user_action'
       @_hash
     end
 
@@ -68,6 +79,8 @@ module PaypalServerSdk
         cancel_url
         shipping_preference
         vault_instruction
+        app_switch_context
+        user_action
       ]
     end
 
@@ -78,8 +91,9 @@ module PaypalServerSdk
 
     def initialize(
       brand_name: SKIP, locale: SKIP, return_url: SKIP, cancel_url: SKIP,
-      shipping_preference: OrderApplicationContextShippingPreference::GET_FROM_FILE,
-      vault_instruction: VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
+      shipping_preference: ExperienceContextShippingPreference::GET_FROM_FILE,
+      vault_instruction: SKIP, app_switch_context: SKIP,
+      user_action: VaultUserAction::CONTINUE
     )
       @brand_name = brand_name unless brand_name == SKIP
       @locale = locale unless locale == SKIP
@@ -87,6 +101,8 @@ module PaypalServerSdk
       @cancel_url = cancel_url unless cancel_url == SKIP
       @shipping_preference = shipping_preference unless shipping_preference == SKIP
       @vault_instruction = vault_instruction unless vault_instruction == SKIP
+      @app_switch_context = app_switch_context unless app_switch_context == SKIP
+      @user_action = user_action unless user_action == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -99,9 +115,12 @@ module PaypalServerSdk
       return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
       cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
       shipping_preference =
-        hash['shipping_preference'] ||= OrderApplicationContextShippingPreference::GET_FROM_FILE
+        hash['shipping_preference'] ||= ExperienceContextShippingPreference::GET_FROM_FILE
       vault_instruction =
-        hash['vault_instruction'] ||= VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
+        hash.key?('vault_instruction') ? hash['vault_instruction'] : SKIP
+      app_switch_context = AppSwitchContext.from_hash(hash['app_switch_context']) if
+        hash['app_switch_context']
+      user_action = hash['user_action'] ||= VaultUserAction::CONTINUE
 
       # Create object from extracted values.
       VaultExperienceContext.new(brand_name: brand_name,
@@ -109,7 +128,9 @@ module PaypalServerSdk
                                  return_url: return_url,
                                  cancel_url: cancel_url,
                                  shipping_preference: shipping_preference,
-                                 vault_instruction: vault_instruction)
+                                 vault_instruction: vault_instruction,
+                                 app_switch_context: app_switch_context,
+                                 user_action: user_action)
     end
 
     # Provides a human-readable string representation of the object.
@@ -117,7 +138,8 @@ module PaypalServerSdk
       class_name = self.class.name.split('::').last
       "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, return_url: #{@return_url},"\
       " cancel_url: #{@cancel_url}, shipping_preference: #{@shipping_preference},"\
-      " vault_instruction: #{@vault_instruction}>"
+      " vault_instruction: #{@vault_instruction}, app_switch_context: #{@app_switch_context},"\
+      " user_action: #{@user_action}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -125,7 +147,8 @@ module PaypalServerSdk
       class_name = self.class.name.split('::').last
       "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect}, return_url:"\
       " #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}, shipping_preference:"\
-      " #{@shipping_preference.inspect}, vault_instruction: #{@vault_instruction.inspect}>"
+      " #{@shipping_preference.inspect}, vault_instruction: #{@vault_instruction.inspect},"\
+      " app_switch_context: #{@app_switch_context.inspect}, user_action: #{@user_action.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/vault_instruction.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Base vaulting specification. The object can be extended for specific use

data/lib/paypal_server_sdk/models/vault_instruction_action.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Vault Instruction on action to be performed after a successful payer

data/lib/paypal_server_sdk/models/vault_instruction_base.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Basic vault instruction specification that can be extended by specific

data/lib/paypal_server_sdk/models/vault_paypal_wallet_request.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # A resource representing a request to vault PayPal Wallet.
@@ -49,7 +49,7 @@ module PaypalServerSdk
     # @return [Plan]
     attr_accessor :billing_plan
 
-    # Customizes the Vault creation flow experience for your customers.
+    # A resource representing an experience context of vault PayPal Wallet.
     # @return [VaultExperienceContext]
     attr_accessor :experience_context
 

data/lib/paypal_server_sdk/models/vault_response.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The details about a saved payment source.
@@ -17,7 +17,8 @@ module PaypalServerSdk
     # @return [VaultStatus]
     attr_accessor :status
 
-    # The details about a customer in PayPal's system of record.
+    # This object represents a merchant’s customer, allowing them to store
+    # contact details, and track all payments associated with the same customer.
     # @return [VaultCustomer]
     attr_accessor :customer
 

data/lib/paypal_server_sdk/models/vault_response_customer.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # This object defines a customer in your system. Use it to manage customer
@@ -20,7 +20,7 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :merchant_customer_id
 
-    # An array of request-related HATEOAS links.
+    # DEPRECATED. This field is DEPRECATED.
     # @return [Array[Object]]
     attr_accessor :links
 

data/lib/paypal_server_sdk/models/vault_status.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The vault status.

data/lib/paypal_server_sdk/models/vault_token_request.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The Tokenized Payment Source representing a Request to Vault a Token.

data/lib/paypal_server_sdk/models/vault_token_request_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The tokenization method that generated the ID.

data/lib/paypal_server_sdk/models/vault_user_action.rb

@@ -0,0 +1,29 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # User Action on action to be performed after a successful payer approval.
+  class VaultUserAction
+    VAULT_USER_ACTION = [
+      # After you redirect the customer to the PayPal payment page, a Setup Now
+      # button appears. Use this option when no additional inputs are needed
+      # from merchant site and to create the billing agreement immediately when
+      # the customer clicks Setup Now.
+      SETUP_NOW = 'SETUP_NOW'.freeze,
+
+      # After you redirect the customer to the PayPal payment page, a Continue
+      # button appears. Use this option when you want to redirect the customer
+      # from the completed payment page to the merchant site for additional
+      # inputs without immediately creating the billing agreement.
+      CONTINUE = 'CONTINUE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_venmo_request.rb

@@ -1,10 +1,10 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
-  # VaultVenmoRequest Model.
+  # A resource representing a request to vault Venmo.
   class VaultVenmoRequest < BaseModel
     SKIP = Object.new
     private_constant :SKIP
@@ -44,8 +44,8 @@ module PaypalServerSdk
     # @return [PaypalPaymentTokenCustomerType]
     attr_accessor :customer_type
 
-    # Customizes the Vault creation flow experience for your customers.
-    # @return [VaultVenmoExperienceContext]
+    # A resource representing an experience context of vault a venmo account.
+    # @return [VenmoExperienceContext]
     attr_accessor :experience_context
 
     # A mapping from model property names to API property names.
@@ -108,7 +108,7 @@ module PaypalServerSdk
         hash['permit_multiple_payment_tokens'] ||= false
       usage_type = hash.key?('usage_type') ? hash['usage_type'] : SKIP
       customer_type = hash.key?('customer_type') ? hash['customer_type'] : SKIP
-      experience_context = VaultVenmoExperienceContext.from_hash(hash['experience_context']) if
+      experience_context = VenmoExperienceContext.from_hash(hash['experience_context']) if
         hash['experience_context']
 
       # Create object from extracted values.

data/lib/paypal_server_sdk/models/vaulted_digital_wallet.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Resource consolidating common request and response attributes for vaulting a

data/lib/paypal_server_sdk/models/vaulted_digital_wallet_shipping_details.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The shipping details.
@@ -13,6 +13,13 @@ module PaypalServerSdk
     # @return [ShippingName]
     attr_accessor :name
 
+    # The internationalized email address. Note: Up to 64 characters are allowed
+    # before and 255 characters are allowed after the @ sign. However, the
+    # generally accepted maximum length for an email address is 254 characters.
+    # The pattern verifies that an unquoted @ sign exists.
+    # @return [String]
+    attr_accessor :email_address
+
     # The phone number, in its canonical international [E.164 numbering plan
     # format](https://www.itu.int/rec/T-REC-E.164/en).
     # @return [PhoneNumberWithCountryCode]
@@ -37,6 +44,7 @@ module PaypalServerSdk
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['name'] = 'name'
+      @_hash['email_address'] = 'email_address'
       @_hash['phone_number'] = 'phone_number'
       @_hash['type'] = 'type'
       @_hash['address'] = 'address'
@@ -47,6 +55,7 @@ module PaypalServerSdk
     def self.optionals
       %w[
         name
+        email_address
         phone_number
         type
         address
@@ -58,8 +67,10 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(name: SKIP, phone_number: SKIP, type: SKIP, address: SKIP)
+    def initialize(name: SKIP, email_address: SKIP, phone_number: SKIP,
+                   type: SKIP, address: SKIP)
       @name = name unless name == SKIP
+      @email_address = email_address unless email_address == SKIP
       @phone_number = phone_number unless phone_number == SKIP
       @type = type unless type == SKIP
       @address = address unless address == SKIP
@@ -71,6 +82,7 @@ module PaypalServerSdk
 
       # Extract variables from the hash.
       name = ShippingName.from_hash(hash['name']) if hash['name']
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
       phone_number = PhoneNumberWithCountryCode.from_hash(hash['phone_number']) if
         hash['phone_number']
       type = hash.key?('type') ? hash['type'] : SKIP
@@ -78,6 +90,7 @@ module PaypalServerSdk
 
       # Create object from extracted values.
       VaultedDigitalWalletShippingDetails.new(name: name,
+                                              email_address: email_address,
                                               phone_number: phone_number,
                                               type: type,
                                               address: address)
@@ -86,15 +99,16 @@ module PaypalServerSdk
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name}, phone_number: #{@phone_number}, type: #{@type}, address:"\
-      " #{@address}>"
+      "<#{class_name} name: #{@name}, email_address: #{@email_address}, phone_number:"\
+      " #{@phone_number}, type: #{@type}, address: #{@address}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name.inspect}, phone_number: #{@phone_number.inspect}, type:"\
-      " #{@type.inspect}, address: #{@address.inspect}>"
+      "<#{class_name} name: #{@name.inspect}, email_address: #{@email_address.inspect},"\
+      " phone_number: #{@phone_number.inspect}, type: #{@type.inspect}, address:"\
+      " #{@address.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/{vault_venmo_experience_context.rb → venmo_experience_context.rb}

@@ -1,11 +1,11 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
-  # Customizes the Vault creation flow experience for your customers.
-  class VaultVenmoExperienceContext < BaseModel
+  # A resource representing an experience context of vault a venmo account.
+  class VenmoExperienceContext < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -16,20 +16,25 @@ module PaypalServerSdk
     attr_accessor :brand_name
 
     # The shipping preference. This only applies to PayPal payment source.
-    # @return [OrderApplicationContextShippingPreference]
+    # @return [ExperienceContextShippingPreference]
     attr_accessor :shipping_preference
 
-    # Vault Instruction on action to be performed after a successful payer
-    # approval.
+    # DEPRECATED. Vault Instruction on action to be performed after a successful
+    # payer approval.
     # @return [VaultInstructionAction]
     attr_accessor :vault_instruction
 
+    # User Action on action to be performed after a successful payer approval.
+    # @return [VaultUserAction]
+    attr_accessor :user_action
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['brand_name'] = 'brand_name'
       @_hash['shipping_preference'] = 'shipping_preference'
       @_hash['vault_instruction'] = 'vault_instruction'
+      @_hash['user_action'] = 'user_action'
       @_hash
     end
 
@@ -39,6 +44,7 @@ module PaypalServerSdk
         brand_name
         shipping_preference
         vault_instruction
+        user_action
       ]
     end
 
@@ -49,12 +55,13 @@ module PaypalServerSdk
 
     def initialize(
       brand_name: SKIP,
-      shipping_preference: OrderApplicationContextShippingPreference::GET_FROM_FILE,
-      vault_instruction: VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
+      shipping_preference: ExperienceContextShippingPreference::GET_FROM_FILE,
+      vault_instruction: SKIP, user_action: VaultUserAction::CONTINUE
     )
       @brand_name = brand_name unless brand_name == SKIP
       @shipping_preference = shipping_preference unless shipping_preference == SKIP
       @vault_instruction = vault_instruction unless vault_instruction == SKIP
+      @user_action = user_action unless user_action == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -64,28 +71,31 @@ module PaypalServerSdk
       # Extract variables from the hash.
       brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
       shipping_preference =
-        hash['shipping_preference'] ||= OrderApplicationContextShippingPreference::GET_FROM_FILE
+        hash['shipping_preference'] ||= ExperienceContextShippingPreference::GET_FROM_FILE
       vault_instruction =
-        hash['vault_instruction'] ||= VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
+        hash.key?('vault_instruction') ? hash['vault_instruction'] : SKIP
+      user_action = hash['user_action'] ||= VaultUserAction::CONTINUE
 
       # Create object from extracted values.
-      VaultVenmoExperienceContext.new(brand_name: brand_name,
-                                      shipping_preference: shipping_preference,
-                                      vault_instruction: vault_instruction)
+      VenmoExperienceContext.new(brand_name: brand_name,
+                                 shipping_preference: shipping_preference,
+                                 vault_instruction: vault_instruction,
+                                 user_action: user_action)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
       "<#{class_name} brand_name: #{@brand_name}, shipping_preference: #{@shipping_preference},"\
-      " vault_instruction: #{@vault_instruction}>"
+      " vault_instruction: #{@vault_instruction}, user_action: #{@user_action}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
       "<#{class_name} brand_name: #{@brand_name.inspect}, shipping_preference:"\
-      " #{@shipping_preference.inspect}, vault_instruction: #{@vault_instruction.inspect}>"
+      " #{@shipping_preference.inspect}, vault_instruction: #{@vault_instruction.inspect},"\
+      " user_action: #{@user_action.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/venmo_payment_token.rb

@@ -1,10 +1,10 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
-  # VenmoPaymentToken Model.
+  # Full representation of a Venmo Payment Token.
   class VenmoPaymentToken < BaseModel
     SKIP = Object.new
     private_constant :SKIP
@@ -44,10 +44,11 @@ module PaypalServerSdk
     # @return [PaypalPaymentTokenCustomerType]
     attr_accessor :customer_type
 
-    # The internationalized email address. Note: Up to 64 characters are allowed
-    # before and 255 characters are allowed after the @ sign. However, the
-    # generally accepted maximum length for an email address is 254 characters.
-    # The pattern verifies that an unquoted @ sign exists.
+    # The internationalized email address.<blockquote><strong>Note:</strong> Up
+    # to 64 characters are allowed before and 255 characters are allowed after
+    # the <code>@</code> sign. However, the generally accepted maximum length
+    # for an email address is 254 characters. The pattern verifies that an
+    # unquoted <code>@</code> sign exists.</blockquote>
     # @return [String]
     attr_accessor :email_address
 

data/lib/paypal_server_sdk/models/venmo_payment_token_customer_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The customer type associated with the Venmo payment token. This is to

data/lib/paypal_server_sdk/models/venmo_payment_token_usage_pattern.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Expected business/pricing model for the billing agreement.

data/lib/paypal_server_sdk/models/venmo_payment_token_usage_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The usage type associated with the Venmo payment token.