square-ruby 0.1.0

data/lib/square/data_types/item_image.rb

@@ -0,0 +1,12 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-itemimage
+    class ItemImage < Square::DataType
+      # The image's unique ID.
+      property :id
+
+      # The image's publicly accessible URL.
+      property :url
+    end
+  end
+end

data/lib/square/data_types/item_variation.rb

@@ -0,0 +1,49 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-itemvariation
+    class ItemVariation < DataType
+      # The item variation's unique ID.
+      property :id
+
+      # The item variation's name.
+      property :name
+
+      # The ID of the variation's associated item.
+      property :item_id
+
+      # Indicates the variation's list position when displayed in Square
+      # Register and the merchant dashboard. If more than one variation for
+      # the same item has the same ordinal value, those variations are
+      # displayed in alphabetical order.
+      # An item's variation with the lowest ordinal value is displayed first.
+      property :ordinal # number
+
+      # Indicates whether the item variation's price is fixed or determined at
+      # the time of sale.
+      property :pricing_type # ItemVariation.PricingType
+
+      # The item variation's price, if any.
+      property :price_money, coerce: Square::DataTypes::Money
+
+      # The item variation's SKU, if any.
+      property :sku
+
+      # If true, inventory tracking is active for the variation.
+      property :track_inventory # boolean
+
+      # Indicates whether the item variation displays an alert when its
+      # inventory quantity is less than or equal to its
+      # inventory_alert_threshold.
+      property :inventory_alert_type # InventoryAlertType
+
+      # If the inventory quantity for the variation is less than or equal to
+      # this value and inventory_alert_type is LOW_QUANTITY, the variation
+      # displays an alert in the merchant dashboard.
+      # This value is always an integer.
+      property :inventory_alert_threshold # number
+
+      # Arbitrary metadata associated with the variation. Cannot exceed 255 characters.
+      property :user_data
+    end
+  end
+end

data/lib/square/data_types/merchant.rb

@@ -0,0 +1,61 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-merchant
+    class Merchant < Square::DataType
+      # The merchant account's unique identifier.
+      property :id
+
+      # The name associated with the merchant account.
+      property :name
+
+      # The email address associated with the merchant account.
+      property :email
+
+      # Indicates whether the merchant account corresponds to a single-location
+      # account (LOCATION) or a business account (BUSINESS). This value is
+      # almost always LOCATION. See Multi-Location Overview for more
+      # information.
+      property :account_type # Merchant.AccountType
+
+      # Capabilities that are enabled for the merchant's Square account.
+      # Capabilities that are not listed in this array are not enabled for
+      # the account. Currently there is only one capability,
+      # CREDIT_CARD_PROCESSING.
+      property :account_capabilities, coerce: Array[String] # Merchant.AccountCapability[]
+
+      # The country associated with the merchant account, in
+      # ISO 3166-1-alpha-2 format.
+      property :country_code
+
+      # The language associated with the merchant account, in BCP 47 format.
+      property :language_code
+
+      # The currency associated with the merchant account, in ISO 4217 format.
+      # For example, the currency code for US dollars is USD.
+      property :currency_code
+
+      # The name of the merchant's business.
+      property :business_name
+
+      # The address of the merchant's business.
+      property :business_address, coerce: Square::DataTypes::GlobalAddress
+
+      # The phone number of the merchant's business.
+      property :business_phone, coerce: Square::DataTypes::PhoneNumber
+
+      # The type of business operated by the merchant.
+      property :business_type # Merchant.BusinessType
+
+      # The merchant's shipping address.
+      property :shipping_address, coerce: Square::DataTypes::GlobalAddress
+
+      # Additional information for a single-location account specified by its
+      # associated business account, if it has one.
+      # Never included in Merchant objects with the account_typeBUSINESS.
+      property :location_details, coerce: Square::DataTypes::MerchantLocationDetails
+
+      # The URL of the merchant's online store.
+      property :market_url
+    end
+  end
+end

data/lib/square/data_types/merchant_location_details.rb

@@ -0,0 +1,11 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-merchantlocationdetails
+    class MerchantLocationDetails < Square::DataType
+      # The nickname assigned to the single-location account by the parent
+      # business. This value appears in the parent business's multi-location
+      # dashboard.
+      property :nickname
+    end
+  end
+end

data/lib/square/data_types/modifier_list.rb

@@ -0,0 +1,19 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-modifierlist
+    class ModifierList < Square::DataType
+      # The modifier list's unique ID.
+      property :id
+
+      # The modifier list's name.
+      property :name
+
+      # Indicates whether MULTIPLE options or a SINGLE option from the
+      # modifier list can be applied to a single item.
+      property :selection_type # ModifierList.SelectionType
+
+      # The options included in the modifier list.
+      property :modifier_options#, coerce: Array[Square::DataTypes::ModifierOption]
+    end
+  end
+end

data/lib/square/data_types/modifier_option.rb

@@ -0,0 +1,30 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-modifieroption
+    class ModifierOption < Square::DataType
+      # The modifier option's unique ID.
+      property :id
+
+      # The modifier option's name.
+      property :name
+
+      # The modifier option's price.
+      property :price_money, coerce: Square::DataTypes::Money
+
+      # If true, the modifier option is the default option in a modifier
+      # list for which selection_type is SINGLE.
+      property :on_by_default # boolean
+
+      # Indicates the modifier option's list position when displayed in
+      # Square Register and the merchant dashboard. If more than one
+      # modifier option in the same modifier list has the same ordinal
+      # value, those options are displayed in alphabetical order.
+      # A modifier list's option with the lowest ordinal value is
+      # displayed first.
+      property :ordinal # number
+
+      # The ID of the modifier list the option belongs to.
+      property :modifier_list_id
+    end
+  end
+end

data/lib/square/data_types/money.rb

@@ -0,0 +1,40 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-money
+    class Money < Square::DataType
+      # The amount of money, in the smallest unit of the applicable currency.
+      # For US dollars, this value is in cents.
+      property :amount
+
+      # The type of currency involved in the current payment, in ISO 4217 format.
+      # For example, the currency code for US dollars is USD.
+      property :currency_code
+
+      # Initialize.
+      #
+      # @param [Hash] Hash of amount and currency_code.
+      #
+      # You can also pass in the amount and currency code as separate arguments.
+      #
+      # Example
+      #
+      #  a = Square::DataTypes::Money.new(1)
+      #  b = Square::DataTypes::Money.new({amount: 1, currency_code: 'USD'})
+      #  a == b
+      #  #=> true
+      #
+      # @return [Square::DataTypes::Money]
+      def initialize(*args)
+        if args.count == 1 && args.first.is_a?(Hash)
+          data = args.first
+        else
+          # Should this really even have a default?
+          code = args[1] || 'USD'
+          data = {amount: args[0], currency_code: code}
+        end
+
+        super(data)
+      end
+    end
+  end
+end

data/lib/square/data_types/payment.rb

@@ -0,0 +1,87 @@
+module Square
+  module DataTypes
+    class Payment < Square::DataType
+      # The payment's unique identifier.
+      property :id
+
+      # The unique identifier of the merchant that took the payment.
+      property :merchant_id
+
+      # The time when the payment was created, in ISO 8601 format.
+      property :created_at
+
+      # The unique identifier of the Square account that took the payment.
+      # This value can differ from merchant_id if the merchant has mobile staff.
+      property :creator_id
+
+      # The device that took the payment.
+      property :device, coerce: Square::DataTypes::Device
+
+      # The URL of the payment's detail page in the merchant dashboard.
+      # The merchant must be signed in to the merchant dashboard to view
+      # this page.
+      property :payment_url
+
+      # The URL of the receipt for the payment.
+      # Note that for split tender payments, this URL corresponds to the receipt
+      # for the first tender listed in the payment's tender field. Each
+      # Tender object has its own receipt_url field you can use to get the
+      # other receipts associated with a split tender payment.
+      property :receipt_url
+
+      # The sum of all inclusive taxes associated with the payment.
+      property :inclusive_tax_money, coerce: Square::DataTypes::Money
+
+      # The sum of all additive taxes associated with the payment.
+      property :additive_tax_money, coerce: Square::DataTypes::Money
+
+      # The total of all taxes applied to the payment.
+      # This is always the sum of inclusive_tax_money and additive_tax_money.
+      property :tax_money, coerce: Square::DataTypes::Money
+
+      # The total of all tips applied to the payment.
+      property :tip_money, coerce: Square::DataTypes::Money
+
+      # The total of all discounts applied to the payment.
+      # This value is always 0 or negative.
+      property :discount_money, coerce: Square::DataTypes::Money
+
+      # The total amount of money collected from the buyer for the payment.
+      property :total_collected_money, coerce: Square::DataTypes::Money
+
+      # The total of all processing fees collected by Square for the payment.
+      # This value is always 0 or negative.
+      property :processing_fee_money, coerce: Square::DataTypes::Money
+
+      # The amount to be deposited into the merchant's bank account for
+      # the payment.
+      # This is always the sum of total_collected_money and processing_fee_money
+      # (note that processing_fee_money is always negative or 0).
+      property :net_total_money, coerce: Square::DataTypes::Money
+
+      # The total of all refunds applied to the payment.
+      property :refunded_money, coerce: Square::DataTypes::Money
+
+      # All of the inclusive taxes associated with the payment.
+      property :inclusive_tax, coerce: Array[Square::DataTypes::PaymentTax]
+
+      # All of the additive taxes associated with the payment.
+      property :additive_tax, coerce: Array[Square::DataTypes::PaymentTax]
+
+      # The form(s) of tender provided by the buyer for the payment.
+      property :tender, coerce: Array[Square::DataTypes::Tender]
+
+      # All of the refunds applied to the payment.
+      property :refunds, coerce: Array[Square::DataTypes::Refund]
+
+      # The items purchased in the payment.
+      property :itemizations, coerce: Array[Square::DataTypes::PaymentItemization]
+
+      # undocumented
+      property :gross_sales_money
+      property :swedish_rounding_money
+      property :net_sales_money
+      property :extensions
+    end
+  end
+end

data/lib/square/data_types/payment_discount.rb

@@ -0,0 +1,17 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-paymentdiscount
+    class PaymentDiscount < DataType
+      # The discount's name.
+      property :name
+
+      # The amount of money that this discount adds to the payment (note that
+      # this value is always negative or zero).
+      property :applied_money, coerce: Square::DataTypes::Money
+
+      # The ID of the applied discount, if available. Discounts applied in older
+      # versions of Square Register might not have an ID.
+      property :discount_id
+    end
+  end
+end

data/lib/square/data_types/payment_item_detail.rb

@@ -0,0 +1,18 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-paymentitemdetail
+    class PaymentItemDetail < DataType
+      # The name of the item's merchant-defined category, if any.
+      property :category_name
+
+      # The item's merchant-defined SKU, if any.
+      property :sku
+
+      # The unique ID of the item purchased, if any.
+      property :item_id
+
+      # The unique ID of the item variation purchased, if any.
+      property :item_variation_id
+    end
+  end
+end

data/lib/square/data_types/payment_itemization.rb

@@ -0,0 +1,53 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-paymentitemization
+    class PaymentItemization < DataType
+      # The item's name.
+      property :name
+
+      # The quantity of the item purchased. This can be a decimal value.
+      property :quantity, coerce: Integer
+
+      # The type of purchase that the itemization represents,
+      # such as an ITEM or CUSTOM_AMOUNT.
+      property :itemization_type # PaymentItemization.Type
+
+      # Details of the item, including its unique identifier and the identifier
+      # of the item variation purchased.
+      property :item_detail, coerce: Square::DataTypes::PaymentItemDetail
+
+      # Notes entered by the merchant about the item at the time of payment,
+      # if any.
+      property :notes
+
+      # The name of the item variation purchased, if any.
+      property :item_variation_name
+
+      # The total cost of the item, including all taxes and discounts.
+      property :total_money, coerce: Square::DataTypes::Money
+
+      # The cost of a single unit of this item.
+      property :single_quantity_money, coerce: Square::DataTypes::Money
+
+      # The total cost of the itemization and its modifiers, not including
+      # taxes or discounts.
+      property :gross_sales_money, coerce: Square::DataTypes::Money
+
+      # The total of all discounts applied to the itemization. This value is
+      # always negative or zero.
+      property :discount_money, coerce: Square::DataTypes::Money
+
+      # The sum of gross_sales_money and discount_money.
+      property :net_sales_money, coerce: Square::DataTypes::Money
+
+      # All taxes applied to this itemization.
+      property :taxes, coerce: Array[Square::DataTypes::PaymentTax]
+
+      # All discounts applied to this itemization.
+      property :discounts, coerce: Array[Square::DataTypes::PaymentDiscount]
+
+      # All modifier options applied to this itemization.
+      property :modifiers, coerce: Array[Square::DataTypes::PaymentModifier]
+    end
+  end
+end

data/lib/square/data_types/payment_modifier.rb

@@ -0,0 +1,16 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-paymentmodifier
+    class PaymentModifier < DataType
+      # The modifier option's name.
+      property :name
+
+      # The amount of money that this modifier option adds to the payment.
+      property :applied_money, coerce: Square::DataTypes::Money
+
+      # The ID of the applied modifier option, if available. Modifier options
+      # applied in older versions of Square Register might not have an ID.
+      property :modifier_option_id
+    end
+  end
+end

data/lib/square/data_types/payment_tax.rb

@@ -0,0 +1,23 @@
+module Square
+  module DataTypes
+    # https://docs.connect.squareup.com/api/connect/v1/#datatype-paymenttax
+    class PaymentTax < DataType
+      # The merchant-defined name of the tax.
+      property :name
+
+      # The amount of money that this tax adds to the payment.
+      property :applied_money, coerce: Square::DataTypes::Money
+
+      # The rate of the tax, as a string representation of a decimal number.
+      # A value of 0.07 corresponds to a rate of 7%.
+      property :rate
+
+      # Whether the tax is an ADDITIVE tax or an INCLUSIVE tax.
+      property :inclusion_type # Fee.InclusionType
+
+      # The ID of the tax, if available. Taxes applied in older versions of
+      # Square Register might not have an ID.
+      property :fee_id
+    end
+  end
+end