paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/shipping_details.rb

@@ -0,0 +1,106 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The shipping details.
+  class ShippingDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the party.
+    # @return [ShippingName]
+    attr_accessor :name
+
+    # The phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumberWithCountryCode]
+    attr_accessor :phone_number
+
+    # 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.
+    # @return [FullfillmentType]
+    attr_accessor :type
+
+    # An array of shipping options that the payee or merchant offers to the
+    # payer to ship or pick up their items.
+    # @return [Array[ShippingOption]]
+    attr_accessor :options
+
+    # 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 :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['type'] = 'type'
+      @_hash['options'] = 'options'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        phone_number
+        type
+        options
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, phone_number: SKIP, type: SKIP, options: SKIP,
+                   address: SKIP)
+      @name = name unless name == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @type = type unless type == SKIP
+      @options = options unless options == SKIP
+      @address = address unless 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 = ShippingName.from_hash(hash['name']) if hash['name']
+      phone_number = PhoneNumberWithCountryCode.from_hash(hash['phone_number']) if
+        hash['phone_number']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      options = nil
+      unless hash['options'].nil?
+        options = []
+        hash['options'].each do |structure|
+          options << (ShippingOption.from_hash(structure) if structure)
+        end
+      end
+
+      options = SKIP unless hash.key?('options')
+      address = Address.from_hash(hash['address']) if hash['address']
+
+      # Create object from extracted values.
+      ShippingDetails.new(name: name,
+                          phone_number: phone_number,
+                          type: type,
+                          options: options,
+                          address: address)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/shipping_name.rb

@@ -0,0 +1,50 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The name of the party.
+  class ShippingName < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the party is a person, the party's full name.
+    # @return [String]
+    attr_accessor :full_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['full_name'] = 'full_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        full_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(full_name: SKIP)
+      @full_name = full_name unless full_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.
+      full_name = hash.key?('full_name') ? hash['full_name'] : SKIP
+
+      # Create object from extracted values.
+      ShippingName.new(full_name: full_name)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/shipping_option.rb

@@ -0,0 +1,94 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The options that the payee or merchant offers to the payer to ship or pick
+  # up their items.
+  class ShippingOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique ID that identifies a payer-selected shipping option.
+    # @return [String]
+    attr_accessor :id
+
+    # A description that the payer sees, which helps them choose an appropriate
+    # shipping option. For example, `Free Shipping`, `USPS Priority Shipping`,
+    # `Expédition prioritaire USPS`, or `USPS yōuxiān fā huò`. Localize this
+    # description to the payer's locale.
+    # @return [String]
+    attr_accessor :label
+
+    # A classification for the method of purchase fulfillment.
+    # @return [ShippingType]
+    attr_accessor :type
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # If the API request sets `selected = true`, it represents the shipping
+    # option that the payee or merchant expects to be pre-selected for the payer
+    # when they first view the `shipping.options` in the PayPal Checkout
+    # experience. As part of the response if a `shipping.option` contains
+    # `selected=true`, it represents the shipping option that the payer selected
+    # during the course of checkout with PayPal. Only one `shipping.option` can
+    # be set to `selected=true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :selected
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['label'] = 'label'
+      @_hash['type'] = 'type'
+      @_hash['amount'] = 'amount'
+      @_hash['selected'] = 'selected'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, label:, selected:, type: SKIP, amount: SKIP)
+      @id = id
+      @label = label
+      @type = type unless type == SKIP
+      @amount = amount unless amount == SKIP
+      @selected = selected
+    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
+      label = hash.key?('label') ? hash['label'] : nil
+      selected = hash.key?('selected') ? hash['selected'] : nil
+      type = hash.key?('type') ? hash['type'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      ShippingOption.new(id: id,
+                         label: label,
+                         selected: selected,
+                         type: type,
+                         amount: amount)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/shipping_preference.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The location from which the shipping address is derived.
+  class ShippingPreference
+    SHIPPING_PREFERENCE = [
+      # TODO: Write general description for GET_FROM_FILE
+      GET_FROM_FILE = 'GET_FROM_FILE'.freeze,
+
+      # TODO: Write general description for NO_SHIPPING
+      NO_SHIPPING = 'NO_SHIPPING'.freeze,
+
+      # TODO: Write general description for SET_PROVIDED_ADDRESS
+      SET_PROVIDED_ADDRESS = 'SET_PROVIDED_ADDRESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/shipping_type.rb

@@ -0,0 +1,29 @@
+# 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.
+  class ShippingType
+    SHIPPING_TYPE = [
+      # TODO: Write general description for SHIPPING
+      SHIPPING = 'SHIPPING'.freeze,
+
+      # TODO: Write general description for PICKUP
+      PICKUP = 'PICKUP'.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/shipping_with_tracking_details.rb

@@ -0,0 +1,124 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The order shipping details.
+  class ShippingWithTrackingDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the party.
+    # @return [ShippingName]
+    attr_accessor :name
+
+    # The phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumberWithCountryCode]
+    attr_accessor :phone_number
+
+    # 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.
+    # @return [FullfillmentType]
+    attr_accessor :type
+
+    # An array of shipping options that the payee or merchant offers to the
+    # payer to ship or pick up their items.
+    # @return [Array[ShippingOption]]
+    attr_accessor :options
+
+    # 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 :address
+
+    # An array of trackers for a transaction.
+    # @return [Array[OrderTrackerResponse]]
+    attr_accessor :trackers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['type'] = 'type'
+      @_hash['options'] = 'options'
+      @_hash['address'] = 'address'
+      @_hash['trackers'] = 'trackers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        phone_number
+        type
+        options
+        address
+        trackers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, phone_number: SKIP, type: SKIP, options: SKIP,
+                   address: SKIP, trackers: SKIP)
+      @name = name unless name == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @type = type unless type == SKIP
+      @options = options unless options == SKIP
+      @address = address unless address == SKIP
+      @trackers = trackers unless trackers == 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 = ShippingName.from_hash(hash['name']) if hash['name']
+      phone_number = PhoneNumberWithCountryCode.from_hash(hash['phone_number']) if
+        hash['phone_number']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      options = nil
+      unless hash['options'].nil?
+        options = []
+        hash['options'].each do |structure|
+          options << (ShippingOption.from_hash(structure) if structure)
+        end
+      end
+
+      options = SKIP unless hash.key?('options')
+      address = Address.from_hash(hash['address']) if hash['address']
+      # Parameter is an array, so we need to iterate through it
+      trackers = nil
+      unless hash['trackers'].nil?
+        trackers = []
+        hash['trackers'].each do |structure|
+          trackers << (OrderTrackerResponse.from_hash(structure) if structure)
+        end
+      end
+
+      trackers = SKIP unless hash.key?('trackers')
+
+      # Create object from extracted values.
+      ShippingWithTrackingDetails.new(name: name,
+                                      phone_number: phone_number,
+                                      type: type,
+                                      options: options,
+                                      address: address,
+                                      trackers: trackers)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/sofort_payment_object.rb

@@ -0,0 +1,85 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using Sofort.
+  class SofortPaymentObject < 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
+
+    # The last characters of the IBAN used to pay.
+    # @return [String]
+    attr_accessor :iban_last_chars
+
+    # 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['iban_last_chars'] = 'iban_last_chars'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        bic
+        iban_last_chars
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, bic: SKIP,
+                   iban_last_chars: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @bic = bic unless bic == SKIP
+      @iban_last_chars = iban_last_chars unless iban_last_chars == 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
+      iban_last_chars =
+        hash.key?('iban_last_chars') ? hash['iban_last_chars'] : SKIP
+
+      # Create object from extracted values.
+      SofortPaymentObject.new(name: name,
+                              country_code: country_code,
+                              bic: bic,
+                              iban_last_chars: iban_last_chars)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/sofort_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 Sofort.
+  class SofortPaymentRequest < 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.
+      SofortPaymentRequest.new(name: name,
+                               country_code: country_code,
+                               experience_context: experience_context)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/standard_entry_class_code.rb

@@ -0,0 +1,36 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # NACHA (the regulatory body governing the ACH network) requires that API
+  # callers (merchants, partners) obtain the consumer’s explicit authorization
+  # before initiating a transaction. To stay compliant, you’ll need to make sure
+  # that you retain a compliant authorization for each transaction that you
+  # originate to the ACH Network using this API. ACH transactions are
+  # categorized (using SEC codes) by how you capture authorization from the
+  # Receiver (the person whose bank account is being debited or credited).
+  # PayPal supports the following SEC codes.
+  class StandardEntryClassCode
+    STANDARD_ENTRY_CLASS_CODE = [
+      # TODO: Write general description for TEL
+      TEL = 'TEL'.freeze,
+
+      # TODO: Write general description for WEB
+      WEB = 'WEB'.freeze,
+
+      # TODO: Write general description for CCD
+      CCD = 'CCD'.freeze,
+
+      # TODO: Write general description for PPD
+      PPD = 'PPD'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/store_in_vault_instruction.rb

@@ -0,0 +1,20 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Defines how and when the payment source gets vaulted.
+  class StoreInVaultInstruction
+    STORE_IN_VAULT_INSTRUCTION = [
+      # TODO: Write general description for ON_SUCCESS
+      ON_SUCCESS = 'ON_SUCCESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end