cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/cycle_execution.rb

@@ -0,0 +1,124 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The regular and trial execution details for a billing cycle.
+  class CycleExecution < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of the billing cycle.
+    # @return [TenureType]
+    attr_accessor :tenure_type
+
+    # The order in which to run this cycle among other billing cycles.
+    # @return [Integer]
+    attr_accessor :sequence
+
+    # The number of billing cycles that have completed.
+    # @return [Integer]
+    attr_accessor :cycles_completed
+
+    # For a finite billing cycle, cycles_remaining is the number of remaining
+    # cycles. For an infinite billing cycle, cycles_remaining is set as 0.
+    # @return [Integer]
+    attr_accessor :cycles_remaining
+
+    # The active pricing scheme version for the billing cycle.
+    # @return [Integer]
+    attr_accessor :current_pricing_scheme_version
+
+    # The number of times this billing cycle gets executed. Trial billing cycles
+    # can only be executed a finite number of times (value between 1 and 999 for
+    # total_cycles). Regular billing cycles can be executed infinite times
+    # (value of 0 for total_cycles) or a finite number of times (value between 1
+    # and 999 for total_cycles).
+    # @return [Integer]
+    attr_accessor :total_cycles
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tenure_type'] = 'tenure_type'
+      @_hash['sequence'] = 'sequence'
+      @_hash['cycles_completed'] = 'cycles_completed'
+      @_hash['cycles_remaining'] = 'cycles_remaining'
+      @_hash['current_pricing_scheme_version'] =
+        'current_pricing_scheme_version'
+      @_hash['total_cycles'] = 'total_cycles'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cycles_remaining
+        current_pricing_scheme_version
+        total_cycles
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tenure_type:, sequence:, cycles_completed:,
+                   cycles_remaining: SKIP, current_pricing_scheme_version: SKIP,
+                   total_cycles: SKIP)
+      @tenure_type = tenure_type
+      @sequence = sequence
+      @cycles_completed = cycles_completed
+      @cycles_remaining = cycles_remaining unless cycles_remaining == SKIP
+      unless current_pricing_scheme_version == SKIP
+        @current_pricing_scheme_version =
+          current_pricing_scheme_version
+      end
+      @total_cycles = total_cycles unless total_cycles == 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.
+      tenure_type = hash.key?('tenure_type') ? hash['tenure_type'] : nil
+      sequence = hash.key?('sequence') ? hash['sequence'] : nil
+      cycles_completed =
+        hash.key?('cycles_completed') ? hash['cycles_completed'] : nil
+      cycles_remaining =
+        hash.key?('cycles_remaining') ? hash['cycles_remaining'] : SKIP
+      current_pricing_scheme_version =
+        hash.key?('current_pricing_scheme_version') ? hash['current_pricing_scheme_version'] : SKIP
+      total_cycles = hash.key?('total_cycles') ? hash['total_cycles'] : SKIP
+
+      # Create object from extracted values.
+      CycleExecution.new(tenure_type: tenure_type,
+                         sequence: sequence,
+                         cycles_completed: cycles_completed,
+                         cycles_remaining: cycles_remaining,
+                         current_pricing_scheme_version: current_pricing_scheme_version,
+                         total_cycles: total_cycles)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tenure_type: #{@tenure_type}, sequence: #{@sequence}, cycles_completed:"\
+      " #{@cycles_completed}, cycles_remaining: #{@cycles_remaining},"\
+      " current_pricing_scheme_version: #{@current_pricing_scheme_version}, total_cycles:"\
+      " #{@total_cycles}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tenure_type: #{@tenure_type.inspect}, sequence: #{@sequence.inspect},"\
+      " cycles_completed: #{@cycles_completed.inspect}, cycles_remaining:"\
+      " #{@cycles_remaining.inspect}, current_pricing_scheme_version:"\
+      " #{@current_pricing_scheme_version.inspect}, total_cycles: #{@total_cycles.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/disbursement_mode.rb

@@ -0,0 +1,39 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The funds that are held on behalf of the merchant.
+  class DisbursementMode
+    DISBURSEMENT_MODE = [
+      # The funds are released to the merchant immediately.
+      INSTANT = 'INSTANT'.freeze,
+
+      # The funds are held for a finite number of days. The actual duration
+      # depends on the region and type of integration. You can release the funds
+      # through a referenced payout. Otherwise, the funds disbursed
+      # automatically after the specified duration.
+      DELAYED = 'DELAYED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = INSTANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'instant' then INSTANT
+      when 'delayed' then DELAYED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/dispute_category.rb

@@ -0,0 +1,36 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The condition that is covered for the transaction.
+  class DisputeCategory
+    DISPUTE_CATEGORY = [
+      # The payer paid for an item that they did not receive.
+      ITEM_NOT_RECEIVED = 'ITEM_NOT_RECEIVED'.freeze,
+
+      # The payer did not authorize the payment.
+      UNAUTHORIZED_TRANSACTION = 'UNAUTHORIZED_TRANSACTION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ITEM_NOT_RECEIVED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'item_not_received' then ITEM_NOT_RECEIVED
+      when 'unauthorized_transaction' then UNAUTHORIZED_TRANSACTION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/eci_flag.rb

@@ -0,0 +1,54 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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 = [
+      # Mastercard non-3-D Secure transaction.
+      MASTERCARD_NON_3D_SECURE_TRANSACTION = 'MASTERCARD_NON_3D_SECURE_TRANSACTION'.freeze,
+
+      # Mastercard attempted authentication transaction.
+      MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION = 'MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION'.freeze,
+
+      # Mastercard fully authenticated transaction.
+      MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION = 'MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION'.freeze,
+
+      # VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction.
+      FULLY_AUTHENTICATED_TRANSACTION = 'FULLY_AUTHENTICATED_TRANSACTION'.freeze,
+
+      # VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction.
+      ATTEMPTED_AUTHENTICATION_TRANSACTION = 'ATTEMPTED_AUTHENTICATION_TRANSACTION'.freeze,
+
+      # VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction.
+      NON_3D_SECURE_TRANSACTION = 'NON_3D_SECURE_TRANSACTION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MASTERCARD_NON_3D_SECURE_TRANSACTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'mastercard_non_3d_secure_transaction' then MASTERCARD_NON_3D_SECURE_TRANSACTION
+      when 'mastercard_attempted_authentication_transaction' then MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION
+      when 'mastercard_fully_authenticated_transaction' then MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION
+      when 'fully_authenticated_transaction' then FULLY_AUTHENTICATED_TRANSACTION
+      when 'attempted_authentication_transaction' then ATTEMPTED_AUTHENTICATION_TRANSACTION
+      when 'non_3d_secure_transaction' then NON_3D_SECURE_TRANSACTION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/enrollment_status.rb

@@ -0,0 +1,47 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Status of Authentication eligibility.
+  class EnrollmentStatus
+    ENROLLMENT_STATUS = [
+      # Yes. The bank is participating in 3-D Secure protocol and will return
+      # the ACSUrl.
+      ENROLLED = 'Y'.freeze,
+
+      # No. The bank is not participating in 3-D Secure protocol.
+      NOTENROLLED = 'N'.freeze,
+
+      # Unavailable. The DS or ACS is not available for authentication at the
+      # time of the request.
+      UNAVAILABLE = 'U'.freeze,
+
+      # Bypass. The merchant authentication rule is triggered to bypass
+      # authentication.
+      BYPASS = 'B'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENROLLED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enrolled' then ENROLLED
+      when 'notenrolled' then NOTENROLLED
+      when 'unavailable' then UNAVAILABLE
+      when 'bypass' then BYPASS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/eps_payment_object.rb

@@ -0,0 +1,87 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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](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
+
+    # 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, country_code: #{@country_code}, bic: #{@bic}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, country_code: #{@country_code.inspect}, bic:"\
+      " #{@bic.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/eps_payment_request.rb

@@ -0,0 +1,87 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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](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['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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, 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}, country_code: #{@country_code.inspect},"\
+      " experience_context: #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/error_details.rb

@@ -0,0 +1,125 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The error details. Required for client-side `4XX` errors.
+  class ErrorDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The field that caused the error. If this field is in the body, set this
+    # value to the field's JSON pointer value. Required for client-side errors.
+    # @return [String]
+    attr_accessor :field
+
+    # The value of the field that caused the error.
+    # @return [String]
+    attr_accessor :value
+
+    # The location of the field that caused the error. Value is `body`, `path`,
+    # or `query`.
+    # @return [String]
+    attr_accessor :location
+
+    # The unique, fine-grained application-level error code.
+    # @return [String]
+    attr_accessor :issue
+
+    # An array of request-related [HATEOAS
+    # links](https://developer.paypal.com/api/rest/responses/#hateoas-links)
+    # that are either relevant to the issue by providing additional information
+    # or offering potential resolutions.
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # The human-readable description for an issue. The description can change
+    # over the lifetime of an API, so clients must not depend on this value.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field'] = 'field'
+      @_hash['value'] = 'value'
+      @_hash['location'] = 'location'
+      @_hash['issue'] = 'issue'
+      @_hash['links'] = 'links'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        field
+        value
+        location
+        links
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(issue:, field: SKIP, value: SKIP, location: 'body',
+                   links: SKIP, description: SKIP)
+      @field = field unless field == SKIP
+      @value = value unless value == SKIP
+      @location = location unless location == SKIP
+      @issue = issue
+      @links = links unless links == SKIP
+      @description = description unless 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.
+      issue = hash.key?('issue') ? hash['issue'] : nil
+      field = hash.key?('field') ? hash['field'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+      location = hash['location'] ||= 'body'
+      # 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')
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      ErrorDetails.new(issue: issue,
+                       field: field,
+                       value: value,
+                       location: location,
+                       links: links,
+                       description: description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field: #{@field}, value: #{@value}, location: #{@location}, issue:"\
+      " #{@issue}, links: #{@links}, description: #{@description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field: #{@field.inspect}, value: #{@value.inspect}, location:"\
+      " #{@location.inspect}, issue: #{@issue.inspect}, links: #{@links.inspect}, description:"\
+      " #{@description.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/exchange_rate.rb

@@ -0,0 +1,91 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The exchange rate that determines the amount to convert from one currency to
+  # another currency.
+  class ExchangeRate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The [three-character ISO-4217 currency
+    # code](https://developer.paypal.com/api/rest/reference/currency-codes/)
+    # that identifies the currency.
+    # @return [String]
+    attr_accessor :source_currency
+
+    # The [three-character ISO-4217 currency
+    # code](https://developer.paypal.com/api/rest/reference/currency-codes/)
+    # that identifies the currency.
+    # @return [String]
+    attr_accessor :target_currency
+
+    # The target currency amount. Equivalent to one unit of the source currency.
+    # Formatted as integer or decimal value with one to 15 digits to the right
+    # of the decimal point.
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source_currency'] = 'source_currency'
+      @_hash['target_currency'] = 'target_currency'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        source_currency
+        target_currency
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source_currency: SKIP, target_currency: SKIP, value: SKIP)
+      @source_currency = source_currency unless source_currency == SKIP
+      @target_currency = target_currency unless target_currency == SKIP
+      @value = value unless value == 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.
+      source_currency =
+        hash.key?('source_currency') ? hash['source_currency'] : SKIP
+      target_currency =
+        hash.key?('target_currency') ? hash['target_currency'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      ExchangeRate.new(source_currency: source_currency,
+                       target_currency: target_currency,
+                       value: value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source_currency: #{@source_currency}, target_currency: #{@target_currency},"\
+      " value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source_currency: #{@source_currency.inspect}, target_currency:"\
+      " #{@target_currency.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end