cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/paypal_payment_token.rb

@@ -0,0 +1,211 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Full representation of a PayPal Payment Token.
+  class PaypalPaymentToken < 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
+
+    # Expected business/charge model for the billing agreement.
+    # @return [UsagePattern]
+    attr_accessor :usage_pattern
+
+    # 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 [PaypalPaymentTokenUsageType]
+    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 [PaypalPaymentTokenCustomerType]
+    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 account identifier for a PayPal account.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The phone number, in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [Phone]
+    attr_accessor :phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['usage_pattern'] = 'usage_pattern'
+      @_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['account_id'] = 'account_id'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        usage_pattern
+        shipping
+        permit_multiple_payment_tokens
+        usage_type
+        customer_type
+        email_address
+        payer_id
+        name
+        phone
+        address
+        account_id
+        phone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description: SKIP, usage_pattern: 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, account_id: SKIP,
+                   phone_number: SKIP)
+      @description = description unless description == SKIP
+      @usage_pattern = usage_pattern unless usage_pattern == 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
+      @account_id = account_id unless account_id == SKIP
+      @phone_number = phone_number unless phone_number == 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
+      usage_pattern = hash.key?('usage_pattern') ? hash['usage_pattern'] : 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']
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      phone_number = Phone.from_hash(hash['phone_number']) if hash['phone_number']
+
+      # Create object from extracted values.
+      PaypalPaymentToken.new(description: description,
+                             usage_pattern: usage_pattern,
+                             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,
+                             account_id: account_id,
+                             phone_number: phone_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description}, usage_pattern: #{@usage_pattern}, 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}, account_id: #{@account_id}, phone_number: #{@phone_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, usage_pattern:"\
+      " #{@usage_pattern.inspect}, shipping: #{@shipping.inspect}, permit_multiple_payment_tokens:"\
+      " #{@permit_multiple_payment_tokens.inspect}, usage_type: #{@usage_type.inspect},"\
+      " customer_type: #{@customer_type.inspect}, email_address: #{@email_address.inspect},"\
+      " payer_id: #{@payer_id.inspect}, name: #{@name.inspect}, phone: #{@phone.inspect}, address:"\
+      " #{@address.inspect}, account_id: #{@account_id.inspect}, phone_number:"\
+      " #{@phone_number.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_payment_token_customer_type.rb

@@ -0,0 +1,42 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The customer type associated with the PayPal payment token. This is to
+  # indicate whether the customer acting on the merchant / platform is either a
+  # business or a consumer., 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.
+  class PaypalPaymentTokenCustomerType
+    PAYPAL_PAYMENT_TOKEN_CUSTOMER_TYPE = [
+      # The customer vaulting the PayPal payment token is a consumer on the
+      # merchant / platform.
+      CONSUMER = 'CONSUMER'.freeze,
+
+      # The customer vaulting the PayPal payment token is a business on merchant
+      # / platform.
+      BUSINESS = 'BUSINESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CONSUMER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'consumer' then CONSUMER
+      when 'business' then BUSINESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_payment_token_usage_type.rb

@@ -0,0 +1,40 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The usage type associated with the PayPal payment token., The usage type
+  # associated with a digital wallet payment token.
+  class PaypalPaymentTokenUsageType
+    PAYPAL_PAYMENT_TOKEN_USAGE_TYPE = [
+      # The PayPal Payment Token will be used for future transaction directly
+      # with a merchant.
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # The PayPal Payment Token will be used for future transaction on a
+      # platform. A platform is typically a marketplace or a channel that a
+      # payer can purchase goods and services from multiple merchants.
+      PLATFORM = 'PLATFORM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MERCHANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'merchant' then MERCHANT
+      when 'platform' then PLATFORM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_reference_id_type.rb

@@ -0,0 +1,44 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The PayPal reference ID type.
+  class PaypalReferenceIdType
+    PAYPAL_REFERENCE_ID_TYPE = [
+      # An order ID.
+      ODR = 'ODR'.freeze,
+
+      # A transaction ID.
+      TXN = 'TXN'.freeze,
+
+      # A subscription ID.
+      SUB = 'SUB'.freeze,
+
+      # A pre-approved payment ID.
+      PAP = 'PAP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ODR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'odr' then ODR
+      when 'txn' then TXN
+      when 'sub' then SUB
+      when 'pap' then PAP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_wallet.rb

@@ -0,0 +1,188 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A resource that identifies a PayPal Wallet is used for payment.
+  class PaypalWallet < 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
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # The stand-alone date, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent
+    # special legal values, such as a date of birth, you should use dates with
+    # no associated time or time-zone data. Whenever possible, use the standard
+    # `date_time` type. This regular expression does not validate all dates. For
+    # example, February 31 is valid and nothing is known about leap years.
+    # @return [String]
+    attr_accessor :birth_date
+
+    # The tax ID of the customer. The customer is also known as the payer. Both
+    # `tax_id` and `tax_id_type` are required.
+    # @return [TaxInfo]
+    attr_accessor :tax_info
+
+    # 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
+
+    # Additional attributes associated with the use of this PayPal Wallet.
+    # @return [PaypalWalletAttributes]
+    attr_accessor :attributes
+
+    # 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.
+    # @return [PaypalWalletExperienceContext]
+    attr_accessor :experience_context
+
+    # The PayPal billing agreement ID. References an approved recurring payment
+    # for goods or services.
+    # @return [String]
+    attr_accessor :billing_agreement_id
+
+    # Provides additional details to process a payment using the PayPal wallet
+    # billing agreement or a vaulted payment method that has been stored or is
+    # intended to be stored.
+    # @return [PaypalWalletStoredCredential]
+    attr_accessor :stored_credential
+
+    # 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['name'] = 'name'
+      @_hash['phone'] = 'phone'
+      @_hash['birth_date'] = 'birth_date'
+      @_hash['tax_info'] = 'tax_info'
+      @_hash['address'] = 'address'
+      @_hash['attributes'] = 'attributes'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash['billing_agreement_id'] = 'billing_agreement_id'
+      @_hash['stored_credential'] = 'stored_credential'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vault_id
+        email_address
+        name
+        phone
+        birth_date
+        tax_info
+        address
+        attributes
+        experience_context
+        billing_agreement_id
+        stored_credential
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(vault_id: SKIP, email_address: SKIP, name: SKIP, phone: SKIP,
+                   birth_date: SKIP, tax_info: SKIP, address: SKIP,
+                   attributes: SKIP, experience_context: SKIP,
+                   billing_agreement_id: SKIP, stored_credential: SKIP)
+      @vault_id = vault_id unless vault_id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @name = name unless name == SKIP
+      @phone = phone unless phone == SKIP
+      @birth_date = birth_date unless birth_date == SKIP
+      @tax_info = tax_info unless tax_info == SKIP
+      @address = address unless address == SKIP
+      @attributes = attributes unless attributes == SKIP
+      @experience_context = experience_context unless experience_context == SKIP
+      @billing_agreement_id = billing_agreement_id unless billing_agreement_id == SKIP
+      @stored_credential = stored_credential unless stored_credential == 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
+      name = Name.from_hash(hash['name']) if hash['name']
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
+      birth_date = hash.key?('birth_date') ? hash['birth_date'] : SKIP
+      tax_info = TaxInfo.from_hash(hash['tax_info']) if hash['tax_info']
+      address = Address.from_hash(hash['address']) if hash['address']
+      attributes = PaypalWalletAttributes.from_hash(hash['attributes']) if hash['attributes']
+      experience_context = PaypalWalletExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+      billing_agreement_id =
+        hash.key?('billing_agreement_id') ? hash['billing_agreement_id'] : SKIP
+      stored_credential = PaypalWalletStoredCredential.from_hash(hash['stored_credential']) if
+        hash['stored_credential']
+
+      # Create object from extracted values.
+      PaypalWallet.new(vault_id: vault_id,
+                       email_address: email_address,
+                       name: name,
+                       phone: phone,
+                       birth_date: birth_date,
+                       tax_info: tax_info,
+                       address: address,
+                       attributes: attributes,
+                       experience_context: experience_context,
+                       billing_agreement_id: billing_agreement_id,
+                       stored_credential: stored_credential)
+    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}, name: #{@name},"\
+      " phone: #{@phone}, birth_date: #{@birth_date}, tax_info: #{@tax_info}, address:"\
+      " #{@address}, attributes: #{@attributes}, experience_context: #{@experience_context},"\
+      " billing_agreement_id: #{@billing_agreement_id}, stored_credential: #{@stored_credential}>"
+    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},"\
+      " name: #{@name.inspect}, phone: #{@phone.inspect}, birth_date: #{@birth_date.inspect},"\
+      " tax_info: #{@tax_info.inspect}, address: #{@address.inspect}, attributes:"\
+      " #{@attributes.inspect}, experience_context: #{@experience_context.inspect},"\
+      " billing_agreement_id: #{@billing_agreement_id.inspect}, stored_credential:"\
+      " #{@stored_credential.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_wallet_account_verification_status.rb

@@ -0,0 +1,41 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The account status indicates whether the buyer has verified the financial
+  # details associated with their PayPal account.
+  class PaypalWalletAccountVerificationStatus
+    PAYPAL_WALLET_ACCOUNT_VERIFICATION_STATUS = [
+      # The buyer has completed the verification of the financial details
+      # associated with this PayPal account. For example: confirming their bank
+      # account.
+      VERIFIED = 'VERIFIED'.freeze,
+
+      # The buyer has not completed the verification of the financial details
+      # associated with this PayPal account. For example: confirming their bank
+      # account.
+      UNVERIFIED = 'UNVERIFIED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = VERIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'verified' then VERIFIED
+      when 'unverified' then UNVERIFIED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_wallet_attributes.rb

@@ -0,0 +1,71 @@
+# 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 PayPal Wallet.
+  class PaypalWalletAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PaypalWalletCustomerRequest]
+    attr_accessor :customer
+
+    # TODO: Write general description for this method
+    # @return [PaypalWalletVaultInstruction]
+    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 = PaypalWalletCustomerRequest.from_hash(hash['customer']) if hash['customer']
+      vault = PaypalWalletVaultInstruction.from_hash(hash['vault']) if hash['vault']
+
+      # Create object from extracted values.
+      PaypalWalletAttributes.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