paypal-server-sdk 1.1.0 → 2.0.0

data/lib/paypal_server_sdk/models/reason_code.rb

@@ -0,0 +1,41 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The reason code for the payment failure.
+  class ReasonCode
+    REASON_CODE = [
+      # PayPal declined the payment due to one or more customer issues.
+      PAYMENT_DENIED = 'PAYMENT_DENIED'.freeze,
+
+      # An internal server error has occurred.
+      INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR'.freeze,
+
+      # The payee account is not in good standing and cannot receive payments.
+      PAYEE_ACCOUNT_RESTRICTED = 'PAYEE_ACCOUNT_RESTRICTED'.freeze,
+
+      # The payer account is not in good standing and cannot make payments.
+      PAYER_ACCOUNT_RESTRICTED = 'PAYER_ACCOUNT_RESTRICTED'.freeze,
+
+      # Payer cannot pay for this transaction.
+      PAYER_CANNOT_PAY = 'PAYER_CANNOT_PAY'.freeze,
+
+      # The transaction exceeds the payer's sending limit.
+      SENDING_LIMIT_EXCEEDED = 'SENDING_LIMIT_EXCEEDED'.freeze,
+
+      # The transaction exceeds the receiver's receiving limit.
+      TRANSACTION_RECEIVING_LIMIT_EXCEEDED = 'TRANSACTION_RECEIVING_LIMIT_EXCEEDED'.freeze,
+
+      # The transaction is declined due to a currency mismatch.
+      CURRENCY_MISMATCH = 'CURRENCY_MISMATCH'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/reauthorize_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
   # Reauthorizes an authorized PayPal account payment, by ID. To ensure that
@@ -14,7 +14,6 @@ module PaypalServerSdk
   # payment once. The allowed amount depends on context and geography, for
   # example in US it is up to 115% of the original authorized amount, not to
   # exceed an increase of $75 USD. Supports only the `amount` request parameter.
-  # Note: This request is currently not supported for Partner use cases.
   class ReauthorizeRequest < BaseModel
     SKIP = Object.new
     private_constant :SKIP

data/lib/paypal_server_sdk/models/refund.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 refund information.

data/lib/paypal_server_sdk/models/refund_incomplete_reason.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 reason why the refund has the `PENDING` or `FAILED` status.

data/lib/paypal_server_sdk/models/refund_payment_instruction.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
   # Any additional payments instructions during refund payment processing. This

data/lib/paypal_server_sdk/models/refund_platform_fee.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 platform or partner fee, commission, or brokerage fee that is associated

data/lib/paypal_server_sdk/models/refund_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
   # Refunds a captured payment, by ID. For a full refund, include an empty

data/lib/paypal_server_sdk/models/refund_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 refund.

data/lib/paypal_server_sdk/models/refund_status_details.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 refund status.

data/lib/paypal_server_sdk/models/refund_status_with_details.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 refund status with details.

data/lib/paypal_server_sdk/models/related_identifiers.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
   # Identifiers related to a specific resource.

data/lib/paypal_server_sdk/models/return_flow.rb

@@ -0,0 +1,28 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Merchant preference on how the buyer can navigate back to merchant website
+  # post approving the transaction on the Venmo App.
+  class ReturnFlow
+    RETURN_FLOW = [
+      # After payment approval in the PayPal App, buyer will automatically be
+      # redirected to the merchant website.
+      AUTO = 'AUTO'.freeze,
+
+      # After payment approval in the PayPal App, buyer will be asked to
+      # manually navigate back to the merchant website where they started the
+      # transaction from. The buyer is shown a message like 'Return to Merchant'
+      # to return to the source where the transaction actually started.
+      MANUAL = 'MANUAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/risk_supplementary_data.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
   # Additional information necessary to evaluate the risk profile of a

data/lib/paypal_server_sdk/models/search_response.rb

@@ -0,0 +1,176 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The search response information.
+  class SearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of transaction detail objects.
+    # @return [Array[TransactionDetails]]
+    attr_accessor :transaction_details
+
+    # The merchant account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # 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. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @return [String]
+    attr_accessor :start_date
+
+    # 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. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @return [String]
+    attr_accessor :end_date
+
+    # 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. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @return [String]
+    attr_accessor :last_refreshed_datetime
+
+    # A zero-relative index of transactions.
+    # @return [Integer]
+    attr_accessor :page
+
+    # The total number of transactions as an integer beginning with the
+    # specified `page` in the full result and not just in this response.
+    # @return [Integer]
+    attr_accessor :total_items
+
+    # The total number of pages, as an `integer`, when the `total_items` is
+    # divided into pages of the specified `page_size`.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # An array of request-related [HATEOAS
+    # links](/api/rest/responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_details'] = 'transaction_details'
+      @_hash['account_number'] = 'account_number'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['last_refreshed_datetime'] = 'last_refreshed_datetime'
+      @_hash['page'] = 'page'
+      @_hash['total_items'] = 'total_items'
+      @_hash['total_pages'] = 'total_pages'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_details
+        account_number
+        start_date
+        end_date
+        last_refreshed_datetime
+        page
+        total_items
+        total_pages
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_details: SKIP, account_number: SKIP,
+                   start_date: SKIP, end_date: SKIP,
+                   last_refreshed_datetime: SKIP, page: SKIP, total_items: SKIP,
+                   total_pages: SKIP, links: SKIP)
+      @transaction_details = transaction_details unless transaction_details == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @last_refreshed_datetime = last_refreshed_datetime unless last_refreshed_datetime == SKIP
+      @page = page unless page == SKIP
+      @total_items = total_items unless total_items == SKIP
+      @total_pages = total_pages unless total_pages == 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.
+      # Parameter is an array, so we need to iterate through it
+      transaction_details = nil
+      unless hash['transaction_details'].nil?
+        transaction_details = []
+        hash['transaction_details'].each do |structure|
+          transaction_details << (TransactionDetails.from_hash(structure) if structure)
+        end
+      end
+
+      transaction_details = SKIP unless hash.key?('transaction_details')
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      last_refreshed_datetime =
+        hash.key?('last_refreshed_datetime') ? hash['last_refreshed_datetime'] : SKIP
+      page = hash.key?('page') ? hash['page'] : SKIP
+      total_items = hash.key?('total_items') ? hash['total_items'] : SKIP
+      total_pages = hash.key?('total_pages') ? hash['total_pages'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (LinkDescription.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+
+      # Create object from extracted values.
+      SearchResponse.new(transaction_details: transaction_details,
+                         account_number: account_number,
+                         start_date: start_date,
+                         end_date: end_date,
+                         last_refreshed_datetime: last_refreshed_datetime,
+                         page: page,
+                         total_items: total_items,
+                         total_pages: total_pages,
+                         links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_details: #{@transaction_details}, account_number:"\
+      " #{@account_number}, start_date: #{@start_date}, end_date: #{@end_date},"\
+      " last_refreshed_datetime: #{@last_refreshed_datetime}, page: #{@page}, total_items:"\
+      " #{@total_items}, total_pages: #{@total_pages}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_details: #{@transaction_details.inspect}, account_number:"\
+      " #{@account_number.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, last_refreshed_datetime: #{@last_refreshed_datetime.inspect}, page:"\
+      " #{@page.inspect}, total_items: #{@total_items.inspect}, total_pages:"\
+      " #{@total_pages.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/seller_payable_breakdown.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 breakdown of the refund.

data/lib/paypal_server_sdk/models/seller_protection.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 level of protection offered as defined by [PayPal Seller Protection for

data/lib/paypal_server_sdk/models/seller_protection_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
   # Indicates whether the transaction is eligible for seller protection. For

data/lib/paypal_server_sdk/models/seller_receivable_breakdown.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 detailed breakdown of the capture activity. This is not available for

data/lib/paypal_server_sdk/models/sepa_debit_experience_context.rb

@@ -0,0 +1,88 @@
+# paypal_server_sdk
+#
+# 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 SEPA
+  # Debit payment.
+  class SepaDebitExperienceContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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/).
+    # @return [String]
+    attr_accessor :locale
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :return_url
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['locale'] = 'locale'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        locale
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(return_url:, cancel_url:, locale: SKIP)
+      @locale = locale unless locale == SKIP
+      @return_url = return_url
+      @cancel_url = cancel_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.
+      return_url = hash.key?('return_url') ? hash['return_url'] : nil
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : nil
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+
+      # Create object from extracted values.
+      SepaDebitExperienceContext.new(return_url: return_url,
+                                     cancel_url: cancel_url,
+                                     locale: locale)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} locale: #{@locale}, return_url: #{@return_url}, cancel_url:"\
+      " #{@cancel_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} locale: #{@locale.inspect}, return_url: #{@return_url.inspect}, cancel_url:"\
+      " #{@cancel_url.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/sepa_debit_request.rb

@@ -0,0 +1,64 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # An API resource denoting a request to securely store a SEPA Debit.
+  class SepaDebitRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customizes the payer experience during the approval process for the SEPA
+    # Debit payment.
+    # @return [SepaDebitExperienceContext]
+    attr_accessor :experience_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        experience_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(experience_context: SKIP)
+      @experience_context = experience_context unless experience_context == 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.
+      experience_context = SepaDebitExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      SepaDebitRequest.new(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} 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} experience_context: #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_fee_failure_action.rb

@@ -0,0 +1,24 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The action to take on the subscription if the initial payment for the setup
+  # fails.
+  class SetupFeeFailureAction
+    SETUP_FEE_FAILURE_ACTION = [
+      # Continues the subscription if the initial payment for the setup fails.
+      CONTINUE = 'CONTINUE'.freeze,
+
+      # Cancels the subscription if the initial payment for the setup fails.
+      CANCEL = 'CANCEL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_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
   # Setup Token Request where the `source` defines the type of instrument to be

data/lib/paypal_server_sdk/models/setup_token_request_card.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 Resource representing a request to vault a Card.
@@ -46,8 +46,8 @@ module PaypalServerSdk
     # @return [VaultCardVerificationMethod]
     attr_accessor :verification_method
 
-    # Customizes the Vault creation flow experience for your customers.
-    # @return [SetupTokenCardExperienceContext]
+    # A resource representing an experience context of vault a card.
+    # @return [VaultCardExperienceContext]
     attr_accessor :experience_context
 
     # A mapping from model property names to API property names.
@@ -109,7 +109,7 @@ module PaypalServerSdk
       billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
       verification_method =
         hash.key?('verification_method') ? hash['verification_method'] : SKIP
-      experience_context = SetupTokenCardExperienceContext.from_hash(hash['experience_context']) if
+      experience_context = VaultCardExperienceContext.from_hash(hash['experience_context']) if
         hash['experience_context']
 
       # Create object from extracted values.