square_connect 2.1.0.beta → 2.1.0.78

Sign up to get free protection for your applications and to get access to all the features.
Files changed (188) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +71 -8
  3. data/docs/BatchDeleteCatalogObjectsRequest.md +12 -0
  4. data/docs/BatchDeleteCatalogObjectsResponse.md +14 -0
  5. data/docs/BatchRetrieveCatalogObjectsRequest.md +13 -0
  6. data/docs/BatchRetrieveCatalogObjectsResponse.md +14 -0
  7. data/docs/BatchUpsertCatalogObjectsRequest.md +13 -0
  8. data/docs/BatchUpsertCatalogObjectsResponse.md +15 -0
  9. data/docs/CatalogApi.md +592 -0
  10. data/docs/CatalogCategory.md +12 -0
  11. data/docs/CatalogDiscount.md +17 -0
  12. data/docs/CatalogDiscountType.md +15 -0
  13. data/docs/CatalogIdMapping.md +13 -0
  14. data/docs/CatalogInfoRequest.md +11 -0
  15. data/docs/CatalogInfoResponse.md +13 -0
  16. data/docs/CatalogInfoResponseLimits.md +22 -0
  17. data/docs/CatalogItem.md +25 -0
  18. data/docs/CatalogItemModifierListInfo.md +16 -0
  19. data/docs/CatalogItemProductType.md +16 -0
  20. data/docs/CatalogItemVariation.md +23 -0
  21. data/docs/CatalogModifier.md +13 -0
  22. data/docs/CatalogModifierList.md +14 -0
  23. data/docs/CatalogModifierListSelectionType.md +13 -0
  24. data/docs/CatalogModifierOverride.md +13 -0
  25. data/docs/CatalogObject.md +27 -0
  26. data/docs/CatalogObjectBatch.md +12 -0
  27. data/docs/CatalogObjectType.md +18 -0
  28. data/docs/CatalogPricingType.md +13 -0
  29. data/docs/CatalogQuery.md +18 -0
  30. data/docs/CatalogQueryExact.md +13 -0
  31. data/docs/CatalogQueryItemsForModifierList.md +12 -0
  32. data/docs/CatalogQueryItemsForTax.md +12 -0
  33. data/docs/CatalogQueryPrefix.md +13 -0
  34. data/docs/CatalogQueryRange.md +14 -0
  35. data/docs/CatalogQuerySortedAttribute.md +14 -0
  36. data/docs/CatalogQueryText.md +12 -0
  37. data/docs/CatalogTax.md +17 -0
  38. data/docs/CatalogV1Id.md +13 -0
  39. data/docs/Checkout.md +4 -4
  40. data/docs/CreateCheckoutRequest.md +5 -5
  41. data/docs/DeleteCatalogObjectRequest.md +11 -0
  42. data/docs/DeleteCatalogObjectResponse.md +14 -0
  43. data/docs/ErrorCode.md +2 -0
  44. data/docs/InventoryAlertType.md +13 -0
  45. data/docs/ItemVariationLocationOverrides.md +17 -0
  46. data/docs/ListCatalogRequest.md +13 -0
  47. data/docs/ListCatalogResponse.md +14 -0
  48. data/docs/RetrieveCatalogObjectRequest.md +12 -0
  49. data/docs/RetrieveCatalogObjectResponse.md +14 -0
  50. data/docs/SearchCatalogObjectsRequest.md +18 -0
  51. data/docs/SearchCatalogObjectsResponse.md +15 -0
  52. data/docs/TaxCalculationPhase.md +13 -0
  53. data/docs/TaxInclusionType.md +13 -0
  54. data/docs/UpdateItemModifierListsRequest.md +14 -0
  55. data/docs/UpdateItemModifierListsResponse.md +13 -0
  56. data/docs/UpdateItemTaxesRequest.md +14 -0
  57. data/docs/UpdateItemTaxesResponse.md +13 -0
  58. data/docs/UpsertCatalogObjectRequest.md +13 -0
  59. data/docs/UpsertCatalogObjectResponse.md +14 -0
  60. data/docs/V1Item.md +1 -1
  61. data/docs/V1Variation.md +0 -1
  62. data/lib/square_connect.rb +54 -1
  63. data/lib/square_connect/api/catalog_api.rb +604 -0
  64. data/lib/square_connect/models/batch_delete_catalog_objects_request.rb +188 -0
  65. data/lib/square_connect/models/batch_delete_catalog_objects_response.rb +210 -0
  66. data/lib/square_connect/models/batch_retrieve_catalog_objects_request.rb +203 -0
  67. data/lib/square_connect/models/batch_retrieve_catalog_objects_response.rb +212 -0
  68. data/lib/square_connect/models/batch_upsert_catalog_objects_request.rb +222 -0
  69. data/lib/square_connect/models/batch_upsert_catalog_objects_response.rb +222 -0
  70. data/lib/square_connect/models/catalog_category.rb +210 -0
  71. data/lib/square_connect/models/catalog_discount.rb +293 -0
  72. data/lib/square_connect/models/catalog_discount_type.rb +21 -0
  73. data/lib/square_connect/models/catalog_id_mapping.rb +196 -0
  74. data/lib/square_connect/models/catalog_info_request.rb +176 -0
  75. data/lib/square_connect/models/catalog_info_response.rb +198 -0
  76. data/lib/square_connect/models/catalog_info_response_limits.rb +286 -0
  77. data/lib/square_connect/models/catalog_item.rb +379 -0
  78. data/lib/square_connect/models/catalog_item_modifier_list_info.rb +252 -0
  79. data/lib/square_connect/models/catalog_item_product_type.rb +22 -0
  80. data/lib/square_connect/models/catalog_item_variation.rb +343 -0
  81. data/lib/square_connect/models/catalog_modifier.rb +220 -0
  82. data/lib/square_connect/models/catalog_modifier_list.rb +265 -0
  83. data/lib/square_connect/models/catalog_modifier_list_selection_type.rb +19 -0
  84. data/lib/square_connect/models/catalog_modifier_override.rb +220 -0
  85. data/lib/square_connect/models/catalog_object.rb +404 -0
  86. data/lib/square_connect/models/catalog_object_batch.rb +188 -0
  87. data/lib/square_connect/models/catalog_object_type.rb +24 -0
  88. data/lib/square_connect/models/catalog_pricing_type.rb +19 -0
  89. data/lib/square_connect/models/catalog_query.rb +246 -0
  90. data/lib/square_connect/models/catalog_query_exact.rb +225 -0
  91. data/lib/square_connect/models/catalog_query_items_for_modifier_list.rb +193 -0
  92. data/lib/square_connect/models/catalog_query_items_for_tax.rb +193 -0
  93. data/lib/square_connect/models/catalog_query_prefix.rb +244 -0
  94. data/lib/square_connect/models/catalog_query_range.rb +230 -0
  95. data/lib/square_connect/models/catalog_query_sorted_attribute.rb +263 -0
  96. data/lib/square_connect/models/catalog_query_text.rb +193 -0
  97. data/lib/square_connect/models/catalog_tax.rb +305 -0
  98. data/lib/square_connect/models/catalog_v1_id.rb +196 -0
  99. data/lib/square_connect/models/checkout.rb +4 -4
  100. data/lib/square_connect/models/create_checkout_request.rb +5 -5
  101. data/lib/square_connect/models/delete_catalog_object_request.rb +176 -0
  102. data/lib/square_connect/models/delete_catalog_object_response.rb +210 -0
  103. data/lib/square_connect/models/error.rb +2 -2
  104. data/lib/square_connect/models/error_code.rb +2 -0
  105. data/lib/square_connect/models/inventory_alert_type.rb +19 -0
  106. data/lib/square_connect/models/item_variation_location_overrides.rb +281 -0
  107. data/lib/square_connect/models/list_catalog_request.rb +196 -0
  108. data/lib/square_connect/models/list_catalog_response.rb +210 -0
  109. data/lib/square_connect/models/retrieve_catalog_object_request.rb +186 -0
  110. data/lib/square_connect/models/retrieve_catalog_object_response.rb +210 -0
  111. data/lib/square_connect/models/search_catalog_objects_request.rb +269 -0
  112. data/lib/square_connect/models/search_catalog_objects_response.rb +222 -0
  113. data/lib/square_connect/models/tax_calculation_phase.rb +19 -0
  114. data/lib/square_connect/models/tax_inclusion_type.rb +19 -0
  115. data/lib/square_connect/models/update_item_modifier_lists_request.rb +217 -0
  116. data/lib/square_connect/models/update_item_modifier_lists_response.rb +198 -0
  117. data/lib/square_connect/models/update_item_taxes_request.rb +217 -0
  118. data/lib/square_connect/models/update_item_taxes_response.rb +198 -0
  119. data/lib/square_connect/models/{create_order_request.rb → upsert_catalog_object_request.rb} +14 -23
  120. data/lib/square_connect/models/upsert_catalog_object_response.rb +210 -0
  121. data/lib/square_connect/models/v1_item.rb +1 -1
  122. data/lib/square_connect/models/v1_variation.rb +1 -11
  123. data/lib/square_connect/version.rb +1 -1
  124. data/spec/api/catalog_api_spec.rb +611 -0
  125. data/spec/models/batch_delete_catalog_objects_request_spec.rb +39 -0
  126. data/spec/models/batch_delete_catalog_objects_response_spec.rb +51 -0
  127. data/spec/models/batch_retrieve_catalog_objects_request_spec.rb +45 -0
  128. data/spec/models/batch_retrieve_catalog_objects_response_spec.rb +51 -0
  129. data/spec/models/batch_upsert_catalog_objects_request_spec.rb +45 -0
  130. data/spec/models/batch_upsert_catalog_objects_response_spec.rb +57 -0
  131. data/spec/models/catalog_category_spec.rb +39 -0
  132. data/spec/models/catalog_discount_spec.rb +73 -0
  133. data/spec/models/catalog_discount_type_spec.rb +33 -0
  134. data/spec/models/catalog_id_mapping_spec.rb +45 -0
  135. data/spec/models/catalog_info_request_spec.rb +33 -0
  136. data/spec/models/catalog_info_response_limits_spec.rb +99 -0
  137. data/spec/models/catalog_info_response_spec.rb +45 -0
  138. data/spec/models/catalog_item_modifier_list_info_spec.rb +63 -0
  139. data/spec/models/catalog_item_product_type_spec.rb +33 -0
  140. data/spec/models/catalog_item_spec.rb +121 -0
  141. data/spec/models/catalog_item_variation_spec.rb +113 -0
  142. data/spec/models/catalog_modifier_list_selection_type_spec.rb +33 -0
  143. data/spec/models/catalog_modifier_list_spec.rb +55 -0
  144. data/spec/models/catalog_modifier_override_spec.rb +45 -0
  145. data/spec/models/catalog_modifier_spec.rb +45 -0
  146. data/spec/models/catalog_object_batch_spec.rb +39 -0
  147. data/spec/models/catalog_object_spec.rb +133 -0
  148. data/spec/models/catalog_object_type_spec.rb +33 -0
  149. data/spec/models/catalog_pricing_type_spec.rb +33 -0
  150. data/spec/models/catalog_query_exact_spec.rb +45 -0
  151. data/spec/models/catalog_query_items_for_modifier_list_spec.rb +39 -0
  152. data/spec/models/catalog_query_items_for_tax_spec.rb +39 -0
  153. data/spec/models/catalog_query_prefix_spec.rb +45 -0
  154. data/spec/models/catalog_query_range_spec.rb +51 -0
  155. data/spec/models/catalog_query_sorted_attribute_spec.rb +55 -0
  156. data/spec/models/catalog_query_spec.rb +75 -0
  157. data/spec/models/catalog_query_text_spec.rb +39 -0
  158. data/spec/models/catalog_tax_spec.rb +77 -0
  159. data/spec/models/catalog_v1_id_spec.rb +45 -0
  160. data/spec/models/delete_catalog_object_request_spec.rb +39 -0
  161. data/spec/models/delete_catalog_object_response_spec.rb +51 -0
  162. data/spec/models/inventory_alert_type_spec.rb +33 -0
  163. data/spec/models/item_variation_location_overrides_spec.rb +77 -0
  164. data/spec/models/list_catalog_request_spec.rb +45 -0
  165. data/spec/models/list_catalog_response_spec.rb +51 -0
  166. data/spec/models/retrieve_catalog_object_request_spec.rb +45 -0
  167. data/spec/models/retrieve_catalog_object_response_spec.rb +51 -0
  168. data/spec/models/search_catalog_objects_request_spec.rb +79 -0
  169. data/spec/models/search_catalog_objects_response_spec.rb +57 -0
  170. data/spec/models/tax_calculation_phase_spec.rb +33 -0
  171. data/spec/models/tax_inclusion_type_spec.rb +33 -0
  172. data/spec/models/update_item_modifier_lists_request_spec.rb +51 -0
  173. data/spec/models/update_item_modifier_lists_response_spec.rb +45 -0
  174. data/spec/models/update_item_taxes_request_spec.rb +51 -0
  175. data/spec/models/update_item_taxes_response_spec.rb +45 -0
  176. data/spec/models/{create_order_request_spec.rb → upsert_catalog_object_request_spec.rb} +7 -7
  177. data/spec/models/upsert_catalog_object_response_spec.rb +51 -0
  178. data/square_connect.gemspec +1 -1
  179. data/travis-ci/accounts.enc +0 -0
  180. metadata +222 -17
  181. data/docs/CreateOrderRequest.md +0 -13
  182. data/docs/V1LocationApi.md +0 -102
  183. data/lib/.DS_Store +0 -0
  184. data/lib/square_connect/.DS_Store +0 -0
  185. data/spec/.DS_Store +0 -0
  186. data/square_connect-2.0.2.gem +0 -0
  187. data/square_connect-2.1.0.gem +0 -0
  188. data/square_connect-2.1.0beta.gem +0 -0
@@ -0,0 +1,12 @@
1
+ # SquareConnect::CatalogQueryText
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **keywords** | **Array<String>** | A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored. |
11
+
12
+
@@ -0,0 +1,17 @@
1
+ # SquareConnect::CatalogTax
2
+
3
+ ### Description
4
+
5
+ A tax in the Catalog object model.
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **name** | **String** | The tax's name. Searchable. |
11
+ **calculation_phase** | **String** | Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for all possible values. | [optional]
12
+ **inclusion_type** | **String** | Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for all possible values. | [optional]
13
+ **percentage** | **String** | The percentage of the tax in decimal form, using a '.' as the decimal separator and without a '%' sign. A value of `7.5` corresponds to 7.5%. | [optional]
14
+ **applies_to_custom_amounts** | **BOOLEAN** | If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular [CatalogItem](#type-catalogitem). | [optional]
15
+ **enabled** | **BOOLEAN** | If `true`, the tax will be shown as enabled in the Square Point of Sale app. | [optional]
16
+
17
+
@@ -0,0 +1,13 @@
1
+ # SquareConnect::CatalogV1Id
2
+
3
+ ### Description
4
+
5
+ An Items Connect V1 object ID along with its associated location ID.
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **catalog_v1_id** | **String** | The ID for an object in Connect V1, if different from its Connect V2 ID. | [optional]
11
+ **location_id** | **String** | The ID of the location this Connect V1 ID is associated with. | [optional]
12
+
13
+
@@ -9,10 +9,10 @@ Name | Type | Description | Notes
9
9
  ------------ | ------------- | ------------- | -------------
10
10
  **id** | **String** | ID generated by Square Checkout when a new checkout is requested. | [optional]
11
11
  **checkout_page_url** | **String** | The URL that the buyer's browser should be redirected to after the checkout is completed. | [optional]
12
- **ask_for_shipping_address** | **BOOLEAN** | If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default is `false`. | [optional]
13
- **merchant_support_email** | **String** | The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default is unset. | [optional]
14
- **pre_populate_buyer_email** | **String** | If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default is unset. | [optional]
15
- **pre_populate_shipping_address** | [**Address**](Address.md) | If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields. Default is unset. | [optional]
12
+ **ask_for_shipping_address** | **BOOLEAN** | If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`. | [optional]
13
+ **merchant_support_email** | **String** | The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set. | [optional]
14
+ **pre_populate_buyer_email** | **String** | If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default: none; only exists if explicitly set. | [optional]
15
+ **pre_populate_shipping_address** | [**Address**](Address.md) | If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields. Default: none; only exists if explicitly set. | [optional]
16
16
  **redirect_url** | **String** | The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to: `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow. | [optional]
17
17
  **order** | [**Order**](Order.md) | Order to be checked out. | [optional]
18
18
  **created_at** | **String** | The time when the checkout was created, in RFC 3339 format. | [optional]
@@ -9,10 +9,10 @@ Name | Type | Description | Notes
9
9
  ------------ | ------------- | ------------- | -------------
10
10
  **idempotency_key** | **String** | A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency keys](#idempotencykeys) for more information. |
11
11
  **order** | [**CreateOrderRequestOrder**](CreateOrderRequestOrder.md) | The order including line items to be checked out. |
12
- **ask_for_shipping_address** | **BOOLEAN** | If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default is `false`. | [optional]
13
- **merchant_support_email** | **String** | The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default is unset. | [optional]
14
- **pre_populate_buyer_email** | **String** | If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default is unset. | [optional]
15
- **pre_populate_shipping_address** | [**Address**](Address.md) | If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields. Default is unset. | [optional]
16
- **redirect_url** | **String** | The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to: `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow. Default is unset. | [optional]
12
+ **ask_for_shipping_address** | **BOOLEAN** | If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`. | [optional]
13
+ **merchant_support_email** | **String** | The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set. | [optional]
14
+ **pre_populate_buyer_email** | **String** | If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default: none; only exists if explicitly set. | [optional]
15
+ **pre_populate_shipping_address** | [**Address**](Address.md) | If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields. Default: none; only exists if explicitly set. | [optional]
16
+ **redirect_url** | **String** | The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to: `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow. Default: none; only exists if explicitly set. | [optional]
17
17
 
18
18
 
@@ -0,0 +1,11 @@
1
+ # SquareConnect::DeleteCatalogObjectRequest
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+
11
+
@@ -0,0 +1,14 @@
1
+ # SquareConnect::DeleteCatalogObjectResponse
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional]
11
+ **deleted_object_ids** | **Array<String>** | The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a [CatalogItemVariation](#type-catalogitemvariation) will be deleted (and its ID included in this field) when its parent [CatalogItem](#type-catalogitem) is deleted. | [optional]
12
+ **deleted_at** | **String** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional]
13
+
14
+
@@ -68,6 +68,8 @@ Name | Type
68
68
  **INVALID_CARD_DATA** | string
69
69
  **IDEMPOTENCY_KEY_REUSED** | string
70
70
  **UNEXPECTED_VALUE** | string
71
+ **SANDBOX_NOT_SUPPORTED** | string
72
+ **INVALID_EMAIL_ADDRESS** | string
71
73
  **CARD_DECLINED** | string
72
74
  **VERIFY_CVV_FAILURE** | string
73
75
  **VERIFY_AVS_FAILURE** | string
@@ -0,0 +1,13 @@
1
+ # SquareConnect::InventoryAlertType
2
+
3
+ ### Description
4
+
5
+ Indicates whether Square should alert the merchant when the inventory quantity of a [CatalogItemVariation](#type-catalogitemvariation) is low.
6
+
7
+ ## Properties
8
+ Name | Type
9
+ ------------ | -------------
10
+ **NONE** | string
11
+ **LOW_QUANTITY** | string
12
+
13
+
@@ -0,0 +1,17 @@
1
+ # SquareConnect::ItemVariationLocationOverrides
2
+
3
+ ### Description
4
+
5
+ Price and inventory overrides for a [CatalogItemVariation](#type-catalogitemvariation) at a specific location.
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **location_id** | **String** | The ID of the location. | [optional]
11
+ **price_money** | [**Money**](Money.md) | The price of the [CatalogItemVariation](#type-catalogitemvariation) at the given location, or blank for variable pricing. | [optional]
12
+ **pricing_type** | **String** | The pricing type (fixed or variable) for the [CatalogItemVariation](#type-catalogitemvariation) at the given location. See [CatalogPricingType](#type-catalogpricingtype) for all possible values. | [optional]
13
+ **track_inventory** | **BOOLEAN** | If `true`, inventory tracking is active for the [CatalogItemVariation](#type-catalogitemvariation) at this location. | [optional]
14
+ **inventory_alert_type** | **String** | Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values. | [optional]
15
+ **inventory_alert_threshold** | **Integer** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer. | [optional]
16
+
17
+
@@ -0,0 +1,13 @@
1
+ # SquareConnect::ListCatalogRequest
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional]
11
+ **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]
12
+
13
+
@@ -0,0 +1,14 @@
1
+ # SquareConnect::ListCatalogResponse
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional]
11
+ **cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional]
12
+ **objects** | [**Array<CatalogObject>**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional]
13
+
14
+
@@ -0,0 +1,12 @@
1
+ # SquareConnect::RetrieveCatalogObjectRequest
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **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]
11
+
12
+
@@ -0,0 +1,14 @@
1
+ # SquareConnect::RetrieveCatalogObjectResponse
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional]
11
+ **object** | [**CatalogObject**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional]
12
+ **related_objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `object` field. | [optional]
13
+
14
+
@@ -0,0 +1,18 @@
1
+ # SquareConnect::SearchCatalogObjectsRequest
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional]
11
+ **object_types** | **Array<String>** | The desired set of object types to apper in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. | [optional]
12
+ **include_deleted_objects** | **BOOLEAN** | If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`. | [optional]
13
+ **include_related_objects** | **BOOLEAN** | If `true`, the response will include additional objects that are related to the requested object, as follows: If a [CatalogItem](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response. If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response. | [optional]
14
+ **begin_time** | **String** | Return only objects that have been modified after this [timestamp](#workingwithdates) (in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\"). | [optional]
15
+ **query** | [**CatalogQuery**](CatalogQuery.md) | A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. | [optional]
16
+ **limit** | **Integer** | A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored. | [optional]
17
+
18
+
@@ -0,0 +1,15 @@
1
+ # SquareConnect::SearchCatalogObjectsResponse
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional]
11
+ **cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional]
12
+ **objects** | [**Array<CatalogObject>**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional]
13
+ **related_objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the objects in the `objects` field. | [optional]
14
+
15
+
@@ -0,0 +1,13 @@
1
+ # SquareConnect::TaxCalculationPhase
2
+
3
+ ### Description
4
+
5
+ When to calculate the taxes due on a cart.
6
+
7
+ ## Properties
8
+ Name | Type
9
+ ------------ | -------------
10
+ **TAX_SUBTOTAL_PHASE** | string
11
+ **TAX_TOTAL_PHASE** | string
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # SquareConnect::TaxInclusionType
2
+
3
+ ### Description
4
+
5
+ Whether to the tax amount should be additional to or included in to the [CatalogItem](#type-catalogitem) price.
6
+
7
+ ## Properties
8
+ Name | Type
9
+ ------------ | -------------
10
+ **ADDITIVE** | string
11
+ **INCLUSIVE** | string
12
+
13
+
@@ -0,0 +1,14 @@
1
+ # SquareConnect::UpdateItemModifierListsRequest
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **item_ids** | **Array<String>** | The [CatalogItem](#type-catalogitem)s whose [CatalogModifierList](#type-catalogmodifierlist)s are being updated. |
11
+ **modifier_lists_to_enable** | **Array<String>** | The set of [CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem](#type-catalogitem). | [optional]
12
+ **modifier_lists_to_disable** | **Array<String>** | The set of [CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem](#type-catalogitem). | [optional]
13
+
14
+
@@ -0,0 +1,13 @@
1
+ # SquareConnect::UpdateItemModifierListsResponse
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional]
11
+ **updated_at** | **String** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional]
12
+
13
+
@@ -0,0 +1,14 @@
1
+ # SquareConnect::UpdateItemTaxesRequest
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **item_ids** | **Array<String>** | The [CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax](#type-catalogtax)es are being updated. |
11
+ **taxes_to_enable** | **Array<String>** | The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem](#type-catalogitem). | [optional]
12
+ **taxes_to_disable** | **Array<String>** | The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem](#type-catalogitem). | [optional]
13
+
14
+
@@ -0,0 +1,13 @@
1
+ # SquareConnect::UpdateItemTaxesResponse
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional]
11
+ **updated_at** | **String** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # SquareConnect::UpsertCatalogObjectRequest
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **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. |
11
+ **object** | [**CatalogObject**](CatalogObject.md) | A [CatalogObject](#type-catalogobject) to be created or updated. The object's `is_deleted` field must not be set to `true`. When creating a new object, the object's ID must either start with a `#` character or be left blank. In either case it will be replaced with a server-generated ID. |
12
+
13
+
@@ -0,0 +1,14 @@
1
+ # SquareConnect::UpsertCatalogObjectResponse
2
+
3
+ ### Description
4
+
5
+
6
+
7
+ ## Properties
8
+ Name | Type | Description | Notes
9
+ ------------ | ------------- | ------------- | -------------
10
+ **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional]
11
+ **catalog_object** | [**CatalogObject**](CatalogObject.md) | The created [CatalogObject](#type-catalogobject). | [optional]
12
+ **id_mappings** | [**Array<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this Upsert. | [optional]
13
+
14
+
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
12
12
  **color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. | [optional]
13
13
  **abbreviation** | **String** | The text of the item's display label in Square Register. Only up to the first five characters of the string are used. | [optional]
14
14
  **visibility** | **String** | Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. | [optional]
15
- **available_online** | **String** | If true, the item can be added to shipping orders from the merchant's online store. | [optional]
15
+ **available_online** | **BOOLEAN** | If true, the item can be added to shipping orders from the merchant's online store. | [optional]
16
16
  **master_image** | [**V1ItemImage**](V1ItemImage.md) | The item's master image, if any. | [optional]
17
17
  **category** | [**V1Category**](V1Category.md) | The category the item belongs to, if any. | [optional]
18
18
  **variations** | [**Array<V1Variation>**](V1Variation.md) | The item's variations. You must specify at least one variation. | [optional]
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
8
8
  **id** | **String** | The item variation's unique ID. | [optional]
9
9
  **name** | **String** | The item variation's name. | [optional]
10
10
  **item_id** | **String** | The ID of the variation's associated item. | [optional]
11
- **ordinal** | **String** | ndicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order | [optional]
12
11
  **pricing_type** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. | [optional]
13
12
  **price_money** | [**V1Money**](V1Money.md) | The item variation's price, if any. | [optional]
14
13
  **sku** | **String** | The item variation's SKU, if any. | [optional]
@@ -15,10 +15,45 @@ require 'square_connect/configuration'
15
15
 
16
16
  # Models
17
17
  require 'square_connect/models/address'
18
+ require 'square_connect/models/batch_delete_catalog_objects_request'
19
+ require 'square_connect/models/batch_delete_catalog_objects_response'
20
+ require 'square_connect/models/batch_retrieve_catalog_objects_request'
21
+ require 'square_connect/models/batch_retrieve_catalog_objects_response'
22
+ require 'square_connect/models/batch_upsert_catalog_objects_request'
23
+ require 'square_connect/models/batch_upsert_catalog_objects_response'
18
24
  require 'square_connect/models/capture_transaction_request'
19
25
  require 'square_connect/models/capture_transaction_response'
20
26
  require 'square_connect/models/card'
21
27
  require 'square_connect/models/card_brand'
28
+ require 'square_connect/models/catalog_category'
29
+ require 'square_connect/models/catalog_discount'
30
+ require 'square_connect/models/catalog_discount_type'
31
+ require 'square_connect/models/catalog_id_mapping'
32
+ require 'square_connect/models/catalog_info_request'
33
+ require 'square_connect/models/catalog_info_response'
34
+ require 'square_connect/models/catalog_info_response_limits'
35
+ require 'square_connect/models/catalog_item'
36
+ require 'square_connect/models/catalog_item_modifier_list_info'
37
+ require 'square_connect/models/catalog_item_product_type'
38
+ require 'square_connect/models/catalog_item_variation'
39
+ require 'square_connect/models/catalog_modifier'
40
+ require 'square_connect/models/catalog_modifier_list'
41
+ require 'square_connect/models/catalog_modifier_list_selection_type'
42
+ require 'square_connect/models/catalog_modifier_override'
43
+ require 'square_connect/models/catalog_object'
44
+ require 'square_connect/models/catalog_object_batch'
45
+ require 'square_connect/models/catalog_object_type'
46
+ require 'square_connect/models/catalog_pricing_type'
47
+ require 'square_connect/models/catalog_query'
48
+ require 'square_connect/models/catalog_query_exact'
49
+ require 'square_connect/models/catalog_query_items_for_modifier_list'
50
+ require 'square_connect/models/catalog_query_items_for_tax'
51
+ require 'square_connect/models/catalog_query_prefix'
52
+ require 'square_connect/models/catalog_query_range'
53
+ require 'square_connect/models/catalog_query_sorted_attribute'
54
+ require 'square_connect/models/catalog_query_text'
55
+ require 'square_connect/models/catalog_tax'
56
+ require 'square_connect/models/catalog_v1_id'
22
57
  require 'square_connect/models/charge_request'
23
58
  require 'square_connect/models/charge_response'
24
59
  require 'square_connect/models/checkout'
@@ -29,7 +64,6 @@ require 'square_connect/models/create_customer_card_request'
29
64
  require 'square_connect/models/create_customer_card_response'
30
65
  require 'square_connect/models/create_customer_request'
31
66
  require 'square_connect/models/create_customer_response'
32
- require 'square_connect/models/create_order_request'
33
67
  require 'square_connect/models/create_order_request_line_item'
34
68
  require 'square_connect/models/create_order_request_order'
35
69
  require 'square_connect/models/create_refund_request'
@@ -38,6 +72,8 @@ require 'square_connect/models/currency'
38
72
  require 'square_connect/models/customer'
39
73
  require 'square_connect/models/customer_group_info'
40
74
  require 'square_connect/models/customer_preferences'
75
+ require 'square_connect/models/delete_catalog_object_request'
76
+ require 'square_connect/models/delete_catalog_object_response'
41
77
  require 'square_connect/models/delete_customer_card_request'
42
78
  require 'square_connect/models/delete_customer_card_response'
43
79
  require 'square_connect/models/delete_customer_request'
@@ -46,6 +82,10 @@ require 'square_connect/models/device'
46
82
  require 'square_connect/models/error'
47
83
  require 'square_connect/models/error_category'
48
84
  require 'square_connect/models/error_code'
85
+ require 'square_connect/models/inventory_alert_type'
86
+ require 'square_connect/models/item_variation_location_overrides'
87
+ require 'square_connect/models/list_catalog_request'
88
+ require 'square_connect/models/list_catalog_response'
49
89
  require 'square_connect/models/list_customers_request'
50
90
  require 'square_connect/models/list_customers_response'
51
91
  require 'square_connect/models/list_locations_request'
@@ -61,11 +101,17 @@ require 'square_connect/models/order'
61
101
  require 'square_connect/models/order_line_item'
62
102
  require 'square_connect/models/refund'
63
103
  require 'square_connect/models/refund_status'
104
+ require 'square_connect/models/retrieve_catalog_object_request'
105
+ require 'square_connect/models/retrieve_catalog_object_response'
64
106
  require 'square_connect/models/retrieve_customer_request'
65
107
  require 'square_connect/models/retrieve_customer_response'
66
108
  require 'square_connect/models/retrieve_transaction_request'
67
109
  require 'square_connect/models/retrieve_transaction_response'
110
+ require 'square_connect/models/search_catalog_objects_request'
111
+ require 'square_connect/models/search_catalog_objects_response'
68
112
  require 'square_connect/models/sort_order'
113
+ require 'square_connect/models/tax_calculation_phase'
114
+ require 'square_connect/models/tax_inclusion_type'
69
115
  require 'square_connect/models/tender'
70
116
  require 'square_connect/models/tender_card_details'
71
117
  require 'square_connect/models/tender_card_details_entry_method'
@@ -76,6 +122,12 @@ require 'square_connect/models/transaction'
76
122
  require 'square_connect/models/transaction_product'
77
123
  require 'square_connect/models/update_customer_request'
78
124
  require 'square_connect/models/update_customer_response'
125
+ require 'square_connect/models/update_item_modifier_lists_request'
126
+ require 'square_connect/models/update_item_modifier_lists_response'
127
+ require 'square_connect/models/update_item_taxes_request'
128
+ require 'square_connect/models/update_item_taxes_response'
129
+ require 'square_connect/models/upsert_catalog_object_request'
130
+ require 'square_connect/models/upsert_catalog_object_response'
79
131
  require 'square_connect/models/v1_adjust_inventory_request'
80
132
  require 'square_connect/models/v1_bank_account'
81
133
  require 'square_connect/models/v1_cash_drawer_event'
@@ -118,6 +170,7 @@ require 'square_connect/models/void_transaction_request'
118
170
  require 'square_connect/models/void_transaction_response'
119
171
 
120
172
  # APIs
173
+ require 'square_connect/api/catalog_api'
121
174
  require 'square_connect/api/checkout_api'
122
175
  require 'square_connect/api/customers_api'
123
176
  require 'square_connect/api/locations_api'