paypal-server-sdk 0.6.1 → 0.7.0

data/lib/paypal_server_sdk/models/blik_one_click_payment_object.rb

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

data/lib/paypal_server_sdk/models/blik_one_click_payment_request.rb

@@ -78,5 +78,20 @@ module PaypalServerSdk
                                      alias_label: alias_label,
                                      alias_key: alias_key)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_code: #{@auth_code}, consumer_reference: #{@consumer_reference},"\
+      " alias_label: #{@alias_label}, alias_key: #{@alias_key}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_code: #{@auth_code.inspect}, consumer_reference:"\
+      " #{@consumer_reference.inspect}, alias_label: #{@alias_label.inspect}, alias_key:"\
+      " #{@alias_key.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/blik_payment_object.rb

@@ -14,19 +14,17 @@ module PaypalServerSdk
     attr_accessor :name
 
     # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
-    # that identifies the country or region.<blockquote><strong>Note:</strong>
-    # The country code for Great Britain is <code>GB</code> and not
-    # <code>UK</code> as used in the top-level domain names for that country.
-    # Use the `C2` country code for China worldwide for comparable uncontrolled
-    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # that identifies the country or region. Note: The country code for Great
+    # Britain is GB and not UK as used in the top-level domain names for that
+    # country. Use the `C2` country code for China worldwide for comparable
+    # uncontrolled price (CUP) method, bank card, and cross-border transactions.
     # @return [String]
     attr_accessor :country_code
 
-    # 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
 
@@ -82,5 +80,19 @@ module PaypalServerSdk
                             email: email,
                             one_click: one_click)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, country_code: #{@country_code}, email: #{@email},"\
+      " one_click: #{@one_click}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, country_code: #{@country_code.inspect}, email:"\
+      " #{@email.inspect}, one_click: #{@one_click.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/blik_payment_request.rb

@@ -14,19 +14,17 @@ module PaypalServerSdk
     attr_accessor :name
 
     # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
-    # that identifies the country or region.<blockquote><strong>Note:</strong>
-    # The country code for Great Britain is <code>GB</code> and not
-    # <code>UK</code> as used in the top-level domain names for that country.
-    # Use the `C2` country code for China worldwide for comparable uncontrolled
-    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # that identifies the country or region. Note: The country code for Great
+    # Britain is GB and not UK as used in the top-level domain names for that
+    # country. Use the `C2` country code for China worldwide for comparable
+    # uncontrolled price (CUP) method, bank card, and cross-border transactions.
     # @return [String]
     attr_accessor :country_code
 
-    # 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
 
@@ -101,5 +99,21 @@ module PaypalServerSdk
                              level_0: level_0,
                              one_click: one_click)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, country_code: #{@country_code}, email: #{@email},"\
+      " experience_context: #{@experience_context}, level_0: #{@level_0}, one_click:"\
+      " #{@one_click}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, country_code: #{@country_code.inspect}, email:"\
+      " #{@email.inspect}, experience_context: #{@experience_context.inspect}, level_0:"\
+      " #{@level_0.inspect}, one_click: #{@one_click.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/callback_configuration.rb

@@ -0,0 +1,75 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # CallBack Configuration that the merchant can provide to PayPal/Venmo.
+  class CallbackConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of callback events merchant can subscribe to for the
+    # corresponding callback url. The SHIPPING_ADDRESS callback event is
+    # required.
+    # @return [Array[CallbackEvents]]
+    attr_accessor :callback_events
+
+    # Merchant provided CallBack url.PayPal/Venmo will use this url to call the
+    # merchant back when the events occur .PayPal/Venmo expects a secured url
+    # usually in the https format.merchant can append the cart id or other
+    # params part of the url as query or path params.
+    # @return [String]
+    attr_accessor :callback_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['callback_events'] = 'callback_events'
+      @_hash['callback_url'] = 'callback_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(callback_events:, callback_url:)
+      @callback_events = callback_events
+      @callback_url = callback_url
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      callback_events =
+        hash.key?('callback_events') ? hash['callback_events'] : nil
+      callback_url = hash.key?('callback_url') ? hash['callback_url'] : nil
+
+      # Create object from extracted values.
+      CallbackConfiguration.new(callback_events: callback_events,
+                                callback_url: callback_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} callback_events: #{@callback_events}, callback_url: #{@callback_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} callback_events: #{@callback_events.inspect}, callback_url:"\
+      " #{@callback_url.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/callback_events.rb

@@ -0,0 +1,27 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # CallBack event.
+  class CallbackEvents
+    CALLBACK_EVENTS = [
+      # When Buyer changes or selects the shipping address on the PayPal/Venmo
+      # buyer approval flow , PayPal/Venmo will call merchant with the callback
+      # URL to update order totals.
+      SHIPPING_ADDRESS = 'SHIPPING_ADDRESS'.freeze,
+
+      # When Buyer changes or selects the shipping options on the PayPal/Venmo
+      # buyer approval flow , PayPal/Venmo will call merchant with the callback
+      # URL to update order totals.
+      SHIPPING_OPTIONS = 'SHIPPING_OPTIONS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_incomplete_reason.rb

@@ -7,42 +7,50 @@ module PaypalServerSdk
   # The reason why the captured payment status is `PENDING` or `DENIED`.
   class CaptureIncompleteReason
     CAPTURE_INCOMPLETE_REASON = [
-      # TODO: Write general description for BUYER_COMPLAINT
+      # The payer initiated a dispute for this captured payment with PayPal.
       BUYER_COMPLAINT = 'BUYER_COMPLAINT'.freeze,
 
-      # TODO: Write general description for CHARGEBACK
+      # The captured funds were reversed in response to the payer disputing this
+      # captured payment with the issuer of the financial instrument used to pay
+      # for this captured payment.
       CHARGEBACK = 'CHARGEBACK'.freeze,
 
-      # TODO: Write general description for ECHECK
+      # The payer paid by an eCheck that has not yet cleared.
       ECHECK = 'ECHECK'.freeze,
 
-      # TODO: Write general description for INTERNATIONAL_WITHDRAWAL
+      # Visit your online account. In your **Account Overview**, accept and deny
+      # this payment.
       INTERNATIONAL_WITHDRAWAL = 'INTERNATIONAL_WITHDRAWAL'.freeze,
 
-      # TODO: Write general description for OTHER
+      # No additional specific reason can be provided. For more information
+      # about this captured payment, visit your account online or contact
+      # PayPal.
       OTHER = 'OTHER'.freeze,
 
-      # TODO: Write general description for PENDING_REVIEW
+      # The captured payment is pending manual review.
       PENDING_REVIEW = 'PENDING_REVIEW'.freeze,
 
-      # TODO: Write general description for
-      # RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION
+      # The payee has not yet set up appropriate receiving preferences for their
+      # account. For more information about how to accept or deny this payment,
+      # visit your account online. This reason is typically offered in scenarios
+      # such as when the currency of the captured payment is different from the
+      # primary holding currency of the payee.
       RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION = 'RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION'.freeze,
 
-      # TODO: Write general description for REFUNDED
+      # The captured funds were refunded.
       REFUNDED = 'REFUNDED'.freeze,
 
-      # TODO: Write general description for
-      # TRANSACTION_APPROVED_AWAITING_FUNDING
+      # The payer must send the funds for this captured payment. This code
+      # generally appears for manual EFTs.
       TRANSACTION_APPROVED_AWAITING_FUNDING = 'TRANSACTION_APPROVED_AWAITING_FUNDING'.freeze,
 
-      # TODO: Write general description for UNILATERAL
+      # The payee does not have a PayPal account.
       UNILATERAL = 'UNILATERAL'.freeze,
 
-      # TODO: Write general description for VERIFICATION_REQUIRED
+      # The payee's PayPal account is not verified.
       VERIFICATION_REQUIRED = 'VERIFICATION_REQUIRED'.freeze,
 
-      # TODO: Write general description for DECLINED_BY_RISK_FRAUD_FILTERS
+      # Risk Filter set by the payee failed for the transaction.
       DECLINED_BY_RISK_FRAUD_FILTERS = 'DECLINED_BY_RISK_FRAUD_FILTERS'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/capture_payment_instruction.rb

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

data/lib/paypal_server_sdk/models/capture_request.rb

@@ -104,5 +104,22 @@ module PaypalServerSdk
                          payment_instruction: payment_instruction,
                          soft_descriptor: soft_descriptor)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} invoice_id: #{@invoice_id}, note_to_payer: #{@note_to_payer}, amount:"\
+      " #{@amount}, final_capture: #{@final_capture}, payment_instruction:"\
+      " #{@payment_instruction}, soft_descriptor: #{@soft_descriptor}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} invoice_id: #{@invoice_id.inspect}, note_to_payer:"\
+      " #{@note_to_payer.inspect}, amount: #{@amount.inspect}, final_capture:"\
+      " #{@final_capture.inspect}, payment_instruction: #{@payment_instruction.inspect},"\
+      " soft_descriptor: #{@soft_descriptor.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/capture_status.rb

@@ -7,22 +7,26 @@ module PaypalServerSdk
   # The status of the captured payment.
   class CaptureStatus
     CAPTURE_STATUS = [
-      # TODO: Write general description for COMPLETED
+      # The funds for this captured payment were credited to the payee's PayPal
+      # account.
       COMPLETED = 'COMPLETED'.freeze,
 
-      # TODO: Write general description for DECLINED
+      # The funds could not be captured.
       DECLINED = 'DECLINED'.freeze,
 
-      # TODO: Write general description for PARTIALLY_REFUNDED
+      # An amount less than this captured payment's amount was partially
+      # refunded to the payer.
       PARTIALLY_REFUNDED = 'PARTIALLY_REFUNDED'.freeze,
 
-      # TODO: Write general description for PENDING
+      # The funds for this captured payment was not yet credited to the payee's
+      # PayPal account. For more information, see status.details.
       PENDING = 'PENDING'.freeze,
 
-      # TODO: Write general description for REFUNDED
+      # An amount greater than or equal to this captured payment's amount was
+      # refunded to the payer.
       REFUNDED = 'REFUNDED'.freeze,
 
-      # TODO: Write general description for FAILED
+      # There was an error while capturing payment.
       FAILED = 'FAILED'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/capture_status_details.rb

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

data/lib/paypal_server_sdk/models/capture_status_with_details.rb

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

data/lib/paypal_server_sdk/models/captured_payment.rb

@@ -72,22 +72,20 @@ module PaypalServerSdk
 
     # The processor response information for payment requests, such as direct
     # credit card transactions.
-    # @return [ProcessorResponse]
+    # @return [PaymentsProcessorResponse]
     attr_accessor :processor_response
 
     # The date and time, in [Internet date and time
     # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
-    # required while fractional seconds are
-    # optional.<blockquote><strong>Note:</strong> The regular expression
-    # provides guidance but does not reject all invalid dates.</blockquote>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @return [String]
     attr_accessor :create_time
 
     # The date and time, in [Internet date and time
     # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
-    # required while fractional seconds are
-    # optional.<blockquote><strong>Note:</strong> The regular expression
-    # provides guidance but does not reject all invalid dates.</blockquote>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @return [String]
     attr_accessor :update_time
 
@@ -97,7 +95,7 @@ module PaypalServerSdk
 
     # The details for the merchant who receives the funds and fulfills the
     # order. The merchant is also known as the payee.
-    # @return [Payee]
+    # @return [PayeeBase]
     attr_accessor :payee
 
     # A mapping from model property names to API property names.
@@ -217,13 +215,13 @@ module PaypalServerSdk
       end
 
       links = SKIP unless hash.key?('links')
-      processor_response = ProcessorResponse.from_hash(hash['processor_response']) if
+      processor_response = PaymentsProcessorResponse.from_hash(hash['processor_response']) if
         hash['processor_response']
       create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
       update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
       supplementary_data = PaymentSupplementaryData.from_hash(hash['supplementary_data']) if
         hash['supplementary_data']
-      payee = Payee.from_hash(hash['payee']) if hash['payee']
+      payee = PayeeBase.from_hash(hash['payee']) if hash['payee']
 
       # Create object from extracted values.
       CapturedPayment.new(status: status,
@@ -244,5 +242,33 @@ module PaypalServerSdk
                           supplementary_data: supplementary_data,
                           payee: payee)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_details: #{@status_details}, id: #{@id}, amount:"\
+      " #{@amount}, invoice_id: #{@invoice_id}, custom_id: #{@custom_id},"\
+      " network_transaction_reference: #{@network_transaction_reference}, seller_protection:"\
+      " #{@seller_protection}, final_capture: #{@final_capture}, seller_receivable_breakdown:"\
+      " #{@seller_receivable_breakdown}, disbursement_mode: #{@disbursement_mode}, links:"\
+      " #{@links}, processor_response: #{@processor_response}, create_time: #{@create_time},"\
+      " update_time: #{@update_time}, supplementary_data: #{@supplementary_data}, payee:"\
+      " #{@payee}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}, id:"\
+      " #{@id.inspect}, amount: #{@amount.inspect}, invoice_id: #{@invoice_id.inspect}, custom_id:"\
+      " #{@custom_id.inspect}, network_transaction_reference:"\
+      " #{@network_transaction_reference.inspect}, seller_protection:"\
+      " #{@seller_protection.inspect}, final_capture: #{@final_capture.inspect},"\
+      " seller_receivable_breakdown: #{@seller_receivable_breakdown.inspect}, disbursement_mode:"\
+      " #{@disbursement_mode.inspect}, links: #{@links.inspect}, processor_response:"\
+      " #{@processor_response.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}, supplementary_data: #{@supplementary_data.inspect}, payee:"\
+      " #{@payee.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/card_attributes.rb

@@ -66,5 +66,18 @@ module PaypalServerSdk
                          vault: vault,
                          verification: verification)
     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}, verification: #{@verification}>"
+    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}, verification:"\
+      " #{@verification.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/card_attributes_response.rb

@@ -46,5 +46,17 @@ module PaypalServerSdk
       # Create object from extracted values.
       CardAttributesResponse.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/card_authentication_response.rb

@@ -10,7 +10,7 @@ module PaypalServerSdk
     private_constant :SKIP
 
     # Results of 3D Secure Authentication.
-    # @return [ThreeDSecureAuthenticationResponse]
+    # @return [ThreeDSecureCardAuthenticationResponse]
     attr_accessor :three_d_secure
 
     # A mapping from model property names to API property names.
@@ -41,11 +41,23 @@ module PaypalServerSdk
       return nil unless hash
 
       # Extract variables from the hash.
-      three_d_secure = ThreeDSecureAuthenticationResponse.from_hash(hash['three_d_secure']) if
+      three_d_secure = ThreeDSecureCardAuthenticationResponse.from_hash(hash['three_d_secure']) if
         hash['three_d_secure']
 
       # Create object from extracted values.
       CardAuthenticationResponse.new(three_d_secure: three_d_secure)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} three_d_secure: #{@three_d_secure}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} three_d_secure: #{@three_d_secure.inspect}>"
+    end
   end
 end