paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/vault_venmo_experience_context.rb

@@ -0,0 +1,73 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Customizes the Vault creation flow experience for your customers.
+  class VaultVenmoExperienceContext < 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 shipping preference. This only applies to PayPal payment source.
+    # @return [String]
+    attr_accessor :shipping_preference
+
+    # Vault Instruction on action to be performed after a successful payer
+    # approval.
+    # @return [String]
+    attr_accessor :vault_instruction
+
+    # 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['vault_instruction'] = 'vault_instruction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        shipping_preference
+        vault_instruction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(brand_name: SKIP, shipping_preference: 'GET_FROM_FILE',
+                   vault_instruction: 'ON_CREATE_PAYMENT_TOKENS')
+      @brand_name = brand_name unless brand_name == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      @vault_instruction = vault_instruction unless vault_instruction == 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'] ||= 'GET_FROM_FILE'
+      vault_instruction =
+        hash['vault_instruction'] ||= 'ON_CREATE_PAYMENT_TOKENS'
+
+      # Create object from extracted values.
+      VaultVenmoExperienceContext.new(brand_name: brand_name,
+                                      shipping_preference: shipping_preference,
+                                      vault_instruction: vault_instruction)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_venmo_request.rb

@@ -0,0 +1,115 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # VaultVenmoRequest Model.
+  class VaultVenmoRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description displayed to the consumer on the approval flow for a
+    # digital wallet, as well as on the merchant view of the payment token
+    # management experience. exp: PayPal.com.
+    # @return [String]
+    attr_accessor :description
+
+    # The shipping details.
+    # @return [VaultedDigitalWalletShippingDetails]
+    attr_accessor :shipping
+
+    # Create multiple payment tokens for the same payer, merchant/platform
+    # combination. Use this when the customer has not logged in at
+    # merchant/platform. The payment token thus generated, can then also be used
+    # to create the customer account at merchant/platform. Use this also when
+    # multiple payment tokens are required for the same payer, different
+    # customer at merchant/platform. This helps to identify customers distinctly
+    # even though they may share the same PayPal account. This only applies to
+    # PayPal payment source.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :permit_multiple_payment_tokens
+
+    # The usage type associated with a digital wallet payment token.
+    # @return [String]
+    attr_accessor :usage_type
+
+    # The customer type associated with a digital wallet payment token. This is
+    # to indicate whether the customer acting on the merchant / platform is
+    # either a business or a consumer.
+    # @return [String]
+    attr_accessor :customer_type
+
+    # Customizes the Vault creation flow experience for your customers.
+    # @return [VaultVenmoExperienceContext]
+    attr_accessor :experience_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['shipping'] = 'shipping'
+      @_hash['permit_multiple_payment_tokens'] =
+        'permit_multiple_payment_tokens'
+      @_hash['usage_type'] = 'usage_type'
+      @_hash['customer_type'] = 'customer_type'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        shipping
+        permit_multiple_payment_tokens
+        usage_type
+        customer_type
+        experience_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description: SKIP, shipping: SKIP,
+                   permit_multiple_payment_tokens: false, usage_type: SKIP,
+                   customer_type: SKIP, experience_context: SKIP)
+      @description = description unless description == SKIP
+      @shipping = shipping unless shipping == SKIP
+      unless permit_multiple_payment_tokens == SKIP
+        @permit_multiple_payment_tokens =
+          permit_multiple_payment_tokens
+      end
+      @usage_type = usage_type unless usage_type == SKIP
+      @customer_type = customer_type unless customer_type == SKIP
+      @experience_context = experience_context unless experience_context == 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.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      shipping = VaultedDigitalWalletShippingDetails.from_hash(hash['shipping']) if
+        hash['shipping']
+      permit_multiple_payment_tokens =
+        hash['permit_multiple_payment_tokens'] ||= false
+      usage_type = hash.key?('usage_type') ? hash['usage_type'] : SKIP
+      customer_type = hash.key?('customer_type') ? hash['customer_type'] : SKIP
+      experience_context = VaultVenmoExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      VaultVenmoRequest.new(description: description,
+                            shipping: shipping,
+                            permit_multiple_payment_tokens: permit_multiple_payment_tokens,
+                            usage_type: usage_type,
+                            customer_type: customer_type,
+                            experience_context: experience_context)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vaulted_digital_wallet.rb

@@ -0,0 +1,106 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Resource consolidating common request and response attributes for vaulting a
+  # Digital Wallet.
+  class VaultedDigitalWallet < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description displayed to the consumer on the approval flow for a
+    # digital wallet, as well as on the merchant view of the payment token
+    # management experience. exp: PayPal.com.
+    # @return [String]
+    attr_accessor :description
+
+    # The shipping details.
+    # @return [VaultedDigitalWalletShippingDetails]
+    attr_accessor :shipping
+
+    # Create multiple payment tokens for the same payer, merchant/platform
+    # combination. Use this when the customer has not logged in at
+    # merchant/platform. The payment token thus generated, can then also be used
+    # to create the customer account at merchant/platform. Use this also when
+    # multiple payment tokens are required for the same payer, different
+    # customer at merchant/platform. This helps to identify customers distinctly
+    # even though they may share the same PayPal account. This only applies to
+    # PayPal payment source.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :permit_multiple_payment_tokens
+
+    # The usage type associated with a digital wallet payment token.
+    # @return [String]
+    attr_accessor :usage_type
+
+    # The customer type associated with a digital wallet payment token. This is
+    # to indicate whether the customer acting on the merchant / platform is
+    # either a business or a consumer.
+    # @return [String]
+    attr_accessor :customer_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['shipping'] = 'shipping'
+      @_hash['permit_multiple_payment_tokens'] =
+        'permit_multiple_payment_tokens'
+      @_hash['usage_type'] = 'usage_type'
+      @_hash['customer_type'] = 'customer_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        shipping
+        permit_multiple_payment_tokens
+        usage_type
+        customer_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description: SKIP, shipping: SKIP,
+                   permit_multiple_payment_tokens: false, usage_type: SKIP,
+                   customer_type: SKIP)
+      @description = description unless description == SKIP
+      @shipping = shipping unless shipping == SKIP
+      unless permit_multiple_payment_tokens == SKIP
+        @permit_multiple_payment_tokens =
+          permit_multiple_payment_tokens
+      end
+      @usage_type = usage_type unless usage_type == SKIP
+      @customer_type = customer_type unless customer_type == 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.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      shipping = VaultedDigitalWalletShippingDetails.from_hash(hash['shipping']) if
+        hash['shipping']
+      permit_multiple_payment_tokens =
+        hash['permit_multiple_payment_tokens'] ||= false
+      usage_type = hash.key?('usage_type') ? hash['usage_type'] : SKIP
+      customer_type = hash.key?('customer_type') ? hash['customer_type'] : SKIP
+
+      # Create object from extracted values.
+      VaultedDigitalWallet.new(description: description,
+                               shipping: shipping,
+                               permit_multiple_payment_tokens: permit_multiple_payment_tokens,
+                               usage_type: usage_type,
+                               customer_type: customer_type)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vaulted_digital_wallet_shipping_details.rb

@@ -0,0 +1,75 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The shipping details.
+  class VaultedDigitalWalletShippingDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the party.
+    # @return [ShippingName]
+    attr_accessor :name
+
+    # A classification for the method of purchase fulfillment (e.g shipping,
+    # in-store pickup, etc). Either `type` or `options` may be present, but not
+    # both.
+    # @return [FullfillmentType]
+    attr_accessor :type
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['type'] = 'type'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        type
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, type: SKIP, address: SKIP)
+      @name = name unless name == SKIP
+      @type = type unless type == SKIP
+      @address = address unless address == 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 = ShippingName.from_hash(hash['name']) if hash['name']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      address = Address.from_hash(hash['address']) if hash['address']
+
+      # Create object from extracted values.
+      VaultedDigitalWalletShippingDetails.new(name: name,
+                                              type: type,
+                                              address: address)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_payment_token.rb

@@ -0,0 +1,169 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # VenmoPaymentToken Model.
+  class VenmoPaymentToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description displayed to the consumer on the approval flow for a
+    # digital wallet, as well as on the merchant view of the payment token
+    # management experience. exp: PayPal.com.
+    # @return [String]
+    attr_accessor :description
+
+    # The shipping details.
+    # @return [VaultedDigitalWalletShippingDetails]
+    attr_accessor :shipping
+
+    # Create multiple payment tokens for the same payer, merchant/platform
+    # combination. Use this when the customer has not logged in at
+    # merchant/platform. The payment token thus generated, can then also be used
+    # to create the customer account at merchant/platform. Use this also when
+    # multiple payment tokens are required for the same payer, different
+    # customer at merchant/platform. This helps to identify customers distinctly
+    # even though they may share the same PayPal account. This only applies to
+    # PayPal payment source.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :permit_multiple_payment_tokens
+
+    # The usage type associated with a digital wallet payment token.
+    # @return [String]
+    attr_accessor :usage_type
+
+    # The customer type associated with a digital wallet payment token. This is
+    # to indicate whether the customer acting on the merchant / platform is
+    # either a business or a consumer.
+    # @return [String]
+    attr_accessor :customer_type
+
+    # The internationalized email address.<blockquote><strong>Note:</strong> Up
+    # to 64 characters are allowed before and 255 characters are allowed after
+    # the <code>@</code> sign. However, the generally accepted maximum length
+    # for an email address is 254 characters. The pattern verifies that an
+    # unquoted <code>@</code> sign exists.</blockquote>
+    # @return [String]
+    attr_accessor :email_address
+
+    # The account identifier for a PayPal account.
+    # @return [String]
+    attr_accessor :payer_id
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :address
+
+    # The Venmo username, as chosen by the user.
+    # @return [String]
+    attr_accessor :user_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['shipping'] = 'shipping'
+      @_hash['permit_multiple_payment_tokens'] =
+        'permit_multiple_payment_tokens'
+      @_hash['usage_type'] = 'usage_type'
+      @_hash['customer_type'] = 'customer_type'
+      @_hash['email_address'] = 'email_address'
+      @_hash['payer_id'] = 'payer_id'
+      @_hash['name'] = 'name'
+      @_hash['phone'] = 'phone'
+      @_hash['address'] = 'address'
+      @_hash['user_name'] = 'user_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        shipping
+        permit_multiple_payment_tokens
+        usage_type
+        customer_type
+        email_address
+        payer_id
+        name
+        phone
+        address
+        user_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description: SKIP, shipping: SKIP,
+                   permit_multiple_payment_tokens: false, usage_type: SKIP,
+                   customer_type: SKIP, email_address: SKIP, payer_id: SKIP,
+                   name: SKIP, phone: SKIP, address: SKIP, user_name: SKIP)
+      @description = description unless description == SKIP
+      @shipping = shipping unless shipping == SKIP
+      unless permit_multiple_payment_tokens == SKIP
+        @permit_multiple_payment_tokens =
+          permit_multiple_payment_tokens
+      end
+      @usage_type = usage_type unless usage_type == SKIP
+      @customer_type = customer_type unless customer_type == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @name = name unless name == SKIP
+      @phone = phone unless phone == SKIP
+      @address = address unless address == SKIP
+      @user_name = user_name unless user_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.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      shipping = VaultedDigitalWalletShippingDetails.from_hash(hash['shipping']) if
+        hash['shipping']
+      permit_multiple_payment_tokens =
+        hash['permit_multiple_payment_tokens'] ||= false
+      usage_type = hash.key?('usage_type') ? hash['usage_type'] : SKIP
+      customer_type = hash.key?('customer_type') ? hash['customer_type'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
+      name = Name.from_hash(hash['name']) if hash['name']
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
+      address = Address.from_hash(hash['address']) if hash['address']
+      user_name = hash.key?('user_name') ? hash['user_name'] : SKIP
+
+      # Create object from extracted values.
+      VenmoPaymentToken.new(description: description,
+                            shipping: shipping,
+                            permit_multiple_payment_tokens: permit_multiple_payment_tokens,
+                            usage_type: usage_type,
+                            customer_type: customer_type,
+                            email_address: email_address,
+                            payer_id: payer_id,
+                            name: name,
+                            phone: phone,
+                            address: address,
+                            user_name: user_name)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_payment_token_customer_type.rb

@@ -0,0 +1,25 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The customer type associated with the Venmo payment token. This is to
+  # indicate whether the customer acting on the merchant / platform is either a
+  # business or a consumer.
+  class VenmoPaymentTokenCustomerType
+    VENMO_PAYMENT_TOKEN_CUSTOMER_TYPE = [
+      # TODO: Write general description for CONSUMER
+      CONSUMER = 'CONSUMER'.freeze,
+
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'BUSINESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_payment_token_usage_pattern.rb

@@ -0,0 +1,35 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Expected business/pricing model for the billing agreement.
+  class VenmoPaymentTokenUsagePattern
+    VENMO_PAYMENT_TOKEN_USAGE_PATTERN = [
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'IMMEDIATE'.freeze,
+
+      # TODO: Write general description for DEFERRED
+      DEFERRED = 'DEFERRED'.freeze,
+
+      # TODO: Write general description for RECURRING_PREPAID
+      RECURRING_PREPAID = 'RECURRING_PREPAID'.freeze,
+
+      # TODO: Write general description for RECURRING_POSTPAID
+      RECURRING_POSTPAID = 'RECURRING_POSTPAID'.freeze,
+
+      # TODO: Write general description for THRESHOLD_PREPAID
+      THRESHOLD_PREPAID = 'THRESHOLD_PREPAID'.freeze,
+
+      # TODO: Write general description for THRESHOLD_POSTPAID
+      THRESHOLD_POSTPAID = 'THRESHOLD_POSTPAID'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_payment_token_usage_type.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The usage type associated with the Venmo payment token.
+  class VenmoPaymentTokenUsageType
+    VENMO_PAYMENT_TOKEN_USAGE_TYPE = [
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # TODO: Write general description for PLATFORM
+      PLATFORM = 'PLATFORM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/venmo_wallet_additional_attributes.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://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
+  end
+end