paypal-server-sdk 1.1.0 → 2.0.0

data/lib/paypal_server_sdk/models/capture_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/capture_request.rb

@@ -1,30 +1,26 @@
 # 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
-  # CaptureRequest Model.
+  # Captures either a portion or the full authorized amount of an authorized
+  # payment.
   class CaptureRequest < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
     # The API caller-provided external invoice number for this order. Appears in
     # both the payer's transaction history and the emails that the payer
     # receives.
     # @return [String]
     attr_accessor :invoice_id
 
-    # An informational note about this settlement. Appears in both the payer's
-    # transaction history and the emails that the payer receives.
-    # @return [String]
-    attr_accessor :note_to_payer
-
-    # The currency and amount for a financial transaction, such as a balance or
-    # payment due.
-    # @return [Money]
-    attr_accessor :amount
-
     # Indicates whether you can make additional captures against the authorized
     # payment. Set to `true` if you do not intend to capture additional payments
     # against the authorization. Set to `false` if you intend to capture
@@ -38,6 +34,11 @@ module PaypalServerSdk
     # @return [CapturePaymentInstruction]
     attr_accessor :payment_instruction
 
+    # An informational note about this settlement. Appears in both the payer's
+    # transaction history and the emails that the payer receives.
+    # @return [String]
+    attr_accessor :note_to_payer
+
     # The payment descriptor on the payer's account statement.
     # @return [String]
     attr_accessor :soft_descriptor
@@ -45,11 +46,11 @@ module PaypalServerSdk
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['invoice_id'] = 'invoice_id'
-      @_hash['note_to_payer'] = 'note_to_payer'
       @_hash['amount'] = 'amount'
+      @_hash['invoice_id'] = 'invoice_id'
       @_hash['final_capture'] = 'final_capture'
       @_hash['payment_instruction'] = 'payment_instruction'
+      @_hash['note_to_payer'] = 'note_to_payer'
       @_hash['soft_descriptor'] = 'soft_descriptor'
       @_hash
     end
@@ -57,11 +58,11 @@ module PaypalServerSdk
     # An array for optional fields
     def self.optionals
       %w[
-        invoice_id
-        note_to_payer
         amount
+        invoice_id
         final_capture
         payment_instruction
+        note_to_payer
         soft_descriptor
       ]
     end
@@ -71,14 +72,14 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(invoice_id: SKIP, note_to_payer: SKIP, amount: SKIP,
-                   final_capture: false, payment_instruction: SKIP,
+    def initialize(amount: SKIP, invoice_id: SKIP, final_capture: false,
+                   payment_instruction: SKIP, note_to_payer: SKIP,
                    soft_descriptor: SKIP)
-      @invoice_id = invoice_id unless invoice_id == SKIP
-      @note_to_payer = note_to_payer unless note_to_payer == SKIP
       @amount = amount unless amount == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
       @final_capture = final_capture unless final_capture == SKIP
       @payment_instruction = payment_instruction unless payment_instruction == SKIP
+      @note_to_payer = note_to_payer unless note_to_payer == SKIP
       @soft_descriptor = soft_descriptor unless soft_descriptor == SKIP
     end
 
@@ -87,38 +88,38 @@ module PaypalServerSdk
       return nil unless hash
 
       # Extract variables from the hash.
-      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
-      note_to_payer = hash.key?('note_to_payer') ? hash['note_to_payer'] : SKIP
       amount = Money.from_hash(hash['amount']) if hash['amount']
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
       final_capture = hash['final_capture'] ||= false
       payment_instruction = CapturePaymentInstruction.from_hash(hash['payment_instruction']) if
         hash['payment_instruction']
+      note_to_payer = hash.key?('note_to_payer') ? hash['note_to_payer'] : SKIP
       soft_descriptor =
         hash.key?('soft_descriptor') ? hash['soft_descriptor'] : SKIP
 
       # Create object from extracted values.
-      CaptureRequest.new(invoice_id: invoice_id,
-                         note_to_payer: note_to_payer,
-                         amount: amount,
+      CaptureRequest.new(amount: amount,
+                         invoice_id: invoice_id,
                          final_capture: final_capture,
                          payment_instruction: payment_instruction,
+                         note_to_payer: note_to_payer,
                          soft_descriptor: soft_descriptor)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} invoice_id: #{@invoice_id}, note_to_payer: #{@note_to_payer}, amount:"\
-      " #{@amount}, final_capture: #{@final_capture}, payment_instruction:"\
-      " #{@payment_instruction}, soft_descriptor: #{@soft_descriptor}>"
+      "<#{class_name} amount: #{@amount}, invoice_id: #{@invoice_id}, final_capture:"\
+      " #{@final_capture}, payment_instruction: #{@payment_instruction}, note_to_payer:"\
+      " #{@note_to_payer}, soft_descriptor: #{@soft_descriptor}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} invoice_id: #{@invoice_id.inspect}, note_to_payer:"\
-      " #{@note_to_payer.inspect}, amount: #{@amount.inspect}, final_capture:"\
-      " #{@final_capture.inspect}, payment_instruction: #{@payment_instruction.inspect},"\
+      "<#{class_name} amount: #{@amount.inspect}, invoice_id: #{@invoice_id.inspect},"\
+      " final_capture: #{@final_capture.inspect}, payment_instruction:"\
+      " #{@payment_instruction.inspect}, note_to_payer: #{@note_to_payer.inspect},"\
       " soft_descriptor: #{@soft_descriptor.inspect}>"
     end
   end

data/lib/paypal_server_sdk/models/capture_status.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The status of the captured payment.

data/lib/paypal_server_sdk/models/capture_status_details.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The details of the captured payment status.

data/lib/paypal_server_sdk/models/capture_status_with_details.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The status and status details of a captured payment.

data/lib/paypal_server_sdk/models/capture_subscription_request.rb

@@ -0,0 +1,78 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The charge amount from the subscriber.
+  class CaptureSubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason or note for the subscription charge.
+    # @return [String]
+    attr_accessor :note
+
+    # The type of capture.
+    # @return [CaptureType]
+    attr_accessor :capture_type
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['note'] = 'note'
+      @_hash['capture_type'] = 'capture_type'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(note:, capture_type:, amount:)
+      @note = note
+      @capture_type = capture_type
+      @amount = amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      note = hash.key?('note') ? hash['note'] : nil
+      capture_type = hash.key?('capture_type') ? hash['capture_type'] : nil
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      CaptureSubscriptionRequest.new(note: note,
+                                     capture_type: capture_type,
+                                     amount: amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} note: #{@note}, capture_type: #{@capture_type}, amount: #{@amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} note: #{@note.inspect}, capture_type: #{@capture_type.inspect}, amount:"\
+      " #{@amount.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_type.rb

@@ -0,0 +1,20 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The type of capture.
+  class CaptureType
+    CAPTURE_TYPE = [
+      # The outstanding balance that the subscriber must clear.
+      OUTSTANDING_BALANCE = 'OUTSTANDING_BALANCE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/captured_payment.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 captured payment.
@@ -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
@@ -72,7 +72,7 @@ module PaypalServerSdk
 
     # The processor response information for payment requests, such as direct
     # credit card transactions.
-    # @return [PaymentsProcessorResponse]
+    # @return [ProcessorResponse]
     attr_accessor :processor_response
 
     # The date and time, in [Internet date and time
@@ -195,7 +195,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']
@@ -215,7 +215,7 @@ module PaypalServerSdk
       end
 
       links = SKIP unless hash.key?('links')
-      processor_response = PaymentsProcessorResponse.from_hash(hash['processor_response']) if
+      processor_response = ProcessorResponse.from_hash(hash['processor_response']) if
         hash['processor_response']
       create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
       update_time = hash.key?('update_time') ? hash['update_time'] : SKIP

data/lib/paypal_server_sdk/models/card_attributes.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 attributes associated with the use of this card.

data/lib/paypal_server_sdk/models/card_attributes_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
   # Additional attributes associated with the use of this card.

data/lib/paypal_server_sdk/models/card_authentication_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
   # Results of Authentication such as 3D Secure.

data/lib/paypal_server_sdk/models/card_brand.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 card network or brand. Applies to credit, debit, gift, and payment
@@ -84,6 +84,21 @@ module PaypalServerSdk
       # network.
       EFTPOS = 'EFTPOS'.freeze,
 
+      # The Carte Bancaire payment network.
+      CARTE_BANCAIRE = 'CARTE_BANCAIRE'.freeze,
+
+      # The Star Access payment network.
+      STAR_ACCESS = 'STAR_ACCESS'.freeze,
+
+      # The Pulse payment network.
+      PULSE = 'PULSE'.freeze,
+
+      # The NYCE payment network.
+      NYCE = 'NYCE'.freeze,
+
+      # The Accel payment network.
+      ACCEL = 'ACCEL'.freeze,
+
       # UNKNOWN payment network.
       UNKNOWN = 'UNKNOWN'.freeze
     ].freeze

data/lib/paypal_server_sdk/models/card_customer.rb

@@ -0,0 +1,98 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a customer in PayPal's system of record.
+  class CardCustomer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :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 information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # 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['email_address'] = 'email_address'
+      @_hash['phone'] = 'phone'
+      @_hash['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+        merchant_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP,
+                   merchant_customer_id: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == 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
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      CardCustomer.new(id: id,
+                       email_address: email_address,
+                       phone: phone,
+                       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}, email_address: #{@email_address}, phone: #{@phone},"\
+      " 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}, email_address: #{@email_address.inspect}, phone:"\
+      " #{@phone.inspect}, merchant_customer_id: #{@merchant_customer_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_customer_information.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 about a customer in PayPal's system of record.

data/lib/paypal_server_sdk/models/card_experience_context.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
   # Customizes the payer experience during the 3DS Approval for payment.

data/lib/paypal_server_sdk/models/card_from_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
   # Representation of card details as received in the request.

data/lib/paypal_server_sdk/models/card_payment_token_entity.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
   # Full representation of a Card Payment Token.

data/lib/paypal_server_sdk/models/card_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
   # The payment card to use to fund a payment. Can be a credit or debit card.

data/lib/paypal_server_sdk/models/card_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
   # The payment card to use to fund a payment. Card can be a credit or debit

data/lib/paypal_server_sdk/models/card_response_address.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
   # Address request details.