square_connect 2.20190313.1.282 → 2.20190327.1.292

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3689385935f53e88001e5703fabc163acf179b9987ef368dd4a8e24bd14b12dd
-  data.tar.gz: d40e27bb75a3e67327026f6c57d3a5fb746f75dc7c59771063c8d1ffd05c7fa5
+  metadata.gz: 55251cb61c1c32ec5901e4ea808bb3804558448bdede3d92bffc36ec2c33c10a
+  data.tar.gz: c6a40b10f08c6536568bec779597f127487f83790f78a29f6e84ea2138cc415d
 SHA512:
-  metadata.gz: 0db81d307b556a942c5a7b0c4b80b38e8b4b5508a43f8604108f4560763b796b1c9aeeb034488cb446b361da65cc25c9a9e949bb336b84ab43223d6555885a2b
-  data.tar.gz: 0ec9266c61d630612539eb7fa0bba24b7c6247c27d195598550d8643e8a33ca6dcd7749500ebc607af04a1ee00e5a6d69b919299402d7bf02ce0dc3d9d39e16c
+  metadata.gz: eb94fd041a4c647dc8d941838efad8f5a96edb91f5549f020dda10b604349a6cb63677699331c01167e075dee824beb81f17ad2372c75684fab2eae55b03a002
+  data.tar.gz: 5f2dd118b355caccc119feb04dff476a7d00705d42580992b18b857e81997f6c60c68f3bb1fd75824e46503915a224c2cd9b0983f2557007c534395f960caaab

data/CHANGES.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## Version 2.20190327.1 (2019-03-29)
+
+## Bug Fix: Catalog API
+* Add `image_id` to `CatalogObject`
+
+## Version 2.20190327.0 (2019-03-27)
+
+## New features: Catalog API
+* Deprecated `image_url` field in `CatalogItem` in favor of a richer
+  `CatalogImage` data type.
+* Image information is now set, and returned, at the `CatalogObject` level.
+
 ## Version 2.20190313.1 (2019-03-21)
 
 ### Bug Fix: Connect v1

data/README.md

@@ -10,14 +10,14 @@ for the specification and template files we used to generate this.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0
-- Package version: 2.20190313.1
+- Package version: 2.20190327.1
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
 
 ## Installation
 
-### RubyGems
+### Option1: RubyGems
 The Ruby SDK is published as a gem. Simply run:
 
 ```
@@ -30,13 +30,13 @@ Or add this line to your Gemfile:
 gem 'square_connect'
 ```
 
-### Install from Git
+### Option 2: Install from Git
 
 If the Ruby gem is hosted at a git repository: https://github.com/square/connect-ruby-sdk, then add the following in the Gemfile:
 
     gem 'square_connect', :git => 'https://github.com/square/connect-ruby-sdk.git'
 
-### Include the Ruby code directly
+### Option 3: Include the Ruby code directly
 
 Include the Ruby code directly using `-I` as follows:
 
@@ -233,6 +233,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect::CatalogDiscount](docs/CatalogDiscount.md)
  - [SquareConnect::CatalogDiscountType](docs/CatalogDiscountType.md)
  - [SquareConnect::CatalogIdMapping](docs/CatalogIdMapping.md)
+ - [SquareConnect::CatalogImage](docs/CatalogImage.md)
  - [SquareConnect::CatalogInfoRequest](docs/CatalogInfoRequest.md)
  - [SquareConnect::CatalogInfoResponse](docs/CatalogInfoResponse.md)
  - [SquareConnect::CatalogInfoResponseLimits](docs/CatalogInfoResponseLimits.md)

data/docs/Address.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **administrative_district_level_2** | **String** | A civil entity within the address's `administrative_district_level_1`. In the US, this is the county. | [optional] 
 **administrative_district_level_3** | **String** | A civil entity within the address's `administrative_district_level_2`, if any. | [optional] 
 **postal_code** | **String** | The address's postal code. | [optional] 
-**country** | **String** | The address's country, in ISO 3166-1-alpha-2 format. | [optional] 
+**country** | **String** | The address's country, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values | [optional] 
 **first_name** | **String** | Optional first name when it's representing recipient. | [optional] 
 **last_name** | **String** | Optional last name when it's representing recipient. | [optional] 
 **organization** | **String** | Optional organization name when it's representing recipient. | [optional] 

data/docs/BatchRetrieveInventoryChangesRequest.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **catalog_object_ids** | **Array<String>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
 **location_ids** | **Array<String>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
-**types** | **Array<String>** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. | [optional] 
-**states** | **Array<String>** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional] 
+**types** | **Array<String>** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] 
+**states** | **Array<String>** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values | [optional] 
 **updated_after** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] 
 **updated_before** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] 
 **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 

data/docs/Card.md

@@ -8,7 +8,7 @@ Represents the payment details of a card to be used for payments. These details
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | Unique ID for this card. Generated by Square. | [optional] 
-**card_brand** | **String** | The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for all possible values. | [optional] 
+**card_brand** | **String** | The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for possible values | [optional] 
 **last_4** | **String** | The last 4 digits of the card number. | [optional] 
 **exp_month** | **Integer** | The expiration month of the associated card as an integer between 1 and 12. | [optional] 
 **exp_year** | **Integer** | The four-digit year of the card's expiration date. | [optional] 

data/docs/CatalogDiscount.md

@@ -8,7 +8,7 @@ A discount in the Catalog object model.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The discount's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
-**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] 
+**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 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] 

data/docs/CatalogImage.md

@@ -0,0 +1,14 @@
+# SquareConnect::CatalogImage
+
+### Description
+
+An image file to use in Square catalogs. Can be associated with catalog items, item variations, and categories.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The internal name of this image. Identifies this image in calls to the Connect APIs. | [optional] 
+**url** | **String** | The URL of this image. Generated by Square after an image is uploaded to the CreateCatalogImage endpoint. | [optional] 
+**caption** | **String** | A caption that describes what is shown in the image. Displayed in the Square Online Store. | [optional] 
+
+

data/docs/CatalogItem.md

@@ -17,9 +17,9 @@ Name | Type | Description | Notes
 **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] 
+**image_url** | **String** | __Deprecated__. The URL of an image representing this item. Deprecated in favor of `image_id` in [`CatalogObject`](#type-catalogobject). | [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] 
+**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 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/CatalogItemVariation.md

@@ -12,11 +12,11 @@ Name | Type | Description | Notes
 **sku** | **String** | The item variation's SKU, if any. Searchable. | [optional] 
 **upc** | **String** | The item variation's UPC, if any. Searchable in the Connect API. This field is only exposed in the Connect API. It is not exposed in Square's Dashboard, Square Point of Sale app or Retail Point of Sale app. | [optional] 
 **ordinal** | **Integer** | The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent [CatalogItem](#type-catalogitem) is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique. | [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] 
+**pricing_type** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for 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](#type-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_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 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/CatalogModifierList.md

@@ -8,7 +8,7 @@ A modifier list in the Catalog object model. A [CatalogModifierList](#type-catal
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
-**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] 
+**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 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/CatalogObject.md

@@ -7,7 +7,7 @@ The wrapper object for object types in the Catalog data model. The type of a par
 ## 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. | 
+**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 possible values | 
 **id** | **String** | An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object.  When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. | 
 **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] 
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **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. If not specified, defaults to `true`. | [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] 
+**image_id** | **String** | Identifies the `CatalogImage` attached to this `CatalogObject`. | [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] 
@@ -23,5 +24,6 @@ Name | Type | Description | Notes
 **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] 
+**image_data** | [**CatalogImage**](CatalogImage.md) | Structured data for a [CatalogImage](#type-catalogimage), set for CatalogObjects of type `IMAGE`. | [optional] 
 
 

data/docs/CatalogObjectType.md

@@ -8,6 +8,7 @@ Possible kinds of [CatalogObject](#type-catalogobject)s returned from the Catalo
 Name | Type
 ------------ | -------------
 **ITEM** | string
+**IMAGE** | string
 **CATEGORY** | string
 **ITEM_VARIATION** | string
 **TAX** | string

data/docs/CatalogQuerySortedAttribute.md

@@ -9,6 +9,6 @@ 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] 
+**sort_order** | **String** | The desired [SortOrder](#type-sortorder), `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values | [optional] 
 
 

data/docs/CatalogTax.md

@@ -8,8 +8,8 @@ A tax in the Catalog object model.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The tax's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
-**calculation_phase** | **String** | Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for all possible values. | [optional] 
-**inclusion_type** | **String** | Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for all possible values. | [optional] 
+**calculation_phase** | **String** | Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for possible values | [optional] 
+**inclusion_type** | **String** | Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for possible values | [optional] 
 **percentage** | **String** | The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%. | [optional] 
 **applies_to_custom_amounts** | **BOOLEAN** | If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular [CatalogItem](#type-catalogitem). | [optional] 
 **enabled** | **BOOLEAN** | If `true`, the tax will be shown as enabled in the Square Point of Sale app. | [optional] 

data/docs/CreateOrderRequestTax.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **catalog_object_id** | **String** | Only used for catalog taxes. The catalog object ID of an existing [CatalogTax](#type-catalogtax).  Do not provide a value for this field if you provide values in other fields for an ad hoc tax. | [optional] 
 **name** | **String** | Only used for ad hoc taxes. The tax's name.  Do not provide a value for this field if you set `catalog_object_id`. | [optional] 
-**type** | **String** | Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax.  Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values. | [optional] 
+**type** | **String** | Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax.  Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values | [optional] 
 **percentage** | **String** | Only used for ad hoc taxes. 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%. This value range between 0.0 up to 100.0 | [optional] 
 
 

data/docs/Customer.md

@@ -23,6 +23,6 @@ Name | Type | Description | Notes
 **note** | **String** | A note to associate with the customer. | [optional] 
 **preferences** | [**CustomerPreferences**](CustomerPreferences.md) | The customer's preferences. | [optional] 
 **groups** | [**Array<CustomerGroupInfo>**](CustomerGroupInfo.md) | The groups the customer belongs to. | [optional] 
-**creation_source** | **String** | A creation source represents the method used to create the customer profile. | [optional] 
+**creation_source** | **String** | A creation source represents the method used to create the customer profile. See [CustomerCreationSource](#type-customercreationsource) for possible values | [optional] 
 
 

data/docs/CustomerCreationSourceFilter.md

@@ -7,7 +7,7 @@ Creation source filter.  If one or more creation sources are set, customer profi
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**values** | **Array<String>** | The list of creation sources used as filtering criteria. See [CustomerCreationSource](#type-customercreationsource) for possible values. | [optional] 
-**rule** | **String** | Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values. | [optional] 
+**values** | **Array<String>** | The list of creation sources used as filtering criteria. See [CustomerCreationSource](#type-customercreationsource) for possible values | [optional] 
+**rule** | **String** | Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values | [optional] 
 
 

data/docs/CustomerSort.md

@@ -7,7 +7,7 @@ Indicates the field to use for sorting customer profiles. For example, by total
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**field** | **String** | The field to sort the results on. It could be the total money spent at the merchant, the date of the first visit (etc). See [CustomerSortField](#type-customersortfield) for possible values. Default value: `DEFAULT`. | [optional] 
-**order** | **String** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. See [SortOrder](#type-sortorder) for possible values. Default value: `ASC`. | [optional] 
+**field** | **String** | The field to sort the results on. It could be the total money spent at the merchant, the date of the first visit (etc). See [CustomerSortField](#type-customersortfield) for possible values | [optional] 
+**order** | **String** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. See [SortOrder](#type-sortorder) for possible values | [optional] 
 
 

data/docs/CustomersApi.md

@@ -71,7 +71,7 @@ Name | Type | Description  | Notes
 
 CreateCustomerCard
 
-Adds a card on file to an existing customer.  As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call.
+Adds a card on file to an existing customer.  As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call.  Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged.
 
 ### Example
 ```ruby
@@ -249,8 +249,8 @@ api_instance = SquareConnect::CustomersApi.new
 
 opts = { 
   cursor: "cursor_example", # String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Pagination](/basics/api101/pagination) for more information.
-  sort_field: "sort_field_example", # String | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values.
-  sort_order: "sort_order_example" # String | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values.
+  sort_field: "sort_field_example", # String | Indicates how Customers should be sorted. Default: `DEFAULT`.
+  sort_order: "sort_order_example" # String | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`.
 }
 
 begin
@@ -267,8 +267,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
- **sort_field** | **String**| Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. | [optional] 
- **sort_order** | **String**| Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. | [optional] 
+ **sort_field** | **String**| Indicates how Customers should be sorted. Default: `DEFAULT`. | [optional] 
+ **sort_order** | **String**| Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. | [optional] 
 
 ### Return type
 

data/docs/Employee.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **first_name** | **String** | Given (first) name of the employee. | [optional] 
 **last_name** | **String** | Family (last) name of the employee | [optional] 
 **location_ids** | **Array<String>** | A list of location IDs where this employee has access. | [optional] 
-**status** | **String** | Specifies the status of the employee being fetched. | [optional] 
+**status** | **String** | Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] 
 **created_at** | **String** | A read-only timestamp in RFC 3339 format. | [optional] 
 **updated_at** | **String** | A read-only timestamp in RFC 3339 format. | [optional] 
 

data/docs/Error.md

@@ -7,7 +7,7 @@ Represents an error encountered during a request to the Connect API.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**category** | **String** | The error's high-level category. See [ErrorCategory](#type-errorcategory) for possible values. | 
+**category** | **String** | The error's high-level category. See [ErrorCategory](#type-errorcategory) for possible values | 
 **code** | **String** | The error's specific code. See [ErrorCode](#type-errorcode) for possible values | 
 **detail** | **String** | A human-readable description of the error for debugging purposes. | [optional] 
 **field** | **String** | The name of the field provided in the original request that the error pertains to, if any. | [optional] 

data/docs/InventoryAdjustment.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | A unique ID generated by Square for the [InventoryAdjustment](#type-inventoryadjustment). | [optional] 
 **reference_id** | **String** | An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system. | [optional] 
-**from_state** | **String** | The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. | [optional] 
-**to_state** | **String** | The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. | [optional] 
+**from_state** | **String** | The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values | [optional] 
+**to_state** | **String** | The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values | [optional] 
 **location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional] 
 **catalog_object_id** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] 
 **catalog_object_type** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] 

data/docs/InventoryChange.md

@@ -7,7 +7,7 @@ Represents a single physical count, inventory, adjustment, or transfer that is p
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for all possible values. | [optional] 
+**type** | **String** | Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] 
 **physical_count** | [**InventoryPhysicalCount**](InventoryPhysicalCount.md) | Contains details about the physical count when `type` is `PHYSICAL_COUNT` and unset for all other types. | [optional] 
 **adjustment** | [**InventoryAdjustment**](InventoryAdjustment.md) | Contains details about the inventory adjustment when `type` is `ADJUSTMENT` and unset for all other types. | [optional] 
 **transfer** | [**InventoryTransfer**](InventoryTransfer.md) | Contains details about the inventory transfer when `type` is `TRANSFER` and unset for all other types. | [optional] 

data/docs/InventoryCount.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **catalog_object_id** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] 
 **catalog_object_type** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] 
-**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. | [optional] 
+**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional] 
 **location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional] 
 **quantity** | **String** | The number of items in the count as a decimal string. Fractional quantities are not supported. | [optional] 
 **calculated_at** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count. | [optional] 

data/docs/InventoryPhysicalCount.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **reference_id** | **String** | An optional ID provided by the application to tie the [InventoryPhysicalCount](#type-inventoryphysicalcount) to an external system. | [optional] 
 **catalog_object_id** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] 
 **catalog_object_type** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] 
-**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. | [optional] 
+**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional] 
 **location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional] 
 **quantity** | **String** | The number of items affected by the physical count as a decimal string. Fractional quantities are not supported. | [optional] 
 **source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that submitted the physical count. | [optional] 

data/docs/InventoryTransfer.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | A unique ID generated by Square for the [InventoryTransfer](#type-inventorytransfer). | [optional] 
 **reference_id** | **String** | An optional ID provided by the application to tie the [InventoryTransfer](#type-inventorytransfer) to an external system. | [optional] 
-**state** | **String** | The [InventoryState](#type-inventorystate) for the quantity of items being transfered. | [optional] 
+**state** | **String** | The [InventoryState](#type-inventorystate) for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values | [optional] 
 **from_location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items were tracked before the transfer. | [optional] 
 **to_location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items were tracked after the transfer. | [optional] 
 **catalog_object_id** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] 

data/docs/ItemVariationLocationOverrides.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **location_id** | **String** | The ID of the [location](#type-location). | [optional] 
 **price_money** | [**Money**](Money.md) | The price of the [CatalogItemVariation](#type-catalogitemvariation) at the given [location](#type-location), or blank for variable pricing. | [optional] 
-**pricing_type** | **String** | The pricing type (fixed or variable) for the [CatalogItemVariation](#type-catalogitemvariation) at the given [location](#type-location). See [CatalogPricingType](#type-catalogpricingtype) for all possible values. | [optional] 
+**pricing_type** | **String** | The pricing type (fixed or variable) for the [CatalogItemVariation](#type-catalogitemvariation) at the given [location](#type-location). See [CatalogPricingType](#type-catalogpricingtype) for possible values | [optional] 
 **track_inventory** | **BOOLEAN** | If `true`, inventory tracking is active for the [CatalogItemVariation](#type-catalogitemvariation) at this [location](#type-location). | [optional] 
-**inventory_alert_type** | **String** | Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) 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_type** | **String** | Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for 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] 
 
 

data/docs/ListAdditionalRecipientReceivableRefundsRequest.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **begin_time** | **String** | The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year. | [optional] 
 **end_time** | **String** | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time. | [optional] 
-**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` | [optional] 
+**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] 
 **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
 
 

data/docs/ListAdditionalRecipientReceivablesRequest.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **begin_time** | **String** | The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year. | [optional] 
 **end_time** | **String** | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time. | [optional] 
-**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` | [optional] 
+**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] 
 **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
 
 

data/docs/ListCustomersRequest.md

@@ -8,7 +8,7 @@ Defines the query parameters that can be provided in a request to the [ListCusto
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
-**sort_field** | **String** | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. | [optional] 
-**sort_order** | **String** | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. | [optional] 
+**sort_field** | **String** | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] 
+**sort_order** | **String** | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] 
 
 

data/docs/ListEmployeesRequest.md

@@ -8,7 +8,7 @@ Retrieve a paged-list of employees for a Square account
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **location_id** | **String** | Filter employees returned to only those that are associated with the specified location. | [optional] 
-**status** | **String** | Specifies the EmployeeStatus to filter the employee by. | [optional] 
+**status** | **String** | Specifies the EmployeeStatus to filter the employee by. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] 
 **limit** | **Integer** | The number of employees to be returned on each page. | [optional] 
 **cursor** | **String** | The token required to retrieve the specified page of results. | [optional] 
 

data/docs/ListRefundsRequest.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **begin_time** | **String** | The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year. | [optional] 
 **end_time** | **String** | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time. | [optional] 
-**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` | [optional] 
+**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] 
 **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
 
 

data/docs/ListTransactionsRequest.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **begin_time** | **String** | The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year. | [optional] 
 **end_time** | **String** | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time. | [optional] 
-**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` | [optional] 
+**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] 
 **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional]