square_connect 2.1.0.beta → 2.1.0.78

data/docs/CatalogCategory.md

@@ -0,0 +1,12 @@
+# SquareConnect::CatalogCategory
+
+### Description
+
+A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The category's name. Searchable. | 
+
+

data/docs/CatalogDiscount.md

@@ -0,0 +1,17 @@
+# SquareConnect::CatalogDiscount
+
+### Description
+
+A discount in the Catalog object model.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The discount's name. Searchable. | 
+**discount_type** | **String** | Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for all possible values. | [optional] 
+**percentage** | **String** | The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`.  Do not include this field for amount-based or variable discounts. | [optional] 
+**amount_money** | [**Money**](Money.md) | The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`.  Do not include this field for percentage-based or variable discounts. | [optional] 
+**pin_required** | **BOOLEAN** | Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app. | [optional] 
+**label_color** | **String** | The color of the discount's display label in the Square Point of Sale app. | [optional] 
+
+

data/docs/CatalogDiscountType.md

@@ -0,0 +1,15 @@
+# SquareConnect::CatalogDiscountType
+
+### Description
+
+How to apply a [CatalogDiscount](#type-catalogdiscount) to a [CatalogItem](#type-catalogitem).
+
+## Properties
+Name | Type
+------------ | -------------
+**FIXED_PERCENTAGE** | string
+**FIXED_AMOUNT** | string
+**VARIABLE_PERCENTAGE** | string
+**VARIABLE_AMOUNT** | string
+
+

data/docs/CatalogIdMapping.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogIdMapping
+
+### Description
+
+A mapping between a client-supplied temporary ID and a permanent server ID.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_object_id** | **String** | The client-supplied, temporary `#`-prefixed ID for a new [CatalogObject](#type-catalogobject). | [optional] 
+**object_id** | **String** | The permanent ID for the [CatalogObject](#type-catalogobject) created by the server. | [optional] 
+
+

data/docs/CatalogInfoRequest.md

@@ -0,0 +1,11 @@
+# SquareConnect::CatalogInfoRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/CatalogInfoResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogInfoResponse
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
+**limits** | [**CatalogInfoResponseLimits**](CatalogInfoResponseLimits.md) |  | [optional] 
+
+

data/docs/CatalogInfoResponseLimits.md

@@ -0,0 +1,22 @@
+# SquareConnect::CatalogInfoResponseLimits
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**batch_upsert_max_objects_per_batch** | **Integer** | The maximum number of objects that may appear within a single batch in a `/v2/catalog/batch-upsert` request. | [optional] 
+**batch_upsert_max_total_objects** | **Integer** | The maximum number of objects that may appear across all batches in a `/v2/catalog/batch-upsert` request. | [optional] 
+**batch_retrieve_max_object_ids** | **Integer** | The maximum number of object IDs that may appear in a `/v2/catalog/batch-retrieve` request. | [optional] 
+**search_max_page_limit** | **Integer** | The maximum number of results that may be returned in a page of a `/v2/catalog/search` response. | [optional] 
+**batch_delete_max_object_ids** | **Integer** | The maximum number of object IDs that may be included in a single `/v2/catalog/batch-delete` request. | [optional] 
+**update_item_taxes_max_item_ids** | **Integer** | The maximum number of item IDs that may be included in a single `/v2/catalog/update-item-taxes` request. | [optional] 
+**update_item_taxes_max_taxes_to_enable** | **Integer** | The maximum number of tax IDs to be enabled that may be included in a single `/v2/catalog/update-item-taxes` request. | [optional] 
+**update_item_taxes_max_taxes_to_disable** | **Integer** | The maximum number of tax IDs to be disabled that may be included in a single `/v2/catalog/update-item-taxes` request. | [optional] 
+**update_item_modifier_lists_max_item_ids** | **Integer** | The maximum number of item IDs that may be included in a single `/v2/catalog/update-item-modifier-lists` request. | [optional] 
+**update_item_modifier_lists_max_modifier_lists_to_enable** | **Integer** | The maximum number of modifier list IDs to be enabled that may be included in a single `/v2/catalog/update-item-modifier-lists` request. | [optional] 
+**update_item_modifier_lists_max_modifier_lists_to_disable** | **Integer** | The maximum number of modifier list IDs to be disabled that may be included in a single `/v2/catalog/update-item-modifier-lists` request. | [optional] 
+
+

data/docs/CatalogItem.md

@@ -0,0 +1,25 @@
+# SquareConnect::CatalogItem
+
+### Description
+
+An item (i.e., product family) in the Catalog object model.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The item's name. Searchable. | 
+**description** | **String** | The item's description. Searchable. | [optional] 
+**abbreviation** | **String** | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used.  Searchable. | [optional] 
+**label_color** | **String** | The color of the item's display label in the Square Point of Sale app.  Searchable. | [optional] 
+**available_online** | **BOOLEAN** | If `true`, the item can be added to shipping orders from the merchant's online store. | [optional] 
+**available_for_pickup** | **BOOLEAN** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional] 
+**available_electronically** | **BOOLEAN** | If `true`, the item can be added to electronically fulfilled orders from the merchant's online store. | [optional] 
+**category_id** | **String** | The ID of the item's category, if any. | [optional] 
+**tax_ids** | **Array<String>** | A set of IDs indicating the [CatalogTax](#type-catalogtax)es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. [CatalogTax](#type-catalogtax)es may also be added to or deleted from an item using `UpdateItemTaxes`. | [optional] 
+**modifier_list_info** | [**Array<CatalogItemModifierListInfo>**](CatalogItemModifierListInfo.md) | A set of [CatalogItemModifierListInfo](#type-catalogitemmodifierlistinfo) objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. [CatalogModifierList](#type-catalogmodifierlist)s may also be added to or deleted from an item using `UpdateItemModifierLists`. | [optional] 
+**image_url** | **String** | The URL of an image representing this item. | [optional] 
+**variations** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item. | [optional] 
+**product_type** | **String** | The product type of the item. May not be changed once an item has been created.  Only items of product type `REGULAR` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for all possible values. | [optional] 
+**skip_modifier_screen** | **BOOLEAN** | If `false`, the Square Point of Sale app will present the [CatalogItem](#type-catalogitem)'s details screen immediately, allowing the merchant to choose [CatalogModifier](#type-catalogmodifier)s before adding the item to the cart.  This is the default behavior.  If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details.  Third-party clients are encouraged to implement similar behaviors. | [optional] 
+
+

data/docs/CatalogItemModifierListInfo.md

@@ -0,0 +1,16 @@
+# SquareConnect::CatalogItemModifierListInfo
+
+### Description
+
+Controls the properties of a [CatalogModifierList](#type-catalogmodifierlist) as it applies to this [CatalogItem](#type-catalogitem).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**modifier_list_id** | **String** | The ID of the [CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo](#type-catalogmodifierlistinfo). | 
+**modifier_overrides** | [**Array<CatalogModifierOverride>**](CatalogModifierOverride.md) | A set of [CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier](#type-catalogmodifier) is enabled by default. | [optional] 
+**min_selected_modifiers** | **Integer** | If zero or larger, the smallest number of [CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList](#type-catalogmodifierlist). | [optional] 
+**max_selected_modifiers** | **Integer** | If zero or larger, the largest number of [CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList](#type-catalogmodifierlist). | [optional] 
+**enabled** | **BOOLEAN** | If `true`, enable this [CatalogModifierList](#type-catalogmodifierlist). | [optional] 
+
+

data/docs/CatalogItemProductType.md

@@ -0,0 +1,16 @@
+# SquareConnect::CatalogItemProductType
+
+### Description
+
+The type of a [CatalogItem](#type-catalogitem).
+
+## Properties
+Name | Type
+------------ | -------------
+**REGULAR** | string
+**GIFT_CARD** | string
+**APPOINTMENTS_SERVICE** | string
+**RETAIL_ITEM** | string
+**RESTAURANT_ITEM** | string
+
+

data/docs/CatalogItemVariation.md

@@ -0,0 +1,23 @@
+# SquareConnect::CatalogItemVariation
+
+### Description
+
+An item variation (i.e., product) in the Catalog object model.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_id** | **String** | The ID of the [CatalogItem](#type-catalogitem) associated with this item variation. Searchable. | [optional] 
+**name** | **String** | The item variation's name. Searchable. | [optional] 
+**sku** | **String** | The item variation's SKU, if any. Searchable. | [optional] 
+**upc** | **String** | The item variation's UPC, if any. Searchable. | [optional] 
+**pricing_type** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for all possible values. | [optional] 
+**price_money** | [**Money**](Money.md) | The item variation's price, if fixed pricing is used. | [optional] 
+**location_overrides** | [**Array<ItemVariationLocationOverrides>**](ItemVariationLocationOverrides.md) | Per-location price and inventory overrides. | [optional] 
+**track_inventory** | **BOOLEAN** | If `true`, inventory tracking is active for the variation. | [optional] 
+**inventory_alert_type** | **String** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values. | [optional] 
+**inventory_alert_threshold** | **Integer** | 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. | [optional] 
+**user_data** | **String** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional] 
+**service_duration** | **Integer** | If the [CatalogItem](#type-catalogitem) that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional] 
+
+

data/docs/CatalogModifier.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogModifier
+
+### Description
+
+A modifier in the Catalog object model.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The modifier's name. Searchable. | 
+**price_money** | [**Money**](Money.md) | The modifier's price. | [optional] 
+
+

data/docs/CatalogModifierList.md

@@ -0,0 +1,14 @@
+# SquareConnect::CatalogModifierList
+
+### Description
+
+A modifier list in the Catalog object model. A [CatalogModifierList](#type-catalogmodifierlist) contains [Modifier](#type-catalogmodifier)s that can be applied to a [CatalogItem](#type-catalogitem) at the time of sale.  For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" [CatalogItem](#type-catalogitem) might contain [CatalogModifier](#type-catalogmodifier)s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. | 
+**selection_type** | **String** | Indicates whether multiple options from the [CatalogModifierList](#type-catalogmodifierlist) can be applied to a single [CatalogItem](#type-catalogitem). See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for all possible values. | [optional] 
+**modifiers** | [**Array<CatalogObject>**](CatalogObject.md) | The options included in the [CatalogModifierList](#type-catalogmodifierlist). You must include at least one [CatalogModifier](#type-catalogmodifier). Each [CatalogObject](#type-catalogobject) must have type `MODIFIER` and contain [CatalogModifier](#type-catalogmodifier) data. | [optional] 
+
+

data/docs/CatalogModifierListSelectionType.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogModifierListSelectionType
+
+### Description
+
+Indicates whether a [CatalogModifierList](#type-catalogmodifierlist) supports multiple selections.
+
+## Properties
+Name | Type
+------------ | -------------
+**SINGLE** | string
+**MULTIPLE** | string
+
+

data/docs/CatalogModifierOverride.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogModifierOverride
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**modifier_id** | **String** | The ID of the [CatalogModifier](#type-catalogmodifier) whose default behavior is being overridden. | 
+**on_by_default** | **BOOLEAN** | If `true`, this [CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem](#type-catalogitem). | [optional] 
+
+

data/docs/CatalogObject.md

@@ -0,0 +1,27 @@
+# SquareConnect::CatalogObject
+
+### Description
+
+The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set.  - if type = `ITEM`, only `item_data` will be populated and it will contain a valid [CatalogItem](#type-catalogitem) object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid [CatalogItemVariation](#type-catalogitemvariation) object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid [CatalogModifier](#type-catalogmodifier) object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid [CatalogModifierList](#type-catalogmodifierlist) object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid [CatalogCategory](#type-catalogcategory) object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid [CatalogDiscount](#type-catalogdiscount) object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid [CatalogTax](#type-catalogtax) object.  For a more detailed discussion of the Catalog data model, please see the [Catalog Overview](https://docs.connect.squareup.com/articles/catalog-overview).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below.  See [CatalogObjectType](#type-catalogobjecttype) for all possible values. | 
+**id** | **String** | A unique Square-assigned identifier to reference this object in the catalog. | 
+**updated_at** | **String** | Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional] 
+**version** | **Integer** | The version of the object. When updating an object, the version supplied by the must match the version in the database, otherwise the write will be rejected as conflicting. | [optional] 
+**is_deleted** | **BOOLEAN** | If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional] 
+**catalog_v1_ids** | [**Array<CatalogV1Id>**](CatalogV1Id.md) | The Connect V1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional] 
+**present_at_all_locations** | **BOOLEAN** | If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. | [optional] 
+**present_at_location_ids** | **Array<String>** | A list of locations where the object is present, even if `present_at_all_locations` is `false`. | [optional] 
+**absent_at_location_ids** | **Array<String>** | A list of locations where the object is not present, even if `present_at_all_locations` is `true`. | [optional] 
+**item_data** | [**CatalogItem**](CatalogItem.md) | Structured data for a [CatalogItem](#type-catalogitem), set for CatalogObjects of type `ITEM`. | [optional] 
+**category_data** | [**CatalogCategory**](CatalogCategory.md) | Structured data for a [CatalogCategory](#type-catalogcategory), set for CatalogObjects of type `CATEGORY`. | [optional] 
+**item_variation_data** | [**CatalogItemVariation**](CatalogItemVariation.md) | Structured data for a [CatalogItemVariation](#type-catalogitemvariation), set for CatalogObjects of type `ITEM_VARIATION`. | [optional] 
+**tax_data** | [**CatalogTax**](CatalogTax.md) | Structured data for a [CatalogTax](#type-catalogtax), set for CatalogObjects of type `TAX`. | [optional] 
+**discount_data** | [**CatalogDiscount**](CatalogDiscount.md) | Structured data for a [CatalogDiscount](#type-catalogdiscount), set for CatalogObjects of type `DISCOUNT`. | [optional] 
+**modifier_list_data** | [**CatalogModifierList**](CatalogModifierList.md) | Structured data for a [CatalogModifierList](#type-catalogmodifierlist), set for CatalogObjects of type `MODIFIER_LIST`. | [optional] 
+**modifier_data** | [**CatalogModifier**](CatalogModifier.md) | Structured data for a [CatalogModifier](#type-catalogmodifier), set for CatalogObjects of type `MODIFIER`. | [optional] 
+
+

data/docs/CatalogObjectBatch.md

@@ -0,0 +1,12 @@
+# SquareConnect::CatalogObjectBatch
+
+### Description
+
+A batch of [CatalogObject](#type-catalogobject)s.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s belonging to this batch. | [optional] 
+
+

data/docs/CatalogObjectType.md

@@ -0,0 +1,18 @@
+# SquareConnect::CatalogObjectType
+
+### Description
+
+Possible kinds of [CatalogObject](#type-catalogobject)s returned from the Catalog, each contaning type-specific properties in the `*_data` field corresponding to the object type.
+
+## Properties
+Name | Type
+------------ | -------------
+**ITEM** | string
+**CATEGORY** | string
+**ITEM_VARIATION** | string
+**TAX** | string
+**DISCOUNT** | string
+**MODIFIER_LIST** | string
+**MODIFIER** | string
+
+

data/docs/CatalogPricingType.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogPricingType
+
+### Description
+
+Indicates whether the price of a [CatalogItemVariation](#type-catalogitemvariation) should be entered manually at the time of sale.
+
+## Properties
+Name | Type
+------------ | -------------
+**FIXED_PRICING** | string
+**VARIABLE_PRICING** | string
+
+

data/docs/CatalogQuery.md

@@ -0,0 +1,18 @@
+# SquareConnect::CatalogQuery
+
+### Description
+
+A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest) request. Only one query field may be present.  Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), or [CatalogModifier](#type-catalogmodifier)).  For example, a query that should return Items may specify an attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sorted_attribute_query** | [**CatalogQuerySortedAttribute**](CatalogQuerySortedAttribute.md) | A query that returns all objects, sorted by the given attribute. | [optional] 
+**exact_query** | [**CatalogQueryExact**](CatalogQueryExact.md) | A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value. | [optional] 
+**prefix_query** | [**CatalogQueryPrefix**](CatalogQueryPrefix.md) | A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix. | [optional] 
+**range_query** | [**CatalogQueryRange**](CatalogQueryRange.md) | A query that returns only objects for which the given (integer-valued) attribute lies in the given range. | [optional] 
+**text_query** | [**CatalogQueryText**](CatalogQueryText.md) | A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Red\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sm\", \"re\"]}`. | [optional] 
+**items_for_tax_query** | [**CatalogQueryItemsForTax**](CatalogQueryItemsForTax.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax](#type-catalogtax)es enabled. | [optional] 
+**items_for_modifier_list_query** | [**CatalogQueryItemsForModifierList**](CatalogQueryItemsForModifierList.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList](#type-catalogmodifierlist)s enabled. | [optional] 
+
+

data/docs/CatalogQueryExact.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogQueryExact
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute_name** | **String** | The name of the attribute to be searched. | 
+**attribute_value** | **String** | The desired value of the search attribute. | 
+
+

data/docs/CatalogQueryItemsForModifierList.md

@@ -0,0 +1,12 @@
+# SquareConnect::CatalogQueryItemsForModifierList
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**modifier_list_ids** | **Array<String>** | A set of [CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. | 
+
+

data/docs/CatalogQueryItemsForTax.md

@@ -0,0 +1,12 @@
+# SquareConnect::CatalogQueryItemsForTax
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tax_ids** | **Array<String>** | A set of [CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. | 
+
+

data/docs/CatalogQueryPrefix.md

@@ -0,0 +1,13 @@
+# SquareConnect::CatalogQueryPrefix
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute_name** | **String** | The name of the attribute to be searched. | 
+**attribute_prefix** | **String** | The desired prefix of the search attribute value. | 
+
+

data/docs/CatalogQueryRange.md

@@ -0,0 +1,14 @@
+# SquareConnect::CatalogQueryRange
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute_name** | **String** | The name of the attribute to be searched. | 
+**attribute_min_value** | **Integer** | The desired minimum value for the search attribute (inclusive). | [optional] 
+**attribute_max_value** | **Integer** | The desired maximum value for the search attribute (inclusive). | [optional] 
+
+

data/docs/CatalogQuerySortedAttribute.md

@@ -0,0 +1,14 @@
+# SquareConnect::CatalogQuerySortedAttribute
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute_name** | **String** | The attribute whose value should be used as the sort key. | 
+**initial_attribute_value** | **String** | The first attribute value to be returned by the query. Ascending sorts will return only objects with this value or greater, while descending sorts will return only objects with this value or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts). | [optional] 
+**sort_order** | **String** | The desired [SortOrder](#type-sortorder), `\"ASC\"` (ascending) or `\"DESC\"` (descending). | [optional] 
+
+