cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/paypal_wallet_attributes_response.rb

@@ -0,0 +1,82 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Additional attributes associated with the use of a PayPal Wallet.
+  class PaypalWalletAttributesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The details about a saved PayPal Wallet payment source.
+    # @return [PaypalWalletVaultResponse]
+    attr_accessor :vault
+
+    # An array of merchant cobranded cards used by buyer to complete an order.
+    # This array will be present if a merchant has onboarded their cobranded
+    # card with PayPal and provided corresponding label(s).
+    # @return [Array[CobrandedCard]]
+    attr_accessor :cobranded_cards
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['vault'] = 'vault'
+      @_hash['cobranded_cards'] = 'cobranded_cards'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vault
+        cobranded_cards
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(vault: SKIP, cobranded_cards: SKIP)
+      @vault = vault unless vault == SKIP
+      @cobranded_cards = cobranded_cards unless cobranded_cards == 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.
+      vault = PaypalWalletVaultResponse.from_hash(hash['vault']) if hash['vault']
+      # Parameter is an array, so we need to iterate through it
+      cobranded_cards = nil
+      unless hash['cobranded_cards'].nil?
+        cobranded_cards = []
+        hash['cobranded_cards'].each do |structure|
+          cobranded_cards << (CobrandedCard.from_hash(structure) if structure)
+        end
+      end
+
+      cobranded_cards = SKIP unless hash.key?('cobranded_cards')
+
+      # Create object from extracted values.
+      PaypalWalletAttributesResponse.new(vault: vault,
+                                         cobranded_cards: cobranded_cards)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault: #{@vault}, cobranded_cards: #{@cobranded_cards}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault: #{@vault.inspect}, cobranded_cards: #{@cobranded_cards.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_wallet_contact_preference.rb

@@ -0,0 +1,48 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The preference to display the contact information (buyer’s shipping email &
+  # phone number) on PayPal's checkout for easy merchant-buyer communication.
+  class PaypalWalletContactPreference
+    PAYPAL_WALLET_CONTACT_PREFERENCE = [
+      # The merchant can opt out of showing buyer's contact information on
+      # PayPal checkout.
+      NO_CONTACT_INFO = 'NO_CONTACT_INFO'.freeze,
+
+      # The merchant allows buyer to add or update shipping contact information
+      # on the PayPal checkout. Please ensure to use this updated information
+      # returned in shipping.email_address and shipping.phone_number to contact
+      # your buyers.
+      UPDATE_CONTACT_INFO = 'UPDATE_CONTACT_INFO'.freeze,
+
+      # The buyer can only see but can not override merchant passed contact
+      # information (shipping.email_address and shipping.phone_number) on PayPal
+      # checkout. NOTE: If you don't pass the contact information, the behavior
+      # is the same as NO_CONTACT_INFO preference.
+      RETAIN_CONTACT_INFO = 'RETAIN_CONTACT_INFO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = NO_CONTACT_INFO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'no_contact_info' then NO_CONTACT_INFO
+      when 'update_contact_info' then UPDATE_CONTACT_INFO
+      when 'retain_contact_info' then RETAIN_CONTACT_INFO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_wallet_context_shipping_preference.rb

@@ -0,0 +1,45 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The location from which the shipping address is derived.
+  class PaypalWalletContextShippingPreference
+    PAYPAL_WALLET_CONTEXT_SHIPPING_PREFERENCE = [
+      # Get the customer-provided shipping address on the PayPal site.
+      GET_FROM_FILE = 'GET_FROM_FILE'.freeze,
+
+      # Removes the shipping address information from the API response and the
+      # Paypal site. However, the shipping.phone_number and
+      # shipping.email_address fields will still be returned to allow for
+      # digital goods delivery.
+      NO_SHIPPING = 'NO_SHIPPING'.freeze,
+
+      # Get the merchant-provided address. The customer cannot change this
+      # address on the PayPal site. If merchant does not pass an address,
+      # customer can choose the address on PayPal pages.
+      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/paypal_wallet_customer.rb

@@ -0,0 +1,108 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a customer in PayPal's system of record.
+  class PaypalWalletCustomer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # 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_address
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # Merchants and partners may already have a data-store where their customer
+    # information is persisted. Use merchant_customer_id to associate the
+    # PayPal-generated customer.id to your representation of a customer.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone'] = 'phone'
+      @_hash['name'] = 'name'
+      @_hash['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+        name
+        merchant_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP, name: SKIP,
+                   merchant_customer_id: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == SKIP
+      @name = name unless name == SKIP
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_id == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
+      name = Name.from_hash(hash['name']) if hash['name']
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      PaypalWalletCustomer.new(id: id,
+                               email_address: email_address,
+                               phone: phone,
+                               name: name,
+                               merchant_customer_id: merchant_customer_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, email_address: #{@email_address}, phone: #{@phone}, name:"\
+      " #{@name}, merchant_customer_id: #{@merchant_customer_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, email_address: #{@email_address.inspect}, phone:"\
+      " #{@phone.inspect}, name: #{@name.inspect}, merchant_customer_id:"\
+      " #{@merchant_customer_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_wallet_customer_request.rb

@@ -0,0 +1,108 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # PaypalWalletCustomerRequest Model.
+  class PaypalWalletCustomerRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # 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_address
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # Merchants and partners may already have a data-store where their customer
+    # information is persisted. Use merchant_customer_id to associate the
+    # PayPal-generated customer.id to your representation of a customer.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone'] = 'phone'
+      @_hash['name'] = 'name'
+      @_hash['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+        name
+        merchant_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP, name: SKIP,
+                   merchant_customer_id: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == SKIP
+      @name = name unless name == SKIP
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_id == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
+      name = Name.from_hash(hash['name']) if hash['name']
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      PaypalWalletCustomerRequest.new(id: id,
+                                      email_address: email_address,
+                                      phone: phone,
+                                      name: name,
+                                      merchant_customer_id: merchant_customer_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, email_address: #{@email_address}, phone: #{@phone}, name:"\
+      " #{@name}, merchant_customer_id: #{@merchant_customer_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, email_address: #{@email_address.inspect}, phone:"\
+      " #{@phone.inspect}, name: #{@name.inspect}, merchant_customer_id:"\
+      " #{@merchant_customer_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_wallet_experience_context.rb

@@ -0,0 +1,201 @@
+# 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 payment with
+  # PayPal. Note: Partners and Marketplaces might configure brand_name and
+  # shipping_preference during partner account setup, which overrides the
+  # request values.
+  class PaypalWalletExperienceContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The label that overrides the business name in the PayPal account on the
+    # PayPal site. The pattern is defined by an external party and supports
+    # Unicode.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the
+    # language in which to localize the error-related strings, such as messages,
+    # issues, and suggested actions. The tag is made up of the [ISO 639-2
+    # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
+    # the optional [ISO-15924 script
+    # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
+    # alpha-2 country
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) or
+    # [M49 region code](https://unstats.un.org/unsd/methodology/m49/).
+    # @return [String]
+    attr_accessor :locale
+
+    # The location from which the shipping address is derived.
+    # @return [PaypalWalletContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # The preference to display the contact information (buyer’s shipping email
+    # & phone number) on PayPal's checkout for easy merchant-buyer
+    # communication.
+    # @return [PaypalWalletContactPreference]
+    attr_accessor :contact_preference
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :return_url
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # Merchant provided details of the native app or mobile web browser to
+    # facilitate buyer's app switch to the PayPal consumer app.
+    # @return [AppSwitchContext]
+    attr_accessor :app_switch_context
+
+    # The type of landing page to show on the PayPal site for customer checkout.
+    # @return [PaypalExperienceLandingPage]
+    attr_accessor :landing_page
+
+    # Configures a Continue or Pay Now checkout flow.
+    # @return [PaypalExperienceUserAction]
+    attr_accessor :user_action
+
+    # The merchant-preferred payment methods.
+    # @return [PayeePaymentMethodPreference]
+    attr_accessor :payment_method_preference
+
+    # CallBack Configuration that the merchant can provide to PayPal/Venmo.
+    # @return [CallbackConfiguration]
+    attr_accessor :order_update_callback_config
+
+    # 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['shipping_preference'] = 'shipping_preference'
+      @_hash['contact_preference'] = 'contact_preference'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash['app_switch_context'] = 'app_switch_context'
+      @_hash['landing_page'] = 'landing_page'
+      @_hash['user_action'] = 'user_action'
+      @_hash['payment_method_preference'] = 'payment_method_preference'
+      @_hash['order_update_callback_config'] = 'order_update_callback_config'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        shipping_preference
+        contact_preference
+        return_url
+        cancel_url
+        app_switch_context
+        landing_page
+        user_action
+        payment_method_preference
+        order_update_callback_config
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      brand_name: SKIP, locale: SKIP,
+      shipping_preference: PaypalWalletContextShippingPreference::GET_FROM_FILE,
+      contact_preference: PaypalWalletContactPreference::NO_CONTACT_INFO,
+      return_url: SKIP, cancel_url: SKIP, app_switch_context: SKIP,
+      landing_page: PaypalExperienceLandingPage::NO_PREFERENCE,
+      user_action: PaypalExperienceUserAction::CONTINUE,
+      payment_method_preference: PayeePaymentMethodPreference::UNRESTRICTED,
+      order_update_callback_config: SKIP
+    )
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      @contact_preference = contact_preference unless contact_preference == SKIP
+      @return_url = return_url unless return_url == SKIP
+      @cancel_url = cancel_url unless cancel_url == SKIP
+      @app_switch_context = app_switch_context unless app_switch_context == SKIP
+      @landing_page = landing_page unless landing_page == SKIP
+      @user_action = user_action unless user_action == SKIP
+      unless payment_method_preference == SKIP
+        @payment_method_preference =
+          payment_method_preference
+      end
+      unless order_update_callback_config == SKIP
+        @order_update_callback_config =
+          order_update_callback_config
+      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.
+      brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      shipping_preference =
+        hash['shipping_preference'] ||= PaypalWalletContextShippingPreference::GET_FROM_FILE
+      contact_preference =
+        hash['contact_preference'] ||= PaypalWalletContactPreference::NO_CONTACT_INFO
+      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
+      app_switch_context = AppSwitchContext.from_hash(hash['app_switch_context']) if
+        hash['app_switch_context']
+      landing_page =
+        hash['landing_page'] ||= PaypalExperienceLandingPage::NO_PREFERENCE
+      user_action = hash['user_action'] ||= PaypalExperienceUserAction::CONTINUE
+      payment_method_preference =
+        hash['payment_method_preference'] ||= PayeePaymentMethodPreference::UNRESTRICTED
+      if hash['order_update_callback_config']
+        order_update_callback_config = CallbackConfiguration.from_hash(hash['order_update_callback_config'])
+      end
+
+      # Create object from extracted values.
+      PaypalWalletExperienceContext.new(brand_name: brand_name,
+                                        locale: locale,
+                                        shipping_preference: shipping_preference,
+                                        contact_preference: contact_preference,
+                                        return_url: return_url,
+                                        cancel_url: cancel_url,
+                                        app_switch_context: app_switch_context,
+                                        landing_page: landing_page,
+                                        user_action: user_action,
+                                        payment_method_preference: payment_method_preference,
+                                        order_update_callback_config: order_update_callback_config)
+    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}, shipping_preference:"\
+      " #{@shipping_preference}, contact_preference: #{@contact_preference}, return_url:"\
+      " #{@return_url}, cancel_url: #{@cancel_url}, app_switch_context: #{@app_switch_context},"\
+      " landing_page: #{@landing_page}, user_action: #{@user_action}, payment_method_preference:"\
+      " #{@payment_method_preference}, order_update_callback_config:"\
+      " #{@order_update_callback_config}>"
+    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},"\
+      " shipping_preference: #{@shipping_preference.inspect}, contact_preference:"\
+      " #{@contact_preference.inspect}, return_url: #{@return_url.inspect}, cancel_url:"\
+      " #{@cancel_url.inspect}, app_switch_context: #{@app_switch_context.inspect}, landing_page:"\
+      " #{@landing_page.inspect}, user_action: #{@user_action.inspect}, payment_method_preference:"\
+      " #{@payment_method_preference.inspect}, order_update_callback_config:"\
+      " #{@order_update_callback_config.inspect}>"
+    end
+  end
+end