paypal-server-sdk 1.0.0 → 2.0.0

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.

data/lib/paypal_server_sdk/models/setup_token_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 method to vault with the instrument details.
@@ -17,21 +17,31 @@ module PaypalServerSdk
     # @return [VaultPaypalWalletRequest]
     attr_accessor :paypal
 
-    # A resource representing a request to vault PayPal Wallet.
+    # A resource representing a request to vault Venmo.
     # @return [VaultVenmoRequest]
     attr_accessor :venmo
 
+    # A resource representing a request to vault Apple Pay.
+    # @return [VaultApplePayRequest]
+    attr_accessor :apple_pay
+
     # The Tokenized Payment Source representing a Request to Vault a Token.
     # @return [VaultTokenRequest]
     attr_accessor :token
 
+    # A Resource representing a request to vault a Bank used for ACH Debit.
+    # @return [BankRequest]
+    attr_accessor :bank
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['card'] = 'card'
       @_hash['paypal'] = 'paypal'
       @_hash['venmo'] = 'venmo'
+      @_hash['apple_pay'] = 'apple_pay'
       @_hash['token'] = 'token'
+      @_hash['bank'] = 'bank'
       @_hash
     end
 
@@ -41,7 +51,9 @@ module PaypalServerSdk
         card
         paypal
         venmo
+        apple_pay
         token
+        bank
       ]
     end
 
@@ -50,11 +62,14 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(card: SKIP, paypal: SKIP, venmo: SKIP, token: SKIP)
+    def initialize(card: SKIP, paypal: SKIP, venmo: SKIP, apple_pay: SKIP,
+                   token: SKIP, bank: SKIP)
       @card = card unless card == SKIP
       @paypal = paypal unless paypal == SKIP
       @venmo = venmo unless venmo == SKIP
+      @apple_pay = apple_pay unless apple_pay == SKIP
       @token = token unless token == SKIP
+      @bank = bank unless bank == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -65,26 +80,32 @@ module PaypalServerSdk
       card = SetupTokenRequestCard.from_hash(hash['card']) if hash['card']
       paypal = VaultPaypalWalletRequest.from_hash(hash['paypal']) if hash['paypal']
       venmo = VaultVenmoRequest.from_hash(hash['venmo']) if hash['venmo']
+      apple_pay = VaultApplePayRequest.from_hash(hash['apple_pay']) if hash['apple_pay']
       token = VaultTokenRequest.from_hash(hash['token']) if hash['token']
+      bank = BankRequest.from_hash(hash['bank']) if hash['bank']
 
       # Create object from extracted values.
       SetupTokenRequestPaymentSource.new(card: card,
                                          paypal: paypal,
                                          venmo: venmo,
-                                         token: token)
+                                         apple_pay: apple_pay,
+                                         token: token,
+                                         bank: bank)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} card: #{@card}, paypal: #{@paypal}, venmo: #{@venmo}, token: #{@token}>"
+      "<#{class_name} card: #{@card}, paypal: #{@paypal}, venmo: #{@venmo}, apple_pay:"\
+      " #{@apple_pay}, token: #{@token}, bank: #{@bank}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
       "<#{class_name} card: #{@card.inspect}, paypal: #{@paypal.inspect}, venmo:"\
-      " #{@venmo.inspect}, token: #{@token.inspect}>"
+      " #{@venmo.inspect}, apple_pay: #{@apple_pay.inspect}, token: #{@token.inspect}, bank:"\
+      " #{@bank.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/setup_token_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
   # Minimal representation of a cached setup token.
@@ -9,7 +9,9 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
-    # The PayPal-generated ID for the vault token.
+    # The PayPal-generated ID for the vaulted payment source. This ID should be
+    # stored on the merchant's server so the saved payment source can be used
+    # for future transactions.
     # @return [String]
     attr_accessor :id
 

data/lib/paypal_server_sdk/models/setup_token_response_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
   # SetupTokenResponseCard Model.

data/lib/paypal_server_sdk/models/setup_token_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 setup payment method details.
@@ -13,11 +13,11 @@ module PaypalServerSdk
     # @return [SetupTokenResponseCard]
     attr_accessor :card
 
-    # TODO: Write general description for this method
+    # Full representation of a PayPal Payment Token.
     # @return [PaypalPaymentToken]
     attr_accessor :paypal
 
-    # TODO: Write general description for this method
+    # Full representation of a Venmo Payment Token.
     # @return [VenmoPaymentToken]
     attr_accessor :venmo