paypal-server-sdk 0.6.1 → 0.7.0

data/lib/paypal_server_sdk/models/orders_card_verification_method.rb

@@ -0,0 +1,51 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The method used for card verification.
+  class OrdersCardVerificationMethod
+    ORDERS_CARD_VERIFICATION_METHOD = [
+      # Selecting this option will attempt to force a strong customer
+      # authentication for the authorization/transaction. In countries where SCA
+      # has been defined and implemented it will result in a contingency and
+      # HATEOAS link being returned.  The API caller should redirect the payer
+      # to that link so that they can authenticate themselves against their
+      # issuing bank or other entity. As noted, the HATEOAS link is only
+      # available in all regions where strong authentication is supported, (e.g.
+      # in European countries where 3DS is live). Merchants can use this setting
+      # as an additional layer of security if they choose to. In all cases, when
+      # an authorization is requested the AVS/CVV results will be returned in
+      # the response.
+      SCA_ALWAYS = 'SCA_ALWAYS'.freeze,
+
+      # This is the default. When an authorization or transaction is attempted
+      # this option will return a contingency and HATEOAS link only when local
+      # regulations require strong customer authentication, (e.g. 3DS in
+      # countries and use cases where it is mandated). The API caller should
+      # redirect the payer to the link so that they can authenticate themselves.
+      # In all cases, when an authorization is requested the AVS/CVV results
+      # will be returned in the response.
+      SCA_WHEN_REQUIRED = 'SCA_WHEN_REQUIRED'.freeze,
+
+      # The contingency surfaced as an additional security layer that helps
+      # prevent unauthorized card-not-present transactions and protects the
+      # merchant from exposure to fraud.
+      ENUM_3D_SECURE = '3D_SECURE'.freeze,
+
+      # Places a temporary hold on the card to ensure its validity. This process
+      # protects the merchant from exposure to fraud. This verification method
+      # will confirm that the address information or CVV included matches what
+      # the issuing bank has on file for the associated card, ensuring that only
+      # authorized card users are able to make purchases from you.
+      AVS_CVV = 'AVS_CVV'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/p24_payment_object.rb

@@ -13,20 +13,18 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :name
 
-    # 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
 
     # 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
 
@@ -104,5 +102,21 @@ module PaypalServerSdk
                            method_id: method_id,
                            method_description: method_description)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, email: #{@email}, country_code: #{@country_code},"\
+      " payment_descriptor: #{@payment_descriptor}, method_id: #{@method_id}, method_description:"\
+      " #{@method_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, email: #{@email.inspect}, country_code:"\
+      " #{@country_code.inspect}, payment_descriptor: #{@payment_descriptor.inspect}, method_id:"\
+      " #{@method_id.inspect}, method_description: #{@method_description.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/p24_payment_request.rb

@@ -13,20 +13,18 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :name
 
-    # 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
 
     # 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
 
@@ -81,5 +79,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}, email: #{@email}, 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}, email: #{@email.inspect}, country_code:"\
+      " #{@country_code.inspect}, experience_context: #{@experience_context.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/pa_res_status.rb

@@ -8,29 +8,29 @@ module PaypalServerSdk
   # authentication.
   class PaResStatus
     PA_RES_STATUS = [
-      # TODO: Write general description for Y
-      Y = 'Y'.freeze,
+      # Successful authentication.
+      SUCCESSFULAUTHENTICATION = 'Y'.freeze,
 
-      # TODO: Write general description for N
-      N = 'N'.freeze,
+      # Failed authentication / account not verified / transaction denied.
+      FAILEDAUTHENTICATION = 'N'.freeze,
 
-      # TODO: Write general description for U
-      U = 'U'.freeze,
+      # Unable to complete authentication.
+      UNABLETOCOMPLETEAUTHENTICATION = 'U'.freeze,
 
-      # TODO: Write general description for A
-      A = 'A'.freeze,
+      # Successful attempts transaction.
+      SUCCESSFULATTEMPTSTRANSACTION = 'A'.freeze,
 
-      # TODO: Write general description for C
-      C = 'C'.freeze,
+      # Challenge required for authentication.
+      CHALLENGEREQUIRED = 'C'.freeze,
 
-      # TODO: Write general description for R
-      R = 'R'.freeze,
+      # Authentication rejected (merchant must not submit for authorization).
+      AUTHENTICATIONREJECTED = 'R'.freeze,
 
-      # TODO: Write general description for D
-      D = 'D'.freeze,
+      # Challenge required; decoupled authentication confirmed.
+      DECOUPLEDAUTHENTICATION = 'D'.freeze,
 
-      # TODO: Write general description for I
-      I = 'I'.freeze
+      # Informational only; 3DS requestor challenge preference acknowledged.
+      INFORMATIONALONLY = 'I'.freeze
     ].freeze
 
     def self.validate(value)

data/lib/paypal_server_sdk/models/participant_metadata.rb

@@ -0,0 +1,64 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Profile information of the sender or receiver.
+  class ParticipantMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An Internet Protocol address (IP address). This address assigns a
+    # numerical label to each device that is connected to a computer network
+    # through the Internet Protocol. Supports IPv4 and IPv6 addresses.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ip_address'] = 'ip_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ip_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ip_address: SKIP)
+      @ip_address = ip_address unless ip_address == 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.
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+
+      # Create object from extracted values.
+      ParticipantMetadata.new(ip_address: ip_address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ip_address: #{@ip_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ip_address: #{@ip_address.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/patch.rb

@@ -13,22 +13,19 @@ module PaypalServerSdk
     # @return [PatchOp]
     attr_accessor :op
 
-    # The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the
-    # target document location at which to complete the operation.
+    # The JSON Pointer to the target document location at which to complete the
+    # operation.
     # @return [String]
     attr_accessor :path
 
-    # The value to apply. The <code>remove</code>, <code>copy</code>, and
-    # <code>move</code> operations do not require a value. Since <a
-    # href="https://www.rfc-editor.org/rfc/rfc69021">JSON Patch</a> allows any
-    # type for <code>value</code>, the <code>type</code> property is not
-    # specified.
+    # The value to apply. The remove, copy, and move operations do not require a
+    # value. Since JSON Patch allows any type for value, the type property is
+    # not specified.
     # @return [Object]
     attr_accessor :value
 
-    # The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the
-    # target document location from which to move the value. Required for the
-    # <code>move</code> operation.
+    # The JSON Pointer to the target document location from which to move the
+    # value. Required for the move operation.
     # @return [String]
     attr_accessor :from
 
@@ -79,5 +76,18 @@ module PaypalServerSdk
                 value: value,
                 from: from)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} op: #{@op}, path: #{@path}, value: #{@value}, from: #{@from}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} op: #{@op.inspect}, path: #{@path.inspect}, value: #{@value.inspect}, from:"\
+      " #{@from.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/patch_op.rb

@@ -7,22 +7,59 @@ module PaypalServerSdk
   # The operation.
   class PatchOp
     PATCH_OP = [
-      # TODO: Write general description for ADD
+      # Depending on the target location reference, completes one of these
+      # functions: The target location is an array index. Inserts a new value
+      # into the array at the specified index. The target location is an object
+      # parameter that does not already exist. Adds a new parameter to the
+      # object. The target location is an object parameter that does exist.
+      # Replaces that parameter's value. The value parameter defines the value
+      # to add. For more information, see 4.1. add.
       ADD = 'add'.freeze,
 
-      # TODO: Write general description for REMOVE
+      # Removes the value at the target location. For the operation to succeed,
+      # the target location must exist. For more information, see 4.2. remove.
       REMOVE = 'remove'.freeze,
 
-      # TODO: Write general description for REPLACE
+      # Replaces the value at the target location with a new value. The
+      # operation object must contain a value parameter that defines the
+      # replacement value. For the operation to succeed, the target location
+      # must exist. For more information, see 4.3. replace.
       REPLACE = 'replace'.freeze,
 
-      # TODO: Write general description for MOVE
+      # Removes the value at a specified location and adds it to the target
+      # location. The operation object must contain a from parameter, which is a
+      # string that contains a JSON pointer value that references the location
+      # in the target document from which to move the value. For the operation
+      # to succeed, the from location must exist. For more information, see 4.4.
+      # move.
       MOVE = 'move'.freeze,
 
-      # TODO: Write general description for COPY
+      # Copies the value at a specified location to the target location. The
+      # operation object must contain a from parameter, which is a string that
+      # contains a JSON pointer value that references the location in the target
+      # document from which to copy the value. For the operation to succeed, the
+      # from location must exist. For more information, see 4.5. copy.
       COPY = 'copy'.freeze,
 
-      # TODO: Write general description for TEST
+      # Tests that a value at the target location is equal to a specified value.
+      # The operation object must contain a value parameter that defines the
+      # value to compare to the target location's value. For the operation to
+      # succeed, the target location must be equal to the value value. For test,
+      # equal indicates that the value at the target location and the value that
+      # value defines are of the same JSON type. The data type of the value
+      # determines how equality is defined: Type Considered equal if both values
+      # strings Contain the same number of Unicode characters and their code
+      # points are byte-by-byte equal. numbers Are numerically equal. arrays
+      # Contain the same number of values, and each value is equal to the value
+      # at the corresponding position in the other array, by using these
+      # type-specific rules. objects Contain the same number of parameters, and
+      # each parameter is equal to a parameter in the other object, by comparing
+      # their keys (as strings) and their values (by using these type-specific
+      # rules). literals (false, true, and null) Are the same. The comparison is
+      # a logical comparison. For example, whitespace between the parameter
+      # values of an array is not significant. Also, ordering of the
+      # serialization of object parameters is not significant. For more
+      # information, see 4.6. test.
       TEST = 'test'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/payee_base.rb

@@ -10,11 +10,10 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
-    # 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_address
 
@@ -60,5 +59,18 @@ module PaypalServerSdk
       PayeeBase.new(email_address: email_address,
                     merchant_id: merchant_id)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address}, merchant_id: #{@merchant_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address.inspect}, merchant_id:"\
+      " #{@merchant_id.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/payee_payment_method_preference.rb

@@ -7,10 +7,12 @@ module PaypalServerSdk
   # The merchant-preferred payment methods.
   class PayeePaymentMethodPreference
     PAYEE_PAYMENT_METHOD_PREFERENCE = [
-      # TODO: Write general description for UNRESTRICTED
+      # Accepts any type of payment from the customer.
       UNRESTRICTED = 'UNRESTRICTED'.freeze,
 
-      # TODO: Write general description for IMMEDIATE_PAYMENT_REQUIRED
+      # Accepts only immediate payment from the customer. For example, credit
+      # card, PayPal balance, or instant ACH. Ensures that at the time of
+      # capture, the payment does not have the `pending` status.
       IMMEDIATE_PAYMENT_REQUIRED = 'IMMEDIATE_PAYMENT_REQUIRED'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/payer.rb

@@ -9,11 +9,10 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
-    # 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_address
 
@@ -116,5 +115,21 @@ module PaypalServerSdk
                 tax_info: tax_info,
                 address: address)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address}, payer_id: #{@payer_id}, name: #{@name},"\
+      " phone: #{@phone}, birth_date: #{@birth_date}, tax_info: #{@tax_info}, address:"\
+      " #{@address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address.inspect}, payer_id: #{@payer_id.inspect},"\
+      " name: #{@name.inspect}, phone: #{@phone.inspect}, birth_date: #{@birth_date.inspect},"\
+      " tax_info: #{@tax_info.inspect}, address: #{@address.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/payer_base.rb

@@ -10,11 +10,10 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
-    # 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_address
 
@@ -60,5 +59,17 @@ module PaypalServerSdk
       PayerBase.new(email_address: email_address,
                     payer_id: payer_id)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address}, payer_id: #{@payer_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address.inspect}, payer_id: #{@payer_id.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/payment_advice_code.rb

@@ -8,17 +8,62 @@ module PaypalServerSdk
   # networks, like Visa and Mastercard, return payment advice codes.
   class PaymentAdviceCode
     PAYMENT_ADVICE_CODE = [
-      # TODO: Write general description for ENUM_01
-      ENUM_01 = '01'.freeze,
+      # For Mastercard, expired card account upgrade or portfolio sale
+      # conversion. Obtain new account information before next billing cycle.
+      PAYMENTADVICE_01 = '01'.freeze,
 
-      # TODO: Write general description for ENUM_02
-      ENUM_02 = '02'.freeze,
+      # For Mastercard, over credit limit or insufficient funds. Retry the
+      # transaction 72 hours later. For Visa, the card holder wants to stop only
+      # one specific payment in the recurring payment relationship. The merchant
+      # must NOT resubmit the same transaction. The merchant can continue the
+      # billing process in the subsequent billing period.
+      PAYMENTADVICE_02 = '02'.freeze,
 
-      # TODO: Write general description for ENUM_03
-      ENUM_03 = '03'.freeze,
+      # For Mastercard, account closed as fraudulent. Obtain another type of
+      # payment from customer due to account being closed or fraud. Possible
+      # reason: Account closed as fraudulent. For Visa, the card holder wants to
+      # stop all recurring payment transactions for a specific merchant. Stop
+      # recurring payment requests.
+      PAYMENTADVICE_03 = '03'.freeze,
 
-      # TODO: Write general description for ENUM_21
-      ENUM_21 = '21'.freeze
+      # For Mastercard, token requirements not fulfilled for this token type.
+      PAYMENTADVICE_04 = '04'.freeze,
+
+      # For Mastercard, the card holder has been unsuccessful at canceling
+      # recurring payment through merchant. Stop recurring payment requests. For
+      # Visa, all recurring payments were canceled for the card number
+      # requested. Stop recurring payment requests.
+      PAYMENTADVICE_21 = '21'.freeze,
+
+      # For Mastercard, merchant does not qualify for product code.
+      PAYMENTADVICE_22 = '22'.freeze,
+
+      # For Mastercard, retry after 1 hour.
+      PAYMENTADVICE_24 = '24'.freeze,
+
+      # For Mastercard, retry after 24 hours.
+      PAYMENTADVICE_25 = '25'.freeze,
+
+      # For Mastercard, retry after 2 days.
+      PAYMENTADVICE_26 = '26'.freeze,
+
+      # For Mastercard, retry after 4 days.
+      PAYMENTADVICE_27 = '27'.freeze,
+
+      # For Mastercard, retry after 6 days.
+      PAYMENTADVICE_28 = '28'.freeze,
+
+      # For Mastercard, retry after 8 days.
+      PAYMENTADVICE_29 = '29'.freeze,
+
+      # For Mastercard, retry after 10 days .
+      PAYMENTADVICE_30 = '30'.freeze,
+
+      # For Mastercard, consumer non-reloadable prepaid card.
+      PAYMENTADVICE_40 = '40'.freeze,
+
+      # For Mastercard, consumer multi-use virtual card number.
+      PAYMENTADVICE_43 = '43'.freeze
     ].freeze
 
     def self.validate(value)