Release 2.20190327.0 (#90)

CHANGES.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 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

README.md

@@ -12,7 +12,7 @@ for the specification and template files we used to generate this.
 Make sure you have Python 2 >=2.7.9 or Python 3 >= 3.4
 
 ## Installation & Usage
-### pip install
+### Option 1: pip install
 
 If the python package is hosted on Github, you can install directly from Github
 
@@ -21,7 +21,7 @@ pip install git+https://github.com/square/connect-python-sdk.git
 ```
 (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/square/connect-python-sdk.git`)
 
-### Setuptools
+### Option 2: Setuptools
 
 Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
 
@@ -255,6 +255,7 @@ Class | Method | HTTP request
  - [CatalogCategory](docs/CatalogCategory.md)
  - [CatalogDiscount](docs/CatalogDiscount.md)
  - [CatalogIdMapping](docs/CatalogIdMapping.md)
+ - [CatalogImage](docs/CatalogImage.md)
  - [CatalogInfoRequest](docs/CatalogInfoRequest.md)
  - [CatalogInfoResponse](docs/CatalogInfoResponse.md)
  - [CatalogInfoResponseLimits](docs/CatalogInfoResponseLimits.md)

docs/Address.md

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

docs/BatchRetrieveInventoryChangesRequest.md

@@ -10,8 +10,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **catalog_object_ids** | **list[str]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
 **location_ids** | **list[str]** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
-**types** | **list[str]** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. | [optional] 
-**states** | **list[str]** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional] 
+**types** | **list[str]** | 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** | **list[str]** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values | [optional] 
 **updated_after** | **str** | 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** | **str** | 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** | **str** | 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] 

docs/Card.md

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

docs/CatalogDiscount.md

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

docs/CatalogImage.md

@@ -0,0 +1,17 @@
+# CatalogImage
+> squareconnect.models.catalog_image
+
+### 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** | **str** | The internal name of this image. Identifies this image in calls to the Connect APIs. | [optional] 
+**url** | **str** | The URL of this image. Generated by Square after an image is uploaded to the CreateCatalogImage endpoint. | [optional] 
+**caption** | **str** | A caption that describes what is shown in the image. Displayed in the Square Online Store. | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/CatalogItem.md

@@ -18,9 +18,9 @@ Name | Type | Description | Notes
 **category_id** | **str** | The ID of the item's category, if any. | [optional] 
 **tax_ids** | **list[str]** | 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** | [**list[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** | **str** | The URL of an image representing this item. | [optional] 
+**image_url** | **str** | __Deprecated__. The URL of an image representing this item. Deprecated in favor of `image_data` in [`CatalogObject`](#type-catalogobject). | [optional] 
 **variations** | [**list[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item. | [optional] 
-**product_type** | **str** | 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** | **str** | 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** | **bool** | 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] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/CatalogItemVariation.md

@@ -13,11 +13,11 @@ Name | Type | Description | Notes
 **sku** | **str** | The item variation's SKU, if any. Searchable. | [optional] 
 **upc** | **str** | 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** | **int** | 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** | **str** | 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** | **str** | 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** | [**list[ItemVariationLocationOverrides]**](ItemVariationLocationOverrides.md) | Per-[location](#type-location) price and inventory overrides. | [optional] 
 **track_inventory** | **bool** | If `true`, inventory tracking is active for the variation. | [optional] 
-**inventory_alert_type** | **str** | 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** | **str** | 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** | **int** | 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** | **str** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional] 
 **service_duration** | **int** | 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] 

docs/CatalogModifierList.md

@@ -9,7 +9,7 @@ A modifier list in the Catalog object model. A [CatalogModifierList](#type-catal
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **str** | The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
-**selection_type** | **str** | 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** | **str** | 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** | [**list[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] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/CatalogObject.md

@@ -8,7 +8,7 @@ The wrapper object for object types in the Catalog data model. The type of a par
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **str** | 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** | **str** | 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** | **str** | 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** | **str** | 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** | **int** | 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] 
@@ -24,6 +24,7 @@ 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] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/CatalogObjectType.md

@@ -9,6 +9,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

docs/CatalogQuerySortedAttribute.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **attribute_name** | **str** | The attribute whose value should be used as the sort key. | 
 **initial_attribute_value** | **str** | 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** | **str** | The desired [SortOrder](#type-sortorder), `\"ASC\"` (ascending) or `\"DESC\"` (descending). | [optional] 
+**sort_order** | **str** | The desired [SortOrder](#type-sortorder), `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)