paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/confirm_order_request.rb

@@ -0,0 +1,74 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Payer confirms the intent to pay for the Order using the provided payment
+  # source.
+  class ConfirmOrderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment source definition.
+    # @return [PaymentSource]
+    attr_accessor :payment_source
+
+    # The instruction to process an order.
+    # @return [ProcessingInstruction]
+    attr_accessor :processing_instruction
+
+    # Customizes the payer confirmation experience.
+    # @return [OrderConfirmApplicationContext]
+    attr_accessor :application_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_source'] = 'payment_source'
+      @_hash['processing_instruction'] = 'processing_instruction'
+      @_hash['application_context'] = 'application_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        processing_instruction
+        application_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      payment_source:,
+      processing_instruction: ProcessingInstruction::NO_INSTRUCTION,
+      application_context: SKIP
+    )
+      @payment_source = payment_source
+      @processing_instruction = processing_instruction unless processing_instruction == SKIP
+      @application_context = application_context unless application_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.
+      payment_source = PaymentSource.from_hash(hash['payment_source']) if hash['payment_source']
+      processing_instruction =
+        hash['processing_instruction'] ||= ProcessingInstruction::NO_INSTRUCTION
+      application_context = OrderConfirmApplicationContext.from_hash(hash['application_context']) if
+        hash['application_context']
+
+      # Create object from extracted values.
+      ConfirmOrderRequest.new(payment_source: payment_source,
+                              processing_instruction: processing_instruction,
+                              application_context: application_context)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/customer_information.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a customer in PayPal's system of record.
+  class CustomerInformation < 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.<blockquote><strong>Note:</strong> Up
+    # to 64 characters are allowed before and 255 characters are allowed after
+    # the <code>@</code> sign. However, the generally accepted maximum length
+    # for an email address is 254 characters. The pattern verifies that an
+    # unquoted <code>@</code> sign exists.</blockquote>
+    # @return [String]
+    attr_accessor :email_address
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == 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']
+
+      # Create object from extracted values.
+      CustomerInformation.new(id: id,
+                              email_address: email_address,
+                              phone: phone)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/customer_request.rb

@@ -0,0 +1,62 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Customer in merchant's or partner's system of records.
+  class CustomerRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # 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['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        merchant_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, merchant_customer_id: SKIP)
+      @id = id unless id == 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
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      CustomerRequest.new(id: id,
+                          merchant_customer_id: merchant_customer_id)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/customer_vault_payment_tokens_response.rb

@@ -0,0 +1,105 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Collection of payment tokens saved for a given customer.
+  class CustomerVaultPaymentTokensResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total number of items.
+    # @return [Integer]
+    attr_accessor :total_items
+
+    # Total number of pages.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Customer in merchant's or partner's system of records.
+    # @return [CustomerRequest]
+    attr_accessor :customer
+
+    # Customer in merchant's or partner's system of records.
+    # @return [Array[PaymentTokenResponse]]
+    attr_accessor :payment_tokens
+
+    # An array of related [HATEOAS links](/api/rest/responses/#hateoas).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_items'] = 'total_items'
+      @_hash['total_pages'] = 'total_pages'
+      @_hash['customer'] = 'customer'
+      @_hash['payment_tokens'] = 'payment_tokens'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_items
+        total_pages
+        customer
+        payment_tokens
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_items: SKIP, total_pages: SKIP, customer: SKIP,
+                   payment_tokens: SKIP, links: SKIP)
+      @total_items = total_items unless total_items == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @customer = customer unless customer == SKIP
+      @payment_tokens = payment_tokens unless payment_tokens == SKIP
+      @links = links unless links == 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.
+      total_items = hash.key?('total_items') ? hash['total_items'] : SKIP
+      total_pages = hash.key?('total_pages') ? hash['total_pages'] : SKIP
+      customer = CustomerRequest.from_hash(hash['customer']) if hash['customer']
+      # Parameter is an array, so we need to iterate through it
+      payment_tokens = nil
+      unless hash['payment_tokens'].nil?
+        payment_tokens = []
+        hash['payment_tokens'].each do |structure|
+          payment_tokens << (PaymentTokenResponse.from_hash(structure) if structure)
+        end
+      end
+
+      payment_tokens = SKIP unless hash.key?('payment_tokens')
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (LinkDescription.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+
+      # Create object from extracted values.
+      CustomerVaultPaymentTokensResponse.new(total_items: total_items,
+                                             total_pages: total_pages,
+                                             customer: customer,
+                                             payment_tokens: payment_tokens,
+                                             links: links)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/cvv_code.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The card verification value code for for Visa, Discover, Mastercard, or
+  # American Express.
+  class CVVCode
+    CVV_CODE = [
+      # TODO: Write general description for E
+      E = 'E'.freeze,
+
+      # TODO: Write general description for I
+      I = 'I'.freeze,
+
+      # TODO: Write general description for M
+      M = 'M'.freeze,
+
+      # TODO: Write general description for N
+      N = 'N'.freeze,
+
+      # TODO: Write general description for P
+      P = 'P'.freeze,
+
+      # TODO: Write general description for S
+      S = 'S'.freeze,
+
+      # TODO: Write general description for U
+      U = 'U'.freeze,
+
+      # TODO: Write general description for X
+      X = 'X'.freeze,
+
+      # TODO: Write general description for ENUM_ALL_OTHERS
+      ENUM_ALL_OTHERS = 'All others'.freeze,
+
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = '0'.freeze,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = '1'.freeze,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = '2'.freeze,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = '3'.freeze,
+
+      # TODO: Write general description for ENUM_4
+      ENUM_4 = '4'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/disbursement_mode.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The funds that are held on behalf of the merchant.
+  class DisbursementMode
+    DISBURSEMENT_MODE = [
+      # TODO: Write general description for INSTANT
+      INSTANT = 'INSTANT'.freeze,
+
+      # TODO: Write general description for DELAYED
+      DELAYED = 'DELAYED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/dispute_category.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The condition that is covered for the transaction.
+  class DisputeCategory
+    DISPUTE_CATEGORY = [
+      # TODO: Write general description for ITEM_NOT_RECEIVED
+      ITEM_NOT_RECEIVED = 'ITEM_NOT_RECEIVED'.freeze,
+
+      # TODO: Write general description for UNAUTHORIZED_TRANSACTION
+      UNAUTHORIZED_TRANSACTION = 'UNAUTHORIZED_TRANSACTION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/eci_flag.rb

@@ -0,0 +1,39 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data
+  # elements that indicate the transaction was processed electronically. This
+  # should be passed on the authorization transaction to the Gateway/Processor.
+  class ECIFlag
+    ECI_FLAG = [
+      # TODO: Write general description for MASTERCARD_NON_3D_SECURE_TRANSACTION
+      MASTERCARD_NON_3D_SECURE_TRANSACTION = 'MASTERCARD_NON_3D_SECURE_TRANSACTION'.freeze,
+
+      # TODO: Write general description for
+      # MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION
+      MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION = 'MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION'.freeze,
+
+      # TODO: Write general description for
+      # MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION
+      MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION = 'MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION'.freeze,
+
+      # TODO: Write general description for FULLY_AUTHENTICATED_TRANSACTION
+      FULLY_AUTHENTICATED_TRANSACTION = 'FULLY_AUTHENTICATED_TRANSACTION'.freeze,
+
+      # TODO: Write general description for ATTEMPTED_AUTHENTICATION_TRANSACTION
+      ATTEMPTED_AUTHENTICATION_TRANSACTION = 'ATTEMPTED_AUTHENTICATION_TRANSACTION'.freeze,
+
+      # TODO: Write general description for NON_3D_SECURE_TRANSACTION
+      NON_3D_SECURE_TRANSACTION = 'NON_3D_SECURE_TRANSACTION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/enrollment_status.rb

@@ -0,0 +1,29 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Status of Authentication eligibility.
+  class EnrollmentStatus
+    ENROLLMENT_STATUS = [
+      # TODO: Write general description for Y
+      Y = 'Y'.freeze,
+
+      # TODO: Write general description for N
+      N = 'N'.freeze,
+
+      # TODO: Write general description for U
+      U = 'U'.freeze,
+
+      # TODO: Write general description for B
+      B = 'B'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/eps_payment_object.rb

@@ -0,0 +1,74 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using eps.
+  class EPSPaymentObject < 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        bic
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, bic: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @bic = bic unless bic == 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
+
+      # Create object from extracted values.
+      EPSPaymentObject.new(name: name,
+                           country_code: country_code,
+                           bic: bic)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/eps_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 eps.
+  class EPSPaymentRequest < 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.
+      EPSPaymentRequest.new(name: name,
+                            country_code: country_code,
+                            experience_context: experience_context)
+    end
+  end
+end