cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/payment_collection.rb

@@ -0,0 +1,113 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The collection of payments, or transactions, for a purchase unit in an
+  # order. For example, authorized payments, captured payments, and refunds.
+  class PaymentCollection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of authorized payments for a purchase unit. A purchase unit can
+    # have zero or more authorized payments.
+    # @return [Array[AuthorizationWithAdditionalData]]
+    attr_accessor :authorizations
+
+    # An array of captured payments for a purchase unit. A purchase unit can
+    # have zero or more captured payments.
+    # @return [Array[OrdersCapture]]
+    attr_accessor :captures
+
+    # An array of refunds for a purchase unit. A purchase unit can have zero or
+    # more refunds.
+    # @return [Array[Refund]]
+    attr_accessor :refunds
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authorizations'] = 'authorizations'
+      @_hash['captures'] = 'captures'
+      @_hash['refunds'] = 'refunds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        authorizations
+        captures
+        refunds
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(authorizations: SKIP, captures: SKIP, refunds: SKIP)
+      @authorizations = authorizations unless authorizations == SKIP
+      @captures = captures unless captures == SKIP
+      @refunds = refunds unless refunds == 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.
+      # Parameter is an array, so we need to iterate through it
+      authorizations = nil
+      unless hash['authorizations'].nil?
+        authorizations = []
+        hash['authorizations'].each do |structure|
+          authorizations << (AuthorizationWithAdditionalData.from_hash(structure) if structure)
+        end
+      end
+
+      authorizations = SKIP unless hash.key?('authorizations')
+      # Parameter is an array, so we need to iterate through it
+      captures = nil
+      unless hash['captures'].nil?
+        captures = []
+        hash['captures'].each do |structure|
+          captures << (OrdersCapture.from_hash(structure) if structure)
+        end
+      end
+
+      captures = SKIP unless hash.key?('captures')
+      # Parameter is an array, so we need to iterate through it
+      refunds = nil
+      unless hash['refunds'].nil?
+        refunds = []
+        hash['refunds'].each do |structure|
+          refunds << (Refund.from_hash(structure) if structure)
+        end
+      end
+
+      refunds = SKIP unless hash.key?('refunds')
+
+      # Create object from extracted values.
+      PaymentCollection.new(authorizations: authorizations,
+                            captures: captures,
+                            refunds: refunds)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authorizations: #{@authorizations}, captures: #{@captures}, refunds:"\
+      " #{@refunds}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authorizations: #{@authorizations.inspect}, captures: #{@captures.inspect},"\
+      " refunds: #{@refunds.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_initiator.rb

@@ -0,0 +1,39 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The person or party who initiated or triggered the payment.
+  class PaymentInitiator
+    PAYMENT_INITIATOR = [
+      # Payment is initiated with the active engagement of the customer. e.g. a
+      # customer checking out on a merchant website.
+      CUSTOMER = 'CUSTOMER'.freeze,
+
+      # Payment is initiated by merchant on behalf of the customer without the
+      # active engagement of customer. e.g. a merchant charging the monthly
+      # payment of a subscription to the customer.
+      MERCHANT = 'MERCHANT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CUSTOMER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'customer' then CUSTOMER
+      when 'merchant' then MERCHANT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_instruction.rb

@@ -0,0 +1,121 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Any additional payment instructions to be consider during payment
+  # processing. This processing instruction is applicable for Capturing an order
+  # or Authorizing an Order.
+  class PaymentInstruction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of various fees, commissions, tips, or donations. This field is
+    # only applicable to merchants that been enabled for PayPal Complete
+    # Payments Platform for Marketplaces and Platforms capability.
+    # @return [Array[PlatformFee]]
+    attr_accessor :platform_fees
+
+    # The funds that are held on behalf of the merchant.
+    # @return [DisbursementMode]
+    attr_accessor :disbursement_mode
+
+    # This field is only enabled for selected merchants/partners to use and
+    # provides the ability to trigger a specific pricing rate/plan for a payment
+    # transaction. The list of eligible 'payee_pricing_tier_id' would be
+    # provided to you by your Account Manager. Specifying values other than the
+    # one provided to you by your account manager would result in an error.
+    # @return [String]
+    attr_accessor :payee_pricing_tier_id
+
+    # FX identifier generated returned by PayPal to be used for payment
+    # processing in order to honor FX rate (for eligible integrations) to be
+    # used when amount is settled/received into the payee account.
+    # @return [String]
+    attr_accessor :payee_receivable_fx_rate_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['platform_fees'] = 'platform_fees'
+      @_hash['disbursement_mode'] = 'disbursement_mode'
+      @_hash['payee_pricing_tier_id'] = 'payee_pricing_tier_id'
+      @_hash['payee_receivable_fx_rate_id'] = 'payee_receivable_fx_rate_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        platform_fees
+        disbursement_mode
+        payee_pricing_tier_id
+        payee_receivable_fx_rate_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(platform_fees: SKIP,
+                   disbursement_mode: DisbursementMode::INSTANT,
+                   payee_pricing_tier_id: SKIP,
+                   payee_receivable_fx_rate_id: SKIP)
+      @platform_fees = platform_fees unless platform_fees == SKIP
+      @disbursement_mode = disbursement_mode unless disbursement_mode == SKIP
+      @payee_pricing_tier_id = payee_pricing_tier_id unless payee_pricing_tier_id == SKIP
+      unless payee_receivable_fx_rate_id == SKIP
+        @payee_receivable_fx_rate_id =
+          payee_receivable_fx_rate_id
+      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.
+      # Parameter is an array, so we need to iterate through it
+      platform_fees = nil
+      unless hash['platform_fees'].nil?
+        platform_fees = []
+        hash['platform_fees'].each do |structure|
+          platform_fees << (PlatformFee.from_hash(structure) if structure)
+        end
+      end
+
+      platform_fees = SKIP unless hash.key?('platform_fees')
+      disbursement_mode =
+        hash['disbursement_mode'] ||= DisbursementMode::INSTANT
+      payee_pricing_tier_id =
+        hash.key?('payee_pricing_tier_id') ? hash['payee_pricing_tier_id'] : SKIP
+      payee_receivable_fx_rate_id =
+        hash.key?('payee_receivable_fx_rate_id') ? hash['payee_receivable_fx_rate_id'] : SKIP
+
+      # Create object from extracted values.
+      PaymentInstruction.new(platform_fees: platform_fees,
+                             disbursement_mode: disbursement_mode,
+                             payee_pricing_tier_id: payee_pricing_tier_id,
+                             payee_receivable_fx_rate_id: payee_receivable_fx_rate_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} platform_fees: #{@platform_fees}, disbursement_mode: #{@disbursement_mode},"\
+      " payee_pricing_tier_id: #{@payee_pricing_tier_id}, payee_receivable_fx_rate_id:"\
+      " #{@payee_receivable_fx_rate_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} platform_fees: #{@platform_fees.inspect}, disbursement_mode:"\
+      " #{@disbursement_mode.inspect}, payee_pricing_tier_id: #{@payee_pricing_tier_id.inspect},"\
+      " payee_receivable_fx_rate_id: #{@payee_receivable_fx_rate_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_method.rb

@@ -0,0 +1,63 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The customer and merchant payment preferences.
+  class PaymentMethod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant-preferred payment methods.
+    # @return [PayeePaymentMethodPreference]
+    attr_accessor :payee_preferred
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payee_preferred'] = 'payee_preferred'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payee_preferred
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payee_preferred: PayeePaymentMethodPreference::UNRESTRICTED)
+      @payee_preferred = payee_preferred unless payee_preferred == 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.
+      payee_preferred =
+        hash['payee_preferred'] ||= PayeePaymentMethodPreference::UNRESTRICTED
+
+      # Create object from extracted values.
+      PaymentMethod.new(payee_preferred: payee_preferred)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payee_preferred: #{@payee_preferred}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payee_preferred: #{@payee_preferred.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_method_preference.rb

@@ -0,0 +1,86 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The customer and merchant payment preferences.
+  class PaymentMethodPreference < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant-preferred payment methods.
+    # @return [PayeePaymentMethodPreference]
+    attr_accessor :payee_preferred
+
+    # NACHA (the regulatory body governing the ACH network) requires that API
+    # callers (merchants, partners) obtain the consumer’s explicit authorization
+    # before initiating a transaction. To stay compliant, you’ll need to make
+    # sure that you retain a compliant authorization for each transaction that
+    # you originate to the ACH Network using this API. ACH transactions are
+    # categorized (using SEC codes) by how you capture authorization from the
+    # Receiver (the person whose bank account is being debited or credited).
+    # PayPal supports the following SEC codes.
+    # @return [StandardEntryClassCode]
+    attr_accessor :standard_entry_class_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payee_preferred'] = 'payee_preferred'
+      @_hash['standard_entry_class_code'] = 'standard_entry_class_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payee_preferred
+        standard_entry_class_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payee_preferred: PayeePaymentMethodPreference::UNRESTRICTED,
+                   standard_entry_class_code: StandardEntryClassCode::WEB)
+      @payee_preferred = payee_preferred unless payee_preferred == SKIP
+      unless standard_entry_class_code == SKIP
+        @standard_entry_class_code =
+          standard_entry_class_code
+      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.
+      payee_preferred =
+        hash['payee_preferred'] ||= PayeePaymentMethodPreference::UNRESTRICTED
+      standard_entry_class_code =
+        hash['standard_entry_class_code'] ||= StandardEntryClassCode::WEB
+
+      # Create object from extracted values.
+      PaymentMethodPreference.new(payee_preferred: payee_preferred,
+                                  standard_entry_class_code: standard_entry_class_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payee_preferred: #{@payee_preferred}, standard_entry_class_code:"\
+      " #{@standard_entry_class_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payee_preferred: #{@payee_preferred.inspect}, standard_entry_class_code:"\
+      " #{@standard_entry_class_code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_preferences.rb

@@ -0,0 +1,105 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment preferences for a subscription.
+  class PaymentPreferences < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether to automatically bill the outstanding amount in the next
+    # billing cycle.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_bill_outstanding
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :setup_fee
+
+    # The action to take on the subscription if the initial payment for the
+    # setup fails.
+    # @return [SetupFeeFailureAction]
+    attr_accessor :setup_fee_failure_action
+
+    # The maximum number of payment failures before a subscription is suspended.
+    # For example, if `payment_failure_threshold` is `2`, the subscription
+    # automatically updates to the `SUSPEND` state if two consecutive payments
+    # fail.
+    # @return [Integer]
+    attr_accessor :payment_failure_threshold
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto_bill_outstanding'] = 'auto_bill_outstanding'
+      @_hash['setup_fee'] = 'setup_fee'
+      @_hash['setup_fee_failure_action'] = 'setup_fee_failure_action'
+      @_hash['payment_failure_threshold'] = 'payment_failure_threshold'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auto_bill_outstanding
+        setup_fee
+        setup_fee_failure_action
+        payment_failure_threshold
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auto_bill_outstanding: true, setup_fee: SKIP,
+                   setup_fee_failure_action: SetupFeeFailureAction::CANCEL,
+                   payment_failure_threshold: 0)
+      @auto_bill_outstanding = auto_bill_outstanding unless auto_bill_outstanding == SKIP
+      @setup_fee = setup_fee unless setup_fee == SKIP
+      @setup_fee_failure_action = setup_fee_failure_action unless setup_fee_failure_action == SKIP
+      unless payment_failure_threshold == SKIP
+        @payment_failure_threshold =
+          payment_failure_threshold
+      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.
+      auto_bill_outstanding = hash['auto_bill_outstanding'] ||= true
+      setup_fee = Money.from_hash(hash['setup_fee']) if hash['setup_fee']
+      setup_fee_failure_action =
+        hash['setup_fee_failure_action'] ||= SetupFeeFailureAction::CANCEL
+      payment_failure_threshold = hash['payment_failure_threshold'] ||= 0
+
+      # Create object from extracted values.
+      PaymentPreferences.new(auto_bill_outstanding: auto_bill_outstanding,
+                             setup_fee: setup_fee,
+                             setup_fee_failure_action: setup_fee_failure_action,
+                             payment_failure_threshold: payment_failure_threshold)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auto_bill_outstanding: #{@auto_bill_outstanding}, setup_fee: #{@setup_fee},"\
+      " setup_fee_failure_action: #{@setup_fee_failure_action}, payment_failure_threshold:"\
+      " #{@payment_failure_threshold}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auto_bill_outstanding: #{@auto_bill_outstanding.inspect}, setup_fee:"\
+      " #{@setup_fee.inspect}, setup_fee_failure_action: #{@setup_fee_failure_action.inspect},"\
+      " payment_failure_threshold: #{@payment_failure_threshold.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_preferences_override.rb

@@ -0,0 +1,107 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment preferences to override at subscription level.
+  class PaymentPreferencesOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether to automatically bill the outstanding amount in the next
+    # billing cycle.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_bill_outstanding
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :setup_fee
+
+    # The action to take on the subscription if the initial payment for the
+    # setup fails.
+    # @return [SetupFeeFailureAction]
+    attr_accessor :setup_fee_failure_action
+
+    # The maximum number of payment failures before a subscription is suspended.
+    # For example, if `payment_failure_threshold` is `2`, the subscription
+    # automatically updates to the `SUSPEND` state if two consecutive payments
+    # fail.
+    # @return [Integer]
+    attr_accessor :payment_failure_threshold
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto_bill_outstanding'] = 'auto_bill_outstanding'
+      @_hash['setup_fee'] = 'setup_fee'
+      @_hash['setup_fee_failure_action'] = 'setup_fee_failure_action'
+      @_hash['payment_failure_threshold'] = 'payment_failure_threshold'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auto_bill_outstanding
+        setup_fee
+        setup_fee_failure_action
+        payment_failure_threshold
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auto_bill_outstanding: SKIP, setup_fee: SKIP,
+                   setup_fee_failure_action: SKIP,
+                   payment_failure_threshold: SKIP)
+      @auto_bill_outstanding = auto_bill_outstanding unless auto_bill_outstanding == SKIP
+      @setup_fee = setup_fee unless setup_fee == SKIP
+      @setup_fee_failure_action = setup_fee_failure_action unless setup_fee_failure_action == SKIP
+      unless payment_failure_threshold == SKIP
+        @payment_failure_threshold =
+          payment_failure_threshold
+      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.
+      auto_bill_outstanding =
+        hash.key?('auto_bill_outstanding') ? hash['auto_bill_outstanding'] : SKIP
+      setup_fee = Money.from_hash(hash['setup_fee']) if hash['setup_fee']
+      setup_fee_failure_action =
+        hash.key?('setup_fee_failure_action') ? hash['setup_fee_failure_action'] : SKIP
+      payment_failure_threshold =
+        hash.key?('payment_failure_threshold') ? hash['payment_failure_threshold'] : SKIP
+
+      # Create object from extracted values.
+      PaymentPreferencesOverride.new(auto_bill_outstanding: auto_bill_outstanding,
+                                     setup_fee: setup_fee,
+                                     setup_fee_failure_action: setup_fee_failure_action,
+                                     payment_failure_threshold: payment_failure_threshold)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auto_bill_outstanding: #{@auto_bill_outstanding}, setup_fee: #{@setup_fee},"\
+      " setup_fee_failure_action: #{@setup_fee_failure_action}, payment_failure_threshold:"\
+      " #{@payment_failure_threshold}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auto_bill_outstanding: #{@auto_bill_outstanding.inspect}, setup_fee:"\
+      " #{@setup_fee.inspect}, setup_fee_failure_action: #{@setup_fee_failure_action.inspect},"\
+      " payment_failure_threshold: #{@payment_failure_threshold.inspect}>"
+    end
+  end
+end