paypal-server-sdk 0.6.1 → 0.7.0

data/lib/paypal_server_sdk/models/vault_paypal_wallet_request.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,15 +35,20 @@ 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 merchant level Recurring Billing plan metadata for the Billing
+    # Agreement.
+    # @return [Plan]
+    attr_accessor :billing_plan
+
     # Customizes the Vault creation flow experience for your customers.
     # @return [VaultExperienceContext]
     attr_accessor :experience_context
@@ -48,11 +57,13 @@ 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'
       @_hash['usage_type'] = 'usage_type'
       @_hash['customer_type'] = 'customer_type'
+      @_hash['billing_plan'] = 'billing_plan'
       @_hash['experience_context'] = 'experience_context'
       @_hash
     end
@@ -61,10 +72,12 @@ module PaypalServerSdk
     def self.optionals
       %w[
         description
+        usage_pattern
         shipping
         permit_multiple_payment_tokens
         usage_type
         customer_type
+        billing_plan
         experience_context
       ]
     end
@@ -74,10 +87,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, experience_context: SKIP)
+                   customer_type: SKIP, billing_plan: SKIP,
+                   experience_context: 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 =
@@ -85,6 +100,7 @@ module PaypalServerSdk
       end
       @usage_type = usage_type unless usage_type == SKIP
       @customer_type = customer_type unless customer_type == SKIP
+      @billing_plan = billing_plan unless billing_plan == SKIP
       @experience_context = experience_context unless experience_context == SKIP
     end
 
@@ -94,22 +110,45 @@ 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 =
         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
+      billing_plan = Plan.from_hash(hash['billing_plan']) if hash['billing_plan']
       experience_context = VaultExperienceContext.from_hash(hash['experience_context']) if
         hash['experience_context']
 
       # Create object from extracted values.
       VaultPaypalWalletRequest.new(description: description,
+                                   usage_pattern: usage_pattern,
                                    shipping: shipping,
                                    permit_multiple_payment_tokens: permit_multiple_payment_tokens,
                                    usage_type: usage_type,
                                    customer_type: customer_type,
+                                   billing_plan: billing_plan,
                                    experience_context: experience_context)
     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}, billing_plan:"\
+      " #{@billing_plan}, experience_context: #{@experience_context}>"
+    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}, billing_plan: #{@billing_plan.inspect},"\
+      " experience_context: #{@experience_context.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/vault_response.rb

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

data/lib/paypal_server_sdk/models/vault_response_customer.rb

@@ -0,0 +1,86 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # This object defines a customer in your system. Use it to manage customer
+  # profiles, save payment methods and contact details.
+  class VaultResponseCustomer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # Merchants and partners may already have a data-store where their customer
+    # information is persisted. Use merchant_customer_id to associate the
+    # PayPal-generated customer.id to your representation of a customer.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # An array of request-related HATEOAS links.
+    # @return [Array[Object]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        merchant_customer_id
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, merchant_customer_id: SKIP, links: SKIP)
+      @id = id unless id == SKIP
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_id == SKIP
+      @links = links unless links == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+      links = hash.key?('links') ? hash['links'] : SKIP
+
+      # Create object from extracted values.
+      VaultResponseCustomer.new(id: id,
+                                merchant_customer_id: merchant_customer_id,
+                                links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, merchant_customer_id: #{@merchant_customer_id}, links:"\
+      " #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, merchant_customer_id: #{@merchant_customer_id.inspect},"\
+      " links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_status.rb

@@ -7,13 +7,18 @@ module PaypalServerSdk
   # The vault status.
   class VaultStatus
     VAULT_STATUS = [
-      # TODO: Write general description for VAULTED
+      # The payment source has been saved in your customer's vault. This vault
+      # status reflects `/v3/vault` status.
       VAULTED = 'VAULTED'.freeze,
 
-      # TODO: Write general description for CREATED
+      # DEPRECATED. The payment source has been saved in your customer's vault.
+      # This status applies to deprecated integration patterns and will not be
+      # returned for v3/vault integrations.
       CREATED = 'CREATED'.freeze,
 
-      # TODO: Write general description for APPROVED
+      # Customer has approved the action of saving the specified payment_source
+      # into their vault. Use v3/vault/payment-tokens with given setup_token to
+      # save the payment source in the vault
       APPROVED = 'APPROVED'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/vault_token_request.rb

@@ -14,7 +14,7 @@ module PaypalServerSdk
     attr_accessor :id
 
     # The tokenization method that generated the ID.
-    # @return [TokenRequestType]
+    # @return [VaultTokenRequestType]
     attr_accessor :type
 
     # A mapping from model property names to API property names.
@@ -52,5 +52,17 @@ module PaypalServerSdk
       VaultTokenRequest.new(id: id,
                             type: type)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, type: #{@type.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/vault_token_request_type.rb

@@ -0,0 +1,20 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The tokenization method that generated the ID.
+  class VaultTokenRequestType
+    VAULT_TOKEN_REQUEST_TYPE = [
+      # The setup token, which is a temporary reference to payment source.
+      SETUP_TOKEN = 'SETUP_TOKEN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_venmo_experience_context.rb

@@ -16,12 +16,12 @@ module PaypalServerSdk
     attr_accessor :brand_name
 
     # The shipping preference. This only applies to PayPal payment source.
-    # @return [String]
+    # @return [OrderApplicationContextShippingPreference]
     attr_accessor :shipping_preference
 
     # Vault Instruction on action to be performed after a successful payer
     # approval.
-    # @return [String]
+    # @return [VaultInstructionAction]
     attr_accessor :vault_instruction
 
     # A mapping from model property names to API property names.
@@ -47,8 +47,11 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(brand_name: SKIP, shipping_preference: 'GET_FROM_FILE',
-                   vault_instruction: 'ON_CREATE_PAYMENT_TOKENS')
+    def initialize(
+      brand_name: SKIP,
+      shipping_preference: OrderApplicationContextShippingPreference::GET_FROM_FILE,
+      vault_instruction: VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
+    )
       @brand_name = brand_name unless brand_name == SKIP
       @shipping_preference = shipping_preference unless shipping_preference == SKIP
       @vault_instruction = vault_instruction unless vault_instruction == SKIP
@@ -60,14 +63,29 @@ module PaypalServerSdk
 
       # Extract variables from the hash.
       brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
-      shipping_preference = hash['shipping_preference'] ||= 'GET_FROM_FILE'
+      shipping_preference =
+        hash['shipping_preference'] ||= OrderApplicationContextShippingPreference::GET_FROM_FILE
       vault_instruction =
-        hash['vault_instruction'] ||= 'ON_CREATE_PAYMENT_TOKENS'
+        hash['vault_instruction'] ||= VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
 
       # Create object from extracted values.
       VaultVenmoExperienceContext.new(brand_name: brand_name,
                                       shipping_preference: shipping_preference,
                                       vault_instruction: vault_instruction)
     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}>"
+    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}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/vault_venmo_request.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,13 +35,13 @@ 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
 
     # Customizes the Vault creation flow experience for your customers.
@@ -48,6 +52,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'
@@ -61,6 +66,7 @@ module PaypalServerSdk
     def self.optionals
       %w[
         description
+        usage_pattern
         shipping
         permit_multiple_payment_tokens
         usage_type
@@ -74,10 +80,11 @@ 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, experience_context: 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 =
@@ -94,6 +101,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 =
@@ -105,11 +113,31 @@ module PaypalServerSdk
 
       # Create object from extracted values.
       VaultVenmoRequest.new(description: description,
+                            usage_pattern: usage_pattern,
                             shipping: shipping,
                             permit_multiple_payment_tokens: permit_multiple_payment_tokens,
                             usage_type: usage_type,
                             customer_type: customer_type,
                             experience_context: experience_context)
     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}, experience_context:"\
+      " #{@experience_context}>"
+    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}, experience_context:"\
+      " #{@experience_context.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/vaulted_digital_wallet.rb

@@ -16,6 +16,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
@@ -32,19 +36,20 @@ 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
 
     # A mapping from model property names to API property names.
     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'
@@ -57,6 +62,7 @@ module PaypalServerSdk
     def self.optionals
       %w[
         description
+        usage_pattern
         shipping
         permit_multiple_payment_tokens
         usage_type
@@ -69,10 +75,11 @@ 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)
       @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 =
@@ -88,6 +95,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 =
@@ -97,10 +105,28 @@ module PaypalServerSdk
 
       # Create object from extracted values.
       VaultedDigitalWallet.new(description: description,
+                               usage_pattern: usage_pattern,
                                shipping: shipping,
                                permit_multiple_payment_tokens: permit_multiple_payment_tokens,
                                usage_type: usage_type,
                                customer_type: customer_type)
     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}>"
+    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}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/vaulted_digital_wallet_shipping_details.rb

@@ -13,6 +13,11 @@ module PaypalServerSdk
     # @return [ShippingName]
     attr_accessor :name
 
+    # The phone number, in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumberWithCountryCode]
+    attr_accessor :phone_number
+
     # A classification for the method of purchase fulfillment (e.g shipping,
     # in-store pickup, etc). Either `type` or `options` may be present, but not
     # both.
@@ -32,6 +37,7 @@ module PaypalServerSdk
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['name'] = 'name'
+      @_hash['phone_number'] = 'phone_number'
       @_hash['type'] = 'type'
       @_hash['address'] = 'address'
       @_hash
@@ -41,6 +47,7 @@ module PaypalServerSdk
     def self.optionals
       %w[
         name
+        phone_number
         type
         address
       ]
@@ -51,8 +58,9 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(name: SKIP, type: SKIP, address: SKIP)
+    def initialize(name: SKIP, phone_number: SKIP, type: SKIP, address: SKIP)
       @name = name unless name == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
       @type = type unless type == SKIP
       @address = address unless address == SKIP
     end
@@ -63,13 +71,30 @@ module PaypalServerSdk
 
       # Extract variables from the hash.
       name = ShippingName.from_hash(hash['name']) if hash['name']
+      phone_number = PhoneNumberWithCountryCode.from_hash(hash['phone_number']) if
+        hash['phone_number']
       type = hash.key?('type') ? hash['type'] : SKIP
       address = Address.from_hash(hash['address']) if hash['address']
 
       # Create object from extracted values.
       VaultedDigitalWalletShippingDetails.new(name: name,
+                                              phone_number: phone_number,
                                               type: type,
                                               address: address)
     end
+
+    # 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}>"
+    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}>"
+    end
   end
 end