cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/orders_capture.rb

@@ -0,0 +1,252 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A captured payment.
+  class OrdersCapture < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the captured payment.
+    # @return [CaptureStatus]
+    attr_accessor :status
+
+    # The details of the captured payment status.
+    # @return [CaptureStatusDetails]
+    attr_accessor :status_details
+
+    # The PayPal-generated ID for the captured 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 [NetworkTransaction]
+    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
+
+    # Indicates whether you can make additional captures against the authorized
+    # payment. Set to `true` if you do not intend to capture additional payments
+    # against the authorization. Set to `false` if you intend to capture
+    # additional payments against the authorization.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :final_capture
+
+    # The detailed breakdown of the capture activity. This is not available for
+    # transactions that are in pending state.
+    # @return [SellerReceivableBreakdown]
+    attr_accessor :seller_receivable_breakdown
+
+    # The funds that are held on behalf of the merchant.
+    # @return [DisbursementMode]
+    attr_accessor :disbursement_mode
+
+    # An array of related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # The processor response information for payment requests, such as direct
+    # credit card transactions.
+    # @return [ProcessorResponse]
+    attr_accessor :processor_response
+
+    # 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.
+    # @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. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @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['final_capture'] = 'final_capture'
+      @_hash['seller_receivable_breakdown'] = 'seller_receivable_breakdown'
+      @_hash['disbursement_mode'] = 'disbursement_mode'
+      @_hash['links'] = 'links'
+      @_hash['processor_response'] = 'processor_response'
+      @_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
+        final_capture
+        seller_receivable_breakdown
+        disbursement_mode
+        links
+        processor_response
+        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,
+                   final_capture: false, seller_receivable_breakdown: SKIP,
+                   disbursement_mode: DisbursementMode::INSTANT, links: SKIP,
+                   processor_response: 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
+      @final_capture = final_capture unless final_capture == SKIP
+      unless seller_receivable_breakdown == SKIP
+        @seller_receivable_breakdown =
+          seller_receivable_breakdown
+      end
+      @disbursement_mode = disbursement_mode unless disbursement_mode == SKIP
+      @links = links unless links == SKIP
+      @processor_response = processor_response unless processor_response == 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 = CaptureStatusDetails.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 = NetworkTransaction.from_hash(hash['network_transaction_reference'])
+      end
+      seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
+        hash['seller_protection']
+      final_capture = hash['final_capture'] ||= false
+      if hash['seller_receivable_breakdown']
+        seller_receivable_breakdown = SellerReceivableBreakdown.from_hash(hash['seller_receivable_breakdown'])
+      end
+      disbursement_mode =
+        hash['disbursement_mode'] ||= DisbursementMode::INSTANT
+      # 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')
+      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
+
+      # Create object from extracted values.
+      OrdersCapture.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,
+                        final_capture: final_capture,
+                        seller_receivable_breakdown: seller_receivable_breakdown,
+                        disbursement_mode: disbursement_mode,
+                        links: links,
+                        processor_response: processor_response,
+                        create_time: create_time,
+                        update_time: update_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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}, final_capture: #{@final_capture}, seller_receivable_breakdown:"\
+      " #{@seller_receivable_breakdown}, disbursement_mode: #{@disbursement_mode}, links:"\
+      " #{@links}, processor_response: #{@processor_response}, create_time: #{@create_time},"\
+      " update_time: #{@update_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}, id:"\
+      " #{@id.inspect}, amount: #{@amount.inspect}, invoice_id: #{@invoice_id.inspect}, custom_id:"\
+      " #{@custom_id.inspect}, network_transaction_reference:"\
+      " #{@network_transaction_reference.inspect}, seller_protection:"\
+      " #{@seller_protection.inspect}, final_capture: #{@final_capture.inspect},"\
+      " seller_receivable_breakdown: #{@seller_receivable_breakdown.inspect}, disbursement_mode:"\
+      " #{@disbursement_mode.inspect}, links: #{@links.inspect}, processor_response:"\
+      " #{@processor_response.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/orders_card_verification_method.rb

@@ -0,0 +1,66 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The method used for card verification.
+  class OrdersCardVerificationMethod
+    ORDERS_CARD_VERIFICATION_METHOD = [
+      # Selecting this option will attempt to force a strong customer
+      # authentication for the authorization/transaction. In countries where SCA
+      # has been defined and implemented it will result in a contingency and
+      # HATEOAS link being returned.  The API caller should redirect the payer
+      # to that link so that they can authenticate themselves against their
+      # issuing bank or other entity. As noted, the HATEOAS link is only
+      # available in all regions where strong authentication is supported, (e.g.
+      # in European countries where 3DS is live). Merchants can use this setting
+      # as an additional layer of security if they choose to. In all cases, when
+      # an authorization is requested the AVS/CVV results will be returned in
+      # the response.
+      SCA_ALWAYS = 'SCA_ALWAYS'.freeze,
+
+      # This is the default. When an authorization or transaction is attempted
+      # this option will return a contingency and HATEOAS link only when local
+      # regulations require strong customer authentication, (e.g. 3DS in
+      # countries and use cases where it is mandated). The API caller should
+      # redirect the payer to the link so that they can authenticate themselves.
+      # In all cases, when an authorization is requested the AVS/CVV results
+      # will be returned in the response.
+      SCA_WHEN_REQUIRED = 'SCA_WHEN_REQUIRED'.freeze,
+
+      # The contingency surfaced as an additional security layer that helps
+      # prevent unauthorized card-not-present transactions and protects the
+      # merchant from exposure to fraud.
+      ENUM_3D_SECURE = '3D_SECURE'.freeze,
+
+      # Places a temporary hold on the card to ensure its validity. This process
+      # protects the merchant from exposure to fraud. This verification method
+      # will confirm that the address information or CVV included matches what
+      # the issuing bank has on file for the associated card, ensuring that only
+      # authorized card users are able to make purchases from you.
+      AVS_CVV = 'AVS_CVV'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SCA_ALWAYS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sca_always' then SCA_ALWAYS
+      when 'sca_when_required' then SCA_WHEN_REQUIRED
+      when 'enum_3d_secure' then ENUM_3D_SECURE
+      when 'avs_cvv' then AVS_CVV
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/os_type.rb

@@ -0,0 +1,40 @@
+# 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
+
+    def self.from_value(value, default_value = ANDROID)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'android' then ANDROID
+      when 'ios' then IOS
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/p24_payment_object.rb

@@ -0,0 +1,123 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using P24(Przelewy24).
+  class P24PaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # 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
+
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/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
+
+    # P24 generated payment description.
+    # @return [String]
+    attr_accessor :payment_descriptor
+
+    # Numeric identifier of the payment scheme or bank used for the payment.
+    # @return [String]
+    attr_accessor :method_id
+
+    # Friendly name of the payment scheme or bank used for the payment.
+    # @return [String]
+    attr_accessor :method_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash['country_code'] = 'country_code'
+      @_hash['payment_descriptor'] = 'payment_descriptor'
+      @_hash['method_id'] = 'method_id'
+      @_hash['method_description'] = 'method_description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        email
+        country_code
+        payment_descriptor
+        method_id
+        method_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, email: SKIP, country_code: SKIP,
+                   payment_descriptor: SKIP, method_id: SKIP,
+                   method_description: SKIP)
+      @name = name unless name == SKIP
+      @email = email unless email == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @payment_descriptor = payment_descriptor unless payment_descriptor == SKIP
+      @method_id = method_id unless method_id == SKIP
+      @method_description = method_description unless method_description == 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
+      email = hash.key?('email') ? hash['email'] : SKIP
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      payment_descriptor =
+        hash.key?('payment_descriptor') ? hash['payment_descriptor'] : SKIP
+      method_id = hash.key?('method_id') ? hash['method_id'] : SKIP
+      method_description =
+        hash.key?('method_description') ? hash['method_description'] : SKIP
+
+      # Create object from extracted values.
+      P24PaymentObject.new(name: name,
+                           email: email,
+                           country_code: country_code,
+                           payment_descriptor: payment_descriptor,
+                           method_id: method_id,
+                           method_description: method_description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, email: #{@email}, country_code: #{@country_code},"\
+      " payment_descriptor: #{@payment_descriptor}, method_id: #{@method_id}, method_description:"\
+      " #{@method_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, email: #{@email.inspect}, country_code:"\
+      " #{@country_code.inspect}, payment_descriptor: #{@payment_descriptor.inspect}, method_id:"\
+      " #{@method_id.inspect}, method_description: #{@method_description.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/p24_payment_request.rb

@@ -0,0 +1,98 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using P24 (Przelewy24).
+  class P24PaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # 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
+
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/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
+
+    # 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['email'] = 'email'
+      @_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:, email:, country_code:, experience_context: SKIP)
+      @name = name
+      @email = email
+      @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
+      email = hash.key?('email') ? hash['email'] : 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.
+      P24PaymentRequest.new(name: name,
+                            email: email,
+                            country_code: country_code,
+                            experience_context: experience_context)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, email: #{@email}, country_code: #{@country_code},"\
+      " experience_context: #{@experience_context}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, email: #{@email.inspect}, country_code:"\
+      " #{@country_code.inspect}, experience_context: #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pa_res_status.rb

@@ -0,0 +1,61 @@
+# paypal_server_sdk
+#
+# 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
+  # authentication.
+  class PaResStatus
+    PA_RES_STATUS = [
+      # Successful authentication.
+      SUCCESSFULAUTHENTICATION = 'Y'.freeze,
+
+      # Failed authentication / account not verified / transaction denied.
+      FAILEDAUTHENTICATION = 'N'.freeze,
+
+      # Unable to complete authentication.
+      UNABLETOCOMPLETEAUTHENTICATION = 'U'.freeze,
+
+      # Successful attempts transaction.
+      SUCCESSFULATTEMPTSTRANSACTION = 'A'.freeze,
+
+      # Challenge required for authentication.
+      CHALLENGEREQUIRED = 'C'.freeze,
+
+      # Authentication rejected (merchant must not submit for authorization).
+      AUTHENTICATIONREJECTED = 'R'.freeze,
+
+      # Challenge required; decoupled authentication confirmed.
+      DECOUPLEDAUTHENTICATION = 'D'.freeze,
+
+      # Informational only; 3DS requestor challenge preference acknowledged.
+      INFORMATIONALONLY = 'I'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SUCCESSFULAUTHENTICATION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'successfulauthentication' then SUCCESSFULAUTHENTICATION
+      when 'failedauthentication' then FAILEDAUTHENTICATION
+      when 'unabletocompleteauthentication' then UNABLETOCOMPLETEAUTHENTICATION
+      when 'successfulattemptstransaction' then SUCCESSFULATTEMPTSTRANSACTION
+      when 'challengerequired' then CHALLENGEREQUIRED
+      when 'authenticationrejected' then AUTHENTICATIONREJECTED
+      when 'decoupledauthentication' then DECOUPLEDAUTHENTICATION
+      when 'informationalonly' then INFORMATIONALONLY
+      else
+        default_value
+      end
+    end
+  end
+end