paypal-server-sdk 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 716ca4b1a12121acd6e221becbf2d29c55063b4f8b46eb68b499a84d6c22a175
-  data.tar.gz: c875e40983c4bb398f4d40849540c2e3e8a612f94383ca70326bd7a5a24f7223
+  metadata.gz: 897375c15dd72b5ca2daacf2cab5d59d6ce03c115988a287046464457fe0ff1c
+  data.tar.gz: f550128d4e3650b8b88e3c93e87b3cb531847d71cbec66419671c753f5b5e6c9
 SHA512:
-  metadata.gz: 96c1fd80ecdf37001dc6e351e81677e02740414aba53b4913a71c56a82a1bafcc5d5f55caf6af264a5e065fdbcfcb7ddd07875358c09b893087277016371a6a3
-  data.tar.gz: 0d5bb3db5f27cddfff1c1712fd14d0519108a9d5239605615f6ade8aa5c452cdf5b2cb59986e9e99066e44ea04042867c5c79491b4e21f10be0db6eddb228ebc
+  metadata.gz: 7873e8c5e2f95ca2c3ad61b53bf1a59117f1d543040f0edf84d24808a4fd7b78e94c1968eccf93ad4cf44f62b6220c958069a616db1e6dc4d9aeced4143df03f
+  data.tar.gz: c183c3346a29a306bbcd7a473ed60d642a47512bf8b37e7e86e3450e4cd6d9a138899b586354c3936330cd78e57d7f91be24d259249886dac8b908d5f4cb3d0a

data/README.md

@@ -22,16 +22,16 @@ The PayPal Server SDK provides integration access to the PayPal REST APIs. The A
 Install the gem from the command line:
 
 ```bash
-gem install paypal-server-sdk -v 2.1.0
+gem install paypal-server-sdk -v 2.2.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'paypal-server-sdk', '2.1.0'
+gem 'paypal-server-sdk', '2.2.0'
 ```
 
-For additional gem details, see the [RubyGems page for the paypal-server-sdk gem](https://rubygems.org/gems/paypal-server-sdk/versions/2.1.0).
+For additional gem details, see the [RubyGems page for the paypal-server-sdk gem](https://rubygems.org/gems/paypal-server-sdk/versions/2.2.0).
 
 ## IRB Console Usage
 
@@ -70,7 +70,7 @@ ruby bin/console
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -86,9 +86,9 @@ The following parameters are configurable for the API Client:
 | retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
 | retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
 | http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
-| proxy_settings | [`ProxySettings`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-| logging_configuration | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
-| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| proxy_settings | [`ProxySettings`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
 
 The API client can be initialized as follows:
 
@@ -126,7 +126,7 @@ include PaypalServerSdk
 client = Client.from_env
 ```
 
-See the [`Environment-Based Client Initialization`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/environment-based-client-initialization.md) section for details.
+See the [`Environment-Based Client Initialization`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/environment-based-client-initialization.md) section for details.
 
 ## Environments
 
@@ -143,35 +143,35 @@ The SDK can be configured to use a different environment for making API calls. A
 
 This API uses the following authentication schemes.
 
-* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/auth/oauth-2-client-credentials-grant.md)
+* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/auth/oauth-2-client-credentials-grant.md)
 
 ## List of APIs
 
-* [Orders](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/orders.md)
-* [Payments](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/payments.md)
-* [Vault](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/vault.md)
-* [Transaction Search](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/transaction-search.md)
-* [Subscriptions](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/controllers/subscriptions.md)
+* [Orders](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/controllers/orders.md)
+* [Payments](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/controllers/payments.md)
+* [Vault](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/controllers/vault.md)
+* [Transaction Search](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/controllers/transaction-search.md)
+* [Subscriptions](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/controllers/subscriptions.md)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [ProxySettings](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/environment-based-client-initialization.md)
-* [AbstractLogger](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/abstract-logger.md)
-* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/logging-configuration.md)
-* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/request-logging-configuration.md)
-* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/response-logging-configuration.md)
+* [ProxySettings](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/response-logging-configuration.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/http-request.md)
+* [HttpResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/http-request.md)
 
 ### Utilities
 
-* [ApiResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/api-response.md)
-* [ApiHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.1.0/doc/date-time-helper.md)
+* [ApiResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/api-response.md)
+* [ApiHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.2.0/doc/date-time-helper.md)
 

data/lib/paypal_server_sdk/controllers/base_controller.rb

@@ -10,7 +10,7 @@ module PaypalServerSdk
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'PayPal REST API Ruby SDK, Version: 2.1.0, on OS {os-info}'
+      'PayPal REST API Ruby SDK, Version: 2.2.0, on OS {os-info}'
     end
 
     def self.user_agent_parameters

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_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

data/lib/paypal_server_sdk/models/subscriber.rb

@@ -9,6 +9,17 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
+    # 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 account identifier for a PayPal account.
+    # @return [String]
+    attr_accessor :payer_id
+
     # The name of the party.
     # @return [Name]
     attr_accessor :name
@@ -24,6 +35,8 @@ module PaypalServerSdk
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'email_address'
+      @_hash['payer_id'] = 'payer_id'
       @_hash['name'] = 'name'
       @_hash['shipping_address'] = 'shipping_address'
       @_hash['payment_source'] = 'payment_source'
@@ -33,6 +46,8 @@ module PaypalServerSdk
     # An array for optional fields
     def self.optionals
       %w[
+        email_address
+        payer_id
         name
         shipping_address
         payment_source
@@ -44,7 +59,10 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(name: SKIP, shipping_address: SKIP, payment_source: SKIP)
+    def initialize(email_address: SKIP, payer_id: SKIP, name: SKIP,
+                   shipping_address: SKIP, payment_source: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
       @name = name unless name == SKIP
       @shipping_address = shipping_address unless shipping_address == SKIP
       @payment_source = payment_source unless payment_source == SKIP
@@ -55,6 +73,8 @@ module PaypalServerSdk
       return nil unless hash
 
       # Extract variables from the hash.
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
       name = Name.from_hash(hash['name']) if hash['name']
       shipping_address = ShippingDetails.from_hash(hash['shipping_address']) if
         hash['shipping_address']
@@ -62,7 +82,9 @@ module PaypalServerSdk
         hash['payment_source']
 
       # Create object from extracted values.
-      Subscriber.new(name: name,
+      Subscriber.new(email_address: email_address,
+                     payer_id: payer_id,
+                     name: name,
                      shipping_address: shipping_address,
                      payment_source: payment_source)
     end
@@ -70,15 +92,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}, shipping_address: #{@shipping_address}, payment_source:"\
-      " #{@payment_source}>"
+      "<#{class_name} email_address: #{@email_address}, payer_id: #{@payer_id}, name: #{@name},"\
+      " shipping_address: #{@shipping_address}, payment_source: #{@payment_source}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name.inspect}, shipping_address: #{@shipping_address.inspect},"\
-      " payment_source: #{@payment_source.inspect}>"
+      "<#{class_name} email_address: #{@email_address.inspect}, payer_id: #{@payer_id.inspect},"\
+      " name: #{@name.inspect}, shipping_address: #{@shipping_address.inspect}, payment_source:"\
+      " #{@payment_source.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/subscriber_request.rb

@@ -9,14 +9,21 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
+    # 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 account identifier for a PayPal account.
+    # @return [String]
+    attr_accessor :payer_id
+
     # The name of the party.
     # @return [Name]
     attr_accessor :name
 
-    # The phone information.
-    # @return [PhoneWithType]
-    attr_accessor :phone
-
     # The shipping details.
     # @return [ShippingDetails]
     attr_accessor :shipping_address
@@ -28,23 +35,31 @@ module PaypalServerSdk
     # @return [SubscriptionPaymentSource]
     attr_accessor :payment_source
 
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'email_address'
+      @_hash['payer_id'] = 'payer_id'
       @_hash['name'] = 'name'
-      @_hash['phone'] = 'phone'
       @_hash['shipping_address'] = 'shipping_address'
       @_hash['payment_source'] = 'payment_source'
+      @_hash['phone'] = 'phone'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
       %w[
+        email_address
+        payer_id
         name
-        phone
         shipping_address
         payment_source
+        phone
       ]
     end
 
@@ -53,12 +68,14 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(name: SKIP, phone: SKIP, shipping_address: SKIP,
-                   payment_source: SKIP)
+    def initialize(email_address: SKIP, payer_id: SKIP, name: SKIP,
+                   shipping_address: SKIP, payment_source: SKIP, phone: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
       @name = name unless name == SKIP
-      @phone = phone unless phone == SKIP
       @shipping_address = shipping_address unless shipping_address == SKIP
       @payment_source = payment_source unless payment_source == SKIP
+      @phone = phone unless phone == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -66,32 +83,38 @@ module PaypalServerSdk
       return nil unless hash
 
       # Extract variables from the hash.
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
       name = Name.from_hash(hash['name']) if hash['name']
-      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
       shipping_address = ShippingDetails.from_hash(hash['shipping_address']) if
         hash['shipping_address']
       payment_source = SubscriptionPaymentSource.from_hash(hash['payment_source']) if
         hash['payment_source']
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
 
       # Create object from extracted values.
-      SubscriberRequest.new(name: name,
-                            phone: phone,
+      SubscriberRequest.new(email_address: email_address,
+                            payer_id: payer_id,
+                            name: name,
                             shipping_address: shipping_address,
-                            payment_source: payment_source)
+                            payment_source: payment_source,
+                            phone: phone)
     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: #{@phone}, shipping_address: #{@shipping_address},"\
-      " payment_source: #{@payment_source}>"
+      "<#{class_name} email_address: #{@email_address}, payer_id: #{@payer_id}, name: #{@name},"\
+      " shipping_address: #{@shipping_address}, payment_source: #{@payment_source}, phone:"\
+      " #{@phone}>"
     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: #{@phone.inspect}, shipping_address:"\
-      " #{@shipping_address.inspect}, payment_source: #{@payment_source.inspect}>"
+      "<#{class_name} email_address: #{@email_address.inspect}, payer_id: #{@payer_id.inspect},"\
+      " name: #{@name.inspect}, shipping_address: #{@shipping_address.inspect}, payment_source:"\
+      " #{@payment_source.inspect}, phone: #{@phone.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/subscription_payer.rb

@@ -0,0 +1,85 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The customer who approves and pays for the order. The customer is also known
+  # as the payer.
+  class SubscriptionPayer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 account identifier for a PayPal account.
+    # @return [String]
+    attr_accessor :payer_id
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'email_address'
+      @_hash['payer_id'] = 'payer_id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address
+        payer_id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email_address: SKIP, payer_id: SKIP, name: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @name = name unless name == 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.
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
+      name = Name.from_hash(hash['name']) if hash['name']
+
+      # Create object from extracted values.
+      SubscriptionPayer.new(email_address: email_address,
+                            payer_id: payer_id,
+                            name: name)
+    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}, payer_id: #{@payer_id}, name: #{@name}>"
+    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}, payer_id: #{@payer_id.inspect},"\
+      " name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/usage_type.rb

@@ -0,0 +1,39 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The usage type associated with the PayPal payment token.
+  class UsageType
+    USAGE_TYPE = [
+      # The PayPal Payment Token will be used for future transaction directly
+      # with a merchant.
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # The PayPal 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
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MERCHANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'merchant' then MERCHANT
+      when 'platform' then PLATFORM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk.rb

@@ -176,6 +176,7 @@ require_relative 'paypal_server_sdk/models/venmo_wallet_experience_context'
 require_relative 'paypal_server_sdk/models/venmo_wallet_request'
 require_relative 'paypal_server_sdk/models/venmo_wallet_response'
 require_relative 'paypal_server_sdk/models/payer_base'
+require_relative 'paypal_server_sdk/models/paypal_wallet_vault_base'
 require_relative 'paypal_server_sdk/models/address'
 require_relative 'paypal_server_sdk/models/apple_pay_tokenized_card'
 require_relative 'paypal_server_sdk/models/google_pay_card'
@@ -312,6 +313,7 @@ require_relative 'paypal_server_sdk/models/subscription_transaction_details'
 require_relative 'paypal_server_sdk/models/transactions_list'
 require_relative 'paypal_server_sdk/models/update_pricing_scheme'
 require_relative 'paypal_server_sdk/models/update_pricing_schemes_request'
+require_relative 'paypal_server_sdk/models/subscription_payer'
 require_relative 'paypal_server_sdk/models/last_payment_details'
 require_relative 'paypal_server_sdk/models/payment_method'
 require_relative 'paypal_server_sdk/models/plan_details'
@@ -386,6 +388,7 @@ require_relative 'paypal_server_sdk/models/tax_id_type'
 require_relative 'paypal_server_sdk/models/tenure_type'
 require_relative 'paypal_server_sdk/models/token_type'
 require_relative 'paypal_server_sdk/models/upc_type'
+require_relative 'paypal_server_sdk/models/usage_type'
 require_relative 'paypal_server_sdk/models/vault_status'
 require_relative 'paypal_server_sdk/models/venmo_payment_token_customer_type'
 require_relative 'paypal_server_sdk/models/venmo_payment_token_usage_pattern'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypal-server-sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - PayPal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-04 00:00:00.000000000 Z
+date: 2026-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -306,6 +306,7 @@ files:
 - lib/paypal_server_sdk/models/paypal_wallet_experience_context.rb
 - lib/paypal_server_sdk/models/paypal_wallet_response.rb
 - lib/paypal_server_sdk/models/paypal_wallet_stored_credential.rb
+- lib/paypal_server_sdk/models/paypal_wallet_vault_base.rb
 - lib/paypal_server_sdk/models/paypal_wallet_vault_instruction.rb
 - lib/paypal_server_sdk/models/paypal_wallet_vault_response.rb
 - lib/paypal_server_sdk/models/paypal_wallet_vault_status.rb
@@ -383,6 +384,7 @@ files:
 - lib/paypal_server_sdk/models/subscription_collection.rb
 - lib/paypal_server_sdk/models/subscription_customer_information.rb
 - lib/paypal_server_sdk/models/subscription_patch_application_context.rb
+- lib/paypal_server_sdk/models/subscription_payer.rb
 - lib/paypal_server_sdk/models/subscription_payer_name.rb
 - lib/paypal_server_sdk/models/subscription_payment_source.rb
 - lib/paypal_server_sdk/models/subscription_payment_source_response.rb
@@ -415,6 +417,7 @@ files:
 - lib/paypal_server_sdk/models/update_pricing_scheme.rb
 - lib/paypal_server_sdk/models/update_pricing_schemes_request.rb
 - lib/paypal_server_sdk/models/usage_pattern.rb
+- lib/paypal_server_sdk/models/usage_type.rb
 - lib/paypal_server_sdk/models/vault_apple_pay_request.rb
 - lib/paypal_server_sdk/models/vault_card_experience_context.rb
 - lib/paypal_server_sdk/models/vault_card_verification_method.rb