Merge pull request #94 from square/release/2.20190410.1

Release 2.20190410.1

CHANGES.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## Version 2.20190410.1 (2019-04-24)
+
+## Details
+
+* **New functionality**: Employees API (Connect v2) — New fields to
+  capture contact information for employee profiles.
+* **New functionality**: `V1Tender.CardBrand` — New V1 enum to represent
+  brand information for credit cars.
+
 ## Version 2.20190410.0 (2019-04-10)
 
 ## New features: Orders API beta

README.md

@@ -626,6 +626,7 @@ Class | Method | HTTP request
  - [V1RefundType](docs/V1RefundType.md)
  - [V1SettlementEntryType](docs/V1SettlementEntryType.md)
  - [V1SettlementStatus](docs/V1SettlementStatus.md)
+ - [V1TenderCardBrand](docs/V1TenderCardBrand.md)
  - [V1TenderEntryMethod](docs/V1TenderEntryMethod.md)
  - [V1TenderType](docs/V1TenderType.md)
  - [V1TimecardEventEventType](docs/V1TimecardEventEventType.md)

docs/CatalogItem.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **str** | The item's name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points. | [optional] 
 **description** | **str** | The item's description. Searchable. This field has max length of 4096 Unicode code points. | [optional] 
-**abbreviation** | **str** | 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. This field has max length of 24 Unicode code points. | [optional] 
+**abbreviation** | **str** | 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. This field has max length of 24 Unicode code points. | [optional] 
 **label_color** | **str** | The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] 
 **available_online** | **bool** | If `true`, the item can be added to shipping orders from the merchant's online store. | [optional] 
 **available_for_pickup** | **bool** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional] 

docs/CatalogObject.md

@@ -3,15 +3,15 @@
 
 ### 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](/products/catalog/overview).
+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. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid [CatalogImage](#type-catalogimage) object.  For a more detailed discussion of the Catalog data model, please see the [Catalog Overview](/products/catalog/overview).
 
 ## 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 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] 
+**version** | **int** | The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting. | [optional] 
 **is_deleted** | **bool** | 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. | [optional] 
 **catalog_v1_ids** | [**list[CatalogV1Id]**](CatalogV1Id.md) | The Connect V1 IDs for this object at each [location](#type-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** | **bool** | 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] 

docs/CatalogQuery.md

@@ -3,7 +3,7 @@
 
 ### Description
 
-A query to be applied to a SearchCatalogObjects 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), [CatalogModifier](#type-catalogmodifier)).  For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`.
+A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest). 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), [CatalogModifier](#type-catalogmodifier)).  For example, a query that should return Items may specify 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

docs/ChargeRequest.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **customer_card_id** | **str** | The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`.  If you provide this value, you _must_ also provide a value for `customer_id`. | [optional] 
 **delay_capture** | **bool** | If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction](#endpoint-capturetransaction) endpoint) or a Void (with the [VoidTransaction](#endpoint-voidtransaction) endpoint).  Default value: `false` | [optional] 
 **reference_id** | **str** | An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database).  This value cannot exceed 40 characters. | [optional] 
-**note** | **str** |  | [optional] 
+**note** | **str** | An optional note to associate with the transaction.  This value cannot exceed 60 characters. | [optional] 
 **customer_id** | **str** | The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise. | [optional] 
 **billing_address** | [**Address**](Address.md) | The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided. | [optional] 
 **shipping_address** | [**Address**](Address.md) | The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. | [optional] 

docs/Employee.md

@@ -11,6 +11,8 @@ Name | Type | Description | Notes
 **id** | **str** | UUID for this `Employee`. | [optional] 
 **first_name** | **str** | Given (first) name of the employee. | [optional] 
 **last_name** | **str** | Family (last) name of the employee | [optional] 
+**email** | **str** | Email of the employee | [optional] 
+**phone_number** | **str** | Phone number of the employee in E.164 format, i.e. \"+12125554250\" | [optional] 
 **location_ids** | **list[str]** | A list of location IDs where this employee has access. | [optional] 
 **status** | **str** | Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] 
 **created_at** | **str** | A read-only timestamp in RFC 3339 format. | [optional] 

docs/ListCatalogRequest.md

@@ -9,7 +9,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cursor** | **str** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. | [optional] 
-**types** | **str** | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY`.  The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. | [optional] 
+**types** | **str** | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`.  The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `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/ObtainTokenResponse.md

@@ -8,7 +8,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**access_token** | **str** | A valid OAuth access token. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](/authz/oauth/build-with-the-api) guide for more information. | [optional] 
+**access_token** | **str** | A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](/authz/oauth/build-with-the-api) guide for more information. | [optional] 
 **token_type** | **str** | This value is always _bearer_. | [optional] 
 **expires_at** | **str** | The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. | [optional] 
 **merchant_id** | **str** | The ID of the authorizing merchant's business. | [optional] 

docs/UpsertCatalogObjectRequest.md

@@ -9,7 +9,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **idempotency_key** | **str** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).  If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects.  See [Idempotency](/basics/api101/idempotency) for more information. | 
-**object** | [**CatalogObject**](CatalogObject.md) | A [CatalogObject](#type-catalogobject) to be created or updated. The object's `is_deleted` field must not be set to `true`. When creating a new object, the object's ID must either start with a `#` character or be left blank. In either case it will be replaced with a server-generated ID. | 
+**object** | [**CatalogObject**](CatalogObject.md) | A [CatalogObject](#type-catalogobject) to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. | 
 
 [[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/V1Tender.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **name** | **str** | A human-readable description of the tender. | [optional] 
 **employee_id** | **str** | The ID of the employee that processed the tender. | [optional] 
 **receipt_url** | **str** | The URL of the receipt for the tender. | [optional] 
-**card_brand** | **str** | The brand of credit card provided. See [CardBrand](#type-cardbrand) for possible values | [optional] 
+**card_brand** | **str** | The brand of credit card provided. See [V1TenderCardBrand](#type-v1tendercardbrand) for possible values | [optional] 
 **pan_suffix** | **str** | The last four digits of the provided credit card's account number. | [optional] 
 **entry_method** | **str** | The tender's unique ID. See [V1TenderEntryMethod](#type-v1tenderentrymethod) for possible values | [optional] 
 **payment_note** | **str** | Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER. | [optional] 

docs/V1TenderCardBrand.md

@@ -0,0 +1,23 @@
+# V1TenderCardBrand
+
+
+### Description
+
+The brand of a credit card.
+
+## Properties
+Name | Type
+------------ | -------------
+**OTHER_BRAND** | string
+**VISA** | string
+**MASTER_CARD** | string
+**AMERICAN_EXPRESS** | string
+**DISCOVER** | string
+**DISCOVER_DINERS** | string
+**JCB** | string
+**CHINA_UNIONPAY** | string
+**SQUARE_GIFT_CARD** | string
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

setup.py

@@ -4,7 +4,7 @@
 from setuptools import setup, find_packages
 
 NAME = "squareconnect"
-VERSION = "2.20190410.0"
+VERSION = "2.20190410.1"
 
 
 

squareconnect/__init__.py

@@ -373,6 +373,7 @@
 from .models.v1_settlement_entry_type import V1SettlementEntryType
 from .models.v1_settlement_status import V1SettlementStatus
 from .models.v1_tender import V1Tender
+from .models.v1_tender_card_brand import V1TenderCardBrand
 from .models.v1_tender_entry_method import V1TenderEntryMethod
 from .models.v1_tender_type import V1TenderType
 from .models.v1_timecard import V1Timecard

squareconnect/api_client.py

@@ -75,7 +75,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, cook
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Square-Connect-Python/2.20190410.0'
+        self.user_agent = 'Square-Connect-Python/2.20190410.1'
 
     @property
     def user_agent(self):

squareconnect/apis/catalog_api.py

@@ -441,7 +441,7 @@ def list_catalog(self, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str cursor: The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information.
-        :param str types: An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY`.  The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`.
+        :param str types: An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`.  The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.
         :return: ListCatalogResponse
                  If the method is called asynchronously,
                  returns the request thread.

squareconnect/configuration.py

@@ -229,5 +229,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0\n"\
-               "SDK Package Version: 2.20190410.0".\
+               "SDK Package Version: 2.20190410.1".\
                format(env=sys.platform, pyversion=sys.version)

squareconnect/models/__init__.py

@@ -373,6 +373,7 @@
 from .v1_settlement_entry_type import V1SettlementEntryType
 from .v1_settlement_status import V1SettlementStatus
 from .v1_tender import V1Tender
+from .v1_tender_card_brand import V1TenderCardBrand
 from .v1_tender_entry_method import V1TenderEntryMethod
 from .v1_tender_type import V1TenderType
 from .v1_timecard import V1Timecard