paypal-server-sdk 0.6.1 → 0.7.0

data/lib/paypal_server_sdk/models/venmo_payment_token.rb

@@ -15,6 +15,10 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :description
 
+    # Expected business/charge model for the billing agreement.
+    # @return [UsagePattern]
+    attr_accessor :usage_pattern
+
     # The shipping details.
     # @return [VaultedDigitalWalletShippingDetails]
     attr_accessor :shipping
@@ -31,20 +35,19 @@ module PaypalServerSdk
     attr_accessor :permit_multiple_payment_tokens
 
     # The usage type associated with a digital wallet payment token.
-    # @return [String]
+    # @return [PaypalPaymentTokenUsageType]
     attr_accessor :usage_type
 
     # The customer type associated with a digital wallet payment token. This is
     # to indicate whether the customer acting on the merchant / platform is
     # either a business or a consumer.
-    # @return [String]
+    # @return [PaypalPaymentTokenCustomerType]
     attr_accessor :customer_type
 
-    # 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>
+    # 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
 
@@ -77,6 +80,7 @@ module PaypalServerSdk
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['description'] = 'description'
+      @_hash['usage_pattern'] = 'usage_pattern'
       @_hash['shipping'] = 'shipping'
       @_hash['permit_multiple_payment_tokens'] =
         'permit_multiple_payment_tokens'
@@ -95,6 +99,7 @@ module PaypalServerSdk
     def self.optionals
       %w[
         description
+        usage_pattern
         shipping
         permit_multiple_payment_tokens
         usage_type
@@ -113,11 +118,12 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(description: SKIP, shipping: SKIP,
+    def initialize(description: SKIP, usage_pattern: SKIP, shipping: SKIP,
                    permit_multiple_payment_tokens: false, usage_type: SKIP,
                    customer_type: SKIP, email_address: SKIP, payer_id: SKIP,
                    name: SKIP, phone: SKIP, address: SKIP, user_name: SKIP)
       @description = description unless description == SKIP
+      @usage_pattern = usage_pattern unless usage_pattern == SKIP
       @shipping = shipping unless shipping == SKIP
       unless permit_multiple_payment_tokens == SKIP
         @permit_multiple_payment_tokens =
@@ -139,6 +145,7 @@ module PaypalServerSdk
 
       # Extract variables from the hash.
       description = hash.key?('description') ? hash['description'] : SKIP
+      usage_pattern = hash.key?('usage_pattern') ? hash['usage_pattern'] : SKIP
       shipping = VaultedDigitalWalletShippingDetails.from_hash(hash['shipping']) if
         hash['shipping']
       permit_multiple_payment_tokens =
@@ -154,6 +161,7 @@ module PaypalServerSdk
 
       # Create object from extracted values.
       VenmoPaymentToken.new(description: description,
+                            usage_pattern: usage_pattern,
                             shipping: shipping,
                             permit_multiple_payment_tokens: permit_multiple_payment_tokens,
                             usage_type: usage_type,
@@ -165,5 +173,26 @@ module PaypalServerSdk
                             address: address,
                             user_name: user_name)
     end
+
+    # 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}, shipping:"\
+      " #{@shipping}, permit_multiple_payment_tokens: #{@permit_multiple_payment_tokens},"\
+      " usage_type: #{@usage_type}, customer_type: #{@customer_type}, email_address:"\
+      " #{@email_address}, payer_id: #{@payer_id}, name: #{@name}, phone: #{@phone}, address:"\
+      " #{@address}, user_name: #{@user_name}>"
+    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}, shipping: #{@shipping.inspect}, permit_multiple_payment_tokens:"\
+      " #{@permit_multiple_payment_tokens.inspect}, usage_type: #{@usage_type.inspect},"\
+      " customer_type: #{@customer_type.inspect}, email_address: #{@email_address.inspect},"\
+      " payer_id: #{@payer_id.inspect}, name: #{@name.inspect}, phone: #{@phone.inspect}, address:"\
+      " #{@address.inspect}, user_name: #{@user_name.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/venmo_payment_token_customer_type.rb

@@ -9,10 +9,12 @@ module PaypalServerSdk
   # business or a consumer.
   class VenmoPaymentTokenCustomerType
     VENMO_PAYMENT_TOKEN_CUSTOMER_TYPE = [
-      # TODO: Write general description for CONSUMER
+      # The customer vaulting the Venmo payment token is a consumer on the
+      # merchant / platform.
       CONSUMER = 'CONSUMER'.freeze,
 
-      # TODO: Write general description for BUSINESS
+      # The customer vaulting the Venmo payment token is a business on merchant
+      # / platform.
       BUSINESS = 'BUSINESS'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/venmo_payment_token_usage_pattern.rb

@@ -7,22 +7,28 @@ module PaypalServerSdk
   # Expected business/pricing model for the billing agreement.
   class VenmoPaymentTokenUsagePattern
     VENMO_PAYMENT_TOKEN_USAGE_PATTERN = [
-      # TODO: Write general description for IMMEDIATE
+      # On-demand instant payments – non-recurring, pre-paid, variable amount,
+      # variable frequency.
       IMMEDIATE = 'IMMEDIATE'.freeze,
 
-      # TODO: Write general description for DEFERRED
+      # Pay after use, non-recurring post-paid, variable amount, irregular
+      # frequency.
       DEFERRED = 'DEFERRED'.freeze,
 
-      # TODO: Write general description for RECURRING_PREPAID
+      # Pay upfront fixed or variable amount on a fixed date before the
+      # goods/service is delivered.
       RECURRING_PREPAID = 'RECURRING_PREPAID'.freeze,
 
-      # TODO: Write general description for RECURRING_POSTPAID
+      # Pay on a fixed date based on usage or consumption after the
+      # goods/service is delivered.
       RECURRING_POSTPAID = 'RECURRING_POSTPAID'.freeze,
 
-      # TODO: Write general description for THRESHOLD_PREPAID
+      # Charge payer when the set amount is reached or monthly billing cycle,
+      # whichever comes first, before the goods/service is delivered.
       THRESHOLD_PREPAID = 'THRESHOLD_PREPAID'.freeze,
 
-      # TODO: Write general description for THRESHOLD_POSTPAID
+      # Charge payer when the set amount is reached or monthly billing cycle,
+      # whichever comes first, after the goods/service is delivered.
       THRESHOLD_POSTPAID = 'THRESHOLD_POSTPAID'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/venmo_payment_token_usage_type.rb

@@ -7,10 +7,13 @@ module PaypalServerSdk
   # The usage type associated with the Venmo payment token.
   class VenmoPaymentTokenUsageType
     VENMO_PAYMENT_TOKEN_USAGE_TYPE = [
-      # TODO: Write general description for MERCHANT
+      # The Venmo Payment Token will be used for future transaction directly
+      # with a merchant.
       MERCHANT = 'MERCHANT'.freeze,
 
-      # TODO: Write general description for PLATFORM
+      # The Venmo Payment Token will be used for future transaction on a
+      # platform. A platform is typically a marketplace or a channel that a
+      # payer can purchase goods and services from multiple merchants.
       PLATFORM = 'PLATFORM'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/venmo_wallet_additional_attributes.rb

@@ -56,5 +56,17 @@ module PaypalServerSdk
       VenmoWalletAdditionalAttributes.new(customer: customer,
                                           vault: vault)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer}, vault: #{@vault}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer.inspect}, vault: #{@vault.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/venmo_wallet_attributes_response.rb

@@ -46,5 +46,17 @@ module PaypalServerSdk
       # Create object from extracted values.
       VenmoWalletAttributesResponse.new(vault: vault)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault: #{@vault}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault: #{@vault.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/venmo_wallet_customer_information.rb

@@ -13,11 +13,10 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :id
 
-    # 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>
+    # 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
 
@@ -59,5 +58,17 @@ module PaypalServerSdk
       VenmoWalletCustomerInformation.new(id: id,
                                          email_address: email_address)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, email_address: #{@email_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, email_address: #{@email_address.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/venmo_wallet_experience_context.rb

@@ -5,9 +5,8 @@
 
 module PaypalServerSdk
   # Customizes the buyer experience during the approval process for payment with
-  # Venmo.<blockquote><strong>Note:</strong> Partners and Marketplaces might
-  # configure <code>shipping_preference</code> during partner account setup,
-  # which overrides the request values.</blockquote>
+  # Venmo. Note: Partners and Marketplaces might configure shipping_preference
+  # during partner account setup, which overrides the request values.
   class VenmoWalletExperienceContext < BaseModel
     SKIP = Object.new
     private_constant :SKIP
@@ -21,11 +20,16 @@ module PaypalServerSdk
     # @return [ShippingPreference]
     attr_accessor :shipping_preference
 
+    # CallBack Configuration that the merchant can provide to PayPal/Venmo.
+    # @return [CallbackConfiguration]
+    attr_accessor :order_update_callback_config
+
     # 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['order_update_callback_config'] = 'order_update_callback_config'
       @_hash
     end
 
@@ -34,6 +38,7 @@ module PaypalServerSdk
       %w[
         brand_name
         shipping_preference
+        order_update_callback_config
       ]
     end
 
@@ -43,9 +48,14 @@ module PaypalServerSdk
     end
 
     def initialize(brand_name: SKIP,
-                   shipping_preference: ShippingPreference::GET_FROM_FILE)
+                   shipping_preference: ShippingPreference::GET_FROM_FILE,
+                   order_update_callback_config: SKIP)
       @brand_name = brand_name unless brand_name == SKIP
       @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      unless order_update_callback_config == SKIP
+        @order_update_callback_config =
+          order_update_callback_config
+      end
     end
 
     # Creates an instance of the object from a hash.
@@ -56,10 +66,29 @@ module PaypalServerSdk
       brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
       shipping_preference =
         hash['shipping_preference'] ||= ShippingPreference::GET_FROM_FILE
+      if hash['order_update_callback_config']
+        order_update_callback_config = CallbackConfiguration.from_hash(hash['order_update_callback_config'])
+      end
 
       # Create object from extracted values.
       VenmoWalletExperienceContext.new(brand_name: brand_name,
-                                       shipping_preference: shipping_preference)
+                                       shipping_preference: shipping_preference,
+                                       order_update_callback_config: order_update_callback_config)
+    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},"\
+      " order_update_callback_config: #{@order_update_callback_config}>"
+    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}, order_update_callback_config:"\
+      " #{@order_update_callback_config.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/venmo_wallet_request.rb

@@ -15,18 +15,17 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :vault_id
 
-    # 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>
+    # 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
 
     # Customizes the buyer experience during the approval process for payment
-    # with Venmo.<blockquote><strong>Note:</strong> Partners and Marketplaces
-    # might configure <code>shipping_preference</code> during partner account
-    # setup, which overrides the request values.</blockquote>
+    # with Venmo. Note: Partners and Marketplaces might configure
+    # shipping_preference during partner account setup, which overrides the
+    # request values.
     # @return [VenmoWalletExperienceContext]
     attr_accessor :experience_context
 
@@ -85,5 +84,19 @@ module PaypalServerSdk
                              experience_context: experience_context,
                              attributes: attributes)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault_id: #{@vault_id}, email_address: #{@email_address},"\
+      " experience_context: #{@experience_context}, attributes: #{@attributes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault_id: #{@vault_id.inspect}, email_address: #{@email_address.inspect},"\
+      " experience_context: #{@experience_context.inspect}, attributes: #{@attributes.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/venmo_wallet_response.rb

@@ -9,11 +9,10 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
-    # 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>
+    # 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
 
@@ -116,5 +115,22 @@ module PaypalServerSdk
                               address: address,
                               attributes: attributes)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address}, account_id: #{@account_id}, user_name:"\
+      " #{@user_name}, name: #{@name}, phone_number: #{@phone_number}, address: #{@address},"\
+      " attributes: #{@attributes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address.inspect}, account_id:"\
+      " #{@account_id.inspect}, user_name: #{@user_name.inspect}, name: #{@name.inspect},"\
+      " phone_number: #{@phone_number.inspect}, address: #{@address.inspect}, attributes:"\
+      " #{@attributes.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/venmo_wallet_vault_attributes.rb

@@ -110,5 +110,22 @@ module PaypalServerSdk
                                      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/utilities/file_wrapper.rb

@@ -12,5 +12,17 @@ module PaypalServerSdk
     def initialize(file, content_type: 'application/octet-stream')
       super
     end
-  end
-end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def to_inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file.inspect}, content_type: #{@content_type.inspect}>"
+    end
+  end
+end