cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/usage_type.rb

@@ -0,0 +1,39 @@
+# 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.
+  class UsageType
+    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/vault_apple_pay_request.rb

@@ -0,0 +1,73 @@
+# 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 Apple Pay.
+  class VaultApplePayRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Encrypted Apple Pay token, containing card information. This token would
+    # be base64 encoded.
+    # @return [String]
+    attr_accessor :token
+
+    # The payment card to be used to fund a payment. Can be a credit or debit
+    # card.
+    # @return [ApplePayRequestCard]
+    attr_accessor :card
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['token'] = 'token'
+      @_hash['card'] = 'card'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        token
+        card
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(token: SKIP, card: SKIP)
+      @token = token unless token == SKIP
+      @card = card unless card == 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.
+      token = hash.key?('token') ? hash['token'] : SKIP
+      card = ApplePayRequestCard.from_hash(hash['card']) if hash['card']
+
+      # Create object from extracted values.
+      VaultApplePayRequest.new(token: token,
+                               card: card)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token}, card: #{@card}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token.inspect}, card: #{@card.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_card_experience_context.rb

@@ -0,0 +1,129 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A resource representing an experience context of vault a card.
+  class VaultCardExperienceContext < 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](https://developer.paypal.com/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
+
+    # DEPRECATED. Vault Instruction on action to be performed after a successful
+    # payer approval.
+    # @return [VaultInstructionAction]
+    attr_accessor :vault_instruction
+
+    # User Action on action to be performed after a successful payer approval.
+    # @return [VaultUserAction]
+    attr_accessor :user_action
+
+    # 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['vault_instruction'] = 'vault_instruction'
+      @_hash['user_action'] = 'user_action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        return_url
+        cancel_url
+        vault_instruction
+        user_action
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP,
+                   cancel_url: SKIP, vault_instruction: SKIP,
+                   user_action: VaultUserAction::CONTINUE)
+      @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
+      @vault_instruction = vault_instruction unless vault_instruction == SKIP
+      @user_action = user_action unless user_action == 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
+      vault_instruction =
+        hash.key?('vault_instruction') ? hash['vault_instruction'] : SKIP
+      user_action = hash['user_action'] ||= VaultUserAction::CONTINUE
+
+      # Create object from extracted values.
+      VaultCardExperienceContext.new(brand_name: brand_name,
+                                     locale: locale,
+                                     return_url: return_url,
+                                     cancel_url: cancel_url,
+                                     vault_instruction: vault_instruction,
+                                     user_action: user_action)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, return_url: #{@return_url},"\
+      " cancel_url: #{@cancel_url}, vault_instruction: #{@vault_instruction}, user_action:"\
+      " #{@user_action}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect}, return_url:"\
+      " #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}, vault_instruction:"\
+      " #{@vault_instruction.inspect}, user_action: #{@user_action.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_card_verification_method.rb

@@ -0,0 +1,52 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The verification method of the card.
+  class VaultCardVerificationMethod
+    VAULT_CARD_VERIFICATION_METHOD = [
+      # When an authorization or transaction is attempted this option will
+      # return a contingency and HATEOAS link only when local regulations
+      # require strong customer authentication, (e.g. 3DS in countries and use
+      # cases where it is mandated). The API caller should redirect the payer to
+      # the link so that they can authenticate themselves. In all cases, when an
+      # authorization is requested the AVS/CVV results will be returned in the
+      # response.
+      SCA_WHEN_REQUIRED = 'SCA_WHEN_REQUIRED'.freeze,
+
+      # Selecting this option will attempt to force a strong customer
+      # authentication for the authorization/transaction. In countries where SCA
+      # has been defined and implemented it will result in a contingency and
+      # HATEOAS link being returned.  The API caller should redirect the payer
+      # to that link so that they can authenticate themselves against their
+      # issuing bank or other entity. As noted, the HATEOAS link is only
+      # available in all regions where strong authentication is supported, (e.g.
+      # in European countries where 3DS is live). Merchants can use this setting
+      # as an additional layer of security if they choose to. In all cases, when
+      # an authorization is requested the AVS/CVV results will be returned in
+      # the response.
+      SCA_ALWAYS = 'SCA_ALWAYS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SCA_WHEN_REQUIRED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sca_when_required' then SCA_WHEN_REQUIRED
+      when 'sca_always' then SCA_ALWAYS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_customer.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # This object represents a merchant’s customer, allowing them to store contact
+  # details, and track all payments associated with the same customer.
+  class VaultCustomer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP)
+      @id = id unless id == SKIP
+      @name = name unless 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = Name.from_hash(hash['name']) if hash['name']
+
+      # Create object from extracted values.
+      VaultCustomer.new(id: id,
+                        name: name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_experience_context.rb

@@ -0,0 +1,155 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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](https://developer.paypal.com/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 [ExperienceContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # DEPRECATED. Vault Instruction on action to be performed after a successful
+    # payer approval.
+    # @return [VaultInstructionAction]
+    attr_accessor :vault_instruction
+
+    # Merchant provided details of the native app or mobile web browser to
+    # facilitate buyer's app switch to the PayPal consumer app.
+    # @return [AppSwitchContext]
+    attr_accessor :app_switch_context
+
+    # User Action on action to be performed after a successful payer approval.
+    # @return [VaultUserAction]
+    attr_accessor :user_action
+
+    # 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['app_switch_context'] = 'app_switch_context'
+      @_hash['user_action'] = 'user_action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        return_url
+        cancel_url
+        shipping_preference
+        vault_instruction
+        app_switch_context
+        user_action
+      ]
+    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: ExperienceContextShippingPreference::GET_FROM_FILE,
+      vault_instruction: SKIP, app_switch_context: SKIP,
+      user_action: VaultUserAction::CONTINUE
+    )
+      @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
+      @app_switch_context = app_switch_context unless app_switch_context == SKIP
+      @user_action = user_action unless user_action == 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'] ||= ExperienceContextShippingPreference::GET_FROM_FILE
+      vault_instruction =
+        hash.key?('vault_instruction') ? hash['vault_instruction'] : SKIP
+      app_switch_context = AppSwitchContext.from_hash(hash['app_switch_context']) if
+        hash['app_switch_context']
+      user_action = hash['user_action'] ||= VaultUserAction::CONTINUE
+
+      # 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,
+                                 app_switch_context: app_switch_context,
+                                 user_action: user_action)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, return_url: #{@return_url},"\
+      " cancel_url: #{@cancel_url}, shipping_preference: #{@shipping_preference},"\
+      " vault_instruction: #{@vault_instruction}, app_switch_context: #{@app_switch_context},"\
+      " user_action: #{@user_action}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect}, return_url:"\
+      " #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}, shipping_preference:"\
+      " #{@shipping_preference.inspect}, vault_instruction: #{@vault_instruction.inspect},"\
+      " app_switch_context: #{@app_switch_context.inspect}, user_action: #{@user_action.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_instruction.rb

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

data/lib/paypal_server_sdk/models/vault_instruction_action.rb

@@ -0,0 +1,39 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Vault Instruction on action to be performed after a successful payer
+  # approval.
+  class VaultInstructionAction
+    VAULT_INSTRUCTION_ACTION = [
+      # Vault the payment method after API caller performs a successful POST on
+      # Payment Tokens.
+      ON_CREATE_PAYMENT_TOKENS = 'ON_CREATE_PAYMENT_TOKENS'.freeze,
+
+      # Vault the payment method on successful payer authentication and
+      # approval.
+      ON_PAYER_APPROVAL = 'ON_PAYER_APPROVAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ON_CREATE_PAYMENT_TOKENS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'on_create_payment_tokens' then ON_CREATE_PAYMENT_TOKENS
+      when 'on_payer_approval' then ON_PAYER_APPROVAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_instruction_base.rb

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