Generated PR for Release: 13.1.0.20210818

square · Aug 18, 2021 · 43ac3e0 · 43ac3e0
1 parent 3920c07
commit 43ac3e0
Show file tree

Hide file tree

Showing 97 changed files with 480 additions and 389 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,48 +1,33 @@
 # Change Log
 
-## Version 13.0.0.20210721 (2021-07-21)
-## API updates
+## Version 13.1.0.20210818 (2021-08-18)
+## API updates 
 
-* **Orders  API:** 
-  * [OrderServiceCharge](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderServiceCharge) object. Added a new field, `type`. It identifies the service charge type.
-
-  * [OrderQuantityUnit](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderQuantityUnit), 
-    [OrderLineItem](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItem), 
-    [OrderLineItemDiscount](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItemDiscount), 
-    [OrderLineItemModifier](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItemModifier), 
-    [OrderLineItemTax](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItemTax), 
-    [OrderServiceCharge](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderServiceCharge), 
-    [OrderReturnLineItem](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnLineItem), 
-    [OrderReturnLineItemModifier](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnLineItemModifier), 
-    [OrderReturnServiceCharge](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnServiceCharge), 
-    [OrderReturnTax](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnTax), and 
-    [OrderReturnDiscount](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnDiscount) objects. Added a new field, `catalog_version`.
-* **Locations API:**
-  * [Location](https://developer.squareup.com/reference/square_2021-07-21/objects/Location) object. Added a new field `tax_ids` of type `TaxIds`. In the current implementation, sellers in Ireland and France can configure tax IDs during the onboarding process. They can also provide the information later by updating the location information in the Seller Dashboard. These tax IDs appear in this field.
+* **Customers API:**
+  * [Customer](https://developer.squareup.com/reference/square_2021-08-18/objects/Customer) object. The `version` field has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state. This field represents the current version of the customer profile and enables optimistic concurrency control. For more information, see [Customer profile versions and optimistic concurrency support.](https://developer.squareup.com/docs/customers-api/what-it-does#customer-profile-versions-and-optimistic-concurrency-support) 
+  * [ListCustomers](https://developer.squareup.com/reference/square_2021-08-18/customers-api/list-customers) endpoint. The new, optional `limit` query parameter can be used to specify the maximum number of results in a paginated response.
 
-* **Loyalty API:**
-  * As of July 15, 2021, the country in which the seller’s Square account is activated determines whether Square uses pretax or post-tax purchase amounts to calculate accrued points. This change supports consumption tax models, such as value-added tax (VAT). Previously, point accrual was based on pretax purchase amounts only. This change does not affect the existing point balance of loyalty accounts. For more information, see [Availability of Square Loyalty.](https://developer.squareup.com/docs/loyalty-api/overview#loyalty-market-availability)
+* **Customer Groups API:**
+  * [ListCustomerGroups](https://developer.squareup.com/reference/square_2021-08-18/customer-groups-api/list-customer-groups) endpoint. The new, optional `limit` query parameter can be used to specify the maximum number of results in a paginated response.
 
-* **Payments API:** 
-  * [UpdatePayment](https://developer.squareup.com/reference/square_2021-07-21/payments-api/update-payment). The endpoint has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state. Also, you can now update gift card payments (similar to card, cash, and external payments).
+* **Customer Segments API:**
+  * [ListCustomerSegments](https://developer.squareup.com/reference/square_2021-08-18/customer-segments-api/list-customer-segments) endpoint. The new, optional `limit` query parameter can be used to specify the maximum number of results in a paginated response.
 
-* **Subscriptions API:**
-  * The [Subscriptions API](https://developer.squareup.com/docs/subscriptions-api/overview) has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state.
-  * [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2021-07-21/objects/CatalogSubscriptionPlan) object. The `name` and `price` are now write-once fields. You specify these values at the time  of creating a plan. After the plan is created, these fields cannot be updated. This makes a subscription plan immutable. 
+* **Invoices API:**
+  * Square Invoices Plus is a monthly subscription plan that allows access to premium invoice features. After Invoices Plus is launched in September 2021, a subscription will be required to create invoices with custom fields and installment payments. For more information, including how to handle new errors, see [Premium features available with Invoices Plus.](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)
 
-* **Inventory API:**
-  * [RetrieveInventoryTransfer.](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Transfer) This new endpoint is introduced to support the retrieval of inventory transfer.
-  * [RetrieveInventoryChanges.](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Changes) This endpoint is deprecated. Its support ends when it is retired in about 12 months.  
-  * The following endpoints have updated URLs to conform to the standard REST API convention. For more information about migrating deprecated URLs to updated URLs in your application, see [Inventory API: Migrate to Updated API Entities.](https://developer.squareup.com/docs/inventory-api/migrate-to-updated-api-entities)
-    * [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Adjustment)
-    * [BatchChangeInventory](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Batch-Change-Inventory)
-    * [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Batch-Retrieve-Inventory-Changes) 
-    * [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Batch-Retrieve-Inventory-Counts)
-    * [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Physical-Count)
+* **Loyalty API:**
+  * [LoyaltyAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyAccount) object. Added a new `expiring_point_deadlines` field that specifies when points in the account balance are scheduled to expire. This field contains a list of [LoyaltyAccountExpiringPointDeadline](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyAccountExpiringPointDeadline) objects. For more information, see [Expiring points.](https://developer.squareup.com/docs/loyalty-api/overview#expiring-points)
 
 ## Documentation updates
-* **Webhooks.** Revised the steps and descriptions for creating and using webhooks. For more information, see [Webhooks Overview.](https://developer.squareup.com/docs/webhooks/overview)
 
+* [App Marketplace.](https://developer.squareup.com/docs/app-marketplace) Added the following topics:
+  * [How to apply.](https://developer.squareup.com/docs/app-marketplace#how-to-apply) Documented the process to list an application on the Square App Marketplace.
+  * [App Marketplace API Usage Requirements.](https://developer.squareup.com/docs/app-marketplace/requirements) Added a topic that describes a set of API usage requirements and recommendations for partner applications.   
+
+* [Automatic communications from Square about invoices.](https://developer.squareup.com/docs/invoices-api/overview#automatic-communication-from-square-to-customers) Documented the invoice-related communications sent from Square to customers and sellers. 
+
+* [Snippets best practices.](https://developer.squareup.com/docs/snippets-api/overview#best-practices) Documented best practices and additional requirements for snippets and applications that integrate with the Snippets API.
 
 
 ## Version 12.0.0.20210616 (2021-06-16)

diff --git a/README.md b/README.md
@@ -8,6 +8,10 @@
 
 Use this gem to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders.
 
+## Requirements
+
+We support Ruby 2.5.x, 2.6.x, and 2.7.x.
+
 ## Installation
 
 Install the gem from the command line:
@@ -33,9 +37,6 @@ gem 'square.rb'
 * [Disputes]
 * [Checkout]
 * [Apple Pay]
-* [Cards]
-
-### Terminal
 * [Terminal]
 
 ### Orders
@@ -59,22 +60,19 @@ gem 'square.rb'
 ### Loyalty
 * [Loyalty]
 
-### Gift Cards
-* [Gift Cards]
-* [Gift Card Activities]
-
 ### Bookings
 * [Bookings]
 
 ### Business
 * [Merchants]
 * [Locations]
 * [Devices]
-* [Cash Drawers]
 
 ### Team
 * [Team]
+* [Employees]
 * [Labor]
+* [Cash Drawers]
 
 ### Financials
 * [Bank Accounts]
@@ -88,7 +86,6 @@ gem 'square.rb'
 * [OAuth]
 
 ### Deprecated APIs
-* [Employees]
 * [V1 Employees]
 * [V1 Transactions]
 * [V1 Items]
@@ -340,6 +337,3 @@ You can also use the Square API to create applications or services that work wit
 [Transactions]: doc/api/transactions.md
 [Sites]: doc/api/sites.md
 [Snippets]: doc/api/snippets.md
-[Cards]: doc/api/cards.md
-[Gift Cards]: doc/api/gift-cards.md
-[Gift Card Activities]: doc/api/gift-card-activities.md
diff --git a/doc/api/customer-groups.md b/doc/api/customer-groups.md
@@ -22,14 +22,16 @@ customer_groups_api = client.customer_groups
 Retrieves the list of customer groups of a business.
 
 ```ruby
-def list_customer_groups(cursor: nil)
+def list_customer_groups(cursor: nil,
+                         limit: nil)
 ```
 
 ## Parameters
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for your original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
+| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than 1 or greater than 50. The default value is 50.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
 
 ## Response Type
 
@@ -39,8 +41,9 @@ def list_customer_groups(cursor: nil)
 
 ```ruby
 cursor = 'cursor6'
+limit = 172
 
-result = customer_groups_api.list_customer_groups(cursor: cursor)
+result = customer_groups_api.list_customer_groups(cursor: cursor, limit: limit)
 
 if result.success?
   puts result.data

diff --git a/doc/api/customer-segments.md b/doc/api/customer-segments.md
@@ -19,14 +19,16 @@ customer_segments_api = client.customer_segments
 Retrieves the list of customer segments of a business.
 
 ```ruby
-def list_customer_segments(cursor: nil)
+def list_customer_segments(cursor: nil,
+                           limit: nil)
 ```
 
 ## Parameters
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | A pagination cursor returned by previous calls to `ListCustomerSegments`.<br>This cursor is used to retrieve the next set of query results.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
+| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than 1 or greater than 50. The default value is 50.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
 
 ## Response Type
 
@@ -36,8 +38,9 @@ def list_customer_segments(cursor: nil)
 
 ```ruby
 cursor = 'cursor6'
+limit = 172
 
-result = customer_segments_api.list_customer_segments(cursor: cursor)
+result = customer_segments_api.list_customer_segments(cursor: cursor, limit: limit)
 
 if result.success?
   puts result.data

diff --git a/doc/api/customers.md b/doc/api/customers.md
@@ -32,6 +32,7 @@ profiles can take closer to one minute or longer, especially during network inci
 
 ```ruby
 def list_customers(cursor: nil,
+                   limit: nil,
                    sort_field: nil,
                    sort_order: nil)
 ```
@@ -41,8 +42,9 @@ def list_customers(cursor: nil,
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for your original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
-| `sort_field` | [`String (Customer Sort Field)`](/doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.<br><br>Default: `DEFAULT`. |
-| `sort_order` | [`String (Sort Order)`](/doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>Default: `ASC`. |
+| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than 1 or greater than 100. The default value is 100.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
+| `sort_field` | [`String (Customer Sort Field)`](/doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.<br><br>The default value is `DEFAULT`. |
+| `sort_order` | [`String (Sort Order)`](/doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>The default value is `ASC`. |
 
 ## Response Type
 
@@ -52,10 +54,11 @@ def list_customers(cursor: nil,
 
 ```ruby
 cursor = 'cursor6'
+limit = 172
 sort_field = 'DEFAULT'
 sort_order = 'DESC'
 
-result = customers_api.list_customers(cursor: cursor, sort_field: sort_field, sort_order: sort_order)
+result = customers_api.list_customers(cursor: cursor, limit: limit, sort_field: sort_field, sort_order: sort_order)
 
 if result.success?
   puts result.data

diff --git a/doc/api/gift-cards.md b/doc/api/gift-cards.md
@@ -67,8 +67,8 @@ end
 
 # Create Gift Card
 
-Creates a digital gift card. You must activate the gift card before
-it can be used. For more information, see
+Creates a digital gift card or registers a physical (plastic) gift card. You must activate the gift card before
+it can be used for payment. For more information, see
 [Selling gift cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#selling-square-gift-cards).
 
 ```ruby