cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/apple_pay_payment_data_type.rb

@@ -0,0 +1,41 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Indicates the type of payment data passed, in case of Non China the payment
+  # data is 3DSECURE and for China it is EMV.
+  class ApplePayPaymentDataType
+    APPLE_PAY_PAYMENT_DATA_TYPE = [
+      # The card was authenticated using 3D Secure (3DS) authentication scheme.
+      # While using this value make sure to populate cryptogram and
+      # eci_indicator as part of payment data..
+      ENUM_3DSECURE = '3DSECURE'.freeze,
+
+      # The card was authenticated using EMV method, which is applicable for
+      # China. While using this value make sure to pass emv_data and pin as part
+      # of payment data.
+      EMV = 'EMV'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENUM_3DSECURE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_3dsecure' then ENUM_3DSECURE
+      when 'emv' then EMV
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_payment_object.rb

@@ -0,0 +1,150 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using ApplePay.
+  class ApplePayPaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ApplePay transaction identifier, this will be the unique identifier for
+    # this transaction provided by Apple. The pattern is defined by an external
+    # party and supports Unicode.
+    # @return [String]
+    attr_accessor :id
+
+    # Encrypted ApplePay token, containing card information. This token would be
+    # base64encoded. The pattern is defined by an external party and supports
+    # Unicode.
+    # @return [String]
+    attr_accessor :token
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # 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 phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumber]
+    attr_accessor :phone_number
+
+    # The Card from Apple Pay Wallet used to fund the payment.
+    # @return [ApplePayCardResponse]
+    attr_accessor :card
+
+    # Additional attributes associated with the use of Apple Pay.
+    # @return [ApplePayAttributesResponse]
+    attr_accessor :attributes
+
+    # Provides additional details to process a payment using a `card` that has
+    # been stored or is intended to be stored (also referred to as
+    # stored_credential or card-on-file). Parameter compatibility:
+    # `payment_type=ONE_TIME` is compatible only with
+    # `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with
+    # `payment_initiator=CUSTOMER`. `previous_transaction_reference` or
+    # `previous_network_transaction_reference` is compatible only with
+    # `payment_initiator=MERCHANT`. Only one of the parameters -
+    # `previous_transaction_reference` and
+    # `previous_network_transaction_reference` - can be present in the request.
+    # @return [CardStoredCredential]
+    attr_accessor :stored_credential
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['token'] = 'token'
+      @_hash['name'] = 'name'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['card'] = 'card'
+      @_hash['attributes'] = 'attributes'
+      @_hash['stored_credential'] = 'stored_credential'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        token
+        name
+        email_address
+        phone_number
+        card
+        attributes
+        stored_credential
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, token: SKIP, name: SKIP, email_address: SKIP,
+                   phone_number: SKIP, card: SKIP, attributes: SKIP,
+                   stored_credential: SKIP)
+      @id = id unless id == SKIP
+      @token = token unless token == SKIP
+      @name = name unless name == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @card = card unless card == SKIP
+      @attributes = attributes unless attributes == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      token = hash.key?('token') ? hash['token'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone_number = PhoneNumber.from_hash(hash['phone_number']) if hash['phone_number']
+      card = ApplePayCardResponse.from_hash(hash['card']) if hash['card']
+      attributes = ApplePayAttributesResponse.from_hash(hash['attributes']) if hash['attributes']
+      stored_credential = CardStoredCredential.from_hash(hash['stored_credential']) if
+        hash['stored_credential']
+
+      # Create object from extracted values.
+      ApplePayPaymentObject.new(id: id,
+                                token: token,
+                                name: name,
+                                email_address: email_address,
+                                phone_number: phone_number,
+                                card: card,
+                                attributes: attributes,
+                                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} id: #{@id}, token: #{@token}, name: #{@name}, email_address:"\
+      " #{@email_address}, phone_number: #{@phone_number}, card: #{@card}, attributes:"\
+      " #{@attributes}, 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} id: #{@id.inspect}, token: #{@token.inspect}, name: #{@name.inspect},"\
+      " email_address: #{@email_address.inspect}, phone_number: #{@phone_number.inspect}, card:"\
+      " #{@card.inspect}, attributes: #{@attributes.inspect}, stored_credential:"\
+      " #{@stored_credential.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_payment_token.rb

@@ -0,0 +1,63 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A resource representing a response for Apple Pay.
+  class ApplePayPaymentToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment card to be used to fund a payment. Can be a credit or debit
+    # card.
+    # @return [ApplePayCard]
+    attr_accessor :card
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: 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.
+      card = ApplePayCard.from_hash(hash['card']) if hash['card']
+
+      # Create object from extracted values.
+      ApplePayPaymentToken.new(card: card)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_request.rb

@@ -0,0 +1,165 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using ApplePay.
+  class ApplePayRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ApplePay transaction identifier, this will be the unique identifier for
+    # this transaction provided by Apple. The pattern is defined by an external
+    # party and supports Unicode.
+    # @return [String]
+    attr_accessor :id
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # 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 phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumber]
+    attr_accessor :phone_number
+
+    # Information about the Payment data obtained by decrypting Apple Pay token.
+    # @return [ApplePayDecryptedTokenData]
+    attr_accessor :decrypted_token
+
+    # Provides additional details to process a payment using a `card` that has
+    # been stored or is intended to be stored (also referred to as
+    # stored_credential or card-on-file). Parameter compatibility:
+    # `payment_type=ONE_TIME` is compatible only with
+    # `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with
+    # `payment_initiator=CUSTOMER`. `previous_transaction_reference` or
+    # `previous_network_transaction_reference` is compatible only with
+    # `payment_initiator=MERCHANT`. Only one of the parameters -
+    # `previous_transaction_reference` and
+    # `previous_network_transaction_reference` - can be present in the request.
+    # @return [CardStoredCredential]
+    attr_accessor :stored_credential
+
+    # 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
+
+    # Additional attributes associated with apple pay.
+    # @return [ApplePayAttributes]
+    attr_accessor :attributes
+
+    # Customizes the payer experience during the approval process for the
+    # payment.
+    # @return [ApplePayExperienceContext]
+    attr_accessor :experience_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['decrypted_token'] = 'decrypted_token'
+      @_hash['stored_credential'] = 'stored_credential'
+      @_hash['vault_id'] = 'vault_id'
+      @_hash['attributes'] = 'attributes'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        email_address
+        phone_number
+        decrypted_token
+        stored_credential
+        vault_id
+        attributes
+        experience_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, email_address: SKIP,
+                   phone_number: SKIP, decrypted_token: SKIP,
+                   stored_credential: SKIP, vault_id: SKIP, attributes: SKIP,
+                   experience_context: SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @decrypted_token = decrypted_token unless decrypted_token == SKIP
+      @stored_credential = stored_credential unless stored_credential == SKIP
+      @vault_id = vault_id unless vault_id == SKIP
+      @attributes = attributes unless attributes == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone_number = PhoneNumber.from_hash(hash['phone_number']) if hash['phone_number']
+      decrypted_token = ApplePayDecryptedTokenData.from_hash(hash['decrypted_token']) if
+        hash['decrypted_token']
+      stored_credential = CardStoredCredential.from_hash(hash['stored_credential']) if
+        hash['stored_credential']
+      vault_id = hash.key?('vault_id') ? hash['vault_id'] : SKIP
+      attributes = ApplePayAttributes.from_hash(hash['attributes']) if hash['attributes']
+      experience_context = ApplePayExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      ApplePayRequest.new(id: id,
+                          name: name,
+                          email_address: email_address,
+                          phone_number: phone_number,
+                          decrypted_token: decrypted_token,
+                          stored_credential: stored_credential,
+                          vault_id: vault_id,
+                          attributes: attributes,
+                          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} id: #{@id}, name: #{@name}, email_address: #{@email_address}, phone_number:"\
+      " #{@phone_number}, decrypted_token: #{@decrypted_token}, stored_credential:"\
+      " #{@stored_credential}, vault_id: #{@vault_id}, attributes: #{@attributes},"\
+      " 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} id: #{@id.inspect}, name: #{@name.inspect}, email_address:"\
+      " #{@email_address.inspect}, phone_number: #{@phone_number.inspect}, decrypted_token:"\
+      " #{@decrypted_token.inspect}, stored_credential: #{@stored_credential.inspect}, vault_id:"\
+      " #{@vault_id.inspect}, attributes: #{@attributes.inspect}, experience_context:"\
+      " #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_request_card.rb

@@ -0,0 +1,88 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment card to be used to fund a payment. Can be a credit or debit
+  # card.
+  class ApplePayRequestCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of card. i.e Credit, Debit and so on.
+    # @return [CardType]
+    attr_accessor :type
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :brand
+
+    # 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 :billing_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['brand'] = 'brand'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        brand
+        billing_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, brand: SKIP, billing_address: SKIP)
+      @type = type unless type == SKIP
+      @brand = brand unless brand == SKIP
+      @billing_address = billing_address unless billing_address == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+
+      # Create object from extracted values.
+      ApplePayRequestCard.new(type: type,
+                              brand: brand,
+                              billing_address: billing_address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, brand: #{@brand}, billing_address: #{@billing_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, brand: #{@brand.inspect}, billing_address:"\
+      " #{@billing_address.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_tokenized_card.rb

@@ -0,0 +1,127 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment card to use to fund a payment. Can be a credit or debit card.
+  class ApplePayTokenizedCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The primary account number (PAN) for the payment card.
+    # @return [String]
+    attr_accessor :number
+
+    # The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date
+    # and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
+    # @return [String]
+    attr_accessor :expiry
+
+    # The card brand or network. Typically used in the response.
+    # @return [CardBrand]
+    attr_accessor :card_type
+
+    # Type of card. i.e Credit, Debit and so on.
+    # @return [CardType]
+    attr_accessor :type
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :brand
+
+    # 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 :billing_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['number'] = 'number'
+      @_hash['expiry'] = 'expiry'
+      @_hash['card_type'] = 'card_type'
+      @_hash['type'] = 'type'
+      @_hash['brand'] = 'brand'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        number
+        expiry
+        card_type
+        type
+        brand
+        billing_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, number: SKIP, expiry: SKIP, card_type: SKIP,
+                   type: SKIP, brand: SKIP, billing_address: SKIP)
+      @name = name unless name == SKIP
+      @number = number unless number == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @card_type = card_type unless card_type == SKIP
+      @type = type unless type == SKIP
+      @brand = brand unless brand == SKIP
+      @billing_address = billing_address unless billing_address == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      card_type = hash.key?('card_type') ? hash['card_type'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+
+      # Create object from extracted values.
+      ApplePayTokenizedCard.new(name: name,
+                                number: number,
+                                expiry: expiry,
+                                card_type: card_type,
+                                type: type,
+                                brand: brand,
+                                billing_address: billing_address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, number: #{@number}, expiry: #{@expiry}, card_type:"\
+      " #{@card_type}, type: #{@type}, brand: #{@brand}, billing_address: #{@billing_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, number: #{@number.inspect}, expiry:"\
+      " #{@expiry.inspect}, card_type: #{@card_type.inspect}, type: #{@type.inspect}, brand:"\
+      " #{@brand.inspect}, billing_address: #{@billing_address.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/application_context_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
+  # Configures the label name to `Continue` or `Subscribe Now` for subscription
+  # consent experience.
+  class ApplicationContextUserAction
+    APPLICATION_CONTEXT_USER_ACTION = [
+      # After you redirect the customer to the PayPal subscription consent page,
+      # a Continue button appears. Use this option when you want to control the
+      # activation of the subscription and do not want PayPal to activate the
+      # subscription.
+      CONTINUE = 'CONTINUE'.freeze,
+
+      # After you redirect the customer to the PayPal subscription consent page,
+      # a Subscribe Now button appears. Use this option when you want PayPal to
+      # activate the subscription.
+      SUBSCRIBE_NOW = 'SUBSCRIBE_NOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CONTINUE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'continue' then CONTINUE
+      when 'subscribe_now' then SUBSCRIBE_NOW
+      else
+        default_value
+      end
+    end
+  end
+end