paypal-server-sdk 1.1.0 → 2.0.0

data/lib/paypal_server_sdk/models/native_app_context.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Merchant provided, buyer's native app preferences to app switch to the
+  # PayPal consumer app.
+  class NativeAppContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Operating System type of the device that the buyer is using.
+    # @return [OsType]
+    attr_accessor :os_type
+
+    # Operating System version of the device that the buyer is using.
+    # @return [String]
+    attr_accessor :os_version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['os_type'] = 'os_type'
+      @_hash['os_version'] = 'os_version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        os_type
+        os_version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(os_type: SKIP, os_version: SKIP)
+      @os_type = os_type unless os_type == SKIP
+      @os_version = os_version unless os_version == 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.
+      os_type = hash.key?('os_type') ? hash['os_type'] : SKIP
+      os_version = hash.key?('os_version') ? hash['os_version'] : SKIP
+
+      # Create object from extracted values.
+      NativeAppContext.new(os_type: os_type,
+                           os_version: os_version)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} os_type: #{@os_type}, os_version: #{@os_version}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} os_type: #{@os_type.inspect}, os_version: #{@os_version.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/net_amount_breakdown_item.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 net amount. Returned when the currency of the refund is different from

data/lib/paypal_server_sdk/models/network_token.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 Third Party Network token used to fund a payment.

data/lib/paypal_server_sdk/models/{network_transaction_reference.rb → network_transaction.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
   # Reference values used by the card network to identify a transaction.
-  class NetworkTransactionReference < BaseModel
+  class NetworkTransaction < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -20,7 +20,9 @@ module PaypalServerSdk
 
     # The date that the transaction was authorized by the scheme. This field may
     # not be returned for all networks. MasterCard refers to this field as
-    # "BankNet reference date.
+    # "BankNet reference date". For some specific networks, such as MasterCard
+    # and Discover, this date field is mandatory when the
+    # `previous_network_transaction_reference_id` is passed.
     # @return [String]
     attr_accessor :date
 
@@ -47,6 +49,7 @@ module PaypalServerSdk
     # An array for optional fields
     def self.optionals
       %w[
+        id
         date
         network
         acquirer_reference_number
@@ -58,9 +61,9 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(id:, date: SKIP, network: SKIP,
+    def initialize(id: SKIP, date: SKIP, network: SKIP,
                    acquirer_reference_number: SKIP)
-      @id = id
+      @id = id unless id == SKIP
       @date = date unless date == SKIP
       @network = network unless network == SKIP
       unless acquirer_reference_number == SKIP
@@ -74,17 +77,17 @@ module PaypalServerSdk
       return nil unless hash
 
       # Extract variables from the hash.
-      id = hash.key?('id') ? hash['id'] : nil
+      id = hash.key?('id') ? hash['id'] : SKIP
       date = hash.key?('date') ? hash['date'] : SKIP
       network = hash.key?('network') ? hash['network'] : SKIP
       acquirer_reference_number =
         hash.key?('acquirer_reference_number') ? hash['acquirer_reference_number'] : SKIP
 
       # Create object from extracted values.
-      NetworkTransactionReference.new(id: id,
-                                      date: date,
-                                      network: network,
-                                      acquirer_reference_number: acquirer_reference_number)
+      NetworkTransaction.new(id: id,
+                             date: date,
+                             network: network,
+                             acquirer_reference_number: acquirer_reference_number)
     end
 
     # Provides a human-readable string representation of the object.

data/lib/paypal_server_sdk/models/network_transaction_reference_entity.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
   # Previous network transaction reference including id and network.

data/lib/paypal_server_sdk/models/o_auth_provider_error.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
   # OAuth 2 Authorization error codes

data/lib/paypal_server_sdk/models/o_auth_token.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
   # OAuth 2 Authorization endpoint response

data/lib/paypal_server_sdk/models/one_time_charge.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 one-time charge info at the time of checkout.

data/lib/paypal_server_sdk/models/order.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 order details.
@@ -36,8 +36,11 @@ module PaypalServerSdk
     # @return [CheckoutPaymentIntent]
     attr_accessor :intent
 
-    # The intent to either capture payment immediately or authorize a payment
-    # for an order after order creation.
+    # DEPRECATED. The customer is also known as the payer. The Payer object was
+    # intended to only be used with the `payment_source.paypal` object. In order
+    # to make this design more clear, the details in the `payer` object are now
+    # available under `payment_source.paypal`. Please use
+    # `payment_source.paypal`.
     # @return [Payer]
     attr_accessor :payer
 

data/lib/paypal_server_sdk/models/order_application_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 payer experience during the approval process for the payment
@@ -22,14 +22,15 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :brand_name
 
-    # The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the
-    # language in which to localize the error-related strings, such as messages,
-    # issues, and suggested actions. The tag is made up of the [ISO 639-2
-    # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
-    # the optional [ISO-15924 script
-    # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
-    # alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region
-    # code](https://unstats.un.org/unsd/methodology/m49/).
+    # DEPRECATED. The BCP 47-formatted locale of pages that the PayPal payment
+    # experience shows. PayPal supports a five-character code. For example,
+    # `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`,
+    # `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`.  The fields in
+    # `application_context` are now available in the `experience_context` object
+    # under the `payment_source` which supports them (eg.
+    # `payment_source.paypal.experience_context.locale`). Please specify this
+    # field in the `experience_context` object instead of the
+    # `application_context` object.
     # @return [String]
     attr_accessor :locale
 
@@ -64,7 +65,12 @@ module PaypalServerSdk
     # @return [OrderApplicationContextUserAction]
     attr_accessor :user_action
 
-    # The customer and merchant payment preferences.
+    # DEPRECATED. The customer and merchant payment preferences. The fields in
+    # `application_context` are now available in the `experience_context` object
+    # under the `payment_source` which supports them (eg.
+    # `payment_source.paypal.experience_context.payment_method_selected`).
+    # Please specify this field in the `experience_context` object instead of
+    # the `application_context` object..
     # @return [PaymentMethodPreference]
     attr_accessor :payment_method
 
@@ -87,16 +93,21 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :cancel_url
 
-    # Provides additional details to process a payment using a `payment_source`
-    # that has been stored or is intended to be stored (also referred to as
-    # stored_credential or card-on-file). Parameter compatibility:
-    # `payment_type=ONE_TIME` is compatible only with
+    # DEPRECATED. Provides additional details to process a payment using a
+    # `payment_source` that has been stored or is intended to be stored (also
+    # referred to as stored_credential or card-on-file). Parameter
+    # compatibility: `payment_type=ONE_TIME` is compatible only with
     # `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with
     # `payment_initiator=CUSTOMER`. `previous_transaction_reference` or
     # `previous_network_transaction_reference` is compatible only with
     # `payment_initiator=MERCHANT`. Only one of the parameters -
     # `previous_transaction_reference` and
     # `previous_network_transaction_reference` - can be present in the request.
+    # .  The fields in `stored_payment_source` are now available in the
+    # `stored_credential` object under the `payment_source` which supports them
+    # (eg. `payment_source.card.stored_credential.payment_initiator`). Please
+    # specify this field in the `payment_source` object instead of the
+    # `application_context` object.
     # @return [StoredPaymentSource]
     attr_accessor :stored_payment_source
 

data/lib/paypal_server_sdk/models/order_application_context_landing_page.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
   # DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site

data/lib/paypal_server_sdk/models/order_application_context_shipping_preference.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
   # DEPRECATED. DEPRECATED. The shipping preference: Displays the shipping
@@ -12,9 +12,7 @@ module PaypalServerSdk
   # which supports them (eg.
   # `payment_source.paypal.experience_context.shipping_preference`). Please
   # specify this field in the `experience_context` object instead of the
-  # `application_context` object., The shipping preference. This only applies to
-  # PayPal payment source., The shipping preference. This only applies to PayPal
-  # payment source.
+  # `application_context` object.
   class OrderApplicationContextShippingPreference
     ORDER_APPLICATION_CONTEXT_SHIPPING_PREFERENCE = [
       # Use the customer-provided shipping address on the PayPal site.

data/lib/paypal_server_sdk/models/order_application_context_user_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
   # DEPRECATED. Configures a Continue or Pay Now checkout flow.  The fields in

data/lib/paypal_server_sdk/models/order_authorize_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 authorization of an order request.

data/lib/paypal_server_sdk/models/order_authorize_request_payment_source.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 payment source definition.

data/lib/paypal_server_sdk/models/order_authorize_response.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
-  # OrderAuthorizeResponse Model.
+  # The order authorize response.
   class OrderAuthorizeResponse < BaseModel
     SKIP = Object.new
     private_constant :SKIP
@@ -36,8 +36,8 @@ module PaypalServerSdk
     # @return [CheckoutPaymentIntent]
     attr_accessor :intent
 
-    # The intent to either capture payment immediately or authorize a payment
-    # for an order after order creation.
+    # The customer who approves and pays for the order. The customer is also
+    # known as the payer.
     # @return [Payer]
     attr_accessor :payer
 
@@ -52,10 +52,17 @@ module PaypalServerSdk
     # @return [OrderStatus]
     attr_accessor :status
 
-    # An array of request-related [HATEOAS
-    # links](/api/rest/responses/#hateoas-links) that are either relevant to the
-    # issue by providing additional information or offering potential
-    # resolutions.
+    # An array of request-related HATEOAS links. To complete payer approval, use
+    # the `approve` link to redirect the payer. The API caller has 6 hours
+    # (default setting, this which can be changed by your account manager to
+    # 24/48/72 hours to accommodate your use case) from the time the order is
+    # created, to redirect your payer. Once redirected, the API caller has 6
+    # hours for the payer to approve the order and either authorize or capture
+    # the order. If you are not using the PayPal JavaScript SDK to initiate
+    # PayPal Checkout (in context) ensure that you include
+    # `application_context.return_url` is specified or you will get "We're
+    # sorry, Things don't appear to be working at the moment" after the payer
+    # approves the payment.
     # @return [Array[LinkDescription]]
     attr_accessor :links
 

data/lib/paypal_server_sdk/models/order_authorize_response_payment_source.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 payment source used to fund the payment.

data/lib/paypal_server_sdk/models/order_billing_plan.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
   # Metadata for merchant-managed recurring billing plans. Valid only during the

data/lib/paypal_server_sdk/models/order_capture_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
   # Completes an capture payment for an order.

data/lib/paypal_server_sdk/models/order_capture_request_payment_source.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 payment source definition.

data/lib/paypal_server_sdk/models/order_confirm_application_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 payer confirmation experience.

data/lib/paypal_server_sdk/models/order_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 order request details.
@@ -14,8 +14,11 @@ module PaypalServerSdk
     # @return [CheckoutPaymentIntent]
     attr_accessor :intent
 
-    # The intent to either capture payment immediately or authorize a payment
-    # for an order after order creation.
+    # DEPRECATED. The customer is also known as the payer. The Payer object was
+    # intended to only be used with the `payment_source.paypal` object. In order
+    # to make this design more clear, the details in the `payer` object are now
+    # available under `payment_source.paypal`. Please use
+    # `payment_source.paypal`.
     # @return [Payer]
     attr_accessor :payer
 

data/lib/paypal_server_sdk/models/order_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 order status.

data/lib/paypal_server_sdk/models/order_tracker_item.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 of the items in the shipment.

data/lib/paypal_server_sdk/models/order_tracker_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 tracking details of an order.

data/lib/paypal_server_sdk/models/order_tracker_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 tracking response on creation of tracker.

data/lib/paypal_server_sdk/models/order_tracker_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 status of the item shipment.

data/lib/paypal_server_sdk/models/orders_capture.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 captured payment.
@@ -39,7 +39,7 @@ module PaypalServerSdk
     attr_accessor :custom_id
 
     # Reference values used by the card network to identify a transaction.
-    # @return [NetworkTransactionReference]
+    # @return [NetworkTransaction]
     attr_accessor :network_transaction_reference
 
     # The level of protection offered as defined by [PayPal Seller Protection
@@ -180,7 +180,7 @@ module PaypalServerSdk
       invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
       custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
       if hash['network_transaction_reference']
-        network_transaction_reference = NetworkTransactionReference.from_hash(hash['network_transaction_reference'])
+        network_transaction_reference = NetworkTransaction.from_hash(hash['network_transaction_reference'])
       end
       seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
         hash['seller_protection']

data/lib/paypal_server_sdk/models/orders_card_verification_method.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 method used for card verification.

data/lib/paypal_server_sdk/models/os_type.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Operating System type of the device that the buyer is using.
+  class OsType
+    OS_TYPE = [
+      # Google Android OS.
+      ANDROID = 'ANDROID'.freeze,
+
+      # Apple OS typically found in Apple mobile devices.
+      IOS = 'IOS'.freeze,
+
+      # Any other OS type.
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/p24_payment_object.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
   # Information used to pay using P24(Przelewy24).

data/lib/paypal_server_sdk/models/p24_payment_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
   # Information needed to pay using P24 (Przelewy24).