square_connect 2.20190410.1.300 → 2.20190508.0.304

data/lib/square_connect/models/order_entry.rb

@@ -0,0 +1,196 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module SquareConnect
+  # A lightweight description of an [Order](#type-order) that is returned when `returned_entries` is true on a [SearchOrderRequest](#type-searchorderrequest)
+  class OrderEntry
+    # The id of the Order
+    attr_accessor :order_id
+
+    # The location id the Order belongs to.
+    attr_accessor :location_id
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'order_id' => :'order_id',
+        :'location_id' => :'location_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'order_id' => :'String',
+        :'location_id' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.has_key?(:'location_id')
+        self.location_id = attributes[:'location_id']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          order_id == o.order_id &&
+          location_id == o.location_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [order_id, location_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = SquareConnect.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/square_connect/models/order_line_item.rb

@@ -12,12 +12,18 @@ require 'date'
 module SquareConnect
   # Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.
   class OrderLineItem
+    # The line item's Unique identifier, unique only within this order. This field is read-only.
+    attr_accessor :uid
+
     # The name of the line item.
     attr_accessor :name
 
-    # The quantity purchased, as a string representation of a number.  This string must have a positive integer value.
+    # The quantity purchased, formatted as a decimal number. For example: `\"3\"`.  Line items with a `quantity_unit` can have non-integer quantities. For example: `\"1.70000\"`.  Orders Hub and older versions of Connect do not support non-integer quantities. See [Decimal quantities with Orders hub and older versions of Connect](/more-apis/orders/overview#decimal-quantities).
     attr_accessor :quantity
 
+    # The unit and precision that this line item's quantity is measured in.
+    attr_accessor :quantity_unit
+
     # The note of the line item.
     attr_accessor :note
 
@@ -39,7 +45,10 @@ module SquareConnect
     # The base price for a single unit of the line item.
     attr_accessor :base_price_money
 
-    # The gross sales amount of money calculated as (item base price + modifiers price) * quantity.
+    # The total price of all item variations sold in this line item. Calculated as `base_price_money` multiplied by `quantity`. Does not include modifiers.
+    attr_accessor :variation_total_price_money
+
+    # The amount of money made in gross sales for this line item. Calculated as the sum of the variation's total price and each modifier's total price.
     attr_accessor :gross_sales_money
 
     # The total tax amount of money to collect for the line item.
@@ -55,8 +64,10 @@ module SquareConnect
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'uid' => :'uid',
         :'name' => :'name',
         :'quantity' => :'quantity',
+        :'quantity_unit' => :'quantity_unit',
         :'note' => :'note',
         :'catalog_object_id' => :'catalog_object_id',
         :'variation_name' => :'variation_name',
@@ -64,6 +75,7 @@ module SquareConnect
         :'taxes' => :'taxes',
         :'discounts' => :'discounts',
         :'base_price_money' => :'base_price_money',
+        :'variation_total_price_money' => :'variation_total_price_money',
         :'gross_sales_money' => :'gross_sales_money',
         :'total_tax_money' => :'total_tax_money',
         :'total_discount_money' => :'total_discount_money',
@@ -74,8 +86,10 @@ module SquareConnect
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'uid' => :'String',
         :'name' => :'String',
         :'quantity' => :'String',
+        :'quantity_unit' => :'OrderQuantityUnit',
         :'note' => :'String',
         :'catalog_object_id' => :'String',
         :'variation_name' => :'String',
@@ -83,6 +97,7 @@ module SquareConnect
         :'taxes' => :'Array<OrderLineItemTax>',
         :'discounts' => :'Array<OrderLineItemDiscount>',
         :'base_price_money' => :'Money',
+        :'variation_total_price_money' => :'Money',
         :'gross_sales_money' => :'Money',
         :'total_tax_money' => :'Money',
         :'total_discount_money' => :'Money',
@@ -98,6 +113,10 @@ module SquareConnect
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
+      if attributes.has_key?(:'uid')
+        self.uid = attributes[:'uid']
+      end
+
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
@@ -106,6 +125,10 @@ module SquareConnect
         self.quantity = attributes[:'quantity']
       end
 
+      if attributes.has_key?(:'quantity_unit')
+        self.quantity_unit = attributes[:'quantity_unit']
+      end
+
       if attributes.has_key?(:'note')
         self.note = attributes[:'note']
       end
@@ -140,6 +163,10 @@ module SquareConnect
         self.base_price_money = attributes[:'base_price_money']
       end
 
+      if attributes.has_key?(:'variation_total_price_money')
+        self.variation_total_price_money = attributes[:'variation_total_price_money']
+      end
+
       if attributes.has_key?(:'gross_sales_money')
         self.gross_sales_money = attributes[:'gross_sales_money']
       end
@@ -162,6 +189,10 @@ module SquareConnect
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@uid.nil? && @uid.to_s.length > 60
+        invalid_properties.push("invalid value for 'uid', the character length must be smaller than or equal to 60.")
+      end
+
       if !@name.nil? && @name.to_s.length > 500
         invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 500.")
       end
@@ -170,8 +201,8 @@ module SquareConnect
         invalid_properties.push("invalid value for 'quantity', quantity cannot be nil.")
       end
 
-      if @quantity.to_s.length > 5
-        invalid_properties.push("invalid value for 'quantity', the character length must be smaller than or equal to 5.")
+      if @quantity.to_s.length > 12
+        invalid_properties.push("invalid value for 'quantity', the character length must be smaller than or equal to 12.")
       end
 
       if @quantity.to_s.length < 1
@@ -196,9 +227,10 @@ module SquareConnect
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@uid.nil? && @uid.to_s.length > 60
       return false if !@name.nil? && @name.to_s.length > 500
       return false if @quantity.nil?
-      return false if @quantity.to_s.length > 5
+      return false if @quantity.to_s.length > 12
       return false if @quantity.to_s.length < 1
       return false if !@note.nil? && @note.to_s.length > 500
       return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
@@ -206,6 +238,17 @@ module SquareConnect
       return true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] uid Value to be assigned
+    def uid=(uid)
+
+      if !uid.nil? && uid.to_s.length > 60
+        fail ArgumentError, "invalid value for 'uid', the character length must be smaller than or equal to 60."
+      end
+
+      @uid = uid
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] name Value to be assigned
     def name=(name)
@@ -224,8 +267,8 @@ module SquareConnect
         fail ArgumentError, "quantity cannot be nil"
       end
 
-      if quantity.to_s.length > 5
-        fail ArgumentError, "invalid value for 'quantity', the character length must be smaller than or equal to 5."
+      if quantity.to_s.length > 12
+        fail ArgumentError, "invalid value for 'quantity', the character length must be smaller than or equal to 12."
       end
 
       if quantity.to_s.length < 1
@@ -273,8 +316,10 @@ module SquareConnect
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          uid == o.uid &&
           name == o.name &&
           quantity == o.quantity &&
+          quantity_unit == o.quantity_unit &&
           note == o.note &&
           catalog_object_id == o.catalog_object_id &&
           variation_name == o.variation_name &&
@@ -282,6 +327,7 @@ module SquareConnect
           taxes == o.taxes &&
           discounts == o.discounts &&
           base_price_money == o.base_price_money &&
+          variation_total_price_money == o.variation_total_price_money &&
           gross_sales_money == o.gross_sales_money &&
           total_tax_money == o.total_tax_money &&
           total_discount_money == o.total_discount_money &&
@@ -297,7 +343,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, quantity, note, catalog_object_id, variation_name, modifiers, taxes, discounts, base_price_money, gross_sales_money, total_tax_money, total_discount_money, total_money].hash
+      [uid, name, quantity, quantity_unit, note, catalog_object_id, variation_name, modifiers, taxes, discounts, base_price_money, variation_total_price_money, gross_sales_money, total_tax_money, total_discount_money, total_money].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/models/order_line_item_discount.rb

@@ -12,6 +12,9 @@ require 'date'
 module SquareConnect
   # Represents a discount that applies to one or more line items in an order.  Fixed-amount, order-level discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to that item’s contribution to the order subtotal.
   class OrderLineItemDiscount
+    # The discount's Unique identifier, unique only within this order. This field is read-only.
+    attr_accessor :uid
+
     # The catalog object id referencing [CatalogDiscount](#type-catalogdiscount).
     attr_accessor :catalog_object_id
 
@@ -21,7 +24,7 @@ module SquareConnect
     # The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`.  VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values
     attr_accessor :type
 
-    # The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%.  The percentage won't be set for an amount-based discount.
+    # The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%.  The percentage won't be set for an amount-based discount.
     attr_accessor :percentage
 
     # The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount.  The amount_money won't be set for a percentage-based discount.
@@ -58,6 +61,7 @@ module SquareConnect
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'uid' => :'uid',
         :'catalog_object_id' => :'catalog_object_id',
         :'name' => :'name',
         :'type' => :'type',
@@ -71,6 +75,7 @@ module SquareConnect
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'uid' => :'String',
         :'catalog_object_id' => :'String',
         :'name' => :'String',
         :'type' => :'String',
@@ -89,6 +94,10 @@ module SquareConnect
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
+      if attributes.has_key?(:'uid')
+        self.uid = attributes[:'uid']
+      end
+
       if attributes.has_key?(:'catalog_object_id')
         self.catalog_object_id = attributes[:'catalog_object_id']
       end
@@ -123,6 +132,10 @@ module SquareConnect
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@uid.nil? && @uid.to_s.length > 60
+        invalid_properties.push("invalid value for 'uid', the character length must be smaller than or equal to 60.")
+      end
+
       if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
         invalid_properties.push("invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192.")
       end
@@ -141,6 +154,7 @@ module SquareConnect
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@uid.nil? && @uid.to_s.length > 60
       return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
       return false if !@name.nil? && @name.to_s.length > 255
       type_validator = EnumAttributeValidator.new('String', ["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"])
@@ -151,6 +165,17 @@ module SquareConnect
       return true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] uid Value to be assigned
+    def uid=(uid)
+
+      if !uid.nil? && uid.to_s.length > 60
+        fail ArgumentError, "invalid value for 'uid', the character length must be smaller than or equal to 60."
+      end
+
+      @uid = uid
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] catalog_object_id Value to be assigned
     def catalog_object_id=(catalog_object_id)
@@ -209,6 +234,7 @@ module SquareConnect
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          uid == o.uid &&
           catalog_object_id == o.catalog_object_id &&
           name == o.name &&
           type == o.type &&
@@ -227,7 +253,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [catalog_object_id, name, type, percentage, amount_money, applied_money, scope].hash
+      [uid, catalog_object_id, name, type, percentage, amount_money, applied_money, scope].hash
     end
 
     # Builds the object from hash