cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/order_application_context.rb

@@ -0,0 +1,219 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Customizes the payer experience during the approval process for the payment
+  # with PayPal. Note: Partners and Marketplaces might configure brand_name and
+  # shipping_preference during partner account setup, which overrides the
+  # request values.
+  class OrderApplicationContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # DEPRECATED. The label that overrides the business name in the PayPal
+    # account on the PayPal site. The fields in `application_context` are now
+    # available in the `experience_context` object under the `payment_source`
+    # which supports them (eg.
+    # `payment_source.paypal.experience_context.brand_name`). Please specify
+    # this field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # DEPRECATED. The BCP 47-formatted locale of pages that the PayPal payment
+    # experience shows. PayPal supports a five-character code. For example,
+    # `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`,
+    # `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`.  The fields in
+    # `application_context` are now available in the `experience_context` object
+    # under the `payment_source` which supports them (eg.
+    # `payment_source.paypal.experience_context.locale`). Please specify this
+    # field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @return [String]
+    attr_accessor :locale
+
+    # DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal
+    # site for customer checkout.  The fields in `application_context` are now
+    # available in the `experience_context` object under the `payment_source`
+    # which supports them (eg.
+    # `payment_source.paypal.experience_context.landing_page`). Please specify
+    # this field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @return [OrderApplicationContextLandingPage]
+    attr_accessor :landing_page
+
+    # DEPRECATED. DEPRECATED. The shipping preference: Displays the shipping
+    # address to the customer. Enables the customer to choose an address on the
+    # PayPal site. Restricts the customer from changing the address during the
+    # payment-approval process. .  The fields in `application_context` are now
+    # available in the `experience_context` object under the `payment_source`
+    # which supports them (eg.
+    # `payment_source.paypal.experience_context.shipping_preference`). Please
+    # specify this field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @return [OrderApplicationContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # DEPRECATED. Configures a Continue or Pay Now checkout flow.  The fields in
+    # `application_context` are now available in the `experience_context` object
+    # under the `payment_source` which supports them (eg.
+    # `payment_source.paypal.experience_context.user_action`). Please specify
+    # this field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @return [OrderApplicationContextUserAction]
+    attr_accessor :user_action
+
+    # DEPRECATED. The customer and merchant payment preferences. The fields in
+    # `application_context` are now available in the `experience_context` object
+    # under the `payment_source` which supports them (eg.
+    # `payment_source.paypal.experience_context.payment_method_selected`).
+    # Please specify this field in the `experience_context` object instead of
+    # the `application_context` object..
+    # @return [PaymentMethodPreference]
+    attr_accessor :payment_method
+
+    # DEPRECATED. The URL where the customer is redirected after the customer
+    # approves the payment. The fields in `application_context` are now
+    # available in the `experience_context` object under the `payment_source`
+    # which supports them (eg.
+    # `payment_source.paypal.experience_context.return_url`). Please specify
+    # this field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @return [String]
+    attr_accessor :return_url
+
+    # DEPRECATED. The URL where the customer is redirected after the customer
+    # cancels the payment. The fields in `application_context` are now available
+    # in the `experience_context` object under the `payment_source` which
+    # supports them (eg. `payment_source.paypal.experience_context.cancel_url`).
+    # Please specify this field in the `experience_context` object instead of
+    # the `application_context` object.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # DEPRECATED. Provides additional details to process a payment using a
+    # `payment_source` that has been stored or is intended to be stored (also
+    # referred to as stored_credential or card-on-file). Parameter
+    # compatibility: `payment_type=ONE_TIME` is compatible only with
+    # `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with
+    # `payment_initiator=CUSTOMER`. `previous_transaction_reference` or
+    # `previous_network_transaction_reference` is compatible only with
+    # `payment_initiator=MERCHANT`. Only one of the parameters -
+    # `previous_transaction_reference` and
+    # `previous_network_transaction_reference` - can be present in the request.
+    # .  The fields in `stored_payment_source` are now available in the
+    # `stored_credential` object under the `payment_source` which supports them
+    # (eg. `payment_source.card.stored_credential.payment_initiator`). Please
+    # specify this field in the `payment_source` object instead of the
+    # `application_context` object.
+    # @return [StoredPaymentSource]
+    attr_accessor :stored_payment_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['brand_name'] = 'brand_name'
+      @_hash['locale'] = 'locale'
+      @_hash['landing_page'] = 'landing_page'
+      @_hash['shipping_preference'] = 'shipping_preference'
+      @_hash['user_action'] = 'user_action'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash['stored_payment_source'] = 'stored_payment_source'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        landing_page
+        shipping_preference
+        user_action
+        payment_method
+        return_url
+        cancel_url
+        stored_payment_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      brand_name: SKIP, locale: SKIP,
+      landing_page: OrderApplicationContextLandingPage::NO_PREFERENCE,
+      shipping_preference: OrderApplicationContextShippingPreference::GET_FROM_FILE,
+      user_action: OrderApplicationContextUserAction::CONTINUE,
+      payment_method: SKIP, return_url: SKIP, cancel_url: SKIP,
+      stored_payment_source: SKIP
+    )
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @landing_page = landing_page unless landing_page == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      @user_action = user_action unless user_action == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @return_url = return_url unless return_url == SKIP
+      @cancel_url = cancel_url unless cancel_url == SKIP
+      @stored_payment_source = stored_payment_source unless stored_payment_source == 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.
+      brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      landing_page =
+        hash['landing_page'] ||= OrderApplicationContextLandingPage::NO_PREFERENCE
+      shipping_preference =
+        hash['shipping_preference'] ||= OrderApplicationContextShippingPreference::GET_FROM_FILE
+      user_action =
+        hash['user_action'] ||= OrderApplicationContextUserAction::CONTINUE
+      payment_method = PaymentMethodPreference.from_hash(hash['payment_method']) if
+        hash['payment_method']
+      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
+      stored_payment_source = StoredPaymentSource.from_hash(hash['stored_payment_source']) if
+        hash['stored_payment_source']
+
+      # Create object from extracted values.
+      OrderApplicationContext.new(brand_name: brand_name,
+                                  locale: locale,
+                                  landing_page: landing_page,
+                                  shipping_preference: shipping_preference,
+                                  user_action: user_action,
+                                  payment_method: payment_method,
+                                  return_url: return_url,
+                                  cancel_url: cancel_url,
+                                  stored_payment_source: stored_payment_source)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, landing_page:"\
+      " #{@landing_page}, shipping_preference: #{@shipping_preference}, user_action:"\
+      " #{@user_action}, payment_method: #{@payment_method}, return_url: #{@return_url},"\
+      " cancel_url: #{@cancel_url}, stored_payment_source: #{@stored_payment_source}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect},"\
+      " landing_page: #{@landing_page.inspect}, shipping_preference:"\
+      " #{@shipping_preference.inspect}, user_action: #{@user_action.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, return_url: #{@return_url.inspect}, cancel_url:"\
+      " #{@cancel_url.inspect}, stored_payment_source: #{@stored_payment_source.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_application_context_landing_page.rb

@@ -0,0 +1,53 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site
+  # for customer checkout.  The fields in `application_context` are now
+  # available in the `experience_context` object under the `payment_source`
+  # which supports them (eg.
+  # `payment_source.paypal.experience_context.landing_page`). Please specify
+  # this field in the `experience_context` object instead of the
+  # `application_context` object.
+  class OrderApplicationContextLandingPage
+    ORDER_APPLICATION_CONTEXT_LANDING_PAGE = [
+      # When the customer clicks PayPal Checkout, the customer is redirected to
+      # a page to log in to PayPal and approve the payment.
+      LOGIN = 'LOGIN'.freeze,
+
+      # When the customer clicks PayPal Checkout, the customer is redirected to
+      # a page to enter credit or debit card and other relevant billing
+      # information required to complete the purchase.
+      BILLING = 'BILLING'.freeze,
+
+      # When the customer clicks PayPal Checkout, the customer is redirected to
+      # either a page to log in to PayPal and approve the payment or to a page
+      # to enter credit or debit card and other relevant billing information
+      # required to complete the purchase, depending on their previous
+      # interaction with PayPal.
+      NO_PREFERENCE = 'NO_PREFERENCE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = LOGIN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'login' then LOGIN
+      when 'billing' then BILLING
+      when 'no_preference' then NO_PREFERENCE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_application_context_shipping_preference.rb

@@ -0,0 +1,50 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # DEPRECATED. DEPRECATED. The shipping preference: Displays the shipping
+  # address to the customer. Enables the customer to choose an address on the
+  # PayPal site. Restricts the customer from changing the address during the
+  # payment-approval process. .  The fields in `application_context` are now
+  # available in the `experience_context` object under the `payment_source`
+  # which supports them (eg.
+  # `payment_source.paypal.experience_context.shipping_preference`). Please
+  # specify this field in the `experience_context` object instead of the
+  # `application_context` object.
+  class OrderApplicationContextShippingPreference
+    ORDER_APPLICATION_CONTEXT_SHIPPING_PREFERENCE = [
+      # Use the customer-provided shipping address on the PayPal site.
+      GET_FROM_FILE = 'GET_FROM_FILE'.freeze,
+
+      # Redact the shipping address from the PayPal site. Recommended for
+      # digital goods.
+      NO_SHIPPING = 'NO_SHIPPING'.freeze,
+
+      # Use the merchant-provided address. The customer cannot change this
+      # address on the PayPal site.
+      SET_PROVIDED_ADDRESS = 'SET_PROVIDED_ADDRESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = GET_FROM_FILE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'get_from_file' then GET_FROM_FILE
+      when 'no_shipping' then NO_SHIPPING
+      when 'set_provided_address' then SET_PROVIDED_ADDRESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_application_context_user_action.rb

@@ -0,0 +1,47 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # DEPRECATED. Configures a Continue or Pay Now checkout flow.  The fields in
+  # `application_context` are now available in the `experience_context` object
+  # under the `payment_source` which supports them (eg.
+  # `payment_source.paypal.experience_context.user_action`). Please specify this
+  # field in the `experience_context` object instead of the
+  # `application_context` object.
+  class OrderApplicationContextUserAction
+    ORDER_APPLICATION_CONTEXT_USER_ACTION = [
+      # After you redirect the customer to the PayPal payment page, a Continue
+      # button appears. Use this option when the final amount is not known when
+      # the checkout flow is initiated and you want to redirect the customer to
+      # the merchant page without processing the payment.
+      CONTINUE = 'CONTINUE'.freeze,
+
+      # After you redirect the customer to the PayPal payment page, a Pay Now
+      # button appears. Use this option when the final amount is known when the
+      # checkout is initiated and you want to process the payment immediately
+      # when the customer clicks Pay Now.
+      PAY_NOW = 'PAY_NOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CONTINUE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'continue' then CONTINUE
+      when 'pay_now' then PAY_NOW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_authorize_request.rb

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

data/lib/paypal_server_sdk/models/order_authorize_request_payment_source.rb

@@ -0,0 +1,115 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment source definition.
+  class OrderAuthorizeRequestPaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment card to use to fund a payment. Can be a credit or debit card.
+    # Note: Passing card number, cvv and expiry directly via the API requires
+    # PCI SAQ D compliance. *PayPal offers a mechanism by which you do not have
+    # to take on the PCI SAQ D burden by using hosted fields - refer to this
+    # Integration Guide*.
+    # @return [CardRequest]
+    attr_accessor :card
+
+    # The tokenized payment source to fund a payment.
+    # @return [Token]
+    attr_accessor :token
+
+    # A resource that identifies a PayPal Wallet is used for payment.
+    # @return [PaypalWallet]
+    attr_accessor :paypal
+
+    # Information needed to pay using ApplePay.
+    # @return [ApplePayRequest]
+    attr_accessor :apple_pay
+
+    # Information needed to pay using Google Pay.
+    # @return [GooglePayRequest]
+    attr_accessor :google_pay
+
+    # Information needed to pay using Venmo.
+    # @return [VenmoWalletRequest]
+    attr_accessor :venmo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['token'] = 'token'
+      @_hash['paypal'] = 'paypal'
+      @_hash['apple_pay'] = 'apple_pay'
+      @_hash['google_pay'] = 'google_pay'
+      @_hash['venmo'] = 'venmo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        token
+        paypal
+        apple_pay
+        google_pay
+        venmo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, token: SKIP, paypal: SKIP, apple_pay: SKIP,
+                   google_pay: SKIP, venmo: SKIP)
+      @card = card unless card == SKIP
+      @token = token unless token == SKIP
+      @paypal = paypal unless paypal == SKIP
+      @apple_pay = apple_pay unless apple_pay == SKIP
+      @google_pay = google_pay unless google_pay == SKIP
+      @venmo = venmo unless venmo == 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.
+      card = CardRequest.from_hash(hash['card']) if hash['card']
+      token = Token.from_hash(hash['token']) if hash['token']
+      paypal = PaypalWallet.from_hash(hash['paypal']) if hash['paypal']
+      apple_pay = ApplePayRequest.from_hash(hash['apple_pay']) if hash['apple_pay']
+      google_pay = GooglePayRequest.from_hash(hash['google_pay']) if hash['google_pay']
+      venmo = VenmoWalletRequest.from_hash(hash['venmo']) if hash['venmo']
+
+      # Create object from extracted values.
+      OrderAuthorizeRequestPaymentSource.new(card: card,
+                                             token: token,
+                                             paypal: paypal,
+                                             apple_pay: apple_pay,
+                                             google_pay: google_pay,
+                                             venmo: venmo)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}, token: #{@token}, paypal: #{@paypal}, apple_pay:"\
+      " #{@apple_pay}, google_pay: #{@google_pay}, venmo: #{@venmo}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}, token: #{@token.inspect}, paypal:"\
+      " #{@paypal.inspect}, apple_pay: #{@apple_pay.inspect}, google_pay: #{@google_pay.inspect},"\
+      " venmo: #{@venmo.inspect}>"
+    end
+  end
+end