cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/venmo_vault_response.rb

@@ -0,0 +1,100 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a saved venmo payment source.
+  class VenmoVaultResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal-generated ID for the saved payment source.
+    # @return [String]
+    attr_accessor :id
+
+    # The vault status.
+    # @return [VenmoVaultResponseStatus]
+    attr_accessor :status
+
+    # An array of request-related HATEOAS links.
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # This object represents a merchant’s customer, allowing them to store
+    # contact details, and track all payments associated with the same customer.
+    # @return [CustomerInformation]
+    attr_accessor :customer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['links'] = 'links'
+      @_hash['customer'] = 'customer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        status
+        links
+        customer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, status: SKIP, links: SKIP, customer: SKIP)
+      @id = id unless id == SKIP
+      @status = status unless status == SKIP
+      @links = links unless links == SKIP
+      @customer = customer unless customer == 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
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (LinkDescription.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      customer = CustomerInformation.from_hash(hash['customer']) if hash['customer']
+
+      # Create object from extracted values.
+      VenmoVaultResponse.new(id: id,
+                             status: status,
+                             links: links,
+                             customer: customer)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, status: #{@status}, links: #{@links}, customer: #{@customer}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, status: #{@status.inspect}, links: #{@links.inspect},"\
+      " customer: #{@customer.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_vault_response_status.rb

@@ -0,0 +1,45 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The vault status.
+  class VenmoVaultResponseStatus
+    VENMO_VAULT_RESPONSE_STATUS = [
+      # The payment source has been saved in your customer's vault. This vault
+      # status reflects `/v3/vault` status.
+      VAULTED = 'VAULTED'.freeze,
+
+      # DEPRECATED. The payment source has been saved in your customer's vault.
+      # This status applies to deprecated integration patterns and will not be
+      # returned for v3/vault integrations.
+      CREATED = 'CREATED'.freeze,
+
+      # Customer has approved the action of saving the specified payment_source
+      # into their vault. Use v3/vault/payment-tokens with given setup_token to
+      # save the payment source in the vault
+      APPROVED = 'APPROVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = VAULTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'vaulted' then VAULTED
+      when 'created' then CREATED
+      when 'approved' then APPROVED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_wallet_additional_attributes.rb

@@ -0,0 +1,72 @@
+# 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 this Venmo Wallet.
+  class VenmoWalletAdditionalAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The details about a customer in PayPal's system of record.
+    # @return [VenmoWalletCustomerInformation]
+    attr_accessor :customer
+
+    # Resource consolidating common request and response attirbutes for vaulting
+    # Venmo Wallet.
+    # @return [VenmoWalletVaultAttributes]
+    attr_accessor :vault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer'] = 'customer'
+      @_hash['vault'] = 'vault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer
+        vault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer: SKIP, vault: SKIP)
+      @customer = customer unless customer == SKIP
+      @vault = vault unless vault == 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.
+      customer = VenmoWalletCustomerInformation.from_hash(hash['customer']) if hash['customer']
+      vault = VenmoWalletVaultAttributes.from_hash(hash['vault']) if hash['vault']
+
+      # Create object from extracted values.
+      VenmoWalletAdditionalAttributes.new(customer: customer,
+                                          vault: vault)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer}, vault: #{@vault}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer.inspect}, vault: #{@vault.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_wallet_attributes_response.rb

@@ -0,0 +1,62 @@
+# 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 Venmo Wallet.
+  class VenmoWalletAttributesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The details about a saved venmo payment source.
+    # @return [VenmoVaultResponse]
+    attr_accessor :vault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['vault'] = 'vault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(vault: SKIP)
+      @vault = vault unless vault == 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 = VenmoVaultResponse.from_hash(hash['vault']) if hash['vault']
+
+      # Create object from extracted values.
+      VenmoWalletAttributesResponse.new(vault: vault)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault: #{@vault}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault: #{@vault.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_wallet_customer_information.rb

@@ -0,0 +1,94 @@
+# 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 VenmoWalletCustomerInformation < 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP, name: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == SKIP
+      @name = name unless name == 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']
+
+      # Create object from extracted values.
+      VenmoWalletCustomerInformation.new(id: id,
+                                         email_address: email_address,
+                                         phone: phone,
+                                         name: name)
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_wallet_experience_context.rb

@@ -0,0 +1,108 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Customizes the buyer experience during the approval process for payment with
+  # Venmo. Note: Partners and Marketplaces might configure shipping_preference
+  # during partner account setup, which overrides the request values.
+  class VenmoWalletExperienceContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The business name of the merchant. The pattern is defined by an external
+    # party and supports Unicode.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # The location from which the shipping address is derived.
+    # @return [VenmoWalletExperienceContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # CallBack Configuration that the merchant can provide to PayPal/Venmo.
+    # @return [CallbackConfiguration]
+    attr_accessor :order_update_callback_config
+
+    # Configures a Continue or Pay Now checkout flow.
+    # @return [VenmoWalletExperienceContextUserAction]
+    attr_accessor :user_action
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['brand_name'] = 'brand_name'
+      @_hash['shipping_preference'] = 'shipping_preference'
+      @_hash['order_update_callback_config'] = 'order_update_callback_config'
+      @_hash['user_action'] = 'user_action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        shipping_preference
+        order_update_callback_config
+        user_action
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      brand_name: SKIP,
+      shipping_preference: VenmoWalletExperienceContextShippingPreference::GET_FROM_FILE,
+      order_update_callback_config: SKIP,
+      user_action: VenmoWalletExperienceContextUserAction::CONTINUE
+    )
+      @brand_name = brand_name unless brand_name == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      unless order_update_callback_config == SKIP
+        @order_update_callback_config =
+          order_update_callback_config
+      end
+      @user_action = user_action unless user_action == 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
+      shipping_preference =
+        hash['shipping_preference'] ||= VenmoWalletExperienceContextShippingPreference::GET_FROM_FILE
+      if hash['order_update_callback_config']
+        order_update_callback_config = CallbackConfiguration.from_hash(hash['order_update_callback_config'])
+      end
+      user_action =
+        hash['user_action'] ||= VenmoWalletExperienceContextUserAction::CONTINUE
+
+      # Create object from extracted values.
+      VenmoWalletExperienceContext.new(brand_name: brand_name,
+                                       shipping_preference: shipping_preference,
+                                       order_update_callback_config: order_update_callback_config,
+                                       user_action: user_action)
+    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}, shipping_preference: #{@shipping_preference},"\
+      " order_update_callback_config: #{@order_update_callback_config}, user_action:"\
+      " #{@user_action}>"
+    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}, shipping_preference:"\
+      " #{@shipping_preference.inspect}, order_update_callback_config:"\
+      " #{@order_update_callback_config.inspect}, user_action: #{@user_action.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_wallet_experience_context_shipping_preference.rb

@@ -0,0 +1,43 @@
+# 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 VenmoWalletExperienceContextShippingPreference
+    VENMO_WALLET_EXPERIENCE_CONTEXT_SHIPPING_PREFERENCE = [
+      # Get the customer-provided shipping address on the PayPal site.
+      GET_FROM_FILE = 'GET_FROM_FILE'.freeze,
+
+      # Redacts the shipping address from the PayPal site. Recommended for
+      # digital goods.
+      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/venmo_wallet_experience_context_user_action.rb

@@ -0,0 +1,42 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Configures a Continue or Pay Now checkout flow.
+  class VenmoWalletExperienceContextUserAction
+    VENMO_WALLET_EXPERIENCE_CONTEXT_USER_ACTION = [
+      # After you redirect the customer to the Venmo 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 Venmo 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/venmo_wallet_request.rb

@@ -0,0 +1,102 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using Venmo.
+  class VenmoWalletRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal-generated ID for the vaulted payment source. This ID should be
+    # stored on the merchant's server so the saved payment source can be used
+    # for future transactions.
+    # @return [String]
+    attr_accessor :vault_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
+
+    # Customizes the buyer experience during the approval process for payment
+    # with Venmo. Note: Partners and Marketplaces might configure
+    # shipping_preference during partner account setup, which overrides the
+    # request values.
+    # @return [VenmoWalletExperienceContext]
+    attr_accessor :experience_context
+
+    # Additional attributes associated with the use of this Venmo Wallet.
+    # @return [VenmoWalletAdditionalAttributes]
+    attr_accessor :attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['vault_id'] = 'vault_id'
+      @_hash['email_address'] = 'email_address'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash['attributes'] = 'attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vault_id
+        email_address
+        experience_context
+        attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(vault_id: SKIP, email_address: SKIP,
+                   experience_context: SKIP, attributes: SKIP)
+      @vault_id = vault_id unless vault_id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @experience_context = experience_context unless experience_context == SKIP
+      @attributes = attributes unless attributes == 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_id = hash.key?('vault_id') ? hash['vault_id'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      experience_context = VenmoWalletExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+      attributes = VenmoWalletAdditionalAttributes.from_hash(hash['attributes']) if
+        hash['attributes']
+
+      # Create object from extracted values.
+      VenmoWalletRequest.new(vault_id: vault_id,
+                             email_address: email_address,
+                             experience_context: experience_context,
+                             attributes: attributes)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault_id: #{@vault_id}, email_address: #{@email_address},"\
+      " experience_context: #{@experience_context}, attributes: #{@attributes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vault_id: #{@vault_id.inspect}, email_address: #{@email_address.inspect},"\
+      " experience_context: #{@experience_context.inspect}, attributes: #{@attributes.inspect}>"
+    end
+  end
+end