square_connect 2.1.0.beta → 2.1.0.78

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dd47f4de208912493332e7ed8cba8e5cf5a61e3
-  data.tar.gz: 34d6a856a4d28c7acf039ef6f64ca6c3aa7c3c10
+  metadata.gz: e96e8cef9e8325b5e7d5bfa82cf8ce2a0bf8e0ac
+  data.tar.gz: 155d5dd0bc86fe672626bbfcd56090c76cfcdd8a
 SHA512:
-  metadata.gz: 8d660d20f253bb973a562ccae4193ebeb7bec5c457a814c754f8528630e46a58a83637845baa3c177f10eb73546709e105a78dc3870b17bb4a742fda42135032
-  data.tar.gz: b0bff99a4e1974fa7f936d0c94b967a8dcc4be1bac6dc993997fc42ccac3e86f7162bb41de3afd8a12447cc5a64cd6d09a8be470399d6cff1cf1303f4d2caaaf
+  metadata.gz: 3527bc21da434a01c4078f41b33d10c6e6f9230a8a896cfcc2a2d58fd928d47d7842c6a09e239594eef7ce23615868e65cfea1e1836d0921f50e3a69375abd67
+  data.tar.gz: 31e9bf0f39e7261e094b815e4c3e856276ef312e29e3809595e767fbd1e8cf4156a9b55106982cac0fa24a08515e3eaf00cdb180558583246edeee36b8076bd4

data/README.md

@@ -1,6 +1,8 @@
 Square Connect Ruby SDKs [![Build Status](https://travis-ci.org/square/connect-ruby-sdk.svg?branch=master)](https://travis-ci.org/square/connect-ruby-sdk)[![Gem Version](https://badge.fury.io/rb/square_connect.svg)](https://badge.fury.io/rb/square_connect)
 ==================
 
+**If you have feedback about the new SDKs, or just want to talk to other Square Developers, request an invite to the new [slack community for Square Developers](https://docs.google.com/forms/d/e/1FAIpQLSfAZGIEZoNs-XryKqUoW3atFQHdQw5UqXLMOVPq3V4DEq-AJw/viewform?usp=sf_link#response=ACYDBNj5LFgPy8Tcac2gSgv_IjXvgWsPy2CO2xTXwnc0OSSxCvWFgc7SCDHvVQ)**
+
 This repository contains the released Ruby client SDK. Check out our [API
 specification repository](https://github.com/square/connect-api-specification)
 for the specification and template files we used to generate this.
@@ -55,19 +57,17 @@ SquareConnect.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = SquareConnect::CheckoutApi.new
-
-location_id = "location_id_example" # String | The ID of the business location to associate the checkout with.
+api_instance = SquareConnect::CatalogApi.new
 
-body = SquareConnect::CreateCheckoutRequest.new # CreateCheckoutRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+body = SquareConnect::BatchDeleteCatalogObjectsRequest.new # BatchDeleteCatalogObjectsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
 
 
 begin
-  #CreateCheckout
-  result = api_instance.create_checkout(location_id, body)
+  #BatchDeleteCatalogObjects
+  result = api_instance.batch_delete_catalog_objects(body)
   p result
 rescue SquareConnect::ApiError => e
-  puts "Exception when calling CheckoutApi->create_checkout: #{e}"
+  puts "Exception when calling CatalogApi->batch_delete_catalog_objects: #{e}"
 end
 
 ```
@@ -78,6 +78,17 @@ All URIs are relative to *https://connect.squareup.com*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*SquareConnect::CatalogApi* | [**batch_delete_catalog_objects**](docs/CatalogApi.md#batch_delete_catalog_objects) | **POST** /v2/catalog/batch-delete | BatchDeleteCatalogObjects
+*SquareConnect::CatalogApi* | [**batch_retrieve_catalog_objects**](docs/CatalogApi.md#batch_retrieve_catalog_objects) | **POST** /v2/catalog/batch-retrieve | BatchRetrieveCatalogObjects
+*SquareConnect::CatalogApi* | [**batch_upsert_catalog_objects**](docs/CatalogApi.md#batch_upsert_catalog_objects) | **POST** /v2/catalog/batch-upsert | BatchUpsertCatalogObjects
+*SquareConnect::CatalogApi* | [**catalog_info**](docs/CatalogApi.md#catalog_info) | **GET** /v2/catalog/info | CatalogInfo
+*SquareConnect::CatalogApi* | [**delete_catalog_object**](docs/CatalogApi.md#delete_catalog_object) | **DELETE** /v2/catalog/object/{object_id} | DeleteCatalogObject
+*SquareConnect::CatalogApi* | [**list_catalog**](docs/CatalogApi.md#list_catalog) | **GET** /v2/catalog/list | ListCatalog
+*SquareConnect::CatalogApi* | [**retrieve_catalog_object**](docs/CatalogApi.md#retrieve_catalog_object) | **GET** /v2/catalog/object/{object_id} | RetrieveCatalogObject
+*SquareConnect::CatalogApi* | [**search_catalog_objects**](docs/CatalogApi.md#search_catalog_objects) | **POST** /v2/catalog/search | SearchCatalogObjects
+*SquareConnect::CatalogApi* | [**update_item_modifier_lists**](docs/CatalogApi.md#update_item_modifier_lists) | **POST** /v2/catalog/update-item-modifier-lists | UpdateItemModifierLists
+*SquareConnect::CatalogApi* | [**update_item_taxes**](docs/CatalogApi.md#update_item_taxes) | **POST** /v2/catalog/update-item-taxes | UpdateItemTaxes
+*SquareConnect::CatalogApi* | [**upsert_catalog_object**](docs/CatalogApi.md#upsert_catalog_object) | **POST** /v2/catalog/object | UpsertCatalogObject
 *SquareConnect::CheckoutApi* | [**create_checkout**](docs/CheckoutApi.md#create_checkout) | **POST** /v2/locations/{location_id}/checkouts | CreateCheckout
 *SquareConnect::CustomersApi* | [**create_customer**](docs/CustomersApi.md#create_customer) | **POST** /v2/customers | CreateCustomer
 *SquareConnect::CustomersApi* | [**create_customer_card**](docs/CustomersApi.md#create_customer_card) | **POST** /v2/customers/{customer_id}/cards | CreateCustomerCard
@@ -168,10 +179,45 @@ Class | Method | HTTP request | Description
 ## Documentation for Models
 
  - [SquareConnect::Address](docs/Address.md)
+ - [SquareConnect::BatchDeleteCatalogObjectsRequest](docs/BatchDeleteCatalogObjectsRequest.md)
+ - [SquareConnect::BatchDeleteCatalogObjectsResponse](docs/BatchDeleteCatalogObjectsResponse.md)
+ - [SquareConnect::BatchRetrieveCatalogObjectsRequest](docs/BatchRetrieveCatalogObjectsRequest.md)
+ - [SquareConnect::BatchRetrieveCatalogObjectsResponse](docs/BatchRetrieveCatalogObjectsResponse.md)
+ - [SquareConnect::BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md)
+ - [SquareConnect::BatchUpsertCatalogObjectsResponse](docs/BatchUpsertCatalogObjectsResponse.md)
  - [SquareConnect::CaptureTransactionRequest](docs/CaptureTransactionRequest.md)
  - [SquareConnect::CaptureTransactionResponse](docs/CaptureTransactionResponse.md)
  - [SquareConnect::Card](docs/Card.md)
  - [SquareConnect::CardBrand](docs/CardBrand.md)
+ - [SquareConnect::CatalogCategory](docs/CatalogCategory.md)
+ - [SquareConnect::CatalogDiscount](docs/CatalogDiscount.md)
+ - [SquareConnect::CatalogDiscountType](docs/CatalogDiscountType.md)
+ - [SquareConnect::CatalogIdMapping](docs/CatalogIdMapping.md)
+ - [SquareConnect::CatalogInfoRequest](docs/CatalogInfoRequest.md)
+ - [SquareConnect::CatalogInfoResponse](docs/CatalogInfoResponse.md)
+ - [SquareConnect::CatalogInfoResponseLimits](docs/CatalogInfoResponseLimits.md)
+ - [SquareConnect::CatalogItem](docs/CatalogItem.md)
+ - [SquareConnect::CatalogItemModifierListInfo](docs/CatalogItemModifierListInfo.md)
+ - [SquareConnect::CatalogItemProductType](docs/CatalogItemProductType.md)
+ - [SquareConnect::CatalogItemVariation](docs/CatalogItemVariation.md)
+ - [SquareConnect::CatalogModifier](docs/CatalogModifier.md)
+ - [SquareConnect::CatalogModifierList](docs/CatalogModifierList.md)
+ - [SquareConnect::CatalogModifierListSelectionType](docs/CatalogModifierListSelectionType.md)
+ - [SquareConnect::CatalogModifierOverride](docs/CatalogModifierOverride.md)
+ - [SquareConnect::CatalogObject](docs/CatalogObject.md)
+ - [SquareConnect::CatalogObjectBatch](docs/CatalogObjectBatch.md)
+ - [SquareConnect::CatalogObjectType](docs/CatalogObjectType.md)
+ - [SquareConnect::CatalogPricingType](docs/CatalogPricingType.md)
+ - [SquareConnect::CatalogQuery](docs/CatalogQuery.md)
+ - [SquareConnect::CatalogQueryExact](docs/CatalogQueryExact.md)
+ - [SquareConnect::CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md)
+ - [SquareConnect::CatalogQueryItemsForTax](docs/CatalogQueryItemsForTax.md)
+ - [SquareConnect::CatalogQueryPrefix](docs/CatalogQueryPrefix.md)
+ - [SquareConnect::CatalogQueryRange](docs/CatalogQueryRange.md)
+ - [SquareConnect::CatalogQuerySortedAttribute](docs/CatalogQuerySortedAttribute.md)
+ - [SquareConnect::CatalogQueryText](docs/CatalogQueryText.md)
+ - [SquareConnect::CatalogTax](docs/CatalogTax.md)
+ - [SquareConnect::CatalogV1Id](docs/CatalogV1Id.md)
  - [SquareConnect::ChargeRequest](docs/ChargeRequest.md)
  - [SquareConnect::ChargeResponse](docs/ChargeResponse.md)
  - [SquareConnect::Checkout](docs/Checkout.md)
@@ -182,7 +228,6 @@ Class | Method | HTTP request | Description
  - [SquareConnect::CreateCustomerCardResponse](docs/CreateCustomerCardResponse.md)
  - [SquareConnect::CreateCustomerRequest](docs/CreateCustomerRequest.md)
  - [SquareConnect::CreateCustomerResponse](docs/CreateCustomerResponse.md)
- - [SquareConnect::CreateOrderRequest](docs/CreateOrderRequest.md)
  - [SquareConnect::CreateOrderRequestLineItem](docs/CreateOrderRequestLineItem.md)
  - [SquareConnect::CreateOrderRequestOrder](docs/CreateOrderRequestOrder.md)
  - [SquareConnect::CreateRefundRequest](docs/CreateRefundRequest.md)
@@ -191,6 +236,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect::Customer](docs/Customer.md)
  - [SquareConnect::CustomerGroupInfo](docs/CustomerGroupInfo.md)
  - [SquareConnect::CustomerPreferences](docs/CustomerPreferences.md)
+ - [SquareConnect::DeleteCatalogObjectRequest](docs/DeleteCatalogObjectRequest.md)
+ - [SquareConnect::DeleteCatalogObjectResponse](docs/DeleteCatalogObjectResponse.md)
  - [SquareConnect::DeleteCustomerCardRequest](docs/DeleteCustomerCardRequest.md)
  - [SquareConnect::DeleteCustomerCardResponse](docs/DeleteCustomerCardResponse.md)
  - [SquareConnect::DeleteCustomerRequest](docs/DeleteCustomerRequest.md)
@@ -199,6 +246,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect::Error](docs/Error.md)
  - [SquareConnect::ErrorCategory](docs/ErrorCategory.md)
  - [SquareConnect::ErrorCode](docs/ErrorCode.md)
+ - [SquareConnect::InventoryAlertType](docs/InventoryAlertType.md)
+ - [SquareConnect::ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md)
+ - [SquareConnect::ListCatalogRequest](docs/ListCatalogRequest.md)
+ - [SquareConnect::ListCatalogResponse](docs/ListCatalogResponse.md)
  - [SquareConnect::ListCustomersRequest](docs/ListCustomersRequest.md)
  - [SquareConnect::ListCustomersResponse](docs/ListCustomersResponse.md)
  - [SquareConnect::ListLocationsRequest](docs/ListLocationsRequest.md)
@@ -214,11 +265,17 @@ Class | Method | HTTP request | Description
  - [SquareConnect::OrderLineItem](docs/OrderLineItem.md)
  - [SquareConnect::Refund](docs/Refund.md)
  - [SquareConnect::RefundStatus](docs/RefundStatus.md)
+ - [SquareConnect::RetrieveCatalogObjectRequest](docs/RetrieveCatalogObjectRequest.md)
+ - [SquareConnect::RetrieveCatalogObjectResponse](docs/RetrieveCatalogObjectResponse.md)
  - [SquareConnect::RetrieveCustomerRequest](docs/RetrieveCustomerRequest.md)
  - [SquareConnect::RetrieveCustomerResponse](docs/RetrieveCustomerResponse.md)
  - [SquareConnect::RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md)
  - [SquareConnect::RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md)
+ - [SquareConnect::SearchCatalogObjectsRequest](docs/SearchCatalogObjectsRequest.md)
+ - [SquareConnect::SearchCatalogObjectsResponse](docs/SearchCatalogObjectsResponse.md)
  - [SquareConnect::SortOrder](docs/SortOrder.md)
+ - [SquareConnect::TaxCalculationPhase](docs/TaxCalculationPhase.md)
+ - [SquareConnect::TaxInclusionType](docs/TaxInclusionType.md)
  - [SquareConnect::Tender](docs/Tender.md)
  - [SquareConnect::TenderCardDetails](docs/TenderCardDetails.md)
  - [SquareConnect::TenderCardDetailsEntryMethod](docs/TenderCardDetailsEntryMethod.md)
@@ -229,6 +286,12 @@ Class | Method | HTTP request | Description
  - [SquareConnect::TransactionProduct](docs/TransactionProduct.md)
  - [SquareConnect::UpdateCustomerRequest](docs/UpdateCustomerRequest.md)
  - [SquareConnect::UpdateCustomerResponse](docs/UpdateCustomerResponse.md)
+ - [SquareConnect::UpdateItemModifierListsRequest](docs/UpdateItemModifierListsRequest.md)
+ - [SquareConnect::UpdateItemModifierListsResponse](docs/UpdateItemModifierListsResponse.md)
+ - [SquareConnect::UpdateItemTaxesRequest](docs/UpdateItemTaxesRequest.md)
+ - [SquareConnect::UpdateItemTaxesResponse](docs/UpdateItemTaxesResponse.md)
+ - [SquareConnect::UpsertCatalogObjectRequest](docs/UpsertCatalogObjectRequest.md)
+ - [SquareConnect::UpsertCatalogObjectResponse](docs/UpsertCatalogObjectResponse.md)
  - [SquareConnect::V1AdjustInventoryRequest](docs/V1AdjustInventoryRequest.md)
  - [SquareConnect::V1BankAccount](docs/V1BankAccount.md)
  - [SquareConnect::V1CashDrawerEvent](docs/V1CashDrawerEvent.md)

data/docs/BatchDeleteCatalogObjectsRequest.md

@@ -0,0 +1,12 @@
+# SquareConnect::BatchDeleteCatalogObjectsRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object_ids** | **Array<String>** | The IDs of the [CatalogObject](#type-catalogobject)s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). | [optional] 
+
+

data/docs/BatchDeleteCatalogObjectsResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::BatchDeleteCatalogObjectsResponse
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
+**deleted_object_ids** | **Array<String>** | The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. | [optional] 
+**deleted_at** | **String** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
+
+

data/docs/BatchRetrieveCatalogObjectsRequest.md

@@ -0,0 +1,13 @@
+# SquareConnect::BatchRetrieveCatalogObjectsRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object_ids** | **Array<String>** | The IDs of the [CatalogObject](#type-catalogobject)s to be retrieved. | 
+**include_related_objects** | **BOOLEAN** | If `true`, the response will include additional objects that are related to the requested objects, as follows:  If the `objects` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. | [optional] 
+
+

data/docs/BatchRetrieveCatalogObjectsResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::BatchRetrieveCatalogObjectsResponse
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
+**objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s returned. | [optional] 
+**related_objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `objects` field. | [optional] 
+
+

data/docs/BatchUpsertCatalogObjectsRequest.md

@@ -0,0 +1,13 @@
+# SquareConnect::BatchUpsertCatalogObjectsRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**idempotency_key** | **String** | 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 keys](#idempotencykeys) for more information. | 
+**batches** | [**Array<CatalogObjectBatch>**](CatalogObjectBatch.md) | A batch of [CatalogObject](#type-catalogobject)s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request.  For each object, its `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`.  To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a [CatalogItem](#type-catalogitem) with ID `#ABC` and a [CatalogItemVariation](#type-catalogitemvariation) with its `item_id` attribute set to `#ABC` in order to associate the [CatalogItemVariation](#type-catalogitemvariation) with its parent [CatalogItem](#type-catalogitem).  Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs.  Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. | [optional] 
+
+

data/docs/BatchUpsertCatalogObjectsResponse.md

@@ -0,0 +1,15 @@
+# SquareConnect::BatchUpsertCatalogObjectsResponse
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
+**objects** | [**Array<CatalogObject>**](CatalogObject.md) | The created [CatalogObject](#type-catalogobject)s | [optional] 
+**updated_at** | **String** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
+**id_mappings** | [**Array<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this Upsert. | [optional] 
+
+

data/docs/CatalogApi.md

@@ -0,0 +1,592 @@
+# SquareConnect::CatalogApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**batch_delete_catalog_objects**](CatalogApi.md#batch_delete_catalog_objects) | **POST** /v2/catalog/batch-delete | BatchDeleteCatalogObjects
+[**batch_retrieve_catalog_objects**](CatalogApi.md#batch_retrieve_catalog_objects) | **POST** /v2/catalog/batch-retrieve | BatchRetrieveCatalogObjects
+[**batch_upsert_catalog_objects**](CatalogApi.md#batch_upsert_catalog_objects) | **POST** /v2/catalog/batch-upsert | BatchUpsertCatalogObjects
+[**catalog_info**](CatalogApi.md#catalog_info) | **GET** /v2/catalog/info | CatalogInfo
+[**delete_catalog_object**](CatalogApi.md#delete_catalog_object) | **DELETE** /v2/catalog/object/{object_id} | DeleteCatalogObject
+[**list_catalog**](CatalogApi.md#list_catalog) | **GET** /v2/catalog/list | ListCatalog
+[**retrieve_catalog_object**](CatalogApi.md#retrieve_catalog_object) | **GET** /v2/catalog/object/{object_id} | RetrieveCatalogObject
+[**search_catalog_objects**](CatalogApi.md#search_catalog_objects) | **POST** /v2/catalog/search | SearchCatalogObjects
+[**update_item_modifier_lists**](CatalogApi.md#update_item_modifier_lists) | **POST** /v2/catalog/update-item-modifier-lists | UpdateItemModifierLists
+[**update_item_taxes**](CatalogApi.md#update_item_taxes) | **POST** /v2/catalog/update-item-taxes | UpdateItemTaxes
+[**upsert_catalog_object**](CatalogApi.md#upsert_catalog_object) | **POST** /v2/catalog/object | UpsertCatalogObject
+
+
+# **batch_delete_catalog_objects**
+> BatchDeleteCatalogObjectsResponse batch_delete_catalog_objects(body)
+
+BatchDeleteCatalogObjects
+
+Deletes a set of [CatalogItem](#type-catalogitem)s based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a CatalogItem will also delete all of its [CatalogItemVariation](#type-catalogitemvariation) children.  `BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted IDs can be deleted. The response will only include IDs that were actually deleted.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+body = SquareConnect::BatchDeleteCatalogObjectsRequest.new # BatchDeleteCatalogObjectsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #BatchDeleteCatalogObjects
+  result = api_instance.batch_delete_catalog_objects(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->batch_delete_catalog_objects: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**BatchDeleteCatalogObjectsRequest**](BatchDeleteCatalogObjectsRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**BatchDeleteCatalogObjectsResponse**](BatchDeleteCatalogObjectsResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **batch_retrieve_catalog_objects**
+> BatchRetrieveCatalogObjectsResponse batch_retrieve_catalog_objects(body)
+
+BatchRetrieveCatalogObjects
+
+Returns a set of objects based on the provided ID. [CatalogItem](#type-catalogitem)s returned in the set include all of the child information including: all [CatalogItemVariation](#type-catalogitemvariation) objects, references to its [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of any [CatalogTax](#type-catalogtax) objects that apply to it.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+body = SquareConnect::BatchRetrieveCatalogObjectsRequest.new # BatchRetrieveCatalogObjectsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #BatchRetrieveCatalogObjects
+  result = api_instance.batch_retrieve_catalog_objects(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->batch_retrieve_catalog_objects: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**BatchRetrieveCatalogObjectsRequest**](BatchRetrieveCatalogObjectsRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**BatchRetrieveCatalogObjectsResponse**](BatchRetrieveCatalogObjectsResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **batch_upsert_catalog_objects**
+> BatchUpsertCatalogObjectsResponse batch_upsert_catalog_objects(body)
+
+BatchUpsertCatalogObjects
+
+Creates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is inserted/updated in an all-or-nothing manner. If an object within a batch is malformed in some way, or violates a database constraint, the entire batch containing that item will be disregarded. However, other batches in the same request may still succeed. Each batch may contain up to 1,000 objects, and batches will be processed in order as long as the total object count for the request (items, variations, modifier lists, discounts, and taxes) is no more than 10,000.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+body = SquareConnect::BatchUpsertCatalogObjectsRequest.new # BatchUpsertCatalogObjectsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #BatchUpsertCatalogObjects
+  result = api_instance.batch_upsert_catalog_objects(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->batch_upsert_catalog_objects: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**BatchUpsertCatalogObjectsRequest**](BatchUpsertCatalogObjectsRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**BatchUpsertCatalogObjectsResponse**](BatchUpsertCatalogObjectsResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **catalog_info**
+> CatalogInfoResponse catalog_info
+
+CatalogInfo
+
+Returns information about the Square Catalog API, such as batch size limits for `BatchUpsertCatalogObjects`.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+begin
+  #CatalogInfo
+  result = api_instance.catalog_info
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->catalog_info: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CatalogInfoResponse**](CatalogInfoResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_catalog_object**
+> DeleteCatalogObjectResponse delete_catalog_object(object_id)
+
+DeleteCatalogObject
+
+Deletes a single [CatalogObject](#type-catalogobject) based on the provided ID and returns the set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a [CatalogItem](#type-catalogitem) will also delete all of its [CatalogItemVariation](#type-catalogitemvariation) children.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+object_id = "object_id_example" # String | The ID of the [CatalogObject](#type-catalogobject) to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s).
+
+
+begin
+  #DeleteCatalogObject
+  result = api_instance.delete_catalog_object(object_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->delete_catalog_object: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **object_id** | **String**| The ID of the [CatalogObject](#type-catalogobject) to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). | 
+
+### Return type
+
+[**DeleteCatalogObjectResponse**](DeleteCatalogObjectResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_catalog**
+> ListCatalogResponse list_catalog(opts)
+
+ListCatalog
+
+Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The types parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+opts = { 
+  cursor: "cursor_example", # String | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information.
+  types: "types_example" # String | 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\"`.
+}
+
+begin
+  #ListCatalog
+  result = api_instance.list_catalog(opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->list_catalog: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cursor** | **String**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional] 
+ **types** | **String**| 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] 
+
+### Return type
+
+[**ListCatalogResponse**](ListCatalogResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_catalog_object**
+> RetrieveCatalogObjectResponse retrieve_catalog_object(object_id, opts)
+
+RetrieveCatalogObject
+
+Returns a single [CatalogItem](#type-catalogitem) as a [CatalogObject](#type-catalogobject) based on the provided ID. The returned object includes all of the relevant [CatalogItem](#type-catalogitem) information including: [CatalogItemVariation](#type-catalogitemvariation) children, references to its [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of any [CatalogTax](#type-catalogtax) objects that apply to it.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+object_id = "object_id_example" # String | The object ID of any type of [CatalogObject](#type-catalogobject)s to be retrieved.
+
+opts = { 
+  include_related_objects: true # BOOLEAN | If `true`, the response will include additional objects that are related to the requested object, as follows:  If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response.
+}
+
+begin
+  #RetrieveCatalogObject
+  result = api_instance.retrieve_catalog_object(object_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->retrieve_catalog_object: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **object_id** | **String**| The object ID of any type of [CatalogObject](#type-catalogobject)s to be retrieved. | 
+ **include_related_objects** | **BOOLEAN**| If `true`, the response will include additional objects that are related to the requested object, as follows:  If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. | [optional] 
+
+### Return type
+
+[**RetrieveCatalogObjectResponse**](RetrieveCatalogObjectResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **search_catalog_objects**
+> SearchCatalogObjectsResponse search_catalog_objects(body)
+
+SearchCatalogObjects
+
+Queries the targeted catalog using a variety of query types ([CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), ([CatalogQueryExact](#type-catalogqueryexact, ([CatalogQueryRange](#type-catalogqueryrange), ([CatalogQueryText](#type-catalogquerytext), ([CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), ([CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)).
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+body = SquareConnect::SearchCatalogObjectsRequest.new # SearchCatalogObjectsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #SearchCatalogObjects
+  result = api_instance.search_catalog_objects(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->search_catalog_objects: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SearchCatalogObjectsRequest**](SearchCatalogObjectsRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**SearchCatalogObjectsResponse**](SearchCatalogObjectsResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_item_modifier_lists**
+> UpdateItemModifierListsResponse update_item_modifier_lists(body)
+
+UpdateItemModifierLists
+
+Updates the [CatalogModifierList](#type-catalogmodifierlist) objects that apply to the targeted [CatalogItem](#type-catalogitem) without having to perform an upsert on the entire item.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+body = SquareConnect::UpdateItemModifierListsRequest.new # UpdateItemModifierListsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #UpdateItemModifierLists
+  result = api_instance.update_item_modifier_lists(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->update_item_modifier_lists: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpdateItemModifierListsRequest**](UpdateItemModifierListsRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**UpdateItemModifierListsResponse**](UpdateItemModifierListsResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_item_taxes**
+> UpdateItemTaxesResponse update_item_taxes(body)
+
+UpdateItemTaxes
+
+Updates the [CatalogTax](#type-catalogtax) objects that apply to the targeted [CatalogItem](#type-catalogitem) without having to perform an upsert on the entire item.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+body = SquareConnect::UpdateItemTaxesRequest.new # UpdateItemTaxesRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #UpdateItemTaxes
+  result = api_instance.update_item_taxes(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->update_item_taxes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpdateItemTaxesRequest**](UpdateItemTaxesRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**UpdateItemTaxesResponse**](UpdateItemTaxesResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **upsert_catalog_object**
+> UpsertCatalogObjectResponse upsert_catalog_object(body)
+
+UpsertCatalogObject
+
+Creates or updates the target [CatalogObject](#type-catalogobject).
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::CatalogApi.new
+
+body = SquareConnect::UpsertCatalogObjectRequest.new # UpsertCatalogObjectRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #UpsertCatalogObject
+  result = api_instance.upsert_catalog_object(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling CatalogApi->upsert_catalog_object: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpsertCatalogObjectRequest**](UpsertCatalogObjectRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**UpsertCatalogObjectResponse**](UpsertCatalogObjectResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+