paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/pa_res_status.rb

@@ -0,0 +1,42 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Transactions status result identifier. The outcome of the issuer's
+  # authentication.
+  class PAResStatus
+    PA_RES_STATUS = [
+      # TODO: Write general description for Y
+      Y = 'Y'.freeze,
+
+      # TODO: Write general description for N
+      N = 'N'.freeze,
+
+      # TODO: Write general description for U
+      U = 'U'.freeze,
+
+      # TODO: Write general description for A
+      A = 'A'.freeze,
+
+      # TODO: Write general description for C
+      C = 'C'.freeze,
+
+      # TODO: Write general description for R
+      R = 'R'.freeze,
+
+      # TODO: Write general description for D
+      D = 'D'.freeze,
+
+      # TODO: Write general description for I
+      I = 'I'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/patch.rb

@@ -0,0 +1,83 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The JSON patch object to apply partial updates to resources.
+  class Patch < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The operation.
+    # @return [PatchOp]
+    attr_accessor :op
+
+    # The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the
+    # target document location at which to complete the operation.
+    # @return [String]
+    attr_accessor :path
+
+    # The value to apply. The <code>remove</code>, <code>copy</code>, and
+    # <code>move</code> operations do not require a value. Since <a
+    # href="https://www.rfc-editor.org/rfc/rfc69021">JSON Patch</a> allows any
+    # type for <code>value</code>, the <code>type</code> property is not
+    # specified.
+    # @return [Object]
+    attr_accessor :value
+
+    # The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the
+    # target document location from which to move the value. Required for the
+    # <code>move</code> operation.
+    # @return [String]
+    attr_accessor :from
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['op'] = 'op'
+      @_hash['path'] = 'path'
+      @_hash['value'] = 'value'
+      @_hash['from'] = 'from'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        path
+        value
+        from
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(op:, path: SKIP, value: SKIP, from: SKIP)
+      @op = op
+      @path = path unless path == SKIP
+      @value = value unless value == SKIP
+      @from = from unless from == 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.
+      op = hash.key?('op') ? hash['op'] : nil
+      path = hash.key?('path') ? hash['path'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+      from = hash.key?('from') ? hash['from'] : SKIP
+
+      # Create object from extracted values.
+      Patch.new(op: op,
+                path: path,
+                value: value,
+                from: from)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/patch_op.rb

@@ -0,0 +1,35 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The operation.
+  class PatchOp
+    PATCH_OP = [
+      # TODO: Write general description for ADD
+      ADD = 'add'.freeze,
+
+      # TODO: Write general description for REMOVE
+      REMOVE = 'remove'.freeze,
+
+      # TODO: Write general description for REPLACE
+      REPLACE = 'replace'.freeze,
+
+      # TODO: Write general description for MOVE
+      MOVE = 'move'.freeze,
+
+      # TODO: Write general description for COPY
+      COPY = 'copy'.freeze,
+
+      # TODO: Write general description for TEST
+      TEST = 'test'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_experience_landing_page.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The type of landing page to show on the PayPal site for customer checkout.
+  class PayPalExperienceLandingPage
+    PAY_PAL_EXPERIENCE_LANDING_PAGE = [
+      # TODO: Write general description for LOGIN
+      LOGIN = 'LOGIN'.freeze,
+
+      # TODO: Write general description for GUEST_CHECKOUT
+      GUEST_CHECKOUT = 'GUEST_CHECKOUT'.freeze,
+
+      # TODO: Write general description for NO_PREFERENCE
+      NO_PREFERENCE = 'NO_PREFERENCE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_experience_user_action.rb

@@ -0,0 +1,24 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout
+  # flow.
+  class PayPalExperienceUserAction
+    PAY_PAL_EXPERIENCE_USER_ACTION = [
+      # TODO: Write general description for CONTINUE
+      CONTINUE = 'CONTINUE'.freeze,
+
+      # TODO: Write general description for PAY_NOW
+      PAY_NOW = 'PAY_NOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_payment_token.rb

@@ -0,0 +1,180 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # PayPalPaymentToken Model.
+  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
+
+    # 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 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['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
+        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, 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
+      @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
+      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,
+                             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
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_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 PayPal payment token. This is to
+  # indicate whether the customer acting on the merchant / platform is either a
+  # business or a consumer.
+  class PayPalPaymentTokenCustomerType
+    PAY_PAL_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/pay_pal_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 PayPalPaymentTokenUsagePattern
+    PAY_PAL_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/pay_pal_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 PayPal payment token.
+  class PayPalPaymentTokenUsageType
+    PAY_PAL_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/pay_pal_wallet.rb

@@ -0,0 +1,158 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://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.<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 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.<blockquote><strong>Note:</strong> Partners and Marketplaces
+    # might configure <code>brand_name</code> and
+    # <code>shipping_preference</code> during partner account setup, which
+    # overrides the request values.</blockquote>
+    # @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
+
+    # 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
+    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
+      ]
+    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)
+      @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
+    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
+
+      # 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)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_wallet_account_verification_status.rb

@@ -0,0 +1,24 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The account status indicates whether the buyer has verified the financial
+  # details associated with their PayPal account.
+  class PayPalWalletAccountVerificationStatus
+    PAY_PAL_WALLET_ACCOUNT_VERIFICATION_STATUS = [
+      # TODO: Write general description for VERIFIED
+      VERIFIED = 'VERIFIED'.freeze,
+
+      # TODO: Write general description for UNVERIFIED
+      UNVERIFIED = 'UNVERIFIED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end