paypal-server-sdk 0.6.0 → 0.7.0

data/lib/paypal_server_sdk/models/customer_response.rb

@@ -0,0 +1,76 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # This object defines a customer in your system. Use it to manage customer
+  # profiles, save payment methods and contact details.
+  class CustomerResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # Merchants and partners may already have a data-store where their customer
+    # information is persisted. Use merchant_customer_id to associate the
+    # PayPal-generated customer.id to your representation of a customer.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        merchant_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, merchant_customer_id: SKIP)
+      @id = id unless id == SKIP
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_id == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      CustomerResponse.new(id: id,
+                           merchant_customer_id: merchant_customer_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, merchant_customer_id: #{@merchant_customer_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, merchant_customer_id:"\
+      " #{@merchant_customer_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/customer_vault_payment_tokens_response.rb

@@ -17,11 +17,13 @@ module PaypalServerSdk
     # @return [Integer]
     attr_accessor :total_pages
 
-    # Customer in merchant's or partner's system of records.
-    # @return [CustomerRequest]
+    # This object defines a customer in your system. Use it to manage customer
+    # profiles, save payment methods and contact details.
+    # @return [VaultResponseCustomer]
     attr_accessor :customer
 
-    # Customer in merchant's or partner's system of records.
+    # This object defines a customer in your system. Use it to manage customer
+    # profiles, save payment methods and contact details.
     # @return [Array[PaymentTokenResponse]]
     attr_accessor :payment_tokens
 
@@ -72,7 +74,7 @@ module PaypalServerSdk
       # Extract variables from the hash.
       total_items = hash.key?('total_items') ? hash['total_items'] : SKIP
       total_pages = hash.key?('total_pages') ? hash['total_pages'] : SKIP
-      customer = CustomerRequest.from_hash(hash['customer']) if hash['customer']
+      customer = VaultResponseCustomer.from_hash(hash['customer']) if hash['customer']
       # Parameter is an array, so we need to iterate through it
       payment_tokens = nil
       unless hash['payment_tokens'].nil?
@@ -101,5 +103,20 @@ module PaypalServerSdk
                                              payment_tokens: payment_tokens,
                                              links: links)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_items: #{@total_items}, total_pages: #{@total_pages}, customer:"\
+      " #{@customer}, payment_tokens: #{@payment_tokens}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_items: #{@total_items.inspect}, total_pages: #{@total_pages.inspect},"\
+      " customer: #{@customer.inspect}, payment_tokens: #{@payment_tokens.inspect}, links:"\
+      " #{@links.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/cvv_code.rb

@@ -8,47 +8,55 @@ module PaypalServerSdk
   # American Express.
   class CvvCode
     CVV_CODE = [
-      # TODO: Write general description for E
-      E = 'E'.freeze,
+      # For Visa, Mastercard, Discover, or American Express, error -
+      # unrecognized or unknown response.
+      CVV_E = 'E'.freeze,
 
-      # TODO: Write general description for I
-      I = 'I'.freeze,
+      # For Visa, Mastercard, Discover, or American Express, invalid or null.
+      CVV_I = 'I'.freeze,
 
-      # TODO: Write general description for M
-      M = 'M'.freeze,
+      # For Visa, Mastercard, Discover, or American Express, the CVV2/CSC
+      # matches.
+      CVV_M = 'M'.freeze,
 
-      # TODO: Write general description for N
-      N = 'N'.freeze,
+      # For Visa, Mastercard, Discover, or American Express, the CVV2/CSC does
+      # not match.
+      CVV_N = 'N'.freeze,
 
-      # TODO: Write general description for P
-      P = 'P'.freeze,
+      # For Visa, Mastercard, Discover, or American Express, it was not
+      # processed.
+      CVV_P = 'P'.freeze,
 
-      # TODO: Write general description for S
-      S = 'S'.freeze,
+      # For Visa, Mastercard, Discover, or American Express, the service is not
+      # supported.
+      CVV_S = 'S'.freeze,
 
-      # TODO: Write general description for U
-      U = 'U'.freeze,
+      # For Visa, Mastercard, Discover, or American Express, unknown - the
+      # issuer is not certified.
+      CVV_U = 'U'.freeze,
 
-      # TODO: Write general description for X
-      X = 'X'.freeze,
+      # For Visa, Mastercard, Discover, or American Express, no response. For
+      # Maestro, the service is not available.
+      CVV_X = 'X'.freeze,
 
-      # TODO: Write general description for ENUM_ALL_OTHERS
+      # For Visa, Mastercard, Discover, or American Express, error.
       ENUM_ALL_OTHERS = 'All others'.freeze,
 
-      # TODO: Write general description for ENUM_0
-      ENUM_0 = '0'.freeze,
+      # For Maestro, the CVV2 matched.
+      CVV_0 = '0'.freeze,
 
-      # TODO: Write general description for ENUM_1
-      ENUM_1 = '1'.freeze,
+      # For Maestro, the CVV2 did not match.
+      CVV_1 = '1'.freeze,
 
-      # TODO: Write general description for ENUM_2
-      ENUM_2 = '2'.freeze,
+      # For Maestro, the merchant has not implemented CVV2 code handling.
+      CVV_2 = '2'.freeze,
 
-      # TODO: Write general description for ENUM_3
-      ENUM_3 = '3'.freeze,
+      # For Maestro, the merchant has indicated that CVV2 is not present on
+      # card.
+      CVV_3 = '3'.freeze,
 
-      # TODO: Write general description for ENUM_4
-      ENUM_4 = '4'.freeze
+      # For Maestro, the service is not available.
+      CVV_4 = '4'.freeze
     ].freeze
 
     def self.validate(value)

data/lib/paypal_server_sdk/models/disbursement_mode.rb

@@ -7,10 +7,13 @@ module PaypalServerSdk
   # The funds that are held on behalf of the merchant.
   class DisbursementMode
     DISBURSEMENT_MODE = [
-      # TODO: Write general description for INSTANT
+      # The funds are released to the merchant immediately.
       INSTANT = 'INSTANT'.freeze,
 
-      # TODO: Write general description for DELAYED
+      # The funds are held for a finite number of days. The actual duration
+      # depends on the region and type of integration. You can release the funds
+      # through a referenced payout. Otherwise, the funds disbursed
+      # automatically after the specified duration.
       DELAYED = 'DELAYED'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/dispute_category.rb

@@ -7,10 +7,10 @@ module PaypalServerSdk
   # The condition that is covered for the transaction.
   class DisputeCategory
     DISPUTE_CATEGORY = [
-      # TODO: Write general description for ITEM_NOT_RECEIVED
+      # The payer paid for an item that they did not receive.
       ITEM_NOT_RECEIVED = 'ITEM_NOT_RECEIVED'.freeze,
 
-      # TODO: Write general description for UNAUTHORIZED_TRANSACTION
+      # The payer did not authorize the payment.
       UNAUTHORIZED_TRANSACTION = 'UNAUTHORIZED_TRANSACTION'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/eci_flag.rb

@@ -9,24 +9,22 @@ module PaypalServerSdk
   # should be passed on the authorization transaction to the Gateway/Processor.
   class EciFlag
     ECI_FLAG = [
-      # TODO: Write general description for MASTERCARD_NON_3D_SECURE_TRANSACTION
+      # Mastercard non-3-D Secure transaction.
       MASTERCARD_NON_3D_SECURE_TRANSACTION = 'MASTERCARD_NON_3D_SECURE_TRANSACTION'.freeze,
 
-      # TODO: Write general description for
-      # MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION
+      # Mastercard attempted authentication transaction.
       MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION = 'MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION'.freeze,
 
-      # TODO: Write general description for
-      # MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION
+      # Mastercard fully authenticated transaction.
       MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION = 'MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION'.freeze,
 
-      # TODO: Write general description for FULLY_AUTHENTICATED_TRANSACTION
+      # VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction.
       FULLY_AUTHENTICATED_TRANSACTION = 'FULLY_AUTHENTICATED_TRANSACTION'.freeze,
 
-      # TODO: Write general description for ATTEMPTED_AUTHENTICATION_TRANSACTION
+      # VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction.
       ATTEMPTED_AUTHENTICATION_TRANSACTION = 'ATTEMPTED_AUTHENTICATION_TRANSACTION'.freeze,
 
-      # TODO: Write general description for NON_3D_SECURE_TRANSACTION
+      # VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction.
       NON_3D_SECURE_TRANSACTION = 'NON_3D_SECURE_TRANSACTION'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/enrollment_status.rb

@@ -7,17 +7,20 @@ module PaypalServerSdk
   # Status of Authentication eligibility.
   class EnrollmentStatus
     ENROLLMENT_STATUS = [
-      # TODO: Write general description for Y
-      Y = 'Y'.freeze,
+      # Yes. The bank is participating in 3-D Secure protocol and will return
+      # the ACSUrl.
+      ENROLLED = 'Y'.freeze,
 
-      # TODO: Write general description for N
-      N = 'N'.freeze,
+      # No. The bank is not participating in 3-D Secure protocol.
+      NOTENROLLED = 'N'.freeze,
 
-      # TODO: Write general description for U
-      U = 'U'.freeze,
+      # Unavailable. The DS or ACS is not available for authentication at the
+      # time of the request.
+      UNAVAILABLE = 'U'.freeze,
 
-      # TODO: Write general description for B
-      B = 'B'.freeze
+      # Bypass. The merchant authentication rule is triggered to bypass
+      # authentication.
+      BYPASS = 'B'.freeze
     ].freeze
 
     def self.validate(value)

data/lib/paypal_server_sdk/models/eps_payment_object.rb

@@ -14,11 +14,10 @@ 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
 
@@ -70,5 +69,18 @@ module PaypalServerSdk
                            country_code: country_code,
                            bic: bic)
     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}, bic: #{@bic}>"
+    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}, bic:"\
+      " #{@bic.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/eps_payment_request.rb

@@ -14,11 +14,10 @@ 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
 
@@ -69,5 +68,19 @@ module PaypalServerSdk
                             country_code: country_code,
                             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} name: #{@name}, country_code: #{@country_code}, 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} name: #{@name.inspect}, country_code: #{@country_code.inspect},"\
+      " experience_context: #{@experience_context.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/error_details.rb

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

data/lib/paypal_server_sdk/models/exchange_rate.rb

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

data/lib/paypal_server_sdk/models/experience_context.rb

@@ -94,5 +94,20 @@ module PaypalServerSdk
                             return_url: return_url,
                             cancel_url: cancel_url)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, shipping_preference:"\
+      " #{@shipping_preference}, 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} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect},"\
+      " shipping_preference: #{@shipping_preference.inspect}, return_url: #{@return_url.inspect},"\
+      " cancel_url: #{@cancel_url.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/fulfillment_type.rb

@@ -0,0 +1,36 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # A classification for the method of purchase fulfillment (e.g shipping,
+  # in-store pickup, etc). Either `type` or `options` may be present, but not
+  # both.
+  class FulfillmentType
+    FULFILLMENT_TYPE = [
+      # The payer intends to receive the items at a specified address.
+      SHIPPING = 'SHIPPING'.freeze,
+
+      # DEPRECATED. Please use "PICKUP_FROM_PERSON" instead.
+      PICKUP_IN_PERSON = 'PICKUP_IN_PERSON'.freeze,
+
+      # The payer intends to pick up the item(s) from the payee's physical
+      # store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller
+      # protection is provided with this option.
+      PICKUP_IN_STORE = 'PICKUP_IN_STORE'.freeze,
+
+      # The payer intends to pick up the item(s) from the payee in person. Also
+      # termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is
+      # not available, since the payer is receiving the item from the payee in
+      # person, and can validate the item prior to payment.
+      PICKUP_FROM_PERSON = 'PICKUP_FROM_PERSON'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/giropay_payment_object.rb

@@ -14,11 +14,10 @@ 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
 
@@ -70,5 +69,18 @@ module PaypalServerSdk
                                country_code: country_code,
                                bic: bic)
     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}, bic: #{@bic}>"
+    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}, bic:"\
+      " #{@bic.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/giropay_payment_request.rb

@@ -14,11 +14,10 @@ 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
 
@@ -69,5 +68,19 @@ module PaypalServerSdk
                                 country_code: country_code,
                                 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} name: #{@name}, country_code: #{@country_code}, 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} name: #{@name.inspect}, country_code: #{@country_code.inspect},"\
+      " experience_context: #{@experience_context.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/google_pay_authentication_method.rb

@@ -7,10 +7,16 @@ module PaypalServerSdk
   # Authentication Method which is used for the card transaction.
   class GooglePayAuthenticationMethod
     GOOGLE_PAY_AUTHENTICATION_METHOD = [
-      # TODO: Write general description for PAN_ONLY
+      # This authentication method is associated with payment cards stored on
+      # file with the user's Google Account. Returned payment data includes
+      # primary account number (PAN) with the expiration month and the
+      # expiration year.
       PAN_ONLY = 'PAN_ONLY'.freeze,
 
-      # TODO: Write general description for CRYPTOGRAM_3DS
+      # Returned payment data includes a 3-D Secure (3DS) cryptogram generated
+      # on the device. -> If authentication_method=CRYPTOGRAM, it is required
+      # that 'cryptogram' parameter in the request has a valid 3-D Secure (3DS)
+      # cryptogram generated on the device.
       CRYPTOGRAM_3DS = 'CRYPTOGRAM_3DS'.freeze
     ].freeze