paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/stored_payment_source.rb

@@ -0,0 +1,95 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Provides additional details to process a payment using a `payment_source`
+  # that has been stored or is intended to be stored (also referred to as
+  # stored_credential or card-on-file).<br/>Parameter
+  # compatibility:<br/><ul><li>`payment_type=ONE_TIME` is compatible only with
+  # `payment_initiator=CUSTOMER`.</li><li>`usage=FIRST` is compatible only with
+  # `payment_initiator=CUSTOMER`.</li><li>`previous_transaction_reference` or
+  # `previous_network_transaction_reference` is compatible only with
+  # `payment_initiator=MERCHANT`.</li><li>Only one of the parameters -
+  # `previous_transaction_reference` and
+  # `previous_network_transaction_reference` - can be present in the
+  # request.</li></ul>
+  class StoredPaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The person or party who initiated or triggered the payment.
+    # @return [PaymentInitiator]
+    attr_accessor :payment_initiator
+
+    # Indicates the type of the stored payment_source payment.
+    # @return [StoredPaymentSourcePaymentType]
+    attr_accessor :payment_type
+
+    # Indicates if this is a `first` or `subsequent` payment using a stored
+    # payment source (also referred to as stored credential or card on file).
+    # @return [StoredPaymentSourceUsageType]
+    attr_accessor :usage
+
+    # Reference values used by the card network to identify a transaction.
+    # @return [NetworkTransactionReference]
+    attr_accessor :previous_network_transaction_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_initiator'] = 'payment_initiator'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['usage'] = 'usage'
+      @_hash['previous_network_transaction_reference'] =
+        'previous_network_transaction_reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        usage
+        previous_network_transaction_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_initiator:, payment_type:,
+                   usage: StoredPaymentSourceUsageType::DERIVED,
+                   previous_network_transaction_reference: SKIP)
+      @payment_initiator = payment_initiator
+      @payment_type = payment_type
+      @usage = usage unless usage == SKIP
+      unless previous_network_transaction_reference == SKIP
+        @previous_network_transaction_reference =
+          previous_network_transaction_reference
+      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.
+      payment_initiator =
+        hash.key?('payment_initiator') ? hash['payment_initiator'] : nil
+      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'])
+      end
+
+      # Create object from extracted values.
+      StoredPaymentSource.new(payment_initiator: payment_initiator,
+                              payment_type: payment_type,
+                              usage: usage,
+                              previous_network_transaction_reference: previous_network_transaction_reference)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/stored_payment_source_payment_type.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Indicates the type of the stored payment_source payment.
+  class StoredPaymentSourcePaymentType
+    STORED_PAYMENT_SOURCE_PAYMENT_TYPE = [
+      # TODO: Write general description for ONE_TIME
+      ONE_TIME = 'ONE_TIME'.freeze,
+
+      # TODO: Write general description for RECURRING
+      RECURRING = 'RECURRING'.freeze,
+
+      # TODO: Write general description for UNSCHEDULED
+      UNSCHEDULED = 'UNSCHEDULED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/stored_payment_source_usage_type.rb

@@ -0,0 +1,27 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Indicates if this is a `first` or `subsequent` payment using a stored
+  # payment source (also referred to as stored credential or card on file).
+  class StoredPaymentSourceUsageType
+    STORED_PAYMENT_SOURCE_USAGE_TYPE = [
+      # TODO: Write general description for FIRST
+      FIRST = 'FIRST'.freeze,
+
+      # TODO: Write general description for SUBSEQUENT
+      SUBSEQUENT = 'SUBSEQUENT'.freeze,
+
+      # TODO: Write general description for DERIVED
+      DERIVED = 'DERIVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/supplementary_data.rb

@@ -0,0 +1,58 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Supplementary data about a payment. This object passes information that can
+  # be used to improve risk assessments and processing costs, for example, by
+  # providing Level 2 and Level 3 payment data.
+  class SupplementaryData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchants and partners can add Level 2 and 3 data to payments to reduce
+    # risk and payment processing costs. For more information about processing
+    # payments, see <a
+    # href="https://developer.paypal.com/docs/checkout/advanced/processing/">che
+    # ckout</a> or <a
+    # href="https://developer.paypal.com/docs/multiparty/checkout/advanced/proce
+    # ssing/">multiparty checkout</a>.
+    # @return [CardSupplementaryData]
+    attr_accessor :card
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP)
+      @card = card unless card == 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.
+      card = CardSupplementaryData.from_hash(hash['card']) if hash['card']
+
+      # Create object from extracted values.
+      SupplementaryData.new(card: card)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/supplementary_purchase_data.rb

@@ -0,0 +1,63 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The capture identification-related fields. Includes the invoice ID, custom
+  # ID, note to payer, and soft descriptor.
+  class SupplementaryPurchaseData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        invoice_id
+        note_to_payer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_id: SKIP, note_to_payer: SKIP)
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @note_to_payer = note_to_payer unless note_to_payer == 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.
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      note_to_payer = hash.key?('note_to_payer') ? hash['note_to_payer'] : SKIP
+
+      # Create object from extracted values.
+      SupplementaryPurchaseData.new(invoice_id: invoice_id,
+                                    note_to_payer: note_to_payer)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/tax_id_type.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The customer's tax ID type.
+  class TaxIdType
+    TAX_ID_TYPE = [
+      # TODO: Write general description for BR_CPF
+      BR_CPF = 'BR_CPF'.freeze,
+
+      # TODO: Write general description for BR_CNPJ
+      BR_CNPJ = 'BR_CNPJ'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/tax_info.rb

@@ -0,0 +1,57 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The tax ID of the customer. The customer is also known as the payer. Both
+  # `tax_id` and `tax_id_type` are required.
+  class TaxInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The customer's tax ID value.
+    # @return [String]
+    attr_accessor :tax_id
+
+    # The customer's tax ID type.
+    # @return [TaxIdType]
+    attr_accessor :tax_id_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_id'] = 'tax_id'
+      @_hash['tax_id_type'] = 'tax_id_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_id:, tax_id_type:)
+      @tax_id = tax_id
+      @tax_id_type = tax_id_type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      tax_id = hash.key?('tax_id') ? hash['tax_id'] : nil
+      tax_id_type = hash.key?('tax_id_type') ? hash['tax_id_type'] : nil
+
+      # Create object from extracted values.
+      TaxInfo.new(tax_id: tax_id,
+                  tax_id_type: tax_id_type)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/three_d_secure_authentication_response.rb

@@ -0,0 +1,62 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Results of 3D Secure Authentication.
+  class ThreeDSecureAuthenticationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transactions status result identifier. The outcome of the issuer's
+    # authentication.
+    # @return [PAResStatus]
+    attr_accessor :authentication_status
+
+    # Status of Authentication eligibility.
+    # @return [EnrollmentStatus]
+    attr_accessor :enrollment_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authentication_status'] = 'authentication_status'
+      @_hash['enrollment_status'] = 'enrollment_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        authentication_status
+        enrollment_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(authentication_status: SKIP, enrollment_status: SKIP)
+      @authentication_status = authentication_status unless authentication_status == SKIP
+      @enrollment_status = enrollment_status unless enrollment_status == 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.
+      authentication_status =
+        hash.key?('authentication_status') ? hash['authentication_status'] : SKIP
+      enrollment_status =
+        hash.key?('enrollment_status') ? hash['enrollment_status'] : SKIP
+
+      # Create object from extracted values.
+      ThreeDSecureAuthenticationResponse.new(authentication_status: authentication_status,
+                                             enrollment_status: enrollment_status)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/token.rb

@@ -0,0 +1,56 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The tokenized payment source to fund a payment.
+  class Token < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal-generated ID for the token.
+    # @return [String]
+    attr_accessor :id
+
+    # The tokenization method that generated the ID.
+    # @return [TokenType]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, type:)
+      @id = id
+      @type = type
+    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'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+
+      # Create object from extracted values.
+      Token.new(id: id,
+                type: type)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/token_request_type.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The tokenization method that generated the ID.
+  class TokenRequestType
+    TOKEN_REQUEST_TYPE = [
+      # TODO: Write general description for SETUP_TOKEN
+      SETUP_TOKEN = 'SETUP_TOKEN'.freeze,
+
+      # TODO: Write general description for BILLING_AGREEMENT
+      BILLING_AGREEMENT = 'BILLING_AGREEMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/token_type.rb

@@ -0,0 +1,20 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The tokenization method that generated the ID.
+  class TokenType
+    TOKEN_TYPE = [
+      # TODO: Write general description for BILLING_AGREEMENT
+      BILLING_AGREEMENT = 'BILLING_AGREEMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/trustly_payment_object.rb

@@ -0,0 +1,85 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using Trustly.
+  class TrustlyPaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # 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>
+    # @return [String]
+    attr_accessor :country_code
+
+    # The business identification code (BIC). In payments systems, a BIC is used
+    # to identify a specific business, most commonly a bank.
+    # @return [String]
+    attr_accessor :bic
+
+    # The last characters of the IBAN used to pay.
+    # @return [String]
+    attr_accessor :iban_last_chars
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['bic'] = 'bic'
+      @_hash['iban_last_chars'] = 'iban_last_chars'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        bic
+        iban_last_chars
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, bic: SKIP,
+                   iban_last_chars: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @bic = bic unless bic == SKIP
+      @iban_last_chars = iban_last_chars unless iban_last_chars == 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
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      bic = hash.key?('bic') ? hash['bic'] : SKIP
+      iban_last_chars =
+        hash.key?('iban_last_chars') ? hash['iban_last_chars'] : SKIP
+
+      # Create object from extracted values.
+      TrustlyPaymentObject.new(name: name,
+                               country_code: country_code,
+                               bic: bic,
+                               iban_last_chars: iban_last_chars)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/trustly_payment_request.rb

@@ -0,0 +1,73 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using Trustly.
+  class TrustlyPaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # 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>
+    # @return [String]
+    attr_accessor :country_code
+
+    # Customizes the payer experience during the approval process for the
+    # payment.
+    # @return [ExperienceContext]
+    attr_accessor :experience_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        experience_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, country_code:, experience_context: SKIP)
+      @name = name
+      @country_code = country_code
+      @experience_context = experience_context unless experience_context == 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'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      experience_context = ExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      TrustlyPaymentRequest.new(name: name,
+                                country_code: country_code,
+                                experience_context: experience_context)
+    end
+  end
+end