cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/vault_paypal_wallet_request.rb

@@ -0,0 +1,154 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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
+
+    # 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 merchant level Recurring Billing plan metadata for the Billing
+    # Agreement.
+    # @return [Plan]
+    attr_accessor :billing_plan
+
+    # A resource representing an experience context of vault PayPal Wallet.
+    # @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['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['billing_plan'] = 'billing_plan'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        usage_pattern
+        shipping
+        permit_multiple_payment_tokens
+        usage_type
+        customer_type
+        billing_plan
+        experience_context
+      ]
+    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, billing_plan: SKIP,
+                   experience_context: 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
+      @billing_plan = billing_plan unless billing_plan == 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
+      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
+      billing_plan = Plan.from_hash(hash['billing_plan']) if hash['billing_plan']
+      experience_context = VaultExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      VaultPaypalWalletRequest.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,
+                                   billing_plan: billing_plan,
+                                   experience_context: experience_context)
+    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}, billing_plan:"\
+      " #{@billing_plan}, experience_context: #{@experience_context}>"
+    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}, billing_plan: #{@billing_plan.inspect},"\
+      " experience_context: #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/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 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
+
+    # This object represents a merchant’s customer, allowing them to store
+    # contact details, and track all payments associated with the same customer.
+    # @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
+
+    # 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}, customer: #{@customer}, links: #{@links}>"
+    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}, customer:"\
+      " #{@customer.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_response_customer.rb

@@ -0,0 +1,86 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # This object defines a customer in your system. Use it to manage customer
+  # profiles, save payment methods and contact details.
+  class VaultResponseCustomer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # Merchants and partners may already have a data-store where their customer
+    # information is persisted. Use merchant_customer_id to associate the
+    # PayPal-generated customer.id to your representation of a customer.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # DEPRECATED. This field is DEPRECATED.
+    # @return [Array[Object]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        merchant_customer_id
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, merchant_customer_id: SKIP, links: SKIP)
+      @id = id unless id == SKIP
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_id == 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
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+      links = hash.key?('links') ? hash['links'] : SKIP
+
+      # Create object from extracted values.
+      VaultResponseCustomer.new(id: id,
+                                merchant_customer_id: merchant_customer_id,
+                                links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, merchant_customer_id: #{@merchant_customer_id}, links:"\
+      " #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, merchant_customer_id: #{@merchant_customer_id.inspect},"\
+      " links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_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 VaultStatus
+    VAULT_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/vault_token_request.rb

@@ -0,0 +1,68 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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 [VaultTokenRequestType]
+    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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_token_request_type.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The tokenization method that generated the ID.
+  class VaultTokenRequestType
+    VAULT_TOKEN_REQUEST_TYPE = [
+      # The setup token, which is a temporary reference to payment source.
+      SETUP_TOKEN = 'SETUP_TOKEN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SETUP_TOKEN)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_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
+  # User Action on action to be performed after a successful payer approval.
+  class VaultUserAction
+    VAULT_USER_ACTION = [
+      # After you redirect the customer to the PayPal payment page, a Setup Now
+      # button appears. Use this option when no additional inputs are needed
+      # from merchant site and to create the billing agreement immediately when
+      # the customer clicks Setup Now.
+      SETUP_NOW = 'SETUP_NOW'.freeze,
+
+      # After you redirect the customer to the PayPal payment page, a Continue
+      # button appears. Use this option when you want to redirect the customer
+      # from the completed payment page to the merchant site for additional
+      # inputs without immediately creating the billing agreement.
+      CONTINUE = 'CONTINUE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SETUP_NOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'setup_now' then SETUP_NOW
+      when 'continue' then CONTINUE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_venmo_request.rb

@@ -0,0 +1,143 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A resource representing a request to vault Venmo.
+  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
+
+    # 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
+
+    # A resource representing an experience context of vault a venmo account.
+    # @return [VenmoExperienceContext]
+    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['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['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        usage_pattern
+        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, usage_pattern: SKIP, shipping: SKIP,
+                   permit_multiple_payment_tokens: false, usage_type: SKIP,
+                   customer_type: SKIP, experience_context: 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
+      @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
+      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
+      experience_context = VenmoExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      VaultVenmoRequest.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,
+                            experience_context: experience_context)
+    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}, experience_context:"\
+      " #{@experience_context}>"
+    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}, experience_context:"\
+      " #{@experience_context.inspect}>"
+    end
+  end
+end