cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/blik_one_click_payment_request.rb

@@ -0,0 +1,97 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using BLIK one-click flow.
+  class BlikOneClickPaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The 6-digit code used to authenticate a consumer within BLIK.
+    # @return [String]
+    attr_accessor :auth_code
+
+    # The merchant generated, unique reference serving as a primary identifier
+    # for accounts connected between Blik and a merchant.
+    # @return [String]
+    attr_accessor :consumer_reference
+
+    # A bank defined identifier used as a display name to allow the payer to
+    # differentiate between multiple registered bank accounts.
+    # @return [String]
+    attr_accessor :alias_label
+
+    # A Blik-defined identifier for a specific Blik-enabled bank account that is
+    # associated with a given merchant. Used only in conjunction with a Consumer
+    # Reference.
+    # @return [String]
+    attr_accessor :alias_key
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auth_code'] = 'auth_code'
+      @_hash['consumer_reference'] = 'consumer_reference'
+      @_hash['alias_label'] = 'alias_label'
+      @_hash['alias_key'] = 'alias_key'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auth_code
+        alias_label
+        alias_key
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(consumer_reference:, auth_code: SKIP, alias_label: SKIP,
+                   alias_key: SKIP)
+      @auth_code = auth_code unless auth_code == SKIP
+      @consumer_reference = consumer_reference
+      @alias_label = alias_label unless alias_label == SKIP
+      @alias_key = alias_key unless alias_key == 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.
+      consumer_reference =
+        hash.key?('consumer_reference') ? hash['consumer_reference'] : nil
+      auth_code = hash.key?('auth_code') ? hash['auth_code'] : SKIP
+      alias_label = hash.key?('alias_label') ? hash['alias_label'] : SKIP
+      alias_key = hash.key?('alias_key') ? hash['alias_key'] : SKIP
+
+      # Create object from extracted values.
+      BlikOneClickPaymentRequest.new(consumer_reference: consumer_reference,
+                                     auth_code: auth_code,
+                                     alias_label: alias_label,
+                                     alias_key: alias_key)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_code: #{@auth_code}, consumer_reference: #{@consumer_reference},"\
+      " alias_label: #{@alias_label}, alias_key: #{@alias_key}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auth_code: #{@auth_code.inspect}, consumer_reference:"\
+      " #{@consumer_reference.inspect}, alias_label: #{@alias_label.inspect}, alias_key:"\
+      " #{@alias_key.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_payment_object.rb

@@ -0,0 +1,99 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using BLIK.
+  class BlikPaymentObject < 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 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
+
+    # Information used to pay using BLIK one-click flow.
+    # @return [BlikOneClickPaymentObject]
+    attr_accessor :one_click
+
+    # 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['email'] = 'email'
+      @_hash['one_click'] = 'one_click'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        email
+        one_click
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, email: SKIP, one_click: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @email = email unless email == SKIP
+      @one_click = one_click unless one_click == 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
+      email = hash.key?('email') ? hash['email'] : SKIP
+      one_click = BlikOneClickPaymentObject.from_hash(hash['one_click']) if hash['one_click']
+
+      # Create object from extracted values.
+      BlikPaymentObject.new(name: name,
+                            country_code: country_code,
+                            email: email,
+                            one_click: one_click)
+    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}, email: #{@email},"\
+      " one_click: #{@one_click}>"
+    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}, email:"\
+      " #{@email.inspect}, one_click: #{@one_click.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/blik_payment_request.rb

@@ -0,0 +1,120 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using BLIK.
+  class BlikPaymentRequest < 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 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
+
+    # Customizes the payer experience during the approval process for the BLIK
+    # payment.
+    # @return [BlikExperienceContext]
+    attr_accessor :experience_context
+
+    # Information used to pay using BLIK level_0 flow.
+    # @return [BlikLevel0PaymentObject]
+    attr_accessor :level_0
+
+    # Information used to pay using BLIK one-click flow.
+    # @return [BlikOneClickPaymentRequest]
+    attr_accessor :one_click
+
+    # 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['email'] = 'email'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash['level_0'] = 'level_0'
+      @_hash['one_click'] = 'one_click'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email
+        experience_context
+        level_0
+        one_click
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, country_code:, email: SKIP, experience_context: SKIP,
+                   level_0: SKIP, one_click: SKIP)
+      @name = name
+      @country_code = country_code
+      @email = email unless email == SKIP
+      @experience_context = experience_context unless experience_context == SKIP
+      @level_0 = level_0 unless level_0 == SKIP
+      @one_click = one_click unless one_click == 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
+      email = hash.key?('email') ? hash['email'] : SKIP
+      experience_context = BlikExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+      level_0 = BlikLevel0PaymentObject.from_hash(hash['level_0']) if hash['level_0']
+      one_click = BlikOneClickPaymentRequest.from_hash(hash['one_click']) if hash['one_click']
+
+      # Create object from extracted values.
+      BlikPaymentRequest.new(name: name,
+                             country_code: country_code,
+                             email: email,
+                             experience_context: experience_context,
+                             level_0: level_0,
+                             one_click: one_click)
+    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}, email: #{@email},"\
+      " experience_context: #{@experience_context}, level_0: #{@level_0}, one_click:"\
+      " #{@one_click}>"
+    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}, email:"\
+      " #{@email.inspect}, experience_context: #{@experience_context.inspect}, level_0:"\
+      " #{@level_0.inspect}, one_click: #{@one_click.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/callback_configuration.rb

@@ -0,0 +1,74 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # CallBack Configuration that the merchant can provide to PayPal/Venmo.
+  class CallbackConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of callback events merchant can subscribe to for the
+    # corresponding callback url.
+    # @return [Array[CallbackEvents]]
+    attr_accessor :callback_events
+
+    # Merchant provided CallBack url.PayPal/Venmo will use this url to call the
+    # merchant back when the events occur .PayPal/Venmo expects a secured url
+    # usually in the https format.merchant can append the cart id or other
+    # params part of the url as query or path params.
+    # @return [String]
+    attr_accessor :callback_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['callback_events'] = 'callback_events'
+      @_hash['callback_url'] = 'callback_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(callback_events:, callback_url:)
+      @callback_events = callback_events
+      @callback_url = callback_url
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      callback_events =
+        hash.key?('callback_events') ? hash['callback_events'] : nil
+      callback_url = hash.key?('callback_url') ? hash['callback_url'] : nil
+
+      # Create object from extracted values.
+      CallbackConfiguration.new(callback_events: callback_events,
+                                callback_url: callback_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} callback_events: #{@callback_events}, callback_url: #{@callback_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} callback_events: #{@callback_events.inspect}, callback_url:"\
+      " #{@callback_url.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/callback_events.rb

@@ -0,0 +1,40 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # CallBack event.
+  class CallbackEvents
+    CALLBACK_EVENTS = [
+      # When Buyer changes or selects the shipping address on the PayPal/Venmo
+      # buyer approval flow , PayPal/Venmo will call merchant with the callback
+      # URL to update order totals.
+      SHIPPING_ADDRESS = 'SHIPPING_ADDRESS'.freeze,
+
+      # When Buyer changes or selects the shipping options on the PayPal/Venmo
+      # buyer approval flow , PayPal/Venmo will call merchant with the callback
+      # URL to update order totals.
+      SHIPPING_OPTIONS = 'SHIPPING_OPTIONS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SHIPPING_ADDRESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'shipping_address' then SHIPPING_ADDRESS
+      when 'shipping_options' then SHIPPING_OPTIONS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/cancel_subscription_request.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The cancel subscription request details.
+  class CancelSubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for the cancellation of a subscription.
+    # @return [String]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason:)
+      @reason = reason
+    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'] : nil
+
+      # Create object from extracted values.
+      CancelSubscriptionRequest.new(reason: reason)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_incomplete_reason.rb

@@ -0,0 +1,86 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The reason why the captured payment status is `PENDING` or `DENIED`.
+  class CaptureIncompleteReason
+    CAPTURE_INCOMPLETE_REASON = [
+      # The payer initiated a dispute for this captured payment with PayPal.
+      BUYER_COMPLAINT = 'BUYER_COMPLAINT'.freeze,
+
+      # The captured funds were reversed in response to the payer disputing this
+      # captured payment with the issuer of the financial instrument used to pay
+      # for this captured payment.
+      CHARGEBACK = 'CHARGEBACK'.freeze,
+
+      # The payer paid by an eCheck that has not yet cleared.
+      ECHECK = 'ECHECK'.freeze,
+
+      # Visit your online account. In your **Account Overview**, accept and deny
+      # this payment.
+      INTERNATIONAL_WITHDRAWAL = 'INTERNATIONAL_WITHDRAWAL'.freeze,
+
+      # No additional specific reason can be provided. For more information
+      # about this captured payment, visit your account online or contact
+      # PayPal.
+      OTHER = 'OTHER'.freeze,
+
+      # The captured payment is pending manual review.
+      PENDING_REVIEW = 'PENDING_REVIEW'.freeze,
+
+      # The payee has not yet set up appropriate receiving preferences for their
+      # account. For more information about how to accept or deny this payment,
+      # visit your account online. This reason is typically offered in scenarios
+      # such as when the currency of the captured payment is different from the
+      # primary holding currency of the payee.
+      RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION = 'RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION'.freeze,
+
+      # The captured funds were refunded.
+      REFUNDED = 'REFUNDED'.freeze,
+
+      # The payer must send the funds for this captured payment. This code
+      # generally appears for manual EFTs.
+      TRANSACTION_APPROVED_AWAITING_FUNDING = 'TRANSACTION_APPROVED_AWAITING_FUNDING'.freeze,
+
+      # The payee does not have a PayPal account.
+      UNILATERAL = 'UNILATERAL'.freeze,
+
+      # The payee's PayPal account is not verified.
+      VERIFICATION_REQUIRED = 'VERIFICATION_REQUIRED'.freeze,
+
+      # Risk Filter set by the payee failed for the transaction.
+      DECLINED_BY_RISK_FRAUD_FILTERS = 'DECLINED_BY_RISK_FRAUD_FILTERS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BUYER_COMPLAINT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'buyer_complaint' then BUYER_COMPLAINT
+      when 'chargeback' then CHARGEBACK
+      when 'echeck' then ECHECK
+      when 'international_withdrawal' then INTERNATIONAL_WITHDRAWAL
+      when 'other' then OTHER
+      when 'pending_review' then PENDING_REVIEW
+      when 'receiving_preference_mandates_manual_action' then RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION
+      when 'refunded' then REFUNDED
+      when 'transaction_approved_awaiting_funding' then TRANSACTION_APPROVED_AWAITING_FUNDING
+      when 'unilateral' then UNILATERAL
+      when 'verification_required' then VERIFICATION_REQUIRED
+      when 'declined_by_risk_fraud_filters' then DECLINED_BY_RISK_FRAUD_FILTERS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_payment_instruction.rb

@@ -0,0 +1,104 @@
+# 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 CapturePaymentInstruction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of platform or partner fees, commissions, or brokerage fees that
+    # associated with the captured payment.
+    # @return [Array[PlatformFee]]
+    attr_accessor :platform_fees
+
+    # The funds that are held on behalf of the merchant.
+    # @return [DisbursementMode]
+    attr_accessor :disbursement_mode
+
+    # 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_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_receivable_fx_rate_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(platform_fees: SKIP,
+                   disbursement_mode: DisbursementMode::INSTANT,
+                   payee_receivable_fx_rate_id: SKIP)
+      @platform_fees = platform_fees unless platform_fees == SKIP
+      @disbursement_mode = disbursement_mode unless disbursement_mode == 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_receivable_fx_rate_id =
+        hash.key?('payee_receivable_fx_rate_id') ? hash['payee_receivable_fx_rate_id'] : SKIP
+
+      # Create object from extracted values.
+      CapturePaymentInstruction.new(platform_fees: platform_fees,
+                                    disbursement_mode: disbursement_mode,
+                                    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_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_receivable_fx_rate_id:"\
+      " #{@payee_receivable_fx_rate_id.inspect}>"
+    end
+  end
+end