paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/error_details.rb

@@ -0,0 +1,110 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The error details. Required for client-side `4XX` errors.
+  class ErrorDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The field that caused the error. If this field is in the body, set this
+    # value to the field's JSON pointer value. Required for client-side errors.
+    # @return [String]
+    attr_accessor :field
+
+    # The value of the field that caused the error.
+    # @return [String]
+    attr_accessor :value
+
+    # The location of the field that caused the error. Value is `body`, `path`,
+    # or `query`.
+    # @return [String]
+    attr_accessor :location
+
+    # The unique, fine-grained application-level error code.
+    # @return [String]
+    attr_accessor :issue
+
+    # An array of request-related [HATEOAS
+    # links](/api/rest/responses/#hateoas-links) that are either relevant to the
+    # issue by providing additional information or offering potential
+    # resolutions.
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # The human-readable description for an issue. The description can change
+    # over the lifetime of an API, so clients must not depend on this value.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field'] = 'field'
+      @_hash['value'] = 'value'
+      @_hash['location'] = 'location'
+      @_hash['issue'] = 'issue'
+      @_hash['links'] = 'links'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        field
+        value
+        location
+        links
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(issue:, field: SKIP, value: SKIP, location: 'body',
+                   links: SKIP, description: SKIP)
+      @field = field unless field == SKIP
+      @value = value unless value == SKIP
+      @location = location unless location == SKIP
+      @issue = issue
+      @links = links unless links == SKIP
+      @description = description unless description == 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.
+      issue = hash.key?('issue') ? hash['issue'] : nil
+      field = hash.key?('field') ? hash['field'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+      location = hash['location'] ||= 'body'
+      # 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')
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      ErrorDetails.new(issue: issue,
+                       field: field,
+                       value: value,
+                       location: location,
+                       links: links,
+                       description: description)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/exchange_rate.rb

@@ -0,0 +1,75 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The exchange rate that determines the amount to convert from one currency to
+  # another currency.
+  class ExchangeRate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The [three-character ISO-4217 currency
+    # code](/api/rest/reference/currency-codes/) that identifies the currency.
+    # @return [String]
+    attr_accessor :source_currency
+
+    # The [three-character ISO-4217 currency
+    # code](/api/rest/reference/currency-codes/) that identifies the currency.
+    # @return [String]
+    attr_accessor :target_currency
+
+    # The target currency amount. Equivalent to one unit of the source currency.
+    # Formatted as integer or decimal value with one to 15 digits to the right
+    # of the decimal point.
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source_currency'] = 'source_currency'
+      @_hash['target_currency'] = 'target_currency'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        source_currency
+        target_currency
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source_currency: SKIP, target_currency: SKIP, value: SKIP)
+      @source_currency = source_currency unless source_currency == SKIP
+      @target_currency = target_currency unless target_currency == SKIP
+      @value = value unless value == 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.
+      source_currency =
+        hash.key?('source_currency') ? hash['source_currency'] : SKIP
+      target_currency =
+        hash.key?('target_currency') ? hash['target_currency'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      ExchangeRate.new(source_currency: source_currency,
+                       target_currency: target_currency,
+                       value: value)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/experience_context.rb

@@ -0,0 +1,98 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Customizes the payer experience during the approval process for the payment.
+  class ExperienceContext < 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 location from which the shipping address is derived.
+    # @return [ShippingPreference]
+    attr_accessor :shipping_preference
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :return_url
+
+    # Describes the URL.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # 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['shipping_preference'] = 'shipping_preference'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        shipping_preference
+        return_url
+        cancel_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(brand_name: SKIP, locale: SKIP,
+                   shipping_preference: ShippingPreference::GET_FROM_FILE,
+                   return_url: SKIP, cancel_url: SKIP)
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      @return_url = return_url unless return_url == SKIP
+      @cancel_url = cancel_url unless cancel_url == 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
+      shipping_preference =
+        hash['shipping_preference'] ||= ShippingPreference::GET_FROM_FILE
+      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
+
+      # Create object from extracted values.
+      ExperienceContext.new(brand_name: brand_name,
+                            locale: locale,
+                            shipping_preference: shipping_preference,
+                            return_url: return_url,
+                            cancel_url: cancel_url)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/fullfillment_type.rb

@@ -0,0 +1,31 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # A classification for the method of purchase fulfillment (e.g shipping,
+  # in-store pickup, etc). Either `type` or `options` may be present, but not
+  # both.
+  class FullfillmentType
+    FULLFILLMENT_TYPE = [
+      # TODO: Write general description for SHIPPING
+      SHIPPING = 'SHIPPING'.freeze,
+
+      # TODO: Write general description for PICKUP_IN_PERSON
+      PICKUP_IN_PERSON = 'PICKUP_IN_PERSON'.freeze,
+
+      # TODO: Write general description for PICKUP_IN_STORE
+      PICKUP_IN_STORE = 'PICKUP_IN_STORE'.freeze,
+
+      # TODO: Write general description for PICKUP_FROM_PERSON
+      PICKUP_FROM_PERSON = 'PICKUP_FROM_PERSON'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/giropay_payment_object.rb

@@ -0,0 +1,74 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using giropay.
+  class GiropayPaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
+    # that identifies the country or region.<blockquote><strong>Note:</strong>
+    # The country code for Great Britain is <code>GB</code> and not
+    # <code>UK</code> as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # @return [String]
+    attr_accessor :country_code
+
+    # The business identification code (BIC). In payments systems, a BIC is used
+    # to identify a specific business, most commonly a bank.
+    # @return [String]
+    attr_accessor :bic
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['bic'] = 'bic'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        bic
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, bic: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @bic = bic unless bic == 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
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      bic = hash.key?('bic') ? hash['bic'] : SKIP
+
+      # Create object from extracted values.
+      GiropayPaymentObject.new(name: name,
+                               country_code: country_code,
+                               bic: bic)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/giropay_payment_request.rb

@@ -0,0 +1,73 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using giropay.
+  class GiropayPaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
+    # that identifies the country or region.<blockquote><strong>Note:</strong>
+    # The country code for Great Britain is <code>GB</code> and not
+    # <code>UK</code> as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # @return [String]
+    attr_accessor :country_code
+
+    # Customizes the payer experience during the approval process for the
+    # payment.
+    # @return [ExperienceContext]
+    attr_accessor :experience_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        experience_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, country_code:, experience_context: SKIP)
+      @name = name
+      @country_code = country_code
+      @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.
+      name = hash.key?('name') ? hash['name'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      experience_context = ExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      GiropayPaymentRequest.new(name: name,
+                                country_code: country_code,
+                                experience_context: experience_context)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/google_pay_authentication_method.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Authentication Method which is used for the card transaction.
+  class GooglePayAuthenticationMethod
+    GOOGLE_PAY_AUTHENTICATION_METHOD = [
+      # TODO: Write general description for PAN_ONLY
+      PAN_ONLY = 'PAN_ONLY'.freeze,
+
+      # TODO: Write general description for CRYPTOGRAM_3DS
+      CRYPTOGRAM_3DS = 'CRYPTOGRAM_3DS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/google_pay_card_attributes.rb

@@ -0,0 +1,51 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Additional attributes associated with the use of this card.
+  class GooglePayCardAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The API caller can opt in to verify the card through PayPal offered
+    # verification services (e.g. Smart Dollar Auth, 3DS).
+    # @return [CardVerification]
+    attr_accessor :verification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['verification'] = 'verification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        verification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(verification: SKIP)
+      @verification = verification unless verification == 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.
+      verification = CardVerification.from_hash(hash['verification']) if hash['verification']
+
+      # Create object from extracted values.
+      GooglePayCardAttributes.new(verification: verification)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/google_pay_card_response.rb

@@ -0,0 +1,104 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The payment card to use to fund a Google Pay payment response. Can be a
+  # credit or debit card.
+  class GooglePayCardResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The last digits of the payment card.
+    # @return [String]
+    attr_accessor :last_digits
+
+    # 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
+
+    # Results of Authentication such as 3D Secure.
+    # @return [AuthenticationResponse]
+    attr_accessor :authentication_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['last_digits'] = 'last_digits'
+      @_hash['type'] = 'type'
+      @_hash['brand'] = 'brand'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['authentication_result'] = 'authentication_result'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        last_digits
+        type
+        brand
+        billing_address
+        authentication_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, last_digits: SKIP, type: SKIP, brand: SKIP,
+                   billing_address: SKIP, authentication_result: SKIP)
+      @name = name unless name == SKIP
+      @last_digits = last_digits unless last_digits == SKIP
+      @type = type unless type == SKIP
+      @brand = brand unless brand == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @authentication_result = authentication_result unless authentication_result == 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
+      last_digits = hash.key?('last_digits') ? hash['last_digits'] : 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']
+      authentication_result = AuthenticationResponse.from_hash(hash['authentication_result']) if
+        hash['authentication_result']
+
+      # Create object from extracted values.
+      GooglePayCardResponse.new(name: name,
+                                last_digits: last_digits,
+                                type: type,
+                                brand: brand,
+                                billing_address: billing_address,
+                                authentication_result: authentication_result)
+    end
+  end
+end