paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/apple_pay_tokenized_card.rb

@@ -0,0 +1,113 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The payment card to use to fund a payment. Can be a credit or debit card.
+  class ApplePayTokenizedCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The primary account number (PAN) for the payment card.
+    # @return [String]
+    attr_accessor :number
+
+    # 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 card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :card_type
+
+    # Type of card. i.e Credit, Debit and so on.
+    # @return [CardType]
+    attr_accessor :type
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :brand
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['number'] = 'number'
+      @_hash['expiry'] = 'expiry'
+      @_hash['card_type'] = 'card_type'
+      @_hash['type'] = 'type'
+      @_hash['brand'] = 'brand'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        number
+        expiry
+        card_type
+        type
+        brand
+        billing_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, number: SKIP, expiry: SKIP, card_type: SKIP,
+                   type: SKIP, brand: SKIP, billing_address: SKIP)
+      @name = name unless name == SKIP
+      @number = number unless number == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @card_type = card_type unless card_type == SKIP
+      @type = type unless type == SKIP
+      @brand = brand unless brand == SKIP
+      @billing_address = billing_address unless billing_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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      card_type = hash.key?('card_type') ? hash['card_type'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+
+      # Create object from extracted values.
+      ApplePayTokenizedCard.new(name: name,
+                                number: number,
+                                expiry: expiry,
+                                card_type: card_type,
+                                type: type,
+                                brand: brand,
+                                billing_address: billing_address)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/assurance_details.rb

@@ -0,0 +1,68 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information about cardholder possession validation and cardholder
+  # identification and verifications (ID&V).
+  class AssuranceDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If true, indicates that Cardholder possession validation has been
+    # performed on returned payment credential.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :account_verified
+
+    # If true, indicates that identification and verifications (ID&V) was
+    # performed on the returned payment credential.If false, the same risk-based
+    # authentication can be performed as you would for card transactions. This
+    # risk-based authentication can include, but not limited to, step-up with 3D
+    # Secure protocol if applicable.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :card_holder_authenticated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_verified'] = 'account_verified'
+      @_hash['card_holder_authenticated'] = 'card_holder_authenticated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_verified
+        card_holder_authenticated
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_verified: false, card_holder_authenticated: false)
+      @account_verified = account_verified unless account_verified == SKIP
+      unless card_holder_authenticated == SKIP
+        @card_holder_authenticated =
+          card_holder_authenticated
+      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.
+      account_verified = hash['account_verified'] ||= false
+      card_holder_authenticated = hash['card_holder_authenticated'] ||= false
+
+      # Create object from extracted values.
+      AssuranceDetails.new(account_verified: account_verified,
+                           card_holder_authenticated: card_holder_authenticated)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authentication_response.rb

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

data/lib/paypal_server_sdk/models/authorization.rb

@@ -0,0 +1,192 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The authorized payment transaction.
+  class Authorization < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status for the authorized payment.
+    # @return [AuthorizationStatus]
+    attr_accessor :status
+
+    # The details of the authorized payment status.
+    # @return [AuthorizationStatusDetails]
+    attr_accessor :status_details
+
+    # The PayPal-generated ID for the authorized payment.
+    # @return [String]
+    attr_accessor :id
+
+    # 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
+
+    # The API caller-provided external ID. Used to reconcile API
+    # caller-initiated transactions with PayPal transactions. Appears in
+    # transaction and settlement reports.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # Reference values used by the card network to identify a transaction.
+    # @return [NetworkTransactionReference]
+    attr_accessor :network_transaction_reference
+
+    # The level of protection offered as defined by [PayPal Seller Protection
+    # for
+    # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protectio
+    # n).
+    # @return [SellerProtection]
+    attr_accessor :seller_protection
+
+    # 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.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @return [String]
+    attr_accessor :expiration_time
+
+    # An array of related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # 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.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @return [String]
+    attr_accessor :create_time
+
+    # 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.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @return [String]
+    attr_accessor :update_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['status_details'] = 'status_details'
+      @_hash['id'] = 'id'
+      @_hash['amount'] = 'amount'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['network_transaction_reference'] =
+        'network_transaction_reference'
+      @_hash['seller_protection'] = 'seller_protection'
+      @_hash['expiration_time'] = 'expiration_time'
+      @_hash['links'] = 'links'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        status_details
+        id
+        amount
+        invoice_id
+        custom_id
+        network_transaction_reference
+        seller_protection
+        expiration_time
+        links
+        create_time
+        update_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, status_details: SKIP, id: SKIP, amount: SKIP,
+                   invoice_id: SKIP, custom_id: SKIP,
+                   network_transaction_reference: SKIP, seller_protection: SKIP,
+                   expiration_time: SKIP, links: SKIP, create_time: SKIP,
+                   update_time: SKIP)
+      @status = status unless status == SKIP
+      @status_details = status_details unless status_details == SKIP
+      @id = id unless id == SKIP
+      @amount = amount unless amount == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      unless network_transaction_reference == SKIP
+        @network_transaction_reference =
+          network_transaction_reference
+      end
+      @seller_protection = seller_protection unless seller_protection == SKIP
+      @expiration_time = expiration_time unless expiration_time == SKIP
+      @links = links unless links == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_details = AuthorizationStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      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'])
+      end
+      seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
+        hash['seller_protection']
+      expiration_time =
+        hash.key?('expiration_time') ? hash['expiration_time'] : SKIP
+      # 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_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+
+      # Create object from extracted values.
+      Authorization.new(status: status,
+                        status_details: status_details,
+                        id: id,
+                        amount: amount,
+                        invoice_id: invoice_id,
+                        custom_id: custom_id,
+                        network_transaction_reference: network_transaction_reference,
+                        seller_protection: seller_protection,
+                        expiration_time: expiration_time,
+                        links: links,
+                        create_time: create_time,
+                        update_time: update_time)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authorization_incomplete_reason.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The reason why the authorized status is `PENDING`.
+  class AuthorizationIncompleteReason
+    AUTHORIZATION_INCOMPLETE_REASON = [
+      # TODO: Write general description for PENDING_REVIEW
+      PENDING_REVIEW = 'PENDING_REVIEW'.freeze,
+
+      # TODO: Write general description for DECLINED_BY_RISK_FRAUD_FILTERS
+      DECLINED_BY_RISK_FRAUD_FILTERS = 'DECLINED_BY_RISK_FRAUD_FILTERS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authorization_status.rb

@@ -0,0 +1,35 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The status for the authorized payment.
+  class AuthorizationStatus
+    AUTHORIZATION_STATUS = [
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for CAPTURED
+      CAPTURED = 'CAPTURED'.freeze,
+
+      # TODO: Write general description for DENIED
+      DENIED = 'DENIED'.freeze,
+
+      # TODO: Write general description for PARTIALLY_CAPTURED
+      PARTIALLY_CAPTURED = 'PARTIALLY_CAPTURED'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'VOIDED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authorization_status_details.rb

@@ -0,0 +1,50 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details of the authorized payment status.
+  class AuthorizationStatusDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason why the authorized status is `PENDING`.
+    # @return [AuthorizationIncompleteReason]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason: SKIP)
+      @reason = reason unless reason == 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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      AuthorizationStatusDetails.new(reason: reason)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authorization_status_with_details.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The status fields and status details for an authorized payment.
+  class AuthorizationStatusWithDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status for the authorized payment.
+    # @return [AuthorizationStatus]
+    attr_accessor :status
+
+    # The details of the authorized payment status.
+    # @return [AuthorizationStatusDetails]
+    attr_accessor :status_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['status_details'] = 'status_details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        status_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, status_details: SKIP)
+      @status = status unless status == SKIP
+      @status_details = status_details unless status_details == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_details = AuthorizationStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+
+      # Create object from extracted values.
+      AuthorizationStatusWithDetails.new(status: status,
+                                         status_details: status_details)
+    end
+  end
+end