paypal-server-sdk 1.0.0 → 2.0.0

data/lib/paypal_server_sdk/models/order_authorize_request_payment_source.rb

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

data/lib/paypal_server_sdk/models/order_authorize_response.rb

@@ -1,10 +1,10 @@
 # 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
-  # OrderAuthorizeResponse Model.
+  # The order authorize response.
   class OrderAuthorizeResponse < BaseModel
     SKIP = Object.new
     private_constant :SKIP
@@ -36,8 +36,8 @@ module PaypalServerSdk
     # @return [CheckoutPaymentIntent]
     attr_accessor :intent
 
-    # The intent to either capture payment immediately or authorize a payment
-    # for an order after order creation.
+    # The customer who approves and pays for the order. The customer is also
+    # known as the payer.
     # @return [Payer]
     attr_accessor :payer
 
@@ -52,10 +52,17 @@ module PaypalServerSdk
     # @return [OrderStatus]
     attr_accessor :status
 
-    # An array of request-related [HATEOAS
-    # links](/api/rest/responses/#hateoas-links) that are either relevant to the
-    # issue by providing additional information or offering potential
-    # resolutions.
+    # An array of request-related HATEOAS links. To complete payer approval, use
+    # the `approve` link to redirect the payer. The API caller has 6 hours
+    # (default setting, this which can be changed by your account manager to
+    # 24/48/72 hours to accommodate your use case) from the time the order is
+    # created, to redirect your payer. Once redirected, the API caller has 6
+    # hours for the payer to approve the order and either authorize or capture
+    # the order. If you are not using the PayPal JavaScript SDK to initiate
+    # PayPal Checkout (in context) ensure that you include
+    # `application_context.return_url` is specified or you will get "We're
+    # sorry, Things don't appear to be working at the moment" after the payer
+    # approves the payment.
     # @return [Array[LinkDescription]]
     attr_accessor :links
 

data/lib/paypal_server_sdk/models/order_authorize_response_payment_source.rb

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

data/lib/paypal_server_sdk/models/order_billing_plan.rb

@@ -0,0 +1,93 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Metadata for merchant-managed recurring billing plans. Valid only during the
+  # saved payment method token or billing agreement creation.
+  class OrderBillingPlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of billing cycles for trial billing and regular billing. A plan
+    # can have at most two trial cycles and only one regular cycle.
+    # @return [Array[BillingCycle]]
+    attr_accessor :billing_cycles
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :setup_fee
+
+    # Name of the recurring plan.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['billing_cycles'] = 'billing_cycles'
+      @_hash['setup_fee'] = 'setup_fee'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        setup_fee
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(billing_cycles:, setup_fee: SKIP, name: SKIP)
+      @billing_cycles = billing_cycles
+      @setup_fee = setup_fee unless setup_fee == SKIP
+      @name = name unless 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.
+      # Parameter is an array, so we need to iterate through it
+      billing_cycles = nil
+      unless hash['billing_cycles'].nil?
+        billing_cycles = []
+        hash['billing_cycles'].each do |structure|
+          billing_cycles << (BillingCycle.from_hash(structure) if structure)
+        end
+      end
+
+      billing_cycles = nil unless hash.key?('billing_cycles')
+      setup_fee = Money.from_hash(hash['setup_fee']) if hash['setup_fee']
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      OrderBillingPlan.new(billing_cycles: billing_cycles,
+                           setup_fee: setup_fee,
+                           name: name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycles: #{@billing_cycles}, setup_fee: #{@setup_fee}, name:"\
+      " #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycles: #{@billing_cycles.inspect}, setup_fee:"\
+      " #{@setup_fee.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_capture_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
   # Completes an capture payment for an order.

data/lib/paypal_server_sdk/models/order_capture_request_payment_source.rb

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

data/lib/paypal_server_sdk/models/order_confirm_application_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 confirmation experience.

data/lib/paypal_server_sdk/models/order_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 order request details.
@@ -14,8 +14,11 @@ module PaypalServerSdk
     # @return [CheckoutPaymentIntent]
     attr_accessor :intent
 
-    # The intent to either capture payment immediately or authorize a payment
-    # for an order after order creation.
+    # DEPRECATED. The customer is also known as the payer. The Payer object was
+    # intended to only be used with the `payment_source.paypal` object. In order
+    # to make this design more clear, the details in the `payer` object are now
+    # available under `payment_source.paypal`. Please use
+    # `payment_source.paypal`.
     # @return [Payer]
     attr_accessor :payer
 

data/lib/paypal_server_sdk/models/order_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 order status.
@@ -23,11 +23,11 @@ module PaypalServerSdk
       # All purchase units in the order are voided.
       VOIDED = 'VOIDED'.freeze,
 
-      # The intent of the Order was completed and a `payments` resource was
-      # created. A completed Order may have authorized a payment, captured an
-      # authorized payment, or in some cases, the payment may have been
-      # declined. Please verify the payment status under
-      # purchase_unitsArray.payments before proceeding with Order fulfillment.
+      # The intent of the order was completed and a `payments` resource was
+      # created. Important: Check the payment status in
+      # `purchase_units[].payments.captures[].status` before fulfilling the
+      # order. A completed order can indicate a payment was authorized, an
+      # authorized payment was captured, or a payment was declined.
       COMPLETED = 'COMPLETED'.freeze,
 
       # The order requires an action from the payer (e.g. 3DS authentication).

data/lib/paypal_server_sdk/models/order_tracker_item.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 items in the shipment.

data/lib/paypal_server_sdk/models/order_tracker_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 tracking details of an order.

data/lib/paypal_server_sdk/models/order_tracker_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 tracking response on creation of tracker.

data/lib/paypal_server_sdk/models/order_tracker_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 item shipment.

data/lib/paypal_server_sdk/models/orders_capture.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
@@ -180,7 +180,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/orders_card_verification_method.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 method used for card verification.

data/lib/paypal_server_sdk/models/os_type.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Operating System type of the device that the buyer is using.
+  class OsType
+    OS_TYPE = [
+      # Google Android OS.
+      ANDROID = 'ANDROID'.freeze,
+
+      # Apple OS typically found in Apple mobile devices.
+      IOS = 'IOS'.freeze,
+
+      # Any other OS type.
+      OTHER = 'OTHER'.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

@@ -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
   # Information used to pay using P24(Przelewy24).

data/lib/paypal_server_sdk/models/p24_payment_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
   # Information needed to pay using P24 (Przelewy24).

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