paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/universal_product_code.rb

@@ -0,0 +1,56 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The Universal Product Code of the item.
+  class UniversalProductCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Universal Product Code type.
+    # @return [UPCType]
+    attr_accessor :type
+
+    # The UPC product code of the item.
+    # @return [String]
+    attr_accessor :code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['code'] = 'code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, code:)
+      @type = type
+      @code = code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : nil
+      code = hash.key?('code') ? hash['code'] : nil
+
+      # Create object from extracted values.
+      UniversalProductCode.new(type: type,
+                               code: code)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/upc_type.rb

@@ -0,0 +1,38 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The Universal Product Code type.
+  class UPCType
+    UPC_TYPE = [
+      # TODO: Write general description for UPCA
+      UPCA = 'UPC-A'.freeze,
+
+      # TODO: Write general description for UPCB
+      UPCB = 'UPC-B'.freeze,
+
+      # TODO: Write general description for UPCC
+      UPCC = 'UPC-C'.freeze,
+
+      # TODO: Write general description for UPCD
+      UPCD = 'UPC-D'.freeze,
+
+      # TODO: Write general description for UPCE
+      UPCE = 'UPC-E'.freeze,
+
+      # TODO: Write general description for UPC2
+      UPC2 = 'UPC-2'.freeze,
+
+      # TODO: Write general description for UPC5
+      UPC5 = 'UPC-5'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_customer.rb

@@ -0,0 +1,50 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a customer in PayPal's system of record.
+  class VaultCustomer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP)
+      @id = id unless id == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      VaultCustomer.new(id: id)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_experience_context.rb

@@ -0,0 +1,112 @@
+# 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 VaultExperienceContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The label that overrides the business name in the PayPal account on the
+    # PayPal site. The pattern is defined by an external party and supports
+    # Unicode.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the
+    # language in which to localize the error-related strings, such as messages,
+    # issues, and suggested actions. The tag is made up of the [ISO 639-2
+    # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
+    # the optional [ISO-15924 script
+    # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
+    # alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region
+    # code](https://unstats.un.org/unsd/methodology/m49/).
+    # @return [String]
+    attr_accessor :locale
+
+    # The URL where the customer is redirected after customer approves leaves
+    # the flow. It is a required field for contingency flows like PayPal wallet,
+    # 3DS.
+    # @return [String]
+    attr_accessor :return_url
+
+    # The URL where the customer is redirected after customer cancels or leaves
+    # the flow. It is a required field for contingency flows like PayPal wallet,
+    # 3DS.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # 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['locale'] = 'locale'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash['shipping_preference'] = 'shipping_preference'
+      @_hash['vault_instruction'] = 'vault_instruction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        return_url
+        cancel_url
+        shipping_preference
+        vault_instruction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP,
+                   cancel_url: SKIP, shipping_preference: 'GET_FROM_FILE',
+                   vault_instruction: 'ON_CREATE_PAYMENT_TOKENS')
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @return_url = return_url unless return_url == SKIP
+      @cancel_url = cancel_url unless cancel_url == 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
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
+      shipping_preference = hash['shipping_preference'] ||= 'GET_FROM_FILE'
+      vault_instruction =
+        hash['vault_instruction'] ||= 'ON_CREATE_PAYMENT_TOKENS'
+
+      # Create object from extracted values.
+      VaultExperienceContext.new(brand_name: brand_name,
+                                 locale: locale,
+                                 return_url: return_url,
+                                 cancel_url: cancel_url,
+                                 shipping_preference: shipping_preference,
+                                 vault_instruction: vault_instruction)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_instruction.rb

@@ -0,0 +1,50 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Base vaulting specification. The object can be extended for specific use
+  # cases within each payment_source that supports vaulting.
+  class VaultInstruction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines how and when the payment source gets vaulted.
+    # @return [StoreInVaultInstruction]
+    attr_accessor :store_in_vault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['store_in_vault'] = 'store_in_vault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(store_in_vault:)
+      @store_in_vault = store_in_vault
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      store_in_vault =
+        hash.key?('store_in_vault') ? hash['store_in_vault'] : nil
+
+      # Create object from extracted values.
+      VaultInstruction.new(store_in_vault: store_in_vault)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_instruction_base.rb

@@ -0,0 +1,52 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Basic vault instruction specification that can be extended by specific
+  # payment sources that supports vaulting.
+  class VaultInstructionBase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines how and when the payment source gets vaulted.
+    # @return [StoreInVaultInstruction]
+    attr_accessor :store_in_vault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['store_in_vault'] = 'store_in_vault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        store_in_vault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(store_in_vault: SKIP)
+      @store_in_vault = store_in_vault unless store_in_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.
+      store_in_vault =
+        hash.key?('store_in_vault') ? hash['store_in_vault'] : SKIP
+
+      # Create object from extracted values.
+      VaultInstructionBase.new(store_in_vault: store_in_vault)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_pay_pal_wallet_request.rb

@@ -0,0 +1,115 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # A resource representing a request to vault PayPal Wallet.
+  class VaultPayPalWalletRequest < 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 [VaultExperienceContext]
+    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 = VaultExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      VaultPayPalWalletRequest.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/vault_response.rb

@@ -0,0 +1,86 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a saved payment source.
+  class VaultResponse < 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 [VaultStatus]
+    attr_accessor :status
+
+    # The details about a customer in PayPal's system of record.
+    # @return [VaultCustomer]
+    attr_accessor :customer
+
+    # An array of request-related HATEOAS links.
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['customer'] = 'customer'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        status
+        customer
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, status: SKIP, customer: SKIP, links: SKIP)
+      @id = id unless id == SKIP
+      @status = status unless status == SKIP
+      @customer = customer unless customer == SKIP
+      @links = links unless links == 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
+      customer = VaultCustomer.from_hash(hash['customer']) if hash['customer']
+      # 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')
+
+      # Create object from extracted values.
+      VaultResponse.new(id: id,
+                        status: status,
+                        customer: customer,
+                        links: links)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_status.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The vault status.
+  class VaultStatus
+    VAULT_STATUS = [
+      # TODO: Write general description for VAULTED
+      VAULTED = 'VAULTED'.freeze,
+
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for APPROVED
+      APPROVED = 'APPROVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_token_request.rb

@@ -0,0 +1,56 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The Tokenized Payment Source representing a Request to Vault a Token.
+  class VaultTokenRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal-generated ID for the token.
+    # @return [String]
+    attr_accessor :id
+
+    # The tokenization method that generated the ID.
+    # @return [TokenRequestType]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, type:)
+      @id = id
+      @type = type
+    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'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+
+      # Create object from extracted values.
+      VaultTokenRequest.new(id: id,
+                            type: type)
+    end
+  end
+end