paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/item.rb

@@ -0,0 +1,134 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details for the items to be purchased.
+  class Item < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The item name or title.
+    # @return [String]
+    attr_accessor :name
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :unit_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :tax
+
+    # The item quantity. Must be a whole number.
+    # @return [String]
+    attr_accessor :quantity
+
+    # The detailed item description.
+    # @return [String]
+    attr_accessor :description
+
+    # The stock keeping unit (SKU) for the item.
+    # @return [String]
+    attr_accessor :sku
+
+    # The URL to the item being purchased. Visible to buyer and used in buyer
+    # experiences.
+    # @return [String]
+    attr_accessor :url
+
+    # The item category type.
+    # @return [ItemCategory]
+    attr_accessor :category
+
+    # The URL of the item's image. File type and size restrictions apply. An
+    # image that violates these restrictions will not be honored.
+    # @return [String]
+    attr_accessor :image_url
+
+    # The Universal Product Code of the item.
+    # @return [UniversalProductCode]
+    attr_accessor :upc
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash['tax'] = 'tax'
+      @_hash['quantity'] = 'quantity'
+      @_hash['description'] = 'description'
+      @_hash['sku'] = 'sku'
+      @_hash['url'] = 'url'
+      @_hash['category'] = 'category'
+      @_hash['image_url'] = 'image_url'
+      @_hash['upc'] = 'upc'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax
+        description
+        sku
+        url
+        category
+        image_url
+        upc
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, unit_amount:, quantity:, tax: SKIP, description: SKIP,
+                   sku: SKIP, url: SKIP, category: SKIP, image_url: SKIP,
+                   upc: SKIP)
+      @name = name
+      @unit_amount = unit_amount
+      @tax = tax unless tax == SKIP
+      @quantity = quantity
+      @description = description unless description == SKIP
+      @sku = sku unless sku == SKIP
+      @url = url unless url == SKIP
+      @category = category unless category == SKIP
+      @image_url = image_url unless image_url == SKIP
+      @upc = upc unless upc == 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
+      unit_amount = Money.from_hash(hash['unit_amount']) if hash['unit_amount']
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      tax = Money.from_hash(hash['tax']) if hash['tax']
+      description = hash.key?('description') ? hash['description'] : SKIP
+      sku = hash.key?('sku') ? hash['sku'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      category = hash.key?('category') ? hash['category'] : SKIP
+      image_url = hash.key?('image_url') ? hash['image_url'] : SKIP
+      upc = UniversalProductCode.from_hash(hash['upc']) if hash['upc']
+
+      # Create object from extracted values.
+      Item.new(name: name,
+               unit_amount: unit_amount,
+               quantity: quantity,
+               tax: tax,
+               description: description,
+               sku: sku,
+               url: url,
+               category: category,
+               image_url: image_url,
+               upc: upc)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/item_category.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The item category type.
+  class ItemCategory
+    ITEM_CATEGORY = [
+      # TODO: Write general description for DIGITAL_GOODS
+      DIGITAL_GOODS = 'DIGITAL_GOODS'.freeze,
+
+      # TODO: Write general description for PHYSICAL_GOODS
+      PHYSICAL_GOODS = 'PHYSICAL_GOODS'.freeze,
+
+      # TODO: Write general description for DONATION
+      DONATION = 'DONATION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/level2_card_processing_data.rb

@@ -0,0 +1,66 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The level 2 card processing data collections. If your merchant account has
+  # been configured for Level 2 processing this field will be passed to the
+  # processor on your behalf. Please contact your PayPal Technical Account
+  # Manager to define level 2 data for your business.
+  class Level2CardProcessingData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Use this field to pass a purchase identification value of up to 127 ASCII
+    # characters. The length of this field will be adjusted to meet network
+    # specifications (25chars for Visa and Mastercard, 17chars for Amex), and
+    # the original invoice ID will still be displayed in your existing reports.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :tax_total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['tax_total'] = 'tax_total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        invoice_id
+        tax_total
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_id: SKIP, tax_total: SKIP)
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @tax_total = tax_total unless tax_total == 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.
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      tax_total = Money.from_hash(hash['tax_total']) if hash['tax_total']
+
+      # Create object from extracted values.
+      Level2CardProcessingData.new(invoice_id: invoice_id,
+                                   tax_total: tax_total)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/level3_card_processing_data.rb

@@ -0,0 +1,120 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The level 3 card processing data collections, If your merchant account has
+  # been configured for Level 3 processing this field will be passed to the
+  # processor on your behalf. Please contact your PayPal Technical Account
+  # Manager to define level 3 data for your business.
+  class Level3CardProcessingData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :shipping_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :duty_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :discount_amount
+
+    # 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 :shipping_address
+
+    # Use this field to specify the postal code of the shipping location.
+    # @return [String]
+    attr_accessor :ships_from_postal_code
+
+    # A list of the items that were purchased with this payment. If your
+    # merchant account has been configured for Level 3 processing this field
+    # will be passed to the processor on your behalf.
+    # @return [Array[LineItem]]
+    attr_accessor :line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shipping_amount'] = 'shipping_amount'
+      @_hash['duty_amount'] = 'duty_amount'
+      @_hash['discount_amount'] = 'discount_amount'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['ships_from_postal_code'] = 'ships_from_postal_code'
+      @_hash['line_items'] = 'line_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        shipping_amount
+        duty_amount
+        discount_amount
+        shipping_address
+        ships_from_postal_code
+        line_items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipping_amount: SKIP, duty_amount: SKIP,
+                   discount_amount: SKIP, shipping_address: SKIP,
+                   ships_from_postal_code: SKIP, line_items: SKIP)
+      @shipping_amount = shipping_amount unless shipping_amount == SKIP
+      @duty_amount = duty_amount unless duty_amount == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @ships_from_postal_code = ships_from_postal_code unless ships_from_postal_code == SKIP
+      @line_items = line_items unless line_items == 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.
+      shipping_amount = Money.from_hash(hash['shipping_amount']) if hash['shipping_amount']
+      duty_amount = Money.from_hash(hash['duty_amount']) if hash['duty_amount']
+      discount_amount = Money.from_hash(hash['discount_amount']) if hash['discount_amount']
+      shipping_address = Address.from_hash(hash['shipping_address']) if hash['shipping_address']
+      ships_from_postal_code =
+        hash.key?('ships_from_postal_code') ? hash['ships_from_postal_code'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (LineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('line_items')
+
+      # Create object from extracted values.
+      Level3CardProcessingData.new(shipping_amount: shipping_amount,
+                                   duty_amount: duty_amount,
+                                   discount_amount: discount_amount,
+                                   shipping_address: shipping_address,
+                                   ships_from_postal_code: ships_from_postal_code,
+                                   line_items: line_items)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/liability_shift_indicator.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Liability shift indicator. The outcome of the issuer's authentication.
+  class LiabilityShiftIndicator
+    LIABILITY_SHIFT_INDICATOR = [
+      # TODO: Write general description for NO
+      NO = 'NO'.freeze,
+
+      # TODO: Write general description for POSSIBLE
+      POSSIBLE = 'POSSIBLE'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/line_item.rb

@@ -0,0 +1,177 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The line items for this purchase. If your merchant account has been
+  # configured for Level 3 processing this field will be passed to the processor
+  # on your behalf.
+  class LineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The item name or title.
+    # @return [String]
+    attr_accessor :name
+
+    # The item quantity. Must be a whole number.
+    # @return [String]
+    attr_accessor :quantity
+
+    # The detailed item description.
+    # @return [String]
+    attr_accessor :description
+
+    # The stock keeping unit (SKU) for the item.
+    # @return [String]
+    attr_accessor :sku
+
+    # The URL to the item being purchased. Visible to buyer and used in buyer
+    # experiences.
+    # @return [String]
+    attr_accessor :url
+
+    # The URL of the item's image. File type and size restrictions apply. An
+    # image that violates these restrictions will not be honored.
+    # @return [String]
+    attr_accessor :image_url
+
+    # The Universal Product Code of the item.
+    # @return [UniversalProductCode]
+    attr_accessor :upc
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :unit_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :tax
+
+    # Code used to classify items purchased and track the total amount spent
+    # across various categories of products and services. Different corporate
+    # purchasing organizations may use different standards, but the United
+    # Nations Standard Products and Services Code (UNSPSC) is frequently used.
+    # @return [String]
+    attr_accessor :commodity_code
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :discount_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :total_amount
+
+    # Unit of measure is a standard used to express the magnitude of a quantity
+    # in international trade. Most commonly used (but not limited to) examples
+    # are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic
+    # inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR),
+    # Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon
+    # (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK).
+    # @return [String]
+    attr_accessor :unit_of_measure
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['quantity'] = 'quantity'
+      @_hash['description'] = 'description'
+      @_hash['sku'] = 'sku'
+      @_hash['url'] = 'url'
+      @_hash['image_url'] = 'image_url'
+      @_hash['upc'] = 'upc'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash['tax'] = 'tax'
+      @_hash['commodity_code'] = 'commodity_code'
+      @_hash['discount_amount'] = 'discount_amount'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash['unit_of_measure'] = 'unit_of_measure'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        sku
+        url
+        image_url
+        upc
+        unit_amount
+        tax
+        commodity_code
+        discount_amount
+        total_amount
+        unit_of_measure
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, quantity:, description: SKIP, sku: SKIP, url: SKIP,
+                   image_url: SKIP, upc: SKIP, unit_amount: SKIP, tax: SKIP,
+                   commodity_code: SKIP, discount_amount: SKIP,
+                   total_amount: SKIP, unit_of_measure: SKIP)
+      @name = name
+      @quantity = quantity
+      @description = description unless description == SKIP
+      @sku = sku unless sku == SKIP
+      @url = url unless url == SKIP
+      @image_url = image_url unless image_url == SKIP
+      @upc = upc unless upc == SKIP
+      @unit_amount = unit_amount unless unit_amount == SKIP
+      @tax = tax unless tax == SKIP
+      @commodity_code = commodity_code unless commodity_code == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @unit_of_measure = unit_of_measure unless unit_of_measure == 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
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      sku = hash.key?('sku') ? hash['sku'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      image_url = hash.key?('image_url') ? hash['image_url'] : SKIP
+      upc = UniversalProductCode.from_hash(hash['upc']) if hash['upc']
+      unit_amount = Money.from_hash(hash['unit_amount']) if hash['unit_amount']
+      tax = Money.from_hash(hash['tax']) if hash['tax']
+      commodity_code =
+        hash.key?('commodity_code') ? hash['commodity_code'] : SKIP
+      discount_amount = Money.from_hash(hash['discount_amount']) if hash['discount_amount']
+      total_amount = Money.from_hash(hash['total_amount']) if hash['total_amount']
+      unit_of_measure =
+        hash.key?('unit_of_measure') ? hash['unit_of_measure'] : SKIP
+
+      # Create object from extracted values.
+      LineItem.new(name: name,
+                   quantity: quantity,
+                   description: description,
+                   sku: sku,
+                   url: url,
+                   image_url: image_url,
+                   upc: upc,
+                   unit_amount: unit_amount,
+                   tax: tax,
+                   commodity_code: commodity_code,
+                   discount_amount: discount_amount,
+                   total_amount: total_amount,
+                   unit_of_measure: unit_of_measure)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/link_description.rb

@@ -0,0 +1,75 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The request-related [HATEOAS link](/api/rest/responses/#hateoas-links)
+  # information.
+  class LinkDescription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The complete target URL. To make the related call, combine the method with
+    # this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link.
+    # For pre-processing, include the `$`, `(`, and `)` characters. The `href`
+    # is the key HATEOAS component that links a completed call with a subsequent
+    # call.
+    # @return [String]
+    attr_accessor :href
+
+    # The [link relation type](https://tools.ietf.org/html/rfc5988#section-4),
+    # which serves as an ID for a link that unambiguously describes the
+    # semantics of the link. See [Link
+    # Relations](https://www.iana.org/assignments/link-relations/link-relations.
+    # xhtml).
+    # @return [String]
+    attr_accessor :rel
+
+    # The HTTP method required to make the related call.
+    # @return [LinkHTTPMethod]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['rel'] = 'rel'
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href:, rel:, method: SKIP)
+      @href = href
+      @rel = rel
+      @method = method unless method == 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.
+      href = hash.key?('href') ? hash['href'] : nil
+      rel = hash.key?('rel') ? hash['rel'] : nil
+      method = hash.key?('method') ? hash['method'] : SKIP
+
+      # Create object from extracted values.
+      LinkDescription.new(href: href,
+                          rel: rel,
+                          method: method)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/link_http_method.rb

@@ -0,0 +1,41 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The HTTP method required to make the related call.
+  class LinkHTTPMethod
+    LINK_HTTP_METHOD = [
+      # TODO: Write general description for GET
+      GET = 'GET'.freeze,
+
+      # TODO: Write general description for POST
+      POST = 'POST'.freeze,
+
+      # TODO: Write general description for PUT
+      PUT = 'PUT'.freeze,
+
+      # TODO: Write general description for DELETE
+      DELETE = 'DELETE'.freeze,
+
+      # TODO: Write general description for HEAD
+      HEAD = 'HEAD'.freeze,
+
+      # TODO: Write general description for CONNECT
+      CONNECT = 'CONNECT'.freeze,
+
+      # TODO: Write general description for OPTIONS
+      OPTIONS = 'OPTIONS'.freeze,
+
+      # TODO: Write general description for PATCH
+      PATCH = 'PATCH'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end