square_connect 2.20181212.0.267 → 2.20190213.0.274

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a5543b9333917661531679ff8c0612e93c8e98ece230ec0f03cbc9d13006eb
-  data.tar.gz: 14146918959bf5804f9c9ad01e8de8f7d79ecf67cafbbd26bca9ccef005d1ad3
+  metadata.gz: 9248ee87a6327b22731e6c3969f7b376acb466d62eb3ee9e18f6231e41292974
+  data.tar.gz: 83db1d9bda16329b6f446495ad947f8dd476c7d8f908a8b16296d656176ccaf6
 SHA512:
-  metadata.gz: 82e5b8578e50aba62d7af11511a235cd91bc90255a433dd1f8c3cc7e02aaf0407391edfa587f6f4ddb6113e1fffb42ca7f9d986d0861e3abd7bb65f1da29787a
-  data.tar.gz: 9c735f99e23e3d6a458752e5b84abc96c6213a04aa8d86f310881bead6f90beb6354be5e31e1008ff185e89cbf486fba19dd09173d436ca1385e18e2adfc0465
+  metadata.gz: 7b2d8556af89a50b3c2599ec894cda2f511a40a4c48147797df04c4139032e882a2c5cc04010388babf7f1cc18c8d1516e24210fc704eca9a32217d3a38023c1
+  data.tar.gz: 2e176849449ec3e08152fa03a400febfa7366b46e39ced492d3d0f1816fd1a1fea1cb6ee201f81473d770f14056c28070df8b04e49e30c0354429b4639f1c215

data/CHANGES.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## Version 2.20190213.0 (2019-02-13)
+
+## New feature: Order fulfillment BETA
+
+The Orders API now includes beta
+functionality that supports in-person fulfillment through Square Point of Sale
+for orders placed online.
+
+## Improvement: New CreateOrder request structure
+
+The `CreateOrderRequest` datatype now groups order details under a single
+object.
+
+
+## Improvement: CreateOrder requests preserve order-level price adjustment objects
+
+The `CreateOrderResponse` datatype now retains structure of order-level
+price adjustments in addition to converting them to scoped, line-item price
+adjustments. Previously, `CreateOrderResponse` did not preserve the original
+order-level price-adjustment objects.
+
 ## Version 2.20181212.0 (2018-12-12)
 
 ## Improvement: ListCustomers return set expanded

data/README.md

@@ -10,7 +10,7 @@ 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.20181212.0
+- Package version: 2.20190213.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
@@ -314,12 +314,19 @@ Class | Method | HTTP request | Description
  - [SquareConnect::ObtainTokenRequest](docs/ObtainTokenRequest.md)
  - [SquareConnect::ObtainTokenResponse](docs/ObtainTokenResponse.md)
  - [SquareConnect::Order](docs/Order.md)
+ - [SquareConnect::OrderFulfillment](docs/OrderFulfillment.md)
+ - [SquareConnect::OrderFulfillmentPickupDetails](docs/OrderFulfillmentPickupDetails.md)
+ - [SquareConnect::OrderFulfillmentPickupDetailsScheduleType](docs/OrderFulfillmentPickupDetailsScheduleType.md)
+ - [SquareConnect::OrderFulfillmentRecipient](docs/OrderFulfillmentRecipient.md)
+ - [SquareConnect::OrderFulfillmentState](docs/OrderFulfillmentState.md)
+ - [SquareConnect::OrderFulfillmentType](docs/OrderFulfillmentType.md)
  - [SquareConnect::OrderLineItem](docs/OrderLineItem.md)
  - [SquareConnect::OrderLineItemDiscount](docs/OrderLineItemDiscount.md)
  - [SquareConnect::OrderLineItemDiscountScope](docs/OrderLineItemDiscountScope.md)
  - [SquareConnect::OrderLineItemDiscountType](docs/OrderLineItemDiscountType.md)
  - [SquareConnect::OrderLineItemModifier](docs/OrderLineItemModifier.md)
  - [SquareConnect::OrderLineItemTax](docs/OrderLineItemTax.md)
+ - [SquareConnect::OrderLineItemTaxScope](docs/OrderLineItemTaxScope.md)
  - [SquareConnect::OrderLineItemTaxType](docs/OrderLineItemTaxType.md)
  - [SquareConnect::Product](docs/Product.md)
  - [SquareConnect::Refund](docs/Refund.md)

data/docs/CardBrand.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-Indicates a credit card's brand, such as `VISA` or `MASTERCARD`.
+Indicates a card's brand, such as `VISA` or `MASTERCARD`.
 
 ## Properties
 Name | Type

data/docs/CatalogCategory.md

@@ -7,6 +7,6 @@ A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog o
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The category's name. Searchable. | [optional] 
+**name** | **String** | The category's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 
 

data/docs/CatalogDiscount.md

@@ -7,11 +7,11 @@ A discount in the Catalog object model.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The discount's name. Searchable. | [optional] 
+**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] 
 **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] 
+**label_color** | **String** | The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] 
 
 

data/docs/CatalogItem.md

@@ -7,10 +7,10 @@ An item (i.e., product family) in the Catalog object model.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The item's name. Searchable. | [optional] 
-**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. | [optional] 
+**name** | **String** | The item's name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points. | [optional] 
+**description** | **String** | The item's description. Searchable. This field has max length of 4096 Unicode code points. | [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. This field has max length of 24 Unicode code points. | [optional] 
+**label_color** | **String** | 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** | **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] 

data/docs/CatalogItemVariation.md

@@ -8,7 +8,7 @@ An item variation (i.e., product) in the Catalog object model.
 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] 
+**name** | **String** | The item variation's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 **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] 
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **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] 
+**user_data** | **String** | Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. | [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

@@ -7,7 +7,7 @@ A modifier in the Catalog object model.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The modifier's name. Searchable. | [optional] 
+**name** | **String** | The modifier's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
 **price_money** | [**Money**](Money.md) | The modifier's price. | [optional] 
 
 

data/docs/CatalogModifierList.md

@@ -7,7 +7,7 @@ A modifier list in the Catalog object model. A [CatalogModifierList](#type-catal
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. | [optional] 
+**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] 
 **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

@@ -10,7 +10,7 @@ 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** | 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] 
+**version** | **Integer** | 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** | **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. | [optional] 
 **catalog_v1_ids** | [**Array<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** | **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] 

data/docs/CatalogObjectType.md

@@ -2,7 +2,7 @@
 
 ### 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.
+Possible kinds of [CatalogObject](#type-catalogobject)s returned from the Catalog, each containing type-specific properties in the `*_data` field corresponding to the object type.
 
 ## Properties
 Name | Type

data/docs/CatalogTax.md

@@ -7,7 +7,7 @@ A tax in the Catalog object model.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | The tax's name. Searchable. | [optional] 
+**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] 
 **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] 

data/docs/CheckoutApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 CreateCheckout
 
-Creates a [Checkout](#type-checkout) response that links a `checkoutId` and `checkout_page_url` that customers can be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
+Links a `checkoutId` to a `checkout_page_url` that customers will be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
 
 ### Example
 ```ruby

data/docs/CreateOrderRequest.md

@@ -7,10 +7,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**order** | [**Order**](Order.md) | The order to create. If this field is set, then the only other top-level field that can be set is the idempotency_key. | [optional] 
 **idempotency_key** | **String** | A value you specify that uniquely identifies this order among orders you've created.  If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders.  See [Idempotency keys](#idempotencykeys) for more information. | [optional] 
-**reference_id** | **String** | An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database).  This value cannot exceed 40 characters. | [optional] 
-**line_items** | [**Array<CreateOrderRequestLineItem>**](CreateOrderRequestLineItem.md) | The line items to associate with this order.  Each line item represents a different product to include in a purchase. | 
-**taxes** | [**Array<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | The taxes to include on the order. | [optional] 
-**discounts** | [**Array<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | The discounts to include on the order. | [optional] 
+**reference_id** | **String** | __Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead.  An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database).  This value cannot exceed 40 characters. | [optional] 
+**line_items** | [**Array<CreateOrderRequestLineItem>**](CreateOrderRequestLineItem.md) | __Deprecated__: Please set the line_items on the nested [order](#type-order) field instead.  The line items to associate with this order.  Each line item represents a different product to include in a purchase. | [optional] 
+**taxes** | [**Array<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | __Deprecated__: Please set the taxes on the nested [order](#type-order) field instead.  The taxes to include on the order. | [optional] 
+**discounts** | [**Array<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | __Deprecated__: Please set the discounts on the nested [order](#type-order) field instead.  The discounts to include on the order. | [optional] 
 
 

data/docs/CreateOrderRequestDiscount.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-Represents a discount that can apply to either a single line item or an entire order.
+__Deprecated__: Please use the [OrderLineItemDiscount](#type-orderlineitemdiscount) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead.  Represents a discount that can apply to either a single line item or an entire order.
 
 ## Properties
 Name | Type | Description | Notes

data/docs/CreateOrderRequestLineItem.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-Represents a line item to include in an order. Each line item describes a different product to purchase, with its own quantity and price details.  Line items can either reference objects from the merchant's catalog, or can alternatively specify a name and price instead.
+__Deprecated__: Please use the [OrderLineItem](#type-orderlineitem) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead.  Represents a line item to include in an order. Each line item describes a different product to purchase, with its own quantity and price details.  Line items can either reference objects from the merchant's catalog, or can alternatively specify a name and price instead.
 
 ## Properties
 Name | Type | Description | Notes

data/docs/CreateOrderRequestModifier.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-Represents a modifier applied to a single line item.  Modifiers can reference existing objects in a merchant catalog or be constructed ad hoc at the time of purchase by providing a name and price.
+__Deprecated__: Please use the [OrderLineItemModifier](#type-orderlineitemmodifier) type instead.  Represents a modifier applied to a single line item.  Modifiers can reference existing objects in a merchant catalog or be constructed ad hoc at the time of purchase by providing a name and price.
 
 ## Properties
 Name | Type | Description | Notes

data/docs/CreateOrderRequestTax.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-Represents a tax that can apply to either a single line item or an entire order.
+__Deprecated__: Please use the [OrderLineItemTax](#type-orderlineitemtax) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead.  Represents a tax that can apply to either a single line item or an entire order.
 
 ## Properties
 Name | Type | Description | Notes

data/docs/ErrorCode.md

@@ -87,6 +87,7 @@ Name | Type
 **NOT_FOUND** | string
 **APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND** | string
 **METHOD_NOT_ALLOWED** | string
+**NOT_ACCEPTABLE** | string
 **REQUEST_TIMEOUT** | string
 **CONFLICT** | string
 **REQUEST_ENTITY_TOO_LARGE** | string

data/docs/Order.md

@@ -10,7 +10,10 @@ Name | Type | Description | Notes
 **id** | **String** | The order's unique ID.  This value is only present for Order objects created by the Orders API through the [CreateOrder](#endpoint-createorder) endpoint. | [optional] 
 **location_id** | **String** | The ID of the merchant location this order is associated with. | 
 **reference_id** | **String** | A client specified identifier to associate an entity in another system with this order. | [optional] 
-**line_items** | [**Array<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. Every order has at least one line item. | 
+**line_items** | [**Array<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. | [optional] 
+**taxes** | [**Array<OrderLineItemTax>**](OrderLineItemTax.md) | A list of taxes applied to this order. On read or retrieve, this list includes both order-level and item-level taxes. When creating an Order, set your order-level taxes in this list. | [optional] 
+**discounts** | [**Array<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | A list of discounts applied to this order. On read or retrieve, this list includes both order-level and item-level discounts. When creating an Order, set your order-level discounts in this list. | [optional] 
+**fulfillments** | [**Array<OrderFulfillment>**](OrderFulfillment.md) | Details on order fulfillment.  Orders can only be created with at most one fulfillment. However, orders returned by the API may contain multiple fulfillments. | [optional] 
 **total_money** | [**Money**](Money.md) | The total amount of money to collect for the order. | [optional] 
 **total_tax_money** | [**Money**](Money.md) | The total tax amount of money to collect for the order. | [optional] 
 **total_discount_money** | [**Money**](Money.md) | The total discount amount of money to collect for the order. | [optional] 

data/docs/OrderFulfillment.md

@@ -0,0 +1,14 @@
+# SquareConnect::OrderFulfillment
+
+### Description
+
+Contains details on how to fulfill this order.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of the fulfillment. | [optional] 
+**state** | **String** | The state of the fulfillment. | [optional] 
+**pickup_details** | [**OrderFulfillmentPickupDetails**](OrderFulfillmentPickupDetails.md) | Contains pickup-specific details. Required when fulfillment type is `PICKUP`. | [optional] 
+
+

data/docs/OrderFulfillmentPickupDetails.md

@@ -0,0 +1,27 @@
+# SquareConnect::OrderFulfillmentPickupDetails
+
+### Description
+
+Contains details necessary to fulfill a pickup order.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recipient** | [**OrderFulfillmentRecipient**](OrderFulfillmentRecipient.md) | The recipient of this pickup fulfillment. | [optional] 
+**expires_at** | **String** | The expiry [timestamp](#workingwithdates) in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". This timestamp indicates when the pickup fulfillment will expire if it is not accepted by the merchant. Expiration time can only be set up to 7 days in the future. If not set, this pickup fulfillment will be automatically accepted when placed. | [optional] 
+**auto_complete_duration** | **String** | The auto completion duration in RFC3339 duration format, e.g., \"P1W3D\". If set, an open and accepted pickup fulfillment will automatically move to the `COMPLETED` state after this period of time. If not set, this pickup fulfillment will remain accepted until it is canceled or completed. | [optional] 
+**schedule_type** | **String** | The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. | [optional] 
+**pickup_at** | **String** | The pickup [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment. This represents the start of the pickup window. | [optional] 
+**pickup_window_duration** | **String** | The pickup window duration in RFC3339 duration format, e.g., \"P1W3D\". This duration represents the window of time for which the order should be picked up after the `pickup_at` time. Can be used as an informational guideline for merchants. | [optional] 
+**prep_time_duration** | **String** | The preparation time duration in RFC3339 duration format, e.g., \"P1W3D\". This duration indicates how long it takes the merchant to prepare this fulfillment. | [optional] 
+**note** | **String** | A general note about the pickup fulfillment.  Notes are useful for providing additional instructions and are displayed in Square apps. | [optional] 
+**placed_at** | **String** | The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the fulfillment was placed. | [optional] 
+**accepted_at** | **String** | The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the fulfillment was accepted by the merchant. | [optional] 
+**rejected_at** | **String** | The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the fulfillment was rejected. | [optional] 
+**ready_at** | **String** | The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the merchant set the fulfillment as ready for pickup. | [optional] 
+**expired_at** | **String** | The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the fulfillment expired. | [optional] 
+**picked_up_at** | **String** | The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the fulfillment was picked up by the recipient. | [optional] 
+**canceled_at** | **String** | The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the fulfillment was canceled by the merchant or buyer. | [optional] 
+**cancel_reason** | **String** | A description of why the pickup was canceled. Max length is 100 characters. | [optional] 
+
+

data/docs/OrderFulfillmentPickupDetailsScheduleType.md

@@ -0,0 +1,13 @@
+# SquareConnect::OrderFulfillmentPickupDetailsScheduleType
+
+### Description
+
+The schedule type of the pickup fulfillment.
+
+## Properties
+Name | Type
+------------ | -------------
+**SCHEDULED** | string
+**ASAP** | string
+
+

data/docs/OrderFulfillmentRecipient.md

@@ -0,0 +1,15 @@
+# SquareConnect::OrderFulfillmentRecipient
+
+### Description
+
+The recipient of a fulfillment.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_id** | **String** | The Customer ID of the customer associated with the fulfillment.  If customer_id is provided, the corresponding recipient information fields (`display_name`, `email_address`, and `phone_number`) are automatically populated from the relevant customer profile. If the targeted profile information does not contain the necessary required information, the request will result in an error. | [optional] 
+**display_name** | **String** | The display name of the fulfillment recipient.  If provided, overrides the value from customer profile indicated by customer_id. | [optional] 
+**email_address** | **String** | The email address of the fulfillment recipient.  If provided, overrides the value from customer profile indicated by customer_id. | [optional] 
+**phone_number** | **String** | The phone number of the fulfillment recipient.  If provided, overrides the value from customer profile indicated by customer_id. | [optional] 
+
+

data/docs/OrderFulfillmentState.md

@@ -0,0 +1,17 @@
+# SquareConnect::OrderFulfillmentState
+
+### Description
+
+The state of the fulfillment.
+
+## Properties
+Name | Type
+------------ | -------------
+**PROPOSED** | string
+**RESERVED** | string
+**PREPARED** | string
+**COMPLETED** | string
+**CANCELED** | string
+**FAILED** | string
+
+

data/docs/OrderFulfillmentType.md

@@ -0,0 +1,12 @@
+# SquareConnect::OrderFulfillmentType
+
+### Description
+
+The type of fulfillment.
+
+## Properties
+Name | Type
+------------ | -------------
+**PICKUP** | string
+
+

data/docs/OrderLineItem.md

@@ -13,8 +13,8 @@ Name | Type | Description | Notes
 **catalog_object_id** | **String** | The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item. | [optional] 
 **variation_name** | **String** | The name of the variation applied to this line item. | [optional] 
 **modifiers** | [**Array<OrderLineItemModifier>**](OrderLineItemModifier.md) | The [CatalogModifier](#type-catalogmodifier)s applied to this line item. | [optional] 
-**taxes** | [**Array<OrderLineItemTax>**](OrderLineItemTax.md) | The taxes applied to this line item. | [optional] 
-**discounts** | [**Array<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | The discounts applied to this line item. | [optional] 
+**taxes** | [**Array<OrderLineItemTax>**](OrderLineItemTax.md) | A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any order-level taxes apportioned to this item. When creating an Order, set your item-level taxes in this list. | [optional] 
+**discounts** | [**Array<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any order-level discounts apportioned to this item. When creating an Order, set your item-level discounts in this list. | [optional] 
 **base_price_money** | [**Money**](Money.md) | The base price for a single unit of the line item. | [optional] 
 **gross_sales_money** | [**Money**](Money.md) | The gross sales amount of money calculated as (item base price + modifiers price) * quantity. | [optional] 
 **total_tax_money** | [**Money**](Money.md) | The total tax amount of money to collect for the line item. | [optional] 

data/docs/OrderLineItemDiscount.md

@@ -13,6 +13,6 @@ Name | Type | Description | Notes
 **percentage** | **String** | 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%.  The percentage won't be set for an amount-based discount. | [optional] 
 **amount_money** | [**Money**](Money.md) | The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount.  The amount_money won't be set for a percentage-based discount. | [optional] 
 **applied_money** | [**Money**](Money.md) | The amount of discount actually applied to this line item.  Represents the amount of money applied to a line item as a discount When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items. | [optional] 
-**scope** | **String** | Indicates the level at which the discount applies. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values. | [optional] 
+**scope** | **String** | Indicates the level at which the discount applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values. | [optional] 
 
 

data/docs/OrderLineItemTax.md

@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 **type** | **String** | Indicates the calculation method used to apply the tax.  See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values. | [optional] 
 **percentage** | **String** | 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%. | [optional] 
 **applied_money** | [**Money**](Money.md) | The amount of the money applied by the tax in an order. | [optional] 
+**scope** | **String** | Indicates the level at which the tax applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values. | [optional] 
 
 

data/docs/OrderLineItemTaxScope.md

@@ -0,0 +1,14 @@
+# SquareConnect::OrderLineItemTaxScope
+
+### Description
+
+Indicates whether this is a line item or order level tax.
+
+## Properties
+Name | Type
+------------ | -------------
+**OTHER_TAX_SCOPE** | string
+**LINE_ITEM** | string
+**ORDER** | string
+
+

data/docs/V1Timecard.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **deleted** | **BOOLEAN** | If true, the timecard was deleted by the merchant, and it is no longer valid. | [optional] 
 **clockin_time** | **String** | The clock-in time for the timecard, in ISO 8601 format. | [optional] 
 **clockout_time** | **String** | The clock-out time for the timecard, in ISO 8601 format. Provide this value only if importing timecard information from another system. | [optional] 
-**clockin_location_id** | **String** | The ID of the location the employee clocked in from. We strongly reccomend providing a clockin_location_id. Square uses the clockin_location_id to determine a timecard’s timezone and overtime rules. | [optional] 
+**clockin_location_id** | **String** | The ID of the location the employee clocked in from. We strongly reccomend providing a clockin_location_id. Square uses the clockin_location_id to determine a timecard���s timezone and overtime rules. | [optional] 
 **clockout_location_id** | **String** | The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system. | [optional] 
 **created_at** | **String** | The time when the timecard was created, in ISO 8601 format. | [optional] 
 **updated_at** | **String** | The time when the timecard was most recently updated, in ISO 8601 format. | [optional] 

data/lib/square_connect/api/apple_pay_api.rb

@@ -51,7 +51,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}

data/lib/square_connect/api/catalog_api.rb

@@ -51,7 +51,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -106,7 +106,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -161,7 +161,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -212,7 +212,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -267,7 +267,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -324,7 +324,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -382,7 +382,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -437,7 +437,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -492,7 +492,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -547,7 +547,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}
@@ -602,7 +602,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}

data/lib/square_connect/api/checkout_api.rb

@@ -18,7 +18,7 @@ module SquareConnect
     end
 
     # CreateCheckout
-    # Creates a [Checkout](#type-checkout) response that links a `checkoutId` and `checkout_page_url` that customers can be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
+    # Links a `checkoutId` to a `checkout_page_url` that customers will be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
     # @param location_id The ID of the business location to associate the checkout with.
     # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
     # @param [Hash] opts the optional parameters
@@ -29,7 +29,7 @@ module SquareConnect
     end
 
     # CreateCheckout
-    # Creates a [Checkout](#type-checkout) response that links a `checkoutId` and `checkout_page_url` that customers can be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
+    # Links a `checkoutId` to a `checkout_page_url` that customers will be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
     # @param location_id The ID of the business location to associate the checkout with.
     # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
     # @param [Hash] opts the optional parameters
@@ -55,7 +55,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-12-12"
+      header_params['Square-Version'] = "2019-02-13"
 
       # form parameters
       form_params = {}