docs/V1ItemsApi.md in square_connect-2.20190213.0.274 vs docs/V1ItemsApi.md in square_connect-2.20190313.0.278
- old
+ new
@@ -2,56 +2,56 @@
All URIs are relative to *https://connect.squareup.com*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**adjust_inventory**](V1ItemsApi.md#adjust_inventory) | **POST** /v1/{location_id}/inventory/{variation_id} | Adjusts an item variation's current available inventory.
-[**apply_fee**](V1ItemsApi.md#apply_fee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.
-[**apply_modifier_list**](V1ItemsApi.md#apply_modifier_list) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.
-[**create_category**](V1ItemsApi.md#create_category) | **POST** /v1/{location_id}/categories | Creates an item category.
-[**create_discount**](V1ItemsApi.md#create_discount) | **POST** /v1/{location_id}/discounts | Creates a discount.
-[**create_fee**](V1ItemsApi.md#create_fee) | **POST** /v1/{location_id}/fees | Creates a fee (tax).
-[**create_item**](V1ItemsApi.md#create_item) | **POST** /v1/{location_id}/items | Creates an item and at least one variation for it.
-[**create_modifier_list**](V1ItemsApi.md#create_modifier_list) | **POST** /v1/{location_id}/modifier-lists | Creates an item modifier list and at least one modifier option for it.
-[**create_modifier_option**](V1ItemsApi.md#create_modifier_option) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | Creates an item modifier option and adds it to a modifier list.
-[**create_page**](V1ItemsApi.md#create_page) | **POST** /v1/{location_id}/pages | Creates a Favorites page in Square Register.
-[**create_variation**](V1ItemsApi.md#create_variation) | **POST** /v1/{location_id}/items/{item_id}/variations | Creates an item variation for an existing item.
-[**delete_category**](V1ItemsApi.md#delete_category) | **DELETE** /v1/{location_id}/categories/{category_id} | Deletes an existing item category.
-[**delete_discount**](V1ItemsApi.md#delete_discount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | Deletes an existing discount.
-[**delete_fee**](V1ItemsApi.md#delete_fee) | **DELETE** /v1/{location_id}/fees/{fee_id} | Deletes an existing fee (tax).
-[**delete_item**](V1ItemsApi.md#delete_item) | **DELETE** /v1/{location_id}/items/{item_id} | Deletes an existing item and all item variations associated with it.
-[**delete_modifier_list**](V1ItemsApi.md#delete_modifier_list) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | Deletes an existing item modifier list and all modifier options associated with it.
-[**delete_modifier_option**](V1ItemsApi.md#delete_modifier_option) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | Deletes an existing item modifier option from a modifier list.
-[**delete_page**](V1ItemsApi.md#delete_page) | **DELETE** /v1/{location_id}/pages/{page_id} | Deletes an existing Favorites page and all of its cells.
-[**delete_page_cell**](V1ItemsApi.md#delete_page_cell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | Deletes a cell from a Favorites page in Square Register.
-[**delete_variation**](V1ItemsApi.md#delete_variation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | Deletes an existing item variation from an item.
-[**list_categories**](V1ItemsApi.md#list_categories) | **GET** /v1/{location_id}/categories | Lists all of a location's item categories.
-[**list_discounts**](V1ItemsApi.md#list_discounts) | **GET** /v1/{location_id}/discounts | Lists all of a location's discounts.
-[**list_fees**](V1ItemsApi.md#list_fees) | **GET** /v1/{location_id}/fees | Lists all of a location's fees (taxes).
-[**list_inventory**](V1ItemsApi.md#list_inventory) | **GET** /v1/{location_id}/inventory | Provides inventory information for all of a merchant's inventory-enabled item variations.
-[**list_items**](V1ItemsApi.md#list_items) | **GET** /v1/{location_id}/items | Provides summary information for all of a location's items.
-[**list_modifier_lists**](V1ItemsApi.md#list_modifier_lists) | **GET** /v1/{location_id}/modifier-lists | Lists all of a location's modifier lists.
-[**list_pages**](V1ItemsApi.md#list_pages) | **GET** /v1/{location_id}/pages | Lists all of a location's Favorites pages in Square Register.
-[**remove_fee**](V1ItemsApi.md#remove_fee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.
-[**remove_modifier_list**](V1ItemsApi.md#remove_modifier_list) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.
-[**retrieve_item**](V1ItemsApi.md#retrieve_item) | **GET** /v1/{location_id}/items/{item_id} | Provides the details for a single item, including associated modifier lists and fees.
-[**retrieve_modifier_list**](V1ItemsApi.md#retrieve_modifier_list) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | Provides the details for a single modifier list.
-[**update_category**](V1ItemsApi.md#update_category) | **PUT** /v1/{location_id}/categories/{category_id} | Modifies the details of an existing item category.
-[**update_discount**](V1ItemsApi.md#update_discount) | **PUT** /v1/{location_id}/discounts/{discount_id} | Modifies the details of an existing discount.
-[**update_fee**](V1ItemsApi.md#update_fee) | **PUT** /v1/{location_id}/fees/{fee_id} | Modifies the details of an existing fee (tax).
-[**update_item**](V1ItemsApi.md#update_item) | **PUT** /v1/{location_id}/items/{item_id} | Modifies the core details of an existing item.
-[**update_modifier_list**](V1ItemsApi.md#update_modifier_list) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | Modifies the details of an existing item modifier list.
-[**update_modifier_option**](V1ItemsApi.md#update_modifier_option) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | Modifies the details of an existing item modifier option.
-[**update_page**](V1ItemsApi.md#update_page) | **PUT** /v1/{location_id}/pages/{page_id} | Modifies the details of a Favorites page in Square Register.
-[**update_page_cell**](V1ItemsApi.md#update_page_cell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | Modifies a cell of a Favorites page in Square Register.
-[**update_variation**](V1ItemsApi.md#update_variation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | Modifies the details of an existing item variation.
+[**adjust_inventory**](V1ItemsApi.md#adjust_inventory) | **POST** /v1/{location_id}/inventory/{variation_id} | AdjustInventory
+[**apply_fee**](V1ItemsApi.md#apply_fee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | ApplyFee
+[**apply_modifier_list**](V1ItemsApi.md#apply_modifier_list) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | ApplyModifierList
+[**create_category**](V1ItemsApi.md#create_category) | **POST** /v1/{location_id}/categories | CreateCategory
+[**create_discount**](V1ItemsApi.md#create_discount) | **POST** /v1/{location_id}/discounts | CreateDiscount
+[**create_fee**](V1ItemsApi.md#create_fee) | **POST** /v1/{location_id}/fees | CreateFee
+[**create_item**](V1ItemsApi.md#create_item) | **POST** /v1/{location_id}/items | CreateItem
+[**create_modifier_list**](V1ItemsApi.md#create_modifier_list) | **POST** /v1/{location_id}/modifier-lists | CreateModifierList
+[**create_modifier_option**](V1ItemsApi.md#create_modifier_option) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | CreateModifierOption
+[**create_page**](V1ItemsApi.md#create_page) | **POST** /v1/{location_id}/pages | CreatePage
+[**create_variation**](V1ItemsApi.md#create_variation) | **POST** /v1/{location_id}/items/{item_id}/variations | CreateVariation
+[**delete_category**](V1ItemsApi.md#delete_category) | **DELETE** /v1/{location_id}/categories/{category_id} | DeleteCategory
+[**delete_discount**](V1ItemsApi.md#delete_discount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | DeleteDiscount
+[**delete_fee**](V1ItemsApi.md#delete_fee) | **DELETE** /v1/{location_id}/fees/{fee_id} | DeleteFee
+[**delete_item**](V1ItemsApi.md#delete_item) | **DELETE** /v1/{location_id}/items/{item_id} | DeleteItem
+[**delete_modifier_list**](V1ItemsApi.md#delete_modifier_list) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | DeleteModifierList
+[**delete_modifier_option**](V1ItemsApi.md#delete_modifier_option) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | DeleteModifierOption
+[**delete_page**](V1ItemsApi.md#delete_page) | **DELETE** /v1/{location_id}/pages/{page_id} | DeletePage
+[**delete_page_cell**](V1ItemsApi.md#delete_page_cell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | DeletePageCell
+[**delete_variation**](V1ItemsApi.md#delete_variation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | DeleteVariation
+[**list_categories**](V1ItemsApi.md#list_categories) | **GET** /v1/{location_id}/categories | ListCategories
+[**list_discounts**](V1ItemsApi.md#list_discounts) | **GET** /v1/{location_id}/discounts | ListDiscounts
+[**list_fees**](V1ItemsApi.md#list_fees) | **GET** /v1/{location_id}/fees | ListFees
+[**list_inventory**](V1ItemsApi.md#list_inventory) | **GET** /v1/{location_id}/inventory | ListInventory
+[**list_items**](V1ItemsApi.md#list_items) | **GET** /v1/{location_id}/items | ListItems
+[**list_modifier_lists**](V1ItemsApi.md#list_modifier_lists) | **GET** /v1/{location_id}/modifier-lists | ListModifierLists
+[**list_pages**](V1ItemsApi.md#list_pages) | **GET** /v1/{location_id}/pages | ListPages
+[**remove_fee**](V1ItemsApi.md#remove_fee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | RemoveFee
+[**remove_modifier_list**](V1ItemsApi.md#remove_modifier_list) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | RemoveModifierList
+[**retrieve_item**](V1ItemsApi.md#retrieve_item) | **GET** /v1/{location_id}/items/{item_id} | RetrieveItem
+[**retrieve_modifier_list**](V1ItemsApi.md#retrieve_modifier_list) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | RetrieveModifierList
+[**update_category**](V1ItemsApi.md#update_category) | **PUT** /v1/{location_id}/categories/{category_id} | UpdateCategory
+[**update_discount**](V1ItemsApi.md#update_discount) | **PUT** /v1/{location_id}/discounts/{discount_id} | UpdateDiscount
+[**update_fee**](V1ItemsApi.md#update_fee) | **PUT** /v1/{location_id}/fees/{fee_id} | UpdateFee
+[**update_item**](V1ItemsApi.md#update_item) | **PUT** /v1/{location_id}/items/{item_id} | UpdateItem
+[**update_modifier_list**](V1ItemsApi.md#update_modifier_list) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | UpdateModifierList
+[**update_modifier_option**](V1ItemsApi.md#update_modifier_option) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | UpdateModifierOption
+[**update_page**](V1ItemsApi.md#update_page) | **PUT** /v1/{location_id}/pages/{page_id} | UpdatePage
+[**update_page_cell**](V1ItemsApi.md#update_page_cell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | UpdatePageCell
+[**update_variation**](V1ItemsApi.md#update_variation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | UpdateVariation
# **adjust_inventory**
> V1InventoryEntry adjust_inventory(location_id, variation_id, body)
-Adjusts an item variation's current available inventory.
+AdjustInventory
Adjusts an item variation's current available inventory.
### Example
```ruby
@@ -71,11 +71,11 @@
body = SquareConnect::V1AdjustInventoryRequest.new # V1AdjustInventoryRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Adjusts an item variation's current available inventory.
+ #AdjustInventory
result = api_instance.adjust_inventory(location_id, variation_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->adjust_inventory: #{e}"
end
@@ -105,11 +105,11 @@
# **apply_fee**
> V1Item apply_fee(location_id, item_id, fee_id)
-Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.
+ApplyFee
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.
### Example
```ruby
@@ -129,11 +129,11 @@
fee_id = "fee_id_example" # String | The ID of the fee to apply.
begin
- #Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.
+ #ApplyFee
result = api_instance.apply_fee(location_id, item_id, fee_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->apply_fee: #{e}"
end
@@ -163,11 +163,11 @@
# **apply_modifier_list**
> V1Item apply_modifier_list(location_id, modifier_list_id, item_id)
-Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.
+ApplyModifierList
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.
### Example
```ruby
@@ -187,11 +187,11 @@
item_id = "item_id_example" # String | The ID of the item to add the modifier list to.
begin
- #Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.
+ #ApplyModifierList
result = api_instance.apply_modifier_list(location_id, modifier_list_id, item_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->apply_modifier_list: #{e}"
end
@@ -221,11 +221,11 @@
# **create_category**
> V1Category create_category(location_id, body)
-Creates an item category.
+CreateCategory
Creates an item category.
### Example
```ruby
@@ -243,11 +243,11 @@
body = SquareConnect::V1Category.new # V1Category | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Creates an item category.
+ #CreateCategory
result = api_instance.create_category(location_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->create_category: #{e}"
end
@@ -276,11 +276,11 @@
# **create_discount**
> V1Discount create_discount(location_id, body)
-Creates a discount.
+CreateDiscount
Creates a discount.
### Example
```ruby
@@ -298,11 +298,11 @@
body = SquareConnect::V1Discount.new # V1Discount | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Creates a discount.
+ #CreateDiscount
result = api_instance.create_discount(location_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->create_discount: #{e}"
end
@@ -331,11 +331,11 @@
# **create_fee**
> V1Fee create_fee(location_id, body)
-Creates a fee (tax).
+CreateFee
Creates a fee (tax).
### Example
```ruby
@@ -353,11 +353,11 @@
body = SquareConnect::V1Fee.new # V1Fee | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Creates a fee (tax).
+ #CreateFee
result = api_instance.create_fee(location_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->create_fee: #{e}"
end
@@ -386,13 +386,13 @@
# **create_item**
> V1Item create_item(location_id, body)
-Creates an item and at least one variation for it.
+CreateItem
-Creates an item and at least one variation for it.
+Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -408,11 +408,11 @@
body = SquareConnect::V1Item.new # V1Item | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Creates an item and at least one variation for it.
+ #CreateItem
result = api_instance.create_item(location_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->create_item: #{e}"
end
@@ -441,11 +441,11 @@
# **create_modifier_list**
> V1ModifierList create_modifier_list(location_id, body)
-Creates an item modifier list and at least one modifier option for it.
+CreateModifierList
Creates an item modifier list and at least one modifier option for it.
### Example
```ruby
@@ -463,11 +463,11 @@
body = SquareConnect::V1ModifierList.new # V1ModifierList | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Creates an item modifier list and at least one modifier option for it.
+ #CreateModifierList
result = api_instance.create_modifier_list(location_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->create_modifier_list: #{e}"
end
@@ -496,11 +496,11 @@
# **create_modifier_option**
> V1ModifierOption create_modifier_option(location_id, modifier_list_id, body)
-Creates an item modifier option and adds it to a modifier list.
+CreateModifierOption
Creates an item modifier option and adds it to a modifier list.
### Example
```ruby
@@ -520,11 +520,11 @@
body = SquareConnect::V1ModifierOption.new # V1ModifierOption | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Creates an item modifier option and adds it to a modifier list.
+ #CreateModifierOption
result = api_instance.create_modifier_option(location_id, modifier_list_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->create_modifier_option: #{e}"
end
@@ -554,11 +554,11 @@
# **create_page**
> V1Page create_page(location_id, body)
-Creates a Favorites page in Square Register.
+CreatePage
Creates a Favorites page in Square Register.
### Example
```ruby
@@ -576,11 +576,11 @@
body = SquareConnect::V1Page.new # V1Page | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Creates a Favorites page in Square Register.
+ #CreatePage
result = api_instance.create_page(location_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->create_page: #{e}"
end
@@ -609,11 +609,11 @@
# **create_variation**
> V1Variation create_variation(location_id, item_id, body)
-Creates an item variation for an existing item.
+CreateVariation
Creates an item variation for an existing item.
### Example
```ruby
@@ -633,11 +633,11 @@
body = SquareConnect::V1Variation.new # V1Variation | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Creates an item variation for an existing item.
+ #CreateVariation
result = api_instance.create_variation(location_id, item_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->create_variation: #{e}"
end
@@ -667,13 +667,13 @@
# **delete_category**
> V1Category delete_category(location_id, category_id)
-Deletes an existing item category.
+DeleteCategory
-Deletes an existing item category.
+Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -689,11 +689,11 @@
category_id = "category_id_example" # String | The ID of the category to delete.
begin
- #Deletes an existing item category.
+ #DeleteCategory
result = api_instance.delete_category(location_id, category_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->delete_category: #{e}"
end
@@ -722,13 +722,13 @@
# **delete_discount**
> V1Discount delete_discount(location_id, discount_id)
-Deletes an existing discount.
+DeleteDiscount
-Deletes an existing discount.
+Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -744,11 +744,11 @@
discount_id = "discount_id_example" # String | The ID of the discount to delete.
begin
- #Deletes an existing discount.
+ #DeleteDiscount
result = api_instance.delete_discount(location_id, discount_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->delete_discount: #{e}"
end
@@ -777,13 +777,13 @@
# **delete_fee**
> V1Fee delete_fee(location_id, fee_id)
-Deletes an existing fee (tax).
+DeleteFee
-Deletes an existing fee (tax).
+Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -799,11 +799,11 @@
fee_id = "fee_id_example" # String | The ID of the fee to delete.
begin
- #Deletes an existing fee (tax).
+ #DeleteFee
result = api_instance.delete_fee(location_id, fee_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->delete_fee: #{e}"
end
@@ -832,13 +832,13 @@
# **delete_item**
> V1Item delete_item(location_id, item_id)
-Deletes an existing item and all item variations associated with it.
+DeleteItem
-Deletes an existing item and all item variations associated with it.
+Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -854,11 +854,11 @@
item_id = "item_id_example" # String | The ID of the item to modify.
begin
- #Deletes an existing item and all item variations associated with it.
+ #DeleteItem
result = api_instance.delete_item(location_id, item_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->delete_item: #{e}"
end
@@ -887,13 +887,13 @@
# **delete_modifier_list**
> V1ModifierList delete_modifier_list(location_id, modifier_list_id)
-Deletes an existing item modifier list and all modifier options associated with it.
+DeleteModifierList
-Deletes an existing item modifier list and all modifier options associated with it.
+Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -909,11 +909,11 @@
modifier_list_id = "modifier_list_id_example" # String | The ID of the modifier list to delete.
begin
- #Deletes an existing item modifier list and all modifier options associated with it.
+ #DeleteModifierList
result = api_instance.delete_modifier_list(location_id, modifier_list_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->delete_modifier_list: #{e}"
end
@@ -942,13 +942,13 @@
# **delete_modifier_option**
> V1ModifierOption delete_modifier_option(location_id, modifier_list_id, modifier_option_id)
-Deletes an existing item modifier option from a modifier list.
+DeleteModifierOption
-Deletes an existing item modifier option from a modifier list.
+Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -966,11 +966,11 @@
modifier_option_id = "modifier_option_id_example" # String | The ID of the modifier list to edit.
begin
- #Deletes an existing item modifier option from a modifier list.
+ #DeleteModifierOption
result = api_instance.delete_modifier_option(location_id, modifier_list_id, modifier_option_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->delete_modifier_option: #{e}"
end
@@ -1000,13 +1000,13 @@
# **delete_page**
> V1Page delete_page(location_id, page_id)
-Deletes an existing Favorites page and all of its cells.
+DeletePage
-Deletes an existing Favorites page and all of its cells.
+Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -1022,11 +1022,11 @@
page_id = "page_id_example" # String | The ID of the page to delete.
begin
- #Deletes an existing Favorites page and all of its cells.
+ #DeletePage
result = api_instance.delete_page(location_id, page_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->delete_page: #{e}"
end
@@ -1055,13 +1055,13 @@
# **delete_page_cell**
> V1Page delete_page_cell(location_id, page_id, opts)
-Deletes a cell from a Favorites page in Square Register.
+DeletePageCell
-Deletes a cell from a Favorites page in Square Register.
+Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -1081,11 +1081,11 @@
row: "row_example", # String | The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row.
column: "column_example" # String | The column of the cell to clear. Always an integer between 0 and 4, inclusive. Column 0 is the leftmost column.
}
begin
- #Deletes a cell from a Favorites page in Square Register.
+ #DeletePageCell
result = api_instance.delete_page_cell(location_id, page_id, opts)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->delete_page_cell: #{e}"
end
@@ -1116,13 +1116,13 @@
# **delete_variation**
> V1Variation delete_variation(location_id, item_id, variation_id)
-Deletes an existing item variation from an item.
+DeleteVariation
-Deletes an existing item variation from an item.
+Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below.
### Example
```ruby
# load the gem
require 'square_connect'
@@ -1140,11 +1140,11 @@
variation_id = "variation_id_example" # String | The ID of the variation to delete.
begin
- #Deletes an existing item variation from an item.
+ #DeleteVariation
result = api_instance.delete_variation(location_id, item_id, variation_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->delete_variation: #{e}"
end
@@ -1174,11 +1174,11 @@
# **list_categories**
> Array<V1Category> list_categories(location_id)
-Lists all of a location's item categories.
+ListCategories
Lists all of a location's item categories.
### Example
```ruby
@@ -1194,11 +1194,11 @@
location_id = "location_id_example" # String | The ID of the location to list categories for.
begin
- #Lists all of a location's item categories.
+ #ListCategories
result = api_instance.list_categories(location_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->list_categories: #{e}"
end
@@ -1226,11 +1226,11 @@
# **list_discounts**
> Array<V1Discount> list_discounts(location_id)
-Lists all of a location's discounts.
+ListDiscounts
Lists all of a location's discounts.
### Example
```ruby
@@ -1246,11 +1246,11 @@
location_id = "location_id_example" # String | The ID of the location to list categories for.
begin
- #Lists all of a location's discounts.
+ #ListDiscounts
result = api_instance.list_discounts(location_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->list_discounts: #{e}"
end
@@ -1278,11 +1278,11 @@
# **list_fees**
> Array<V1Fee> list_fees(location_id)
-Lists all of a location's fees (taxes).
+ListFees
Lists all of a location's fees (taxes).
### Example
```ruby
@@ -1298,11 +1298,11 @@
location_id = "location_id_example" # String | The ID of the location to list fees for.
begin
- #Lists all of a location's fees (taxes).
+ #ListFees
result = api_instance.list_fees(location_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->list_fees: #{e}"
end
@@ -1330,11 +1330,11 @@
# **list_inventory**
> Array<V1InventoryEntry> list_inventory(location_id, opts)
-Provides inventory information for all of a merchant's inventory-enabled item variations.
+ListInventory
Provides inventory information for all of a merchant's inventory-enabled item variations.
### Example
```ruby
@@ -1354,11 +1354,11 @@
limit: 56, # Integer | The maximum number of inventory entries to return in a single response. This value cannot exceed 1000.
batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
}
begin
- #Provides inventory information for all of a merchant's inventory-enabled item variations.
+ #ListInventory
result = api_instance.list_inventory(location_id, opts)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->list_inventory: #{e}"
end
@@ -1388,11 +1388,11 @@
# **list_items**
> Array<V1Item> list_items(location_id, opts)
-Provides summary information for all of a location's items.
+ListItems
Provides summary information for all of a location's items.
### Example
```ruby
@@ -1411,11 +1411,11 @@
opts = {
batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
}
begin
- #Provides summary information for all of a location's items.
+ #ListItems
result = api_instance.list_items(location_id, opts)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->list_items: #{e}"
end
@@ -1444,11 +1444,11 @@
# **list_modifier_lists**
> Array<V1ModifierList> list_modifier_lists(location_id)
-Lists all of a location's modifier lists.
+ListModifierLists
Lists all of a location's modifier lists.
### Example
```ruby
@@ -1464,11 +1464,11 @@
location_id = "location_id_example" # String | The ID of the location to list modifier lists for.
begin
- #Lists all of a location's modifier lists.
+ #ListModifierLists
result = api_instance.list_modifier_lists(location_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->list_modifier_lists: #{e}"
end
@@ -1496,11 +1496,11 @@
# **list_pages**
> Array<V1Page> list_pages(location_id)
-Lists all of a location's Favorites pages in Square Register.
+ListPages
Lists all of a location's Favorites pages in Square Register.
### Example
```ruby
@@ -1516,11 +1516,11 @@
location_id = "location_id_example" # String | The ID of the location to list Favorites pages for.
begin
- #Lists all of a location's Favorites pages in Square Register.
+ #ListPages
result = api_instance.list_pages(location_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->list_pages: #{e}"
end
@@ -1548,11 +1548,11 @@
# **remove_fee**
> V1Item remove_fee(location_id, item_id, fee_id)
-Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.
+RemoveFee
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.
### Example
```ruby
@@ -1572,11 +1572,11 @@
fee_id = "fee_id_example" # String | The ID of the fee to apply.
begin
- #Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.
+ #RemoveFee
result = api_instance.remove_fee(location_id, item_id, fee_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->remove_fee: #{e}"
end
@@ -1606,11 +1606,11 @@
# **remove_modifier_list**
> V1Item remove_modifier_list(location_id, modifier_list_id, item_id)
-Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.
+RemoveModifierList
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.
### Example
```ruby
@@ -1630,11 +1630,11 @@
item_id = "item_id_example" # String | The ID of the item to remove the modifier list from.
begin
- #Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.
+ #RemoveModifierList
result = api_instance.remove_modifier_list(location_id, modifier_list_id, item_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->remove_modifier_list: #{e}"
end
@@ -1664,11 +1664,11 @@
# **retrieve_item**
> V1Item retrieve_item(location_id, item_id)
-Provides the details for a single item, including associated modifier lists and fees.
+RetrieveItem
Provides the details for a single item, including associated modifier lists and fees.
### Example
```ruby
@@ -1686,11 +1686,11 @@
item_id = "item_id_example" # String | The item's ID.
begin
- #Provides the details for a single item, including associated modifier lists and fees.
+ #RetrieveItem
result = api_instance.retrieve_item(location_id, item_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->retrieve_item: #{e}"
end
@@ -1719,11 +1719,11 @@
# **retrieve_modifier_list**
> V1ModifierList retrieve_modifier_list(location_id, modifier_list_id)
-Provides the details for a single modifier list.
+RetrieveModifierList
Provides the details for a single modifier list.
### Example
```ruby
@@ -1741,11 +1741,11 @@
modifier_list_id = "modifier_list_id_example" # String | The modifier list's ID.
begin
- #Provides the details for a single modifier list.
+ #RetrieveModifierList
result = api_instance.retrieve_modifier_list(location_id, modifier_list_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->retrieve_modifier_list: #{e}"
end
@@ -1774,11 +1774,11 @@
# **update_category**
> V1Category update_category(location_id, category_id, body)
-Modifies the details of an existing item category.
+UpdateCategory
Modifies the details of an existing item category.
### Example
```ruby
@@ -1798,11 +1798,11 @@
body = SquareConnect::V1Category.new # V1Category | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Modifies the details of an existing item category.
+ #UpdateCategory
result = api_instance.update_category(location_id, category_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->update_category: #{e}"
end
@@ -1832,11 +1832,11 @@
# **update_discount**
> V1Discount update_discount(location_id, discount_id, body)
-Modifies the details of an existing discount.
+UpdateDiscount
Modifies the details of an existing discount.
### Example
```ruby
@@ -1856,11 +1856,11 @@
body = SquareConnect::V1Discount.new # V1Discount | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Modifies the details of an existing discount.
+ #UpdateDiscount
result = api_instance.update_discount(location_id, discount_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->update_discount: #{e}"
end
@@ -1890,11 +1890,11 @@
# **update_fee**
> V1Fee update_fee(location_id, fee_id, body)
-Modifies the details of an existing fee (tax).
+UpdateFee
Modifies the details of an existing fee (tax).
### Example
```ruby
@@ -1914,11 +1914,11 @@
body = SquareConnect::V1Fee.new # V1Fee | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Modifies the details of an existing fee (tax).
+ #UpdateFee
result = api_instance.update_fee(location_id, fee_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->update_fee: #{e}"
end
@@ -1948,11 +1948,11 @@
# **update_item**
> V1Item update_item(location_id, item_id, body)
-Modifies the core details of an existing item.
+UpdateItem
Modifies the core details of an existing item.
### Example
```ruby
@@ -1972,11 +1972,11 @@
body = SquareConnect::V1Item.new # V1Item | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Modifies the core details of an existing item.
+ #UpdateItem
result = api_instance.update_item(location_id, item_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->update_item: #{e}"
end
@@ -2006,11 +2006,11 @@
# **update_modifier_list**
> V1ModifierList update_modifier_list(location_id, modifier_list_id, body)
-Modifies the details of an existing item modifier list.
+UpdateModifierList
Modifies the details of an existing item modifier list.
### Example
```ruby
@@ -2030,11 +2030,11 @@
body = SquareConnect::V1UpdateModifierListRequest.new # V1UpdateModifierListRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Modifies the details of an existing item modifier list.
+ #UpdateModifierList
result = api_instance.update_modifier_list(location_id, modifier_list_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->update_modifier_list: #{e}"
end
@@ -2064,11 +2064,11 @@
# **update_modifier_option**
> V1ModifierOption update_modifier_option(location_id, modifier_list_id, modifier_option_id, body)
-Modifies the details of an existing item modifier option.
+UpdateModifierOption
Modifies the details of an existing item modifier option.
### Example
```ruby
@@ -2090,11 +2090,11 @@
body = SquareConnect::V1ModifierOption.new # V1ModifierOption | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Modifies the details of an existing item modifier option.
+ #UpdateModifierOption
result = api_instance.update_modifier_option(location_id, modifier_list_id, modifier_option_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->update_modifier_option: #{e}"
end
@@ -2125,11 +2125,11 @@
# **update_page**
> V1Page update_page(location_id, page_id, body)
-Modifies the details of a Favorites page in Square Register.
+UpdatePage
Modifies the details of a Favorites page in Square Register.
### Example
```ruby
@@ -2149,11 +2149,11 @@
body = SquareConnect::V1Page.new # V1Page | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Modifies the details of a Favorites page in Square Register.
+ #UpdatePage
result = api_instance.update_page(location_id, page_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->update_page: #{e}"
end
@@ -2183,11 +2183,11 @@
# **update_page_cell**
> V1Page update_page_cell(location_id, page_id, body)
-Modifies a cell of a Favorites page in Square Register.
+UpdatePageCell
Modifies a cell of a Favorites page in Square Register.
### Example
```ruby
@@ -2207,11 +2207,11 @@
body = SquareConnect::V1PageCell.new # V1PageCell | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Modifies a cell of a Favorites page in Square Register.
+ #UpdatePageCell
result = api_instance.update_page_cell(location_id, page_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->update_page_cell: #{e}"
end
@@ -2241,11 +2241,11 @@
# **update_variation**
> V1Variation update_variation(location_id, item_id, variation_id, body)
-Modifies the details of an existing item variation.
+UpdateVariation
Modifies the details of an existing item variation.
### Example
```ruby
@@ -2267,10 +2267,10 @@
body = SquareConnect::V1Variation.new # V1Variation | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
- #Modifies the details of an existing item variation.
+ #UpdateVariation
result = api_instance.update_variation(location_id, item_id, variation_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1ItemsApi->update_variation: #{e}"
end