paypal-server-sdk 1.1.0 → 2.0.0

data/lib/paypal_server_sdk/models/pa_res_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
   # Transactions status result identifier. The outcome of the issuer's

data/lib/paypal_server_sdk/models/participant_metadata.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
   # Profile information of the sender or receiver.

data/lib/paypal_server_sdk/models/patch.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 JSON patch object to apply partial updates to resources.

data/lib/paypal_server_sdk/models/patch_op.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 operation.

data/lib/paypal_server_sdk/models/payee_base.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 for the merchant who receives the funds and fulfills the order.

data/lib/paypal_server_sdk/models/payee_payment_method_preference.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 merchant-preferred payment methods.

data/lib/paypal_server_sdk/models/payer.rb

@@ -1,10 +1,11 @@
 # 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
-  # Payer Model.
+  # The customer who approves and pays for the order. The customer is also known
+  # as the payer.
   class Payer < BaseModel
     SKIP = Object.new
     private_constant :SKIP

data/lib/paypal_server_sdk/models/payer_base.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 customer who approves and pays for the order. The customer is also known

data/lib/paypal_server_sdk/models/payer_information.rb

@@ -0,0 +1,146 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payer information.
+  class PayerInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal` customer account ID.
+    # @return [String]
+    attr_accessor :account_id
+
+    # 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
+
+    # The phone number, in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [Phone]
+    attr_accessor :phone_number
+
+    # The address status of the payer. Value is either: Y. Verified. N. Not
+    # verified.
+    # @return [String]
+    attr_accessor :address_status
+
+    # The status of the payer. Value is `Y` or `N`.
+    # @return [String]
+    attr_accessor :payer_status
+
+    # The name of the party.
+    # @return [PayerName]
+    attr_accessor :payer_name
+
+    # The [two-character ISO 3166-1
+    # code](/docs/integration/direct/rest/country-codes/) 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
+
+    # A simple postal address with coarse-grained fields. Do not use for an
+    # international address. Use for backward compatibility only. Does not
+    # contain phone.
+    # @return [SimplePostalAddressCoarseGrained]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account_id'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['address_status'] = 'address_status'
+      @_hash['payer_status'] = 'payer_status'
+      @_hash['payer_name'] = 'payer_name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        email_address
+        phone_number
+        address_status
+        payer_status
+        payer_name
+        country_code
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, email_address: SKIP, phone_number: SKIP,
+                   address_status: SKIP, payer_status: SKIP, payer_name: SKIP,
+                   country_code: SKIP, address: SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @address_status = address_status unless address_status == SKIP
+      @payer_status = payer_status unless payer_status == SKIP
+      @payer_name = payer_name unless payer_name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @address = address unless 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.
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone_number = Phone.from_hash(hash['phone_number']) if hash['phone_number']
+      address_status =
+        hash.key?('address_status') ? hash['address_status'] : SKIP
+      payer_status = hash.key?('payer_status') ? hash['payer_status'] : SKIP
+      payer_name = PayerName.from_hash(hash['payer_name']) if hash['payer_name']
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      address = SimplePostalAddressCoarseGrained.from_hash(hash['address']) if hash['address']
+
+      # Create object from extracted values.
+      PayerInformation.new(account_id: account_id,
+                           email_address: email_address,
+                           phone_number: phone_number,
+                           address_status: address_status,
+                           payer_status: payer_status,
+                           payer_name: payer_name,
+                           country_code: country_code,
+                           address: address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, email_address: #{@email_address}, phone_number:"\
+      " #{@phone_number}, address_status: #{@address_status}, payer_status: #{@payer_status},"\
+      " payer_name: #{@payer_name}, country_code: #{@country_code}, address: #{@address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, email_address:"\
+      " #{@email_address.inspect}, phone_number: #{@phone_number.inspect}, address_status:"\
+      " #{@address_status.inspect}, payer_status: #{@payer_status.inspect}, payer_name:"\
+      " #{@payer_name.inspect}, country_code: #{@country_code.inspect}, address:"\
+      " #{@address.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payer_name.rb

@@ -0,0 +1,128 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The name of the party.
+  class PayerName < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The prefix, or title, to the party's name.
+    # @return [String]
+    attr_accessor :prefix
+
+    # When the party is a person, the party's given, or first, name.
+    # @return [String]
+    attr_accessor :given_name
+
+    # When the party is a person, the party's surname or family name. Also known
+    # as the last name. Required when the party is a person. Use also to store
+    # multiple surnames including the matronymic, or mother's, surname.
+    # @return [String]
+    attr_accessor :surname
+
+    # When the party is a person, the party's middle name. Use also to store
+    # multiple middle names including the patronymic, or father's, middle name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # The suffix for the party's name.
+    # @return [String]
+    attr_accessor :suffix
+
+    # DEPRECATED. The party's alternate name. Can be a business name, nickname,
+    # or any other name that cannot be split into first, last name. Required
+    # when the party is a business.
+    # @return [String]
+    attr_accessor :alternate_full_name
+
+    # When the party is a person, the party's full name.
+    # @return [String]
+    attr_accessor :full_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prefix'] = 'prefix'
+      @_hash['given_name'] = 'given_name'
+      @_hash['surname'] = 'surname'
+      @_hash['middle_name'] = 'middle_name'
+      @_hash['suffix'] = 'suffix'
+      @_hash['alternate_full_name'] = 'alternate_full_name'
+      @_hash['full_name'] = 'full_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prefix
+        given_name
+        surname
+        middle_name
+        suffix
+        alternate_full_name
+        full_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prefix: SKIP, given_name: SKIP, surname: SKIP,
+                   middle_name: SKIP, suffix: SKIP, alternate_full_name: SKIP,
+                   full_name: SKIP)
+      @prefix = prefix unless prefix == SKIP
+      @given_name = given_name unless given_name == SKIP
+      @surname = surname unless surname == SKIP
+      @middle_name = middle_name unless middle_name == SKIP
+      @suffix = suffix unless suffix == SKIP
+      @alternate_full_name = alternate_full_name unless alternate_full_name == SKIP
+      @full_name = full_name unless full_name == 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.
+      prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
+      given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
+      surname = hash.key?('surname') ? hash['surname'] : SKIP
+      middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      alternate_full_name =
+        hash.key?('alternate_full_name') ? hash['alternate_full_name'] : SKIP
+      full_name = hash.key?('full_name') ? hash['full_name'] : SKIP
+
+      # Create object from extracted values.
+      PayerName.new(prefix: prefix,
+                    given_name: given_name,
+                    surname: surname,
+                    middle_name: middle_name,
+                    suffix: suffix,
+                    alternate_full_name: alternate_full_name,
+                    full_name: full_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} prefix: #{@prefix}, given_name: #{@given_name}, surname: #{@surname},"\
+      " middle_name: #{@middle_name}, suffix: #{@suffix}, alternate_full_name:"\
+      " #{@alternate_full_name}, full_name: #{@full_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} prefix: #{@prefix.inspect}, given_name: #{@given_name.inspect}, surname:"\
+      " #{@surname.inspect}, middle_name: #{@middle_name.inspect}, suffix: #{@suffix.inspect},"\
+      " alternate_full_name: #{@alternate_full_name.inspect}, full_name: #{@full_name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_advice_code.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 declined payment transactions might have payment advice codes. The card

data/lib/paypal_server_sdk/models/payment_authorization.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 authorized payment transaction.
@@ -39,7 +39,7 @@ module PaypalServerSdk
     attr_accessor :custom_id
 
     # Reference values used by the card network to identify a transaction.
-    # @return [NetworkTransactionReference]
+    # @return [NetworkTransaction]
     attr_accessor :network_transaction_reference
 
     # The level of protection offered as defined by [PayPal Seller Protection
@@ -167,7 +167,7 @@ module PaypalServerSdk
       invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
       custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
       if hash['network_transaction_reference']
-        network_transaction_reference = NetworkTransactionReference.from_hash(hash['network_transaction_reference'])
+        network_transaction_reference = NetworkTransaction.from_hash(hash['network_transaction_reference'])
       end
       seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
         hash['seller_protection']

data/lib/paypal_server_sdk/models/payment_collection.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 collection of payments, or transactions, for a purchase unit in an

data/lib/paypal_server_sdk/models/payment_initiator.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 person or party who initiated or triggered the payment.

data/lib/paypal_server_sdk/models/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 payment instructions to be consider during payment

data/lib/paypal_server_sdk/models/payment_method.rb

@@ -0,0 +1,63 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The customer and merchant payment preferences.
+  class PaymentMethod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant-preferred payment methods.
+    # @return [PayeePaymentMethodPreference]
+    attr_accessor :payee_preferred
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payee_preferred'] = 'payee_preferred'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payee_preferred
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payee_preferred: PayeePaymentMethodPreference::UNRESTRICTED)
+      @payee_preferred = payee_preferred unless payee_preferred == 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.
+      payee_preferred =
+        hash['payee_preferred'] ||= PayeePaymentMethodPreference::UNRESTRICTED
+
+      # Create object from extracted values.
+      PaymentMethod.new(payee_preferred: payee_preferred)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payee_preferred: #{@payee_preferred}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payee_preferred: #{@payee_preferred.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_method_preference.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 customer and merchant payment preferences.

data/lib/paypal_server_sdk/models/payment_preferences.rb

@@ -0,0 +1,105 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment preferences for a subscription.
+  class PaymentPreferences < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether to automatically bill the outstanding amount in the next
+    # billing cycle.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_bill_outstanding
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :setup_fee
+
+    # The action to take on the subscription if the initial payment for the
+    # setup fails.
+    # @return [SetupFeeFailureAction]
+    attr_accessor :setup_fee_failure_action
+
+    # The maximum number of payment failures before a subscription is suspended.
+    # For example, if `payment_failure_threshold` is `2`, the subscription
+    # automatically updates to the `SUSPEND` state if two consecutive payments
+    # fail.
+    # @return [Integer]
+    attr_accessor :payment_failure_threshold
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto_bill_outstanding'] = 'auto_bill_outstanding'
+      @_hash['setup_fee'] = 'setup_fee'
+      @_hash['setup_fee_failure_action'] = 'setup_fee_failure_action'
+      @_hash['payment_failure_threshold'] = 'payment_failure_threshold'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auto_bill_outstanding
+        setup_fee
+        setup_fee_failure_action
+        payment_failure_threshold
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auto_bill_outstanding: true, setup_fee: SKIP,
+                   setup_fee_failure_action: SetupFeeFailureAction::CANCEL,
+                   payment_failure_threshold: 0)
+      @auto_bill_outstanding = auto_bill_outstanding unless auto_bill_outstanding == SKIP
+      @setup_fee = setup_fee unless setup_fee == SKIP
+      @setup_fee_failure_action = setup_fee_failure_action unless setup_fee_failure_action == SKIP
+      unless payment_failure_threshold == SKIP
+        @payment_failure_threshold =
+          payment_failure_threshold
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      auto_bill_outstanding = hash['auto_bill_outstanding'] ||= true
+      setup_fee = Money.from_hash(hash['setup_fee']) if hash['setup_fee']
+      setup_fee_failure_action =
+        hash['setup_fee_failure_action'] ||= SetupFeeFailureAction::CANCEL
+      payment_failure_threshold = hash['payment_failure_threshold'] ||= 0
+
+      # Create object from extracted values.
+      PaymentPreferences.new(auto_bill_outstanding: auto_bill_outstanding,
+                             setup_fee: setup_fee,
+                             setup_fee_failure_action: setup_fee_failure_action,
+                             payment_failure_threshold: payment_failure_threshold)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auto_bill_outstanding: #{@auto_bill_outstanding}, setup_fee: #{@setup_fee},"\
+      " setup_fee_failure_action: #{@setup_fee_failure_action}, payment_failure_threshold:"\
+      " #{@payment_failure_threshold}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auto_bill_outstanding: #{@auto_bill_outstanding.inspect}, setup_fee:"\
+      " #{@setup_fee.inspect}, setup_fee_failure_action: #{@setup_fee_failure_action.inspect},"\
+      " payment_failure_threshold: #{@payment_failure_threshold.inspect}>"
+    end
+  end
+end