paypal-server-sdk 1.1.0 → 2.1.0

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,26 @@
+# 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
+
+    def self.from_value(value, default_value = OUTSTANDING_BALANCE)
+      return default_value if value.nil?
+
+      default_value
+    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
@@ -93,5 +108,46 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = VISA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'visa' then VISA
+      when 'mastercard' then MASTERCARD
+      when 'discover' then DISCOVER
+      when 'amex' then AMEX
+      when 'solo' then SOLO
+      when 'jcb' then JCB
+      when 'star' then STAR
+      when 'delta' then DELTA
+      when 'switch' then SWITCH
+      when 'maestro' then MAESTRO
+      when 'cb_nationale' then CB_NATIONALE
+      when 'configoga' then CONFIGOGA
+      when 'confidis' then CONFIDIS
+      when 'electron' then ELECTRON
+      when 'cetelem' then CETELEM
+      when 'china_union_pay' then CHINA_UNION_PAY
+      when 'diners' then DINERS
+      when 'elo' then ELO
+      when 'hiper' then HIPER
+      when 'hipercard' then HIPERCARD
+      when 'rupay' then RUPAY
+      when 'ge' then GE
+      when 'synchrony' then SYNCHRONY
+      when 'eftpos' then EFTPOS
+      when 'carte_bancaire' then CARTE_BANCAIRE
+      when 'star_access' then STAR_ACCESS
+      when 'pulse' then PULSE
+      when 'nyce' then NYCE
+      when 'accel' then ACCEL
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
   end
 end

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.

data/lib/paypal_server_sdk/models/card_response_with_billing_address.rb

@@ -0,0 +1,100 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment card used to fund the payment. Card can be a credit or debit
+  # card.
+  class CardResponseWithBillingAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :billing_address
+
+    # The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date
+    # and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
+    # @return [String]
+    attr_accessor :expiry
+
+    # The [three-character ISO-4217 currency
+    # code](/api/rest/reference/currency-codes/) that identifies the currency.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['expiry'] = 'expiry'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        billing_address
+        expiry
+        currency_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, billing_address: SKIP, expiry: SKIP,
+                   currency_code: SKIP)
+      @name = name unless name == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @currency_code = currency_code unless currency_code == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : SKIP
+
+      # Create object from extracted values.
+      CardResponseWithBillingAddress.new(name: name,
+                                         billing_address: billing_address,
+                                         expiry: expiry,
+                                         currency_code: currency_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, billing_address: #{@billing_address}, expiry: #{@expiry},"\
+      " currency_code: #{@currency_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, billing_address: #{@billing_address.inspect},"\
+      " expiry: #{@expiry.inspect}, currency_code: #{@currency_code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_stored_credential.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
   # Provides additional details to process a payment using a `card` that has
@@ -32,7 +32,7 @@ module PaypalServerSdk
     attr_accessor :usage
 
     # Reference values used by the card network to identify a transaction.
-    # @return [NetworkTransactionReference]
+    # @return [NetworkTransaction]
     attr_accessor :previous_network_transaction_reference
 
     # A mapping from model property names to API property names.
@@ -81,7 +81,7 @@ module PaypalServerSdk
       payment_type = hash.key?('payment_type') ? hash['payment_type'] : nil
       usage = hash['usage'] ||= StoredPaymentSourceUsageType::DERIVED
       if hash['previous_network_transaction_reference']
-        previous_network_transaction_reference = NetworkTransactionReference.from_hash(hash['previous_network_transaction_reference'])
+        previous_network_transaction_reference = NetworkTransaction.from_hash(hash['previous_network_transaction_reference'])
       end
 
       # Create object from extracted values.

data/lib/paypal_server_sdk/models/card_supplementary_data.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
   # Merchants and partners can add Level 2 and 3 data to payments to reduce risk

data/lib/paypal_server_sdk/models/card_type.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
   # Type of card. i.e Credit, Debit and so on.
@@ -28,5 +28,21 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      when 'prepaid' then PREPAID
+      when 'store' then STORE
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/card_vault_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 details about a saved Card payment source.

data/lib/paypal_server_sdk/models/card_verification.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 API caller can opt in to verify the card through PayPal offered

data/lib/paypal_server_sdk/models/card_verification_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
   # Card Verification details including the authorization details and 3D SECURE
@@ -22,15 +22,15 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :date
 
-    # The card network or brand. Applies to credit, debit, gift, and payment
-    # cards.
+    # DEPRECATED. This field is DEPRECATED. Please find the network data in the
+    # 'network' field under the 'network_transaction_reference' object instead
+    # of the 'verification' object.
     # @return [CardBrand]
     attr_accessor :network
 
-    # The date and time, in [Internet date and time
-    # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
-    # required while fractional seconds are optional. Note: The regular
-    # expression provides guidance but does not reject all invalid dates.
+    # DEPRECATED. This field is DEPRECATED. Please find the time data in the
+    # 'time' field under the 'network_transaction_reference' object instead of
+    # the 'verification' object.
     # @return [String]
     attr_accessor :time
 

data/lib/paypal_server_sdk/models/card_verification_processor_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 processor response information for payment requests, such as direct