diff --git a/CHANGES.md b/CHANGES.md index ed6f565..9200c56 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,7 +1,20 @@ # Change Log +## Version 2.20191120.0 (2019-11-20) +!!!important +Square has begun the retirement process for Connect v1 APIs. See the [Connect v1 Retirement](/migrate-from-v1) information page for details. +!!! + +* __GA releases:__ SDKs now support the new `modify_tax_basis` field to Discounts and v2 Sandbox +* __BETA releases:__ SDKs now support the Shifts API webhooks for Labor shift created, updated, deleted, CreateLocation endpoint, and the ability to customize statement description in Payments API. +* **Deprecated**: Support for v1Items API and v1Locations API is fully deprecated. + + + + ## Version 2.20191023.0 (2019-10-23) * **GA release**: Merchants.ListMerchant is GA for all SDKs. +* **Beta release**: All SDKs support new Locations API endpoint, CreateLocation. * **Beta release**: All SDKs support exclusion strategies for pricing rules. diff --git a/README.md b/README.md index 174be70..1def219 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Add this dependency to your project's POM: com.squareup connect - 2.20191023.0 + 2.20191120.0 compile ``` @@ -36,7 +36,7 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "com.squareup:connect:2.20191023.0" +compile "com.squareup:connect:2.20191120.0" ``` ### Option 3: Build and Install locally @@ -78,7 +78,7 @@ At first generate the JAR by executing: Then manually install the following JARs: -* target/connect-2.20191023.0.jar +* target/connect-2.20191120.0.jar * target/lib/*.jar ## Getting Started @@ -200,6 +200,7 @@ Class | Method | HTTP request | Description *LaborApi* | [**updateBreakType**](docs/LaborApi.md#updateBreakType) | **PUT** /v2/labor/break-types/{id} | UpdateBreakType *LaborApi* | [**updateShift**](docs/LaborApi.md#updateShift) | **PUT** /v2/labor/shifts/{id} | UpdateShift *LaborApi* | [**updateWorkweekConfig**](docs/LaborApi.md#updateWorkweekConfig) | **PUT** /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig +*LocationsApi* | [**createLocation**](docs/LocationsApi.md#createLocation) | **POST** /v2/locations | CreateLocation *LocationsApi* | [**listLocations**](docs/LocationsApi.md#listLocations) | **GET** /v2/locations | ListLocations *LocationsApi* | [**retrieveLocation**](docs/LocationsApi.md#retrieveLocation) | **GET** /v2/locations/{location_id} | RetrieveLocation *LocationsApi* | [**updateLocation**](docs/LocationsApi.md#updateLocation) | **PUT** /v2/locations/{location_id} | UpdateLocation @@ -336,8 +337,10 @@ Class | Method | HTTP request | Description - [Card](docs/Card.md) - [CardBrand](docs/CardBrand.md) - [CardPaymentDetails](docs/CardPaymentDetails.md) + - [CashPaymentDetails](docs/CashPaymentDetails.md) - [CatalogCategory](docs/CatalogCategory.md) - [CatalogDiscount](docs/CatalogDiscount.md) + - [CatalogDiscountModifyTaxBasis](docs/CatalogDiscountModifyTaxBasis.md) - [CatalogDiscountType](docs/CatalogDiscountType.md) - [CatalogIdMapping](docs/CatalogIdMapping.md) - [CatalogImage](docs/CatalogImage.md) @@ -364,7 +367,13 @@ Class | Method | HTTP request | Description - [CatalogPricingType](docs/CatalogPricingType.md) - [CatalogProductSet](docs/CatalogProductSet.md) - [CatalogQuery](docs/CatalogQuery.md) + - [CatalogQueryCustomAttributeUsage](docs/CatalogQueryCustomAttributeUsage.md) - [CatalogQueryExact](docs/CatalogQueryExact.md) + - [CatalogQueryFilteredItems](docs/CatalogQueryFilteredItems.md) + - [CatalogQueryFilteredItemsCustomAttributeFilter](docs/CatalogQueryFilteredItemsCustomAttributeFilter.md) + - [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md) + - [CatalogQueryFilteredItemsNullableAttribute](docs/CatalogQueryFilteredItemsNullableAttribute.md) + - [CatalogQueryFilteredItemsStockLevel](docs/CatalogQueryFilteredItemsStockLevel.md) - [CatalogQueryItemVariationsForItemOptionValues](docs/CatalogQueryItemVariationsForItemOptionValues.md) - [CatalogQueryItemsForItemOptions](docs/CatalogQueryItemsForItemOptions.md) - [CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md) @@ -386,12 +395,16 @@ Class | Method | HTTP request | Description - [Country](docs/Country.md) - [CreateBreakTypeRequest](docs/CreateBreakTypeRequest.md) - [CreateBreakTypeResponse](docs/CreateBreakTypeResponse.md) + - [CreateCatalogImageRequest](docs/CreateCatalogImageRequest.md) + - [CreateCatalogImageResponse](docs/CreateCatalogImageResponse.md) - [CreateCheckoutRequest](docs/CreateCheckoutRequest.md) - [CreateCheckoutResponse](docs/CreateCheckoutResponse.md) - [CreateCustomerCardRequest](docs/CreateCustomerCardRequest.md) - [CreateCustomerCardResponse](docs/CreateCustomerCardResponse.md) - [CreateCustomerRequest](docs/CreateCustomerRequest.md) - [CreateCustomerResponse](docs/CreateCustomerResponse.md) + - [CreateLocationRequest](docs/CreateLocationRequest.md) + - [CreateLocationResponse](docs/CreateLocationResponse.md) - [CreateMobileAuthorizationCodeRequest](docs/CreateMobileAuthorizationCodeRequest.md) - [CreateMobileAuthorizationCodeResponse](docs/CreateMobileAuthorizationCodeResponse.md) - [CreateOrderRequest](docs/CreateOrderRequest.md) @@ -437,6 +450,7 @@ Class | Method | HTTP request | Description - [ErrorCategory](docs/ErrorCategory.md) - [ErrorCode](docs/ErrorCode.md) - [ExcludeStrategy](docs/ExcludeStrategy.md) + - [ExternalPaymentDetails](docs/ExternalPaymentDetails.md) - [GetBreakTypeRequest](docs/GetBreakTypeRequest.md) - [GetBreakTypeResponse](docs/GetBreakTypeResponse.md) - [GetEmployeeWageRequest](docs/GetEmployeeWageRequest.md) @@ -794,7 +808,6 @@ Class | Method | HTTP request | Description - [V1VariationPricingType](docs/V1VariationPricingType.md) - [VoidTransactionRequest](docs/VoidTransactionRequest.md) - [VoidTransactionResponse](docs/VoidTransactionResponse.md) - - [WebhookEvents](docs/WebhookEvents.md) - [Weekday](docs/Weekday.md) - [WorkweekConfig](docs/WorkweekConfig.md) @@ -815,18 +828,18 @@ Authentication schemes defined for the API: - EMPLOYEES_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee profile information. For example, to create and modify employee profiles. - INVENTORY_READ: __HTTP Method__: `GET` Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint. - INVENTORY_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint. - - ITEMS_READ: __HTTP Method__: `GET` Grants read access to product catalog information. For example, to get an item or a list of items. + - ITEMS_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. - ITEMS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to product catalog information. For example, to modify or add to a product catalog. - MERCHANT_PROFILE_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. - ORDERS_READ: __HTTP Method__: `GET` Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint. - ORDERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to order information. For example, to call the CreateCheckout endpoint. - PAYMENTS_READ: __HTTP Method__: `GET` Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint. - - PAYMENTS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process payments with the Transactions or Checkout API. - - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: __HTTP Method__: `POST`, `PUT`, `DELETE` Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Transactions API. - - PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process in-person payments. + - PAYMENTS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API. + - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: __HTTP Method__: `POST`, `PUT`, `DELETE` Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Payments API. + - PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to payments and refunds information. For example, to process in-person payments. - SETTLEMENTS_READ: __HTTP Method__: `GET` Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint. - - TIMECARDS_READ: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v1 ListTimecards endpoint. - - TIMECARDS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard information. For example, to create and modify timecards. + - TIMECARDS_READ: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint. + - TIMECARDS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee shift information. For example, to create and modify employee shifts. - TIMECARDS_SETTINGS_READ: __HTTP Method__: `GET` Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint. - TIMECARDS_SETTINGS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint. diff --git a/build.gradle b/build.gradle index c9c4b52..9988f64 100644 --- a/build.gradle +++ b/build.gradle @@ -2,7 +2,7 @@ apply plugin: 'idea' apply plugin: 'eclipse' group = 'com.squareup' -version = '2.20191023.0' +version = '2.20191120.0' buildscript { repositories { diff --git a/docs/ApplePayApi.md b/docs/ApplePayApi.md index 7d8b4c6..69d298e 100644 --- a/docs/ApplePayApi.md +++ b/docs/ApplePayApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description RegisterDomain -Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. +Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). ### Example ```java diff --git a/docs/BatchDeleteCatalogObjectsRequest.md b/docs/BatchDeleteCatalogObjectsRequest.md index f06d319..e367cf8 100644 --- a/docs/BatchDeleteCatalogObjectsRequest.md +++ b/docs/BatchDeleteCatalogObjectsRequest.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**objectIds** | **List<String>** | The IDs of the `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`. | [optional] +**objectIds** | **List<String>** | The IDs of the CatalogObjects 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 will delete its CatalogItemVariation. | [optional] diff --git a/docs/BatchDeleteCatalogObjectsResponse.md b/docs/BatchDeleteCatalogObjectsResponse.md index 54865a2..91f7222 100644 --- a/docs/BatchDeleteCatalogObjectsResponse.md +++ b/docs/BatchDeleteCatalogObjectsResponse.md @@ -8,9 +8,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**deletedObjectIds** | **List<String>** | The IDs of all `CatalogObject`s deleted by this request. | [optional] -**deletedAt** | **String** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**errors** | [**List<Error>**](Error.md) | The set of Errors encountered. | [optional] +**deletedObjectIds** | **List<String>** | The IDs of all CatalogObjects deleted by this request. | [optional] +**deletedAt** | **String** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] diff --git a/docs/BatchRetrieveCatalogObjectsRequest.md b/docs/BatchRetrieveCatalogObjectsRequest.md index 634f3b4..7f68cc0 100644 --- a/docs/BatchRetrieveCatalogObjectsRequest.md +++ b/docs/BatchRetrieveCatalogObjectsRequest.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**objectIds** | **List<String>** | The IDs of the `CatalogObject`s to be retrieved. | -**includeRelatedObjects** | **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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. | [optional] +**objectIds** | **List<String>** | The IDs of the CatalogObjects to be retrieved. | +**includeRelatedObjects** | **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, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. | [optional] diff --git a/docs/BatchRetrieveInventoryChangesRequest.md b/docs/BatchRetrieveInventoryChangesRequest.md index d01df27..ca65330 100644 --- a/docs/BatchRetrieveInventoryChangesRequest.md +++ b/docs/BatchRetrieveInventoryChangesRequest.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **states** | **List<String>** | Filters `ADJUSTMENT` query results by `InventoryState`. Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values | [optional] **updatedAfter** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] **updatedBefore** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryChangesResponse.md b/docs/BatchRetrieveInventoryChangesResponse.md index 1501f8d..5f57859 100644 --- a/docs/BatchRetrieveInventoryChangesResponse.md +++ b/docs/BatchRetrieveInventoryChangesResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **changes** | [**List<InventoryChange>**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryCountsRequest.md b/docs/BatchRetrieveInventoryCountsRequest.md index fdbb20a..3678501 100644 --- a/docs/BatchRetrieveInventoryCountsRequest.md +++ b/docs/BatchRetrieveInventoryCountsRequest.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **catalogObjectIds** | **List<String>** | Filters results by `CatalogObject` ID. Only applied when set. Default: unset. | [optional] **locationIds** | **List<String>** | Filters results by `Location` ID. Only applied when set. Default: unset. | [optional] **updatedAfter** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryCountsResponse.md b/docs/BatchRetrieveInventoryCountsResponse.md index 7e20c05..72bdb43 100644 --- a/docs/BatchRetrieveInventoryCountsResponse.md +++ b/docs/BatchRetrieveInventoryCountsResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **counts** | [**List<InventoryCount>**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/BatchUpsertCatalogObjectsRequest.md b/docs/BatchUpsertCatalogObjectsRequest.md index aa42d68..fed2715 100644 --- a/docs/BatchUpsertCatalogObjectsRequest.md +++ b/docs/BatchUpsertCatalogObjectsRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **idempotencyKey** | **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](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | -**batches** | [**List<CatalogObjectBatch>**](CatalogObjectBatch.md) | A batch of `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` with ID `#ABC` and a `CatalogItemVariation` with its `item_id` attribute set to `#ABC` in order to associate the `CatalogItemVariation` with its parent `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] +**batches** | [**List<CatalogObjectBatch>**](CatalogObjectBatch.md) | A batch of CatalogObjects 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](https://developer.squareup.com/docs/build-basics/working-with-dates), 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 with ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to `#ABC` in order to associate the CatalogItemVariation with its parent 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] diff --git a/docs/BatchUpsertCatalogObjectsResponse.md b/docs/BatchUpsertCatalogObjectsResponse.md index 17397f7..03b0c58 100644 --- a/docs/BatchUpsertCatalogObjectsResponse.md +++ b/docs/BatchUpsertCatalogObjectsResponse.md @@ -8,10 +8,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**objects** | [**List<CatalogObject>**](CatalogObject.md) | The created `CatalogObject`s | [optional] -**updatedAt** | **String** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] -**idMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this Upsert. | [optional] +**errors** | [**List<Error>**](Error.md) | Information on any errors that encountered. | [optional] +**objects** | [**List<CatalogObject>**](CatalogObject.md) | The created successfully created CatalogObjects. | [optional] +**updatedAt** | **String** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**idMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this upsert. | [optional] diff --git a/docs/BusinessHours.md b/docs/BusinessHours.md index 500e61e..e4a143b 100644 --- a/docs/BusinessHours.md +++ b/docs/BusinessHours.md @@ -3,7 +3,7 @@ ### Description - Represents the hours of operation for a business location. +Represents the hours of operation for a business location. ## Properties Name | Type | Description | Notes diff --git a/docs/BusinessHoursPeriod.md b/docs/BusinessHoursPeriod.md index 65df073..91cf1ac 100644 --- a/docs/BusinessHoursPeriod.md +++ b/docs/BusinessHoursPeriod.md @@ -3,7 +3,7 @@ ### Description - Represents a period of time during which a business location is open. +Represents a period of time during which a business location is open. ## Properties Name | Type | Description | Notes diff --git a/docs/CaptureTransactionRequest.md b/docs/CaptureTransactionRequest.md index 38f9f53..1343256 100644 --- a/docs/CaptureTransactionRequest.md +++ b/docs/CaptureTransactionRequest.md @@ -3,7 +3,7 @@ ### Description -Defines the query parameters for calls to the CaptureTransaction endpoint. + **Note: This model is deprecated.** ## Properties diff --git a/docs/Card.md b/docs/Card.md index dc07ec1..5051aed 100644 --- a/docs/Card.md +++ b/docs/Card.md @@ -9,13 +9,13 @@ Represents the payment details of a card to be used for payments. These details Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | Unique ID for this card. Generated by Square. | [optional] -**cardBrand** | **String** | The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for possible values | [optional] +**cardBrand** | **String** | The card's brand (such as `VISA`). See `CardBrand` for all possible values. See [CardBrand](#type-cardbrand) for possible values | [optional] **last4** | **String** | The last 4 digits of the card number. | [optional] **expMonth** | **Long** | The expiration month of the associated card as an integer between 1 and 12. | [optional] **expYear** | **Long** | The four-digit year of the card's expiration date. | [optional] **cardholderName** | **String** | The name of the cardholder. | [optional] **billingAddress** | [**Address**](Address.md) | The billing address for this card. | [optional] -**fingerprint** | **String** | A unique, Square-assigned ID that identifies the card across multiple locations and applications for a single Square account. | [optional] +**fingerprint** | **String** | __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. | [optional] **bin** | **String** | The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field. | [optional] diff --git a/docs/CashPaymentDetails.md b/docs/CashPaymentDetails.md new file mode 100644 index 0000000..e65f72a --- /dev/null +++ b/docs/CashPaymentDetails.md @@ -0,0 +1,15 @@ + +# CashPaymentDetails + +### Description + +Additional details about CASH type payments. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**buyerSuppliedMoney** | [**Money**](Money.md) | The amount and currency of the money supplied by the buyer. | +**changeBackMoney** | [**Money**](Money.md) | The amount of change due back to the buyer. Read Only field calculated from the amount_money and buyer_supplied_money fields. | [optional] + + + diff --git a/docs/CatalogApi.md b/docs/CatalogApi.md index 60ad9f6..6f5ef36 100644 --- a/docs/CatalogApi.md +++ b/docs/CatalogApi.md @@ -249,7 +249,7 @@ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); oauth2.setAccessToken("YOUR ACCESS TOKEN"); CatalogApi apiInstance = new CatalogApi(); -String objectId = "objectId_example"; // String | The ID of the `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`. +String objectId = "objectId_example"; // String | The ID of the catalog object 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 catalog item will delete its catalog item variations). try { DeleteCatalogObjectResponse result = apiInstance.deleteCatalogObject(objectId); System.out.println(result); @@ -263,7 +263,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **objectId** | **String**| The ID of the `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`. | + **objectId** | **String**| The ID of the catalog object 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 catalog item will delete its catalog item variations). | ### Return type @@ -303,7 +303,7 @@ oauth2.setAccessToken("YOUR ACCESS TOKEN"); CatalogApi apiInstance = new CatalogApi(); String cursor = "cursor_example"; // String | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. -String types = "types_example"; // String | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. +String types = "types_example"; // String | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. try { ListCatalogResponse result = apiInstance.listCatalog(cursor, types); System.out.println(result); @@ -318,7 +318,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **cursor** | **String**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] - **types** | **String**| An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] + **types** | **String**| An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] ### Return type @@ -357,8 +357,8 @@ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); oauth2.setAccessToken("YOUR ACCESS TOKEN"); CatalogApi apiInstance = new CatalogApi(); -String objectId = "objectId_example"; // String | The object ID of any type of `CatalogObject`s to be retrieved. -Boolean includeRelatedObjects = 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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` +String objectId = "objectId_example"; // String | The object ID of any type of catalog objects to be retrieved. +Boolean includeRelatedObjects = 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, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` try { RetrieveCatalogObjectResponse result = apiInstance.retrieveCatalogObject(objectId, includeRelatedObjects); System.out.println(result); @@ -372,8 +372,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **objectId** | **String**| The object ID of any type of `CatalogObject`s to be retrieved. | - **includeRelatedObjects** | **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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` | [optional] + **objectId** | **String**| The object ID of any type of catalog objects to be retrieved. | + **includeRelatedObjects** | **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, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` | [optional] ### Return type @@ -394,7 +394,7 @@ Name | Type | Description | Notes 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), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). +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), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). -- -- Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). ### Example ```java diff --git a/docs/CatalogCategory.md b/docs/CatalogCategory.md index e61a75a..43ed80b 100644 --- a/docs/CatalogCategory.md +++ b/docs/CatalogCategory.md @@ -3,12 +3,12 @@ ### Description -A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model. +A category to which a `CatalogItem` belongs in the `Catalog` object model. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The category's name. Searchable. This field has max length of 255 Unicode code points. | [optional] +**name** | **String** | The category name. Searchable. This field has max length of 255 Unicode code points. | [optional] diff --git a/docs/CatalogDiscount.md b/docs/CatalogDiscount.md index f11b1e1..550810c 100644 --- a/docs/CatalogDiscount.md +++ b/docs/CatalogDiscount.md @@ -8,12 +8,13 @@ A discount in the Catalog object model. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The discount's name. Searchable. This field has max length of 255 Unicode code points. | [optional] +**name** | **String** | The discount name. Searchable. This field has max length of 255 Unicode code points. | [optional] **discountType** | **String** | Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for possible values | [optional] **percentage** | **String** | The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`. Do not include this field for amount-based or variable discounts. | [optional] **amountMoney** | [**Money**](Money.md) | The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`. Do not include this field for percentage-based or variable discounts. | [optional] **pinRequired** | **Boolean** | Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app. | [optional] -**labelColor** | **String** | The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] +**labelColor** | **String** | The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] +**modifyTaxBasis** | **String** | Indicates whether this discount should reduce the price used to calculate tax. Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must be calculated based on an item's price, ignoring a particular discount. For example, in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a customer pays but does not reduce the sale price used to calculate how much sales tax is due. In this case, the discount representing that manufacturer coupon should have `DO_NOT_MODIFY_TAX_BASIS` for this field. If you are unsure whether you need to use this field, consult your tax professional. See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values | [optional] diff --git a/docs/CatalogDiscountModifyTaxBasis.md b/docs/CatalogDiscountModifyTaxBasis.md new file mode 100644 index 0000000..62b2c69 --- /dev/null +++ b/docs/CatalogDiscountModifyTaxBasis.md @@ -0,0 +1,10 @@ + +# CatalogDiscountModifyTaxBasis + + +* `"MODIFY_TAX_BASIS"` + +* `"DO_NOT_MODIFY_TAX_BASIS"` + + + diff --git a/docs/CatalogIdMapping.md b/docs/CatalogIdMapping.md index 842d92b..b926377 100644 --- a/docs/CatalogIdMapping.md +++ b/docs/CatalogIdMapping.md @@ -9,7 +9,7 @@ A mapping between a client-supplied temporary ID and a permanent server ID. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **clientObjectId** | **String** | The client-supplied, temporary `#`-prefixed ID for a new `CatalogObject`. | [optional] -**objectId** | **String** | The permanent ID for the `CatalogObject` created by the server. | [optional] +**objectId** | **String** | The permanent ID for the CatalogObject created by the server. | [optional] diff --git a/docs/CatalogInfoResponse.md b/docs/CatalogInfoResponse.md index 5262dfa..c47b7cd 100644 --- a/docs/CatalogInfoResponse.md +++ b/docs/CatalogInfoResponse.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] +**errors** | [**List<Error>**](Error.md) | The set of errors encountered. | [optional] **limits** | [**CatalogInfoResponseLimits**](CatalogInfoResponseLimits.md) | | [optional] **standardUnitDescriptionGroup** | [**StandardUnitDescriptionGroup**](StandardUnitDescriptionGroup.md) | Names and abbreviations for standard units. | [optional] diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md index a4019e0..a96c847 100644 --- a/docs/CatalogItem.md +++ b/docs/CatalogItem.md @@ -16,9 +16,9 @@ Name | Type | Description | Notes **availableForPickup** | **Boolean** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional] **availableElectronically** | **Boolean** | If `true`, the item can be added to electronically fulfilled orders from the merchant's online store. | [optional] **categoryId** | **String** | The ID of the item's category, if any. | [optional] -**taxIds** | **List<String>** | A set of IDs indicating the `CatalogTax`es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. `CatalogTax`es may also be added to or deleted from an item using `UpdateItemTaxes`. | [optional] -**modifierListInfo** | [**List<CatalogItemModifierListInfo>**](CatalogItemModifierListInfo.md) | A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. `CatalogModifierList`s may also be added to or deleted from an item using `UpdateItemModifierLists`. | [optional] -**variations** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations | [optional] +**taxIds** | **List<String>** | A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item. Taxes may also be added to or deleted from an item using `UpdateItemTaxes`. | [optional] +**modifierListInfo** | [**List<CatalogItemModifierListInfo>**](CatalogItemModifierListInfo.md) | A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. Modifier lists may also be added to or deleted from an item using `UpdateItemModifierLists`. | [optional] +**variations** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects containing the `CatalogItemVariation`s for this item. | [optional] **productType** | **String** | The product type of the item. May not be changed once an item has been created. Only items of product type `REGULAR` or `APPOINTMENTS_SERVICE` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values | [optional] **skipModifierScreen** | **Boolean** | If `false`, the Square Point of Sale app will present the `CatalogItem`'s details screen immediately, allowing the merchant to choose `CatalogModifier`s before adding the item to the cart. This is the default behavior. If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details. Third-party clients are encouraged to implement similar behaviors. | [optional] **itemOptions** | [**List<CatalogItemOptionForItem>**](CatalogItemOptionForItem.md) | List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options. | [optional] [beta] diff --git a/docs/CatalogItemModifierListInfo.md b/docs/CatalogItemModifierListInfo.md index f93fbe4..c92d79a 100644 --- a/docs/CatalogItemModifierListInfo.md +++ b/docs/CatalogItemModifierListInfo.md @@ -3,15 +3,15 @@ ### Description -Controls the properties of a [CatalogModifierList](#type-catalogmodifierlist) as it applies to this [CatalogItem](#type-catalogitem). +Controls the properties of a `CatalogModifierList` as it applies to this `CatalogItem`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**modifierListId** | **String** | The ID of the `CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo`. | -**modifierOverrides** | [**List<CatalogModifierOverride>**](CatalogModifierOverride.md) | A set of `CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier` is enabled by default. | [optional] -**minSelectedModifiers** | **Integer** | If zero or larger, the smallest number of `CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList`. | [optional] -**maxSelectedModifiers** | **Integer** | If zero or larger, the largest number of `CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList`. | [optional] +**modifierListId** | **String** | The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`. | +**modifierOverrides** | [**List<CatalogModifierOverride>**](CatalogModifierOverride.md) | A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. | [optional] +**minSelectedModifiers** | **Integer** | If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. | [optional] +**maxSelectedModifiers** | **Integer** | If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. | [optional] **enabled** | **Boolean** | If `true`, enable this `CatalogModifierList`. | [optional] diff --git a/docs/CatalogItemOption.md b/docs/CatalogItemOption.md index db3d9f5..6713090 100644 --- a/docs/CatalogItemOption.md +++ b/docs/CatalogItemOption.md @@ -3,7 +3,7 @@ ### Description -A group of variations for a [CatalogItem](#type-catalogitem)'s. +A group of variations for a `CatalogItem`. **Note: This model is in beta.** ## Properties @@ -11,9 +11,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The item option's display name for the seller. Must be unique across all item options. Searchable. | [optional] **displayName** | **String** | The item option's display name for the customer. Searchable. | [optional] -**description** | **String** | The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. | [optional] +**description** | **String** | The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. | [optional] **showColors** | **Boolean** | If true, display colors for entries in `values` when present. | [optional] -**values** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s containing the `CatalogItemOptionValue`s for this item. | [optional] +**values** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item. | [optional] **itemCount** | **Long** | The number of `CatalogItem`s currently associated with this item option. Present only if the `include_counts` was specified in the request. Any count over 100 will be returned as `100`. | [optional] diff --git a/docs/CatalogItemOptionValue.md b/docs/CatalogItemOptionValue.md index fed0541..0c4e8f9 100644 --- a/docs/CatalogItemOptionValue.md +++ b/docs/CatalogItemOptionValue.md @@ -3,7 +3,7 @@ ### Description -An enumerated value that can link a [CatalogItemVariation(#type-catalogitemvariation) to an item option as one of its item option values. +An enumerated value that can link a `CatalogItemVariation` to an item option as one of its item option values. **Note: This model is in beta.** ## Properties @@ -11,10 +11,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **itemOptionId** | **String** | Unique ID of the associated item option. | [optional] **name** | **String** | Name of this item option value. Searchable. | [optional] -**description** | **String** | The option value's human-readable description. | [optional] +**description** | **String** | A human-readable description for the option value. | [optional] **color** | **String** | The HTML-supported hex color for the item option (e.g., \"#ff8d4e85\"). Only displayed if `show_colors` is enabled on the parent `ItemOption`. When left unset, `color` defaults to white (\"#ffffff\") when `show_colors` is enabled on the parent `ItemOption`. | [optional] **ordinal** | **Integer** | Determines where this option value appears in a list of option values. | [optional] -**itemVariationCount** | **Long** | The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. | [optional] +**itemVariationCount** | **Long** | The number of `CatalogItemVariation`s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. | [optional] diff --git a/docs/CatalogItemOptionValueForItemVariation.md b/docs/CatalogItemOptionValueForItemVariation.md index d8025bf..0354eb2 100644 --- a/docs/CatalogItemOptionValueForItemVariation.md +++ b/docs/CatalogItemOptionValueForItemVariation.md @@ -3,7 +3,7 @@ ### Description -A [CatalogItemOptionValue](#type-catalogitemoptionvalue) links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, “Color:Red, Size:Small” or “Color:Blue, Size:Medium”. +A `CatalogItemOptionValue` links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, \"Color:Red, Size:Small\" or \"Color:Blue, Size:Medium\". **Note: This model is in beta.** ## Properties diff --git a/docs/CatalogItemVariation.md b/docs/CatalogItemVariation.md index 5a91c43..ccc61b9 100644 --- a/docs/CatalogItemVariation.md +++ b/docs/CatalogItemVariation.md @@ -15,11 +15,11 @@ Name | Type | Description | Notes **ordinal** | **Integer** | The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent `CatalogItem` is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique. | [optional] **pricingType** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for possible values | [optional] **priceMoney** | [**Money**](Money.md) | The item variation's price, if fixed pricing is used. | [optional] -**locationOverrides** | [**List<ItemVariationLocationOverrides>**](ItemVariationLocationOverrides.md) | Per-`location` price and inventory overrides. | [optional] +**locationOverrides** | [**List<ItemVariationLocationOverrides>**](ItemVariationLocationOverrides.md) | Per-location price and inventory overrides. | [optional] **trackInventory** | **Boolean** | If `true`, inventory tracking is active for the variation. | [optional] **inventoryAlertType** | **String** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values | [optional] **inventoryAlertThreshold** | **Long** | 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] -**userData** | **String** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional] +**userData** | **String** | Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. | [optional] **serviceDuration** | **Long** | If the `CatalogItem` that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional] **itemOptionValues** | [**List<CatalogItemOptionValueForItemVariation>**](CatalogItemOptionValueForItemVariation.md) | List of item option values associated with this item variation. Listed in the same order as the item options of the parent item. | [optional] [beta] **measurementUnitId** | **String** | ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities. | [optional] [beta] diff --git a/docs/CatalogMeasurementUnit.md b/docs/CatalogMeasurementUnit.md index afdd94c..f693dda 100644 --- a/docs/CatalogMeasurementUnit.md +++ b/docs/CatalogMeasurementUnit.md @@ -3,14 +3,14 @@ ### Description -Represents the unit used to measure a [CatalogItemVariation](#type-catalogitemvariation) and specifies the precision for decimal quantities. +Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities. **Note: This model is in beta.** ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **measurementUnit** | [**MeasurementUnit**](MeasurementUnit.md) | Indicates the unit used to measure the quantity of a catalog item variation. | [optional] -**precision** | **Integer** | Represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example, if the precision is 2, then an itemization’s quantity can be 0.01, 0.12, etc. Min: 0 Max: 5 Default: 3 | [optional] +**precision** | **Integer** | An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3 | [optional] diff --git a/docs/CatalogModifier.md b/docs/CatalogModifier.md index 5e4977b..1d1c97b 100644 --- a/docs/CatalogModifier.md +++ b/docs/CatalogModifier.md @@ -8,8 +8,8 @@ A modifier in the Catalog object model. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The modifier's name. Searchable. This field has max length of 255 Unicode code points. | [optional] -**priceMoney** | [**Money**](Money.md) | The modifier's price. | [optional] +**name** | **String** | The modifier name. Searchable. This field has max length of 255 Unicode code points. | [optional] +**priceMoney** | [**Money**](Money.md) | The modifier price. | [optional] diff --git a/docs/CatalogModifierList.md b/docs/CatalogModifierList.md index 144d557..8f5721a 100644 --- a/docs/CatalogModifierList.md +++ b/docs/CatalogModifierList.md @@ -3,14 +3,14 @@ ### Description -A modifier list in the Catalog object model. A [CatalogModifierList](#type-catalogmodifierlist) contains [Modifier](#type-catalogmodifier)s that can be applied to a [CatalogItem](#type-catalogitem) at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" [CatalogItem](#type-catalogitem) might contain [CatalogModifier](#type-catalogmodifier)s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed. +A modifier list in the Catalog object model. A `CatalogModifierList` contains `CatalogModifier` objects that can be applied to a `CatalogItem` at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" `CatalogItem` might contain `CatalogModifier`s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The `CatalogModifierList`'s name. Searchable. This field has max length of 255 Unicode code points. | [optional] +**name** | **String** | A searchable name for the `CatalogModifierList`. This field has max length of 255 Unicode code points. | [optional] **selectionType** | **String** | Indicates whether multiple options from the `CatalogModifierList` can be applied to a single `CatalogItem`. See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values | [optional] -**modifiers** | [**List<CatalogObject>**](CatalogObject.md) | The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each `CatalogObject` must have type `MODIFIER` and contain `CatalogModifier` data. | [optional] +**modifiers** | [**List<CatalogObject>**](CatalogObject.md) | The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each CatalogObject must have type `MODIFIER` and contain `CatalogModifier` data. | [optional] diff --git a/docs/CatalogModifierOverride.md b/docs/CatalogModifierOverride.md index ad40b50..94ac1b7 100644 --- a/docs/CatalogModifierOverride.md +++ b/docs/CatalogModifierOverride.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **modifierId** | **String** | The ID of the `CatalogModifier` whose default behavior is being overridden. | -**onByDefault** | **Boolean** | If `true`, this `CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem`. | [optional] +**onByDefault** | **Boolean** | If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`. | [optional] diff --git a/docs/CatalogObject.md b/docs/CatalogObject.md index 57d39da..31c2418 100644 --- a/docs/CatalogObject.md +++ b/docs/CatalogObject.md @@ -3,17 +3,17 @@ ### Description -The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid [CatalogItem](#type-catalogitem) object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid [CatalogItemVariation](#type-catalogitemvariation) object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid [CatalogModifier](#type-catalogmodifier) object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid [CatalogModifierList](#type-catalogmodifierlist) object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid [CatalogCategory](#type-catalogcategory) object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid [CatalogDiscount](#type-catalogdiscount) object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid [CatalogTax](#type-catalogtax) object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid [CatalogImage](#type-catalogimage) object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. +The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid `CatalogItem` object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid `CatalogItemVariation` object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid `CatalogModifier` object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid `CatalogModifierList` object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid `CatalogCategory` object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid `CatalogDiscount` object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid `CatalogTax` object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid `CatalogImage` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See [CatalogObjectType](#type-catalogobjecttype) for possible values | -**id** | **String** | An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. | -**updatedAt** | **String** | Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional] +**id** | **String** | An identifier to reference this object in the catalog. When a new `CatalogObject` is inserted, the client should set the id to a temporary identifier starting with a \"`#`\" character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. | +**updatedAt** | **String** | Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional] **version** | **Long** | The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting. | [optional] **isDeleted** | **Boolean** | If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional] -**catalogV1Ids** | [**List<CatalogV1Id>**](CatalogV1Id.md) | The Connect V1 IDs for this object at each `location` where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional] +**catalogV1Ids** | [**List<CatalogV1Id>**](CatalogV1Id.md) | The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional] **presentAtAllLocations** | **Boolean** | If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. | [optional] **presentAtLocationIds** | **List<String>** | A list of locations where the object is present, even if `present_at_all_locations` is `false`. | [optional] **absentAtLocationIds** | **List<String>** | A list of locations where the object is not present, even if `present_at_all_locations` is `true`. | [optional] diff --git a/docs/CatalogObjectBatch.md b/docs/CatalogObjectBatch.md index ecf2569..eecf174 100644 --- a/docs/CatalogObjectBatch.md +++ b/docs/CatalogObjectBatch.md @@ -3,12 +3,12 @@ ### Description -A batch of [CatalogObject](#type-catalogobject)s. +A batch of catalog objects. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s belonging to this batch. | [optional] +**objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects belonging to this batch. | [optional] diff --git a/docs/CatalogPricingRule.md b/docs/CatalogPricingRule.md index d92eb29..e4fa4f3 100644 --- a/docs/CatalogPricingRule.md +++ b/docs/CatalogPricingRule.md @@ -10,16 +10,16 @@ Defines how prices are modified or set for items that match the pricing rule dur Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | User-defined name for the pricing rule. For example, \"Buy one get one free\" or \"10% off\". | [optional] -**timePeriodIds** | **List<String>** | Unique ID for the `CatalogTimePeriod`s when this pricing rule is in effect. If left unset, the pricing rule is always in effect. | [optional] +**timePeriodIds** | **List<String>** | A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect. | [optional] **discountId** | **String** | Unique ID for the `CatalogDiscount` to take off the price of all matched items. | [optional] -**matchProductsId** | **String** | Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. | [optional] -**applyProductsId** | **String** | `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. This field has been deprecated: new pricing rules should prefer the exclude_products_id field. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. | [optional] [deprecated] -**excludeProductsId** | **String** | Identifies the `CatalogProductSet` to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. | [optional] +**matchProductsId** | **String** | Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. A match rule can match multiple times in the cart. If no `ProductSet` is present, the rule will match all products. | [optional] +**applyProductsId** | **String** | __Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. | [optional] [deprecated] +**excludeProductsId** | **String** | `CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. | [optional] **validFromDate** | **String** | Represents the date the Pricing Rule is valid from. Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional] -**validFromLocalTime** | **String** | Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] -**validUntilDate** | **String** | Represents the date the pricing rule will become inactive. Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional] -**validUntilLocalTime** | **String** | Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] -**excludeStrategy** | **String** | If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. See `ExcludeStrategy` for all possible values. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values | [optional] +**validFromLocalTime** | **String** | Represents the local time the pricing rule should be valid from. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] +**validUntilDate** | **String** | Represents the date the Pricing Rule is valid until. Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional] +**validUntilLocalTime** | **String** | Represents the local time the pricing rule should be valid until. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] +**excludeStrategy** | **String** | If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values | [optional] diff --git a/docs/CatalogProductSet.md b/docs/CatalogProductSet.md index 101a7c9..368c3e4 100644 --- a/docs/CatalogProductSet.md +++ b/docs/CatalogProductSet.md @@ -3,15 +3,15 @@ ### Description -Represents a collection of catalog objects for the purpose of applying a [PricingRule](#type-pricingrule). Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations. +Represents a collection of catalog objects for the purpose of applying a `PricingRule`. Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations. **Note: This model is in beta.** ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". | [optional] -**productIdsAny** | **List<String>** | Unique IDs for any `CatalogObjects`s to include in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. | [optional] -**productIdsAll** | **List<String>** | Unique IDs for `CatalogObjects` to include in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. | [optional] +**name** | **String** | User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". | [optional] +**productIdsAny** | **List<String>** | Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. | [optional] +**productIdsAll** | **List<String>** | Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. | [optional] **quantityExact** | **Long** | If set, there must be exactly this many items from `products_any` or `products_all` in the cart for the discount to apply. Cannot be combined with either `quantity_min` or `quantity_max`. | [optional] **quantityMin** | **Long** | If set, there must be at least this many items from `products_any` or `products_all` in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified. | [optional] **quantityMax** | **Long** | If set, the pricing rule will apply to a maximum of this many items from `products_any` or `products_all`. | [optional] diff --git a/docs/CatalogQuery.md b/docs/CatalogQuery.md index c9a59b2..73d81c6 100644 --- a/docs/CatalogQuery.md +++ b/docs/CatalogQuery.md @@ -3,7 +3,7 @@ ### Description -A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest). Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. +A query to be applied to a `SearchCatalogObjectsRequest`. Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) (`CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifierList`, `CatalogModifier`). For example, a query that should return Items may specify attribute names from any of the searchable fields of the `CatalogItem` data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. ## Properties Name | Type | Description | Notes @@ -13,10 +13,10 @@ Name | Type | Description | Notes **prefixQuery** | [**CatalogQueryPrefix**](CatalogQueryPrefix.md) | A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix. | [optional] **rangeQuery** | [**CatalogQueryRange**](CatalogQueryRange.md) | A query that returns only objects for which the given (integer-valued) attribute lies in the given range. | [optional] **textQuery** | [**CatalogQueryText**](CatalogQueryText.md) | A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a `CatalogItem` contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`. | [optional] -**itemsForTaxQuery** | [**CatalogQueryItemsForTax**](CatalogQueryItemsForTax.md) | A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax`es enabled. | [optional] -**itemsForModifierListQuery** | [**CatalogQueryItemsForModifierList**](CatalogQueryItemsForModifierList.md) | A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList`s enabled. | [optional] -**itemsForItemOptionsQuery** | [**CatalogQueryItemsForItemOptions**](CatalogQueryItemsForItemOptions.md) | A query that returns all `CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption`s. | [optional] -**itemVariationsForItemOptionValuesQuery** | [**CatalogQueryItemVariationsForItemOptionValues**](CatalogQueryItemVariationsForItemOptionValues.md) | A query that returns all `CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption` values. | [optional] +**itemsForTaxQuery** | [**CatalogQueryItemsForTax**](CatalogQueryItemsForTax.md) | A query that returns all `CatalogItem`s that have any of the given `CatalogTax`es enabled. | [optional] +**itemsForModifierListQuery** | [**CatalogQueryItemsForModifierList**](CatalogQueryItemsForModifierList.md) | A query that returns all `CatalogItem`s that have any of the given `CatalogModifierList`s enabled. | [optional] +**itemsForItemOptionsQuery** | [**CatalogQueryItemsForItemOptions**](CatalogQueryItemsForItemOptions.md) | A query that returns all `CatalogItem`s that have all of the given `CatalogItemOption`s. | [optional] +**itemVariationsForItemOptionValuesQuery** | [**CatalogQueryItemVariationsForItemOptionValues**](CatalogQueryItemVariationsForItemOptionValues.md) | A query that returns all `CatalogItemVariation`s that have all of the given `CatalogItemOption` values. | [optional] diff --git a/docs/CatalogQueryCustomAttributeUsage.md b/docs/CatalogQueryCustomAttributeUsage.md new file mode 100644 index 0000000..c24b231 --- /dev/null +++ b/docs/CatalogQueryCustomAttributeUsage.md @@ -0,0 +1,15 @@ + +# CatalogQueryCustomAttributeUsage + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customAttributeDefinitionIds** | **List<String>** | | [optional] +**hasValue** | **Boolean** | | [optional] + + + diff --git a/docs/CatalogQueryFilteredItems.md b/docs/CatalogQueryFilteredItems.md new file mode 100644 index 0000000..41298a2 --- /dev/null +++ b/docs/CatalogQueryFilteredItems.md @@ -0,0 +1,23 @@ + +# CatalogQueryFilteredItems + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**textFilter** | **String** | | [optional] +**searchVendorCode** | **Boolean** | | [optional] +**categoryIds** | **List<String>** | | [optional] +**stockLevels** | **List<String>** | See [CatalogQueryFilteredItemsStockLevel](#type-catalogqueryfiltereditemsstocklevel) for possible values | [optional] +**enabledLocationIds** | **List<String>** | | [optional] +**vendorIds** | **List<String>** | | [optional] +**productTypes** | **List<String>** | See [CatalogItemProductType](#type-catalogitemproducttype) for possible values | [optional] +**customAttributeFilters** | [**List<CatalogQueryFilteredItemsCustomAttributeFilter>**](CatalogQueryFilteredItemsCustomAttributeFilter.md) | | [optional] +**doesNotExist** | **List<String>** | See [CatalogQueryFilteredItemsNullableAttribute](#type-catalogqueryfiltereditemsnullableattribute) for possible values | [optional] +**sortOrder** | **String** | See [SortOrder](#type-sortorder) for possible values | [optional] + + + diff --git a/docs/CatalogQueryFilteredItemsCustomAttributeFilter.md b/docs/CatalogQueryFilteredItemsCustomAttributeFilter.md new file mode 100644 index 0000000..f344f2d --- /dev/null +++ b/docs/CatalogQueryFilteredItemsCustomAttributeFilter.md @@ -0,0 +1,19 @@ + +# CatalogQueryFilteredItemsCustomAttributeFilter + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filterType** | **String** | See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values | [optional] +**customAttributeDefinitionIds** | **List<String>** | | [optional] +**customAttributeValueExact** | **String** | | [optional] +**customAttributeValuePrefix** | **String** | | [optional] +**customAttributeMinValue** | **String** | | [optional] +**customAttributeMaxValue** | **String** | | [optional] + + + diff --git a/docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md b/docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md new file mode 100644 index 0000000..b59a91d --- /dev/null +++ b/docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md @@ -0,0 +1,14 @@ + +# CatalogQueryFilteredItemsCustomAttributeFilterFilterType + + +* `"CUSTOM_ATTRIBUTE_FILTER_TYPE_DO_NOT_USE"` + +* `"EXACT"` + +* `"PREFIX"` + +* `"RANGE"` + + + diff --git a/docs/CatalogQueryFilteredItemsNullableAttribute.md b/docs/CatalogQueryFilteredItemsNullableAttribute.md new file mode 100644 index 0000000..2ecde81 --- /dev/null +++ b/docs/CatalogQueryFilteredItemsNullableAttribute.md @@ -0,0 +1,8 @@ + +# CatalogQueryFilteredItemsNullableAttribute + + +* `"VENDOR_TOKEN"` + + + diff --git a/docs/CatalogQueryFilteredItemsStockLevel.md b/docs/CatalogQueryFilteredItemsStockLevel.md new file mode 100644 index 0000000..2f02633 --- /dev/null +++ b/docs/CatalogQueryFilteredItemsStockLevel.md @@ -0,0 +1,10 @@ + +# CatalogQueryFilteredItemsStockLevel + + +* `"OUT"` + +* `"LOW"` + + + diff --git a/docs/CatalogQueryItemsForItemOptions.md b/docs/CatalogQueryItemsForItemOptions.md index 3c40fff..d00cf42 100644 --- a/docs/CatalogQueryItemsForItemOptions.md +++ b/docs/CatalogQueryItemsForItemOptions.md @@ -9,7 +9,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**itemOptionIds** | **List<String>** | A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` will be returned. | [optional] +**itemOptionIds** | **List<String>** | A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem`s. All Items that contain all of the given Item Options (in any order) will be returned. | [optional] diff --git a/docs/CatalogQueryItemsForModifierList.md b/docs/CatalogQueryItemsForModifierList.md index 9b3cd2e..5ffed59 100644 --- a/docs/CatalogQueryItemsForModifierList.md +++ b/docs/CatalogQueryItemsForModifierList.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**modifierListIds** | **List<String>** | A set of `CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem`s. | +**modifierListIds** | **List<String>** | A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. | diff --git a/docs/CatalogQueryItemsForTax.md b/docs/CatalogQueryItemsForTax.md index 46761c7..ad2fa6e 100644 --- a/docs/CatalogQueryItemsForTax.md +++ b/docs/CatalogQueryItemsForTax.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**taxIds** | **List<String>** | A set of `CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem`s. | +**taxIds** | **List<String>** | A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. | diff --git a/docs/CatalogQuerySortedAttribute.md b/docs/CatalogQuerySortedAttribute.md index e9a489d..ce0239c 100644 --- a/docs/CatalogQuerySortedAttribute.md +++ b/docs/CatalogQuerySortedAttribute.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeName** | **String** | The attribute whose value should be used as the sort key. | **initialAttributeValue** | **String** | The first attribute value to be returned by the query. Ascending sorts will return only objects with this value or greater, while descending sorts will return only objects with this value or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts). | [optional] -**sortOrder** | **String** | The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values | [optional] +**sortOrder** | **String** | The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values | [optional] diff --git a/docs/CatalogQueryText.md b/docs/CatalogQueryText.md index 2164d68..b2f18a5 100644 --- a/docs/CatalogQueryText.md +++ b/docs/CatalogQueryText.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**keywords** | **List<String>** | A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored. | +**keywords** | **List<String>** | A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 characters are ignored. | diff --git a/docs/CatalogV1Id.md b/docs/CatalogV1Id.md index 1df735b..082c265 100644 --- a/docs/CatalogV1Id.md +++ b/docs/CatalogV1Id.md @@ -3,13 +3,13 @@ ### Description -An Items Connect V1 object ID along with its associated [location](#type-location) ID. +An Items Connect V1 object ID along with its associated location ID. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **catalogV1Id** | **String** | The ID for an object in Connect V1, if different from its Connect V2 ID. | [optional] -**locationId** | **String** | The ID of the `location` this Connect V1 ID is associated with. | [optional] +**locationId** | **String** | The ID of the `Location` this Connect V1 ID is associated with. | [optional] diff --git a/docs/ChargeRequest.md b/docs/ChargeRequest.md index c7c0ffd..603f7d2 100644 --- a/docs/ChargeRequest.md +++ b/docs/ChargeRequest.md @@ -9,7 +9,7 @@ Defines the parameters that can be included in the body of a request to the [Cha ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotencyKey** | **String** | A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**idempotencyKey** | **String** | A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. | **amountMoney** | [**Money**](Money.md) | The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The value of `currency` must match the currency associated with the business that is charging the card. | **cardNonce** | **String** | A nonce generated from the `SqPaymentForm` that represents the card to charge. The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the `SqPaymentForm`. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for `customer_card_id`. | [optional] **customerCardId** | **String** | The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`. If you provide this value, you _must_ also provide a value for `customer_id`. | [optional] @@ -17,12 +17,12 @@ Name | Type | Description | Notes **referenceId** | **String** | An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters. | [optional] **note** | **String** | An optional note to associate with the transaction. This value cannot exceed 60 characters. | [optional] **customerId** | **String** | The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise. | [optional] -**billingAddress** | [**Address**](Address.md) | The buyer's billing address. | [optional] -**shippingAddress** | [**Address**](Address.md) | The buyer's shipping address, if available. | [optional] -**buyerEmailAddress** | **String** | The buyer's email address, if available. | [optional] +**billingAddress** | [**Address**](Address.md) | The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided. | [optional] +**shippingAddress** | [**Address**](Address.md) | The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. | [optional] +**buyerEmailAddress** | **String** | The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. | [optional] **orderId** | **String** | The ID of the order to associate with this transaction. If you provide this value, the `amount_money` value of your request must __exactly match__ the value of the order's `total_money` field. | [optional] **additionalRecipients** | [**List<AdditionalRecipient>**](AdditionalRecipient.md) | The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in the charge request. The `location_id` must be the valid location of the app owner merchant. This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox. | [optional] -**verificationToken** | **String** | An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. | [optional] +**verificationToken** | **String** | A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result. | [optional] diff --git a/docs/Coordinates.md b/docs/Coordinates.md index ef574a9..696b039 100644 --- a/docs/Coordinates.md +++ b/docs/Coordinates.md @@ -8,8 +8,8 @@ Latitude and longitude coordinates. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**latitude** | [**BigDecimal**](BigDecimal.md) | The coordinate's latitude expressed in degrees. | [optional] -**longitude** | [**BigDecimal**](BigDecimal.md) | The coordinate's longitude expressed in degrees. | [optional] +**latitude** | [**BigDecimal**](BigDecimal.md) | The latitude of the coordinate expressed in degrees. | [optional] +**longitude** | [**BigDecimal**](BigDecimal.md) | The longitude of the coordinate expressed in degrees. | [optional] diff --git a/docs/CreateCatalogImageRequest.md b/docs/CreateCatalogImageRequest.md new file mode 100644 index 0000000..5970c28 --- /dev/null +++ b/docs/CreateCatalogImageRequest.md @@ -0,0 +1,16 @@ + +# CreateCatalogImageRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**idempotencyKey** | **String** | A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**objectId** | **String** | Unique ID of the `CatalogObject` to attach to this `CatalogImage`. Leave this field empty to create unattached images, for example if you are building an integration where these images can be attached to catalog items at a later time. | [optional] +**image** | [**CatalogObject**](CatalogObject.md) | The new `IMAGE`-type `CatalogObject` to be attached to this `CatalogImage`. If the `CatalogObject` already has a `CatalogImage`, this call will overwrite it. | [optional] + + + diff --git a/docs/CreateCatalogImageResponse.md b/docs/CreateCatalogImageResponse.md new file mode 100644 index 0000000..6763242 --- /dev/null +++ b/docs/CreateCatalogImageResponse.md @@ -0,0 +1,15 @@ + +# CreateCatalogImageResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**image** | [**CatalogObject**](CatalogObject.md) | The newly created `CatalogImage` including a Square-generated URL for each image. | [optional] + + + diff --git a/docs/CreateCheckoutRequest.md b/docs/CreateCheckoutRequest.md index ea6a2a5..a9f034d 100644 --- a/docs/CreateCheckoutRequest.md +++ b/docs/CreateCheckoutRequest.md @@ -3,12 +3,12 @@ ### Description -Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint. +Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotencyKey** | **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](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**idempotencyKey** | **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. | **order** | [**CreateOrderRequest**](CreateOrderRequest.md) | The order including line items to be checked out. | **askForShippingAddress** | **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] **merchantSupportEmail** | **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] diff --git a/docs/CreateCheckoutResponse.md b/docs/CreateCheckoutResponse.md index 7ce5215..74a318a 100644 --- a/docs/CreateCheckoutResponse.md +++ b/docs/CreateCheckoutResponse.md @@ -3,7 +3,7 @@ ### Description -Defines the fields that are included in the response body of a request to the CreateCheckout endpoint. +Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. ## Properties Name | Type | Description | Notes diff --git a/docs/CreateCustomerCardRequest.md b/docs/CreateCustomerCardRequest.md index 6541669..d749390 100644 --- a/docs/CreateCustomerCardRequest.md +++ b/docs/CreateCustomerCardRequest.md @@ -8,7 +8,7 @@ Defines the fields that are included in the request body of a request to the Cre ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cardNonce** | **String** | A card nonce representing the credit card to link to the customer. Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __Note:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. | +**cardNonce** | **String** | A card nonce representing the credit card to link to the customer. Card nonces are generated by the Square Payment Form when customers enter their card information. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __NOTE:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. | **billingAddress** | [**Address**](Address.md) | Address information for the card on file. Only the `postal_code` field is required for payments in the US and Canada. | [optional] **cardholderName** | **String** | The full name printed on the credit card. | [optional] **verificationToken** | **String** | An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. | [optional] diff --git a/docs/CreateCustomerRequest.md b/docs/CreateCustomerRequest.md index c442d0d..85834cc 100644 --- a/docs/CreateCustomerRequest.md +++ b/docs/CreateCustomerRequest.md @@ -8,17 +8,17 @@ Defines the body parameters that can be provided in a request to the CreateCusto ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotencyKey** | **String** | The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information. | [optional] -**givenName** | **String** | The customer's given (i.e., first) name. | [optional] -**familyName** | **String** | The customer's family (i.e., last) name. | [optional] -**companyName** | **String** | The name of the customer's company. | [optional] -**nickname** | **String** | A nickname for the customer. | [optional] -**emailAddress** | **String** | The customer's email address. | [optional] -**address** | [**Address**](Address.md) | The customer's physical address. | [optional] -**phoneNumber** | **String** | The customer's phone number. | [optional] -**referenceId** | **String** | An optional second ID you can set to associate the customer with an entity in another system. | [optional] -**note** | **String** | An optional note to associate with the customer. | [optional] -**birthday** | **String** | The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. | [optional] +**idempotencyKey** | **String** | The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) guide for more information. | [optional] +**givenName** | **String** | The given (i.e., first) name associated with the customer profile. | [optional] +**familyName** | **String** | The family (i.e., last) name associated with the customer profile. | [optional] +**companyName** | **String** | A business name associated with the customer profile. | [optional] +**nickname** | **String** | A nickname for the customer profile. | [optional] +**emailAddress** | **String** | The email address associated with the customer profile. | [optional] +**address** | [**Address**](Address.md) | The physical address associated with the customer profile. | [optional] +**phoneNumber** | **String** | The 11-digit phone number associated with the customer profile. | [optional] +**referenceId** | **String** | An optional, second ID used to associate the customer profile with an entity in another system. | [optional] +**note** | **String** | A custom note associated with the customer profile. | [optional] +**birthday** | **String** | The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. | [optional] diff --git a/docs/CreateLocationRequest.md b/docs/CreateLocationRequest.md new file mode 100644 index 0000000..2cf39ca --- /dev/null +++ b/docs/CreateLocationRequest.md @@ -0,0 +1,15 @@ + +# CreateLocationRequest + +### Description + +Request object for the [CreateLocation](#endpoint-createlocation) endpoint. +**Note: This model is in beta.** + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location** | [**Location**](Location.md) | The initial values of the location being created. The `name` field is required. All other fields are optional. Unspecified fields will be set to default values using existing location data. | [optional] + + + diff --git a/docs/CreateLocationResponse.md b/docs/CreateLocationResponse.md new file mode 100644 index 0000000..993c8e1 --- /dev/null +++ b/docs/CreateLocationResponse.md @@ -0,0 +1,16 @@ + +# CreateLocationResponse + +### Description + +Response object returned by the [CreateLocation](#endpoint-createlocation) endpoint. +**Note: This model is in beta.** + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] +**location** | [**Location**](Location.md) | The newly created `Location`. | [optional] + + + diff --git a/docs/CreateMobileAuthorizationCodeRequest.md b/docs/CreateMobileAuthorizationCodeRequest.md index a971475..4876d1b 100644 --- a/docs/CreateMobileAuthorizationCodeRequest.md +++ b/docs/CreateMobileAuthorizationCodeRequest.md @@ -3,7 +3,7 @@ ### Description -Defines the body parameters that can be provided in a request to the CreateMobileAuthorizationCode endpoint. +Defines the body parameters that can be provided in a request to the __CreateMobileAuthorizationCode__ endpoint. ## Properties Name | Type | Description | Notes diff --git a/docs/CreateMobileAuthorizationCodeResponse.md b/docs/CreateMobileAuthorizationCodeResponse.md index 92ee1ba..373a141 100644 --- a/docs/CreateMobileAuthorizationCodeResponse.md +++ b/docs/CreateMobileAuthorizationCodeResponse.md @@ -3,7 +3,7 @@ ### Description -Defines the fields that are included in the response body of a request to the CreateMobileAuthorizationCode endpoint. +Defines the fields that are included in the response body of a request to the __CreateMobileAuthorizationCode__ endpoint. ## Properties Name | Type | Description | Notes diff --git a/docs/CreatePaymentRequest.md b/docs/CreatePaymentRequest.md index 3fdba23..97b8d3f 100644 --- a/docs/CreatePaymentRequest.md +++ b/docs/CreatePaymentRequest.md @@ -3,27 +3,28 @@ ### Description -Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees). +Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees). ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sourceId** | **String** | The ID for the source of funds for this payment. This can be a nonce generated by the Payment Form or a card on file made with the Customers API. | -**idempotencyKey** | **String** | A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**idempotencyKey** | **String** | A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | **amountMoney** | [**Money**](Money.md) | The amount of money to accept for this payment, not including `tip_money`. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. | **tipMoney** | [**Money**](Money.md) | The amount designated as a tip, in addition to `amount_money` Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. | [optional] -**appFeeMoney** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). | [optional] +**appFeeMoney** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). | [optional] **autocomplete** | **Boolean** | If set to `true`, this payment will be completed when possible. If set to `false`, this payment will be held in an approved state until either explicitly completed (captured) or canceled (voided). For more information, see [Delayed Payments](https://developer.squareup.com/docs/payments-api/take-payments#delayed-payments). Default: true | [optional] **orderId** | **String** | Associate a previously created order with this payment | [optional] **customerId** | **String** | The ID of the customer associated with the payment. Required if the `source_id` refers to a card on file created using the Customers API. | [optional] **locationId** | **String** | The location ID to associate with the payment. If not specified, the default location is used. | [optional] **referenceId** | **String** | A user-defined ID to associate with the payment. You can use this field to associate the payment to an entity in an external system. For example, you might specify an order ID that is generated by a third-party shopping cart. Limit 40 characters. | [optional] -**verificationToken** | **String** | An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/docs/sca-overview) for more. | [optional] -**acceptPartialAuthorization** | **Boolean** | If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false | [optional] [beta] +**verificationToken** | **String** | An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/sca-overview) for more. | [optional] +**acceptPartialAuthorization** | **Boolean** | If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true`. For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false | [optional] [beta] **buyerEmailAddress** | **String** | The buyer's e-mail address | [optional] **billingAddress** | [**Address**](Address.md) | The buyer's billing address. | [optional] **shippingAddress** | [**Address**](Address.md) | The buyer's shipping address. | [optional] **note** | **String** | An optional note to be entered by the developer when creating a payment Limit 500 characters. | [optional] +**statementDescriptionIdentifier** | **String** | Optional additional payment information to include on the customer's card statement as part of statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Limit 20 characters. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. | [optional] [beta] diff --git a/docs/CreateRefundRequest.md b/docs/CreateRefundRequest.md index 445c24c..8df220e 100644 --- a/docs/CreateRefundRequest.md +++ b/docs/CreateRefundRequest.md @@ -9,7 +9,7 @@ Defines the body parameters that can be included in a request to the [CreateRefu ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotencyKey** | **String** | A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**idempotencyKey** | **String** | A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information. | **tenderId** | **String** | The ID of the tender to refund. A ``Transaction`` has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. | **reason** | **String** | A description of the reason for the refund. Default value: `Refund via API` | [optional] **amountMoney** | [**Money**](Money.md) | The amount of money to refund. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`. | diff --git a/docs/Customer.md b/docs/Customer.md index 8c01de9..8040979 100644 --- a/docs/Customer.md +++ b/docs/Customer.md @@ -3,26 +3,26 @@ ### Description -Represents one of a business's customers, which can have one or more cards on file associated with it. +Represents a Square customer profile, which can have one or more cards on file associated with it. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | The customer's unique ID. | -**createdAt** | **String** | The time when the customer was created, in RFC 3339 format. | -**updatedAt** | **String** | The time when the customer was last updated, in RFC 3339 format. | -**cards** | [**List<Card>**](Card.md) | The payment details of the customer's cards on file. | [optional] -**givenName** | **String** | The customer's given (i.e., first) name. | [optional] -**familyName** | **String** | The customer's family (i.e., last) name. | [optional] -**nickname** | **String** | The customer's nickname. | [optional] -**companyName** | **String** | The name of the customer's company. | [optional] -**emailAddress** | **String** | The customer's email address. | [optional] -**address** | [**Address**](Address.md) | The customer's physical address. | [optional] -**phoneNumber** | **String** | The customer's phone number. | [optional] -**birthday** | **String** | The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. | [optional] -**referenceId** | **String** | A second ID you can set to associate the customer with an entity in another system. | [optional] -**note** | **String** | A note to associate with the customer. | [optional] -**preferences** | [**CustomerPreferences**](CustomerPreferences.md) | The customer's preferences. | [optional] +**id** | **String** | A unique, Square-assigned object ID. | +**createdAt** | **String** | The time when the customer profile was created, in RFC 3339 format. | +**updatedAt** | **String** | The time when the customer profile was last updated, in RFC 3339 format. | +**cards** | [**List<Card>**](Card.md) | Payment details of cards stored on file for the customer profile. | [optional] +**givenName** | **String** | The given (i.e., first) name associated with the customer profile. | [optional] +**familyName** | **String** | The family (i.e., last) name associated with the customer profile. | [optional] +**nickname** | **String** | A nickname for the customer profile. | [optional] +**companyName** | **String** | A business name associated with the customer profile. | [optional] +**emailAddress** | **String** | The email address associated with the customer profile. | [optional] +**address** | [**Address**](Address.md) | The physical address associated with the customer profile. | [optional] +**phoneNumber** | **String** | The 11-digit phone number associated with the customer profile. | [optional] +**birthday** | **String** | The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. | [optional] +**referenceId** | **String** | An optional, second ID used to associate the customer profile with an entity in another system. | [optional] +**note** | **String** | A custom note associated with the customer profile. | [optional] +**preferences** | [**CustomerPreferences**](CustomerPreferences.md) | Represents general customer preferences. | [optional] **groups** | [**List<CustomerGroupInfo>**](CustomerGroupInfo.md) | The groups the customer belongs to. | [optional] **creationSource** | **String** | A creation source represents the method used to create the customer profile. See [CustomerCreationSource](#type-customercreationsource) for possible values | [optional] diff --git a/docs/CustomerCreationSourceFilter.md b/docs/CustomerCreationSourceFilter.md index 635f287..53d21d5 100644 --- a/docs/CustomerCreationSourceFilter.md +++ b/docs/CustomerCreationSourceFilter.md @@ -9,7 +9,7 @@ Creation source filter. If one or more creation sources are set, customer profi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **values** | **List<String>** | The list of creation sources used as filtering criteria. See [CustomerCreationSource](#type-customercreationsource) for possible values | [optional] -**rule** | **String** | Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values | [optional] +**rule** | **String** | Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values | [optional] diff --git a/docs/CustomerFilter.md b/docs/CustomerFilter.md index d6c3f36..52a72ec 100644 --- a/docs/CustomerFilter.md +++ b/docs/CustomerFilter.md @@ -3,7 +3,7 @@ ### Description -Represents a set of `CustomerQuery` filters used to limit the set of Customers returned by SearchCustomers. +Represents a set of `CustomerQuery` filters used to limit the set of `Customers` returned by SearchCustomers. ## Properties Name | Type | Description | Notes diff --git a/docs/CustomerPreferences.md b/docs/CustomerPreferences.md index fc08615..3327009 100644 --- a/docs/CustomerPreferences.md +++ b/docs/CustomerPreferences.md @@ -3,7 +3,7 @@ ### Description -Represents a particular customer's preferences. +Represents communication preferences for the customer profile. ## Properties Name | Type | Description | Notes diff --git a/docs/CustomerSort.md b/docs/CustomerSort.md index 1fa9a1a..2a7fc90 100644 --- a/docs/CustomerSort.md +++ b/docs/CustomerSort.md @@ -8,8 +8,8 @@ Indicates the field to use for sorting customer profiles. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**field** | **String** | Indicates the information used to sort the results. For example, by creation date. Default value: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] -**order** | **String** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default value: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] +**field** | **String** | Indicates the information used to sort the results. For example, by creation date. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] +**order** | **String** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] diff --git a/docs/CustomersApi.md b/docs/CustomersApi.md index c0c64ed..ba0d62e 100644 --- a/docs/CustomersApi.md +++ b/docs/CustomersApi.md @@ -73,7 +73,7 @@ Name | Type | Description | Notes CreateCustomerCard -Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. +Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. ### Example ```java @@ -254,9 +254,9 @@ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); oauth2.setAccessToken("YOUR ACCESS TOKEN"); CustomersApi apiInstance = new CustomersApi(); -String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. -String sortField = "sortField_example"; // String | Indicates how Customers should be sorted. Default: `DEFAULT`. -String sortOrder = "sortOrder_example"; // String | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. +String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. +String sortField = "sortField_example"; // String | Indicates how Customers should be sorted. Default: `DEFAULT`. +String sortOrder = "sortOrder_example"; // String | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. try { ListCustomersResponse result = apiInstance.listCustomers(cursor, sortField, sortOrder); System.out.println(result); @@ -270,9 +270,9 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] - **sortField** | **String**| Indicates how Customers should be sorted. Default: `DEFAULT`. | [optional] - **sortOrder** | **String**| Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. | [optional] + **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] + **sortField** | **String**| Indicates how Customers should be sorted. Default: `DEFAULT`. | [optional] + **sortOrder** | **String**| Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. | [optional] ### Return type @@ -399,7 +399,7 @@ Name | Type | Description | Notes UpdateCustomer -Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. +Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. ### Example ```java diff --git a/docs/DeleteCatalogObjectResponse.md b/docs/DeleteCatalogObjectResponse.md index 11a50d1..c7353a0 100644 --- a/docs/DeleteCatalogObjectResponse.md +++ b/docs/DeleteCatalogObjectResponse.md @@ -8,9 +8,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**deletedObjectIds** | **List<String>** | The IDs of all `CatalogObject`s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a `CatalogItemVariation` when its parent `CatalogItem` is deleted. | [optional] -**deletedAt** | **String** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**deletedObjectIds** | **List<String>** | The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted. | [optional] +**deletedAt** | **String** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. | [optional] diff --git a/docs/Device.md b/docs/Device.md index abeadef..bf15bf7 100644 --- a/docs/Device.md +++ b/docs/Device.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/Employee.md b/docs/Employee.md index 2309558..b12e874 100644 --- a/docs/Employee.md +++ b/docs/Employee.md @@ -3,18 +3,18 @@ ### Description -An employee created in the **Square Dashboard** account of a business. Used by the Labor API. +An employee object that is used by the external API. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | UUID for this `Employee`. | [optional] -**firstName** | **String** | Given (first) name of the employee. | [optional] -**lastName** | **String** | Family (last) name of the employee | [optional] -**email** | **String** | Email of the employee | [optional] -**phoneNumber** | **String** | Phone number of the employee in E.164 format, i.e. \"+12125554250\" | [optional] -**locationIds** | **List<String>** | A list of location IDs where this employee has access. | [optional] -**status** | **String** | Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] +**id** | **String** | UUID for this object. | [optional] +**firstName** | **String** | The employee's first name. | [optional] +**lastName** | **String** | The employee's last name. | [optional] +**email** | **String** | The employee's email address | [optional] +**phoneNumber** | **String** | The employee's phone number in E.164 format, i.e. \"+12125554250\" | [optional] +**locationIds** | **List<String>** | A list of location IDs where this employee has access to. | [optional] +**status** | **String** | Specifies the status of the employees being fetched. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] **createdAt** | **String** | A read-only timestamp in RFC 3339 format. | [optional] **updatedAt** | **String** | A read-only timestamp in RFC 3339 format. | [optional] diff --git a/docs/EmployeesApi.md b/docs/EmployeesApi.md index 8fa5415..f6219d9 100644 --- a/docs/EmployeesApi.md +++ b/docs/EmployeesApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description ListEmployees -Gets a list of `Employee` objects for a business. + ### Example ```java @@ -73,7 +73,7 @@ Name | Type | Description | Notes RetrieveEmployee -Gets an `Employee` by Square-assigned employee `ID` (UUID) + ### Example ```java diff --git a/docs/Error.md b/docs/Error.md index bae2f51..dc3d853 100644 --- a/docs/Error.md +++ b/docs/Error.md @@ -3,13 +3,13 @@ ### Description -Represents an error encountered during a request to the Connect API. +Represents an error encountered during a request to the Connect API. See [Handling errors](#handlingerrors) for more information. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | **String** | The high-level category for the error. See [ErrorCategory](#type-errorcategory) for possible values | -**code** | **String** | The specific code of the error. See [ErrorCode](#type-errorcode) for possible values | +**category** | **String** | The high-level category for the error. See `ErrorCategory` for possible values. See [ErrorCategory](#type-errorcategory) for possible values | +**code** | **String** | The specific code of the error. See `ErrorCode` for possible values See [ErrorCode](#type-errorcode) for possible values | **detail** | **String** | A human-readable description of the error for debugging purposes. | [optional] **field** | **String** | The name of the field provided in the original request (if any) that the error pertains to. | [optional] diff --git a/docs/ErrorCode.md b/docs/ErrorCode.md index 845a4a5..628147f 100644 --- a/docs/ErrorCode.md +++ b/docs/ErrorCode.md @@ -194,6 +194,8 @@ * `"HTTPS_ONLY"` +* `"UNREACHABLE_URL"` + * `"CARD_DECLINED"` * `"VERIFY_CVV_FAILURE"` @@ -224,14 +226,20 @@ * `"CONFLICT"` +* `"GONE"` + * `"REQUEST_ENTITY_TOO_LARGE"` * `"UNSUPPORTED_MEDIA_TYPE"` +* `"UNPROCESSABLE_ENTITY"` + * `"RATE_LIMITED"` * `"NOT_IMPLEMENTED"` +* `"BAD_GATEWAY"` + * `"SERVICE_UNAVAILABLE"` * `"TEMPORARY_ERROR"` diff --git a/docs/ExternalPaymentDetails.md b/docs/ExternalPaymentDetails.md new file mode 100644 index 0000000..28233bd --- /dev/null +++ b/docs/ExternalPaymentDetails.md @@ -0,0 +1,17 @@ + +# ExternalPaymentDetails + +### Description + +Additional details about EXTERNAL type payments. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | The type of External payment which can be one of: CHECK - Paid by a physical check BANK_TRANSFER - Paid by ACH or other bank transfer OTHER_GIFT_CARD - Paid by a non-square gift card CRYPTO - Paid via a crypto currency SQUARE_CASH - Paid via Square Cash app SOCIAL - Venmo, WeChatPay, AliPay, etc. EXTERNAL - A 3rd party application gathered this payment outside of Square EMONEY - A Japanese e-money brand Square doesn’t support CREDIT/DEBIT - A credit/debit card Square doesn’t support OTHER - A type not listed here | +**source** | **String** | A description of the source of the external payment, e.g. “Uber Eats”, “Stripe”, “Shopify”. Limit 255 characters | +**sourceId** | **String** | An ID to associate this payment to its originating source Limit 255 characters. | [optional] +**sourceFeeMoney** | [**Money**](Money.md) | The total of fees paid to the source. (amount_money - source_fee_money) = net money to the merchant | [optional] + + + diff --git a/docs/InventoryAdjustment.md b/docs/InventoryAdjustment.md index d6cb042..c555f35 100644 --- a/docs/InventoryAdjustment.md +++ b/docs/InventoryAdjustment.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **locationId** | **String** | The Square ID of the `Location` where the related quantity of items are being tracked. | [optional] **catalogObjectId** | **String** | The Square generated ID of the `CatalogObject` being tracked. | [optional] **catalogObjectType** | **String** | The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] -**quantity** | **String** | The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. | [optional] [beta] +**quantity** | **String** | The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. | [optional] [beta] **totalPriceMoney** | [**Money**](Money.md) | The read-only total price paid for goods associated with the adjustment. Present if and only if `to_state` is `SOLD`. Always non-negative. | [optional] **occurredAt** | **String** | A client-generated timestamp in RFC 3339 format that indicates when the adjustment took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional] **createdAt** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment. | [optional] diff --git a/docs/InventoryApi.md b/docs/InventoryApi.md index 5404152..3044705 100644 --- a/docs/InventoryApi.md +++ b/docs/InventoryApi.md @@ -251,7 +251,7 @@ oauth2.setAccessToken("YOUR ACCESS TOKEN"); InventoryApi apiInstance = new InventoryApi(); String catalogObjectId = "catalogObjectId_example"; // String | ID of the `CatalogObject` to retrieve. String locationIds = "locationIds_example"; // String | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. -String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. +String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. try { RetrieveInventoryChangesResponse result = apiInstance.retrieveInventoryChanges(catalogObjectId, locationIds, cursor); System.out.println(result); @@ -267,7 +267,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **catalogObjectId** | **String**| ID of the `CatalogObject` to retrieve. | **locationIds** | **String**| The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] - **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] ### Return type @@ -308,7 +308,7 @@ oauth2.setAccessToken("YOUR ACCESS TOKEN"); InventoryApi apiInstance = new InventoryApi(); String catalogObjectId = "catalogObjectId_example"; // String | ID of the `CatalogObject` to retrieve. String locationIds = "locationIds_example"; // String | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. -String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. +String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. try { RetrieveInventoryCountResponse result = apiInstance.retrieveInventoryCount(catalogObjectId, locationIds, cursor); System.out.println(result); @@ -324,7 +324,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **catalogObjectId** | **String**| ID of the `CatalogObject` to retrieve. | **locationIds** | **String**| The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] - **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] ### Return type diff --git a/docs/InventoryChange.md b/docs/InventoryChange.md index d4df0a8..9c6f27f 100644 --- a/docs/InventoryChange.md +++ b/docs/InventoryChange.md @@ -3,12 +3,12 @@ ### Description -Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular [CatalogObject](#type-catalogobject). +Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular `CatalogObject`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] +**type** | **String** | Indicates how the inventory change was applied. See `InventoryChangeType` for all possible values. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] **physicalCount** | [**InventoryPhysicalCount**](InventoryPhysicalCount.md) | Contains details about the physical count when `type` is `PHYSICAL_COUNT` and unset for all other types. | [optional] **adjustment** | [**InventoryAdjustment**](InventoryAdjustment.md) | Contains details about the inventory adjustment when `type` is `ADJUSTMENT` and unset for all other types. | [optional] **transfer** | [**InventoryTransfer**](InventoryTransfer.md) | Contains details about the inventory transfer when `type` is `TRANSFER` and unset for all other types. | [optional] diff --git a/docs/InventoryCount.md b/docs/InventoryCount.md index bcdbe69..ada3d03 100644 --- a/docs/InventoryCount.md +++ b/docs/InventoryCount.md @@ -3,7 +3,7 @@ ### Description -Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments +Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments. ## Properties Name | Type | Description | Notes @@ -12,7 +12,7 @@ Name | Type | Description | Notes **catalogObjectType** | **String** | The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] **state** | **String** | The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional] **locationId** | **String** | The Square ID of the `Location` where the related quantity of items are being tracked. | [optional] -**quantity** | **String** | The number of items in the count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. | [optional] [beta] +**quantity** | **String** | The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. | [optional] [beta] **calculatedAt** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count. | [optional] diff --git a/docs/InventoryPhysicalCount.md b/docs/InventoryPhysicalCount.md index 9f5f64f..bd26b76 100644 --- a/docs/InventoryPhysicalCount.md +++ b/docs/InventoryPhysicalCount.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **catalogObjectType** | **String** | The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] **state** | **String** | The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional] **locationId** | **String** | The Square ID of the `Location` where the related quantity of items are being tracked. | [optional] -**quantity** | **String** | The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. | [optional] [beta] +**quantity** | **String** | The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. | [optional] [beta] **source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that submitted the physical count. | [optional] **employeeId** | **String** | The Square ID of the `Employee` responsible for the physical count. | [optional] **occurredAt** | **String** | A client-generated timestamp in RFC 3339 format that indicates when the physical count took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional] diff --git a/docs/InventoryTransfer.md b/docs/InventoryTransfer.md index bd0370e..f7d3c0a 100644 --- a/docs/InventoryTransfer.md +++ b/docs/InventoryTransfer.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **toLocationId** | **String** | The Square ID of the `Location` where the related quantity of items were tracked after the transfer. | [optional] **catalogObjectId** | **String** | The Square generated ID of the `CatalogObject` being tracked. | [optional] **catalogObjectType** | **String** | The `CatalogObjectType` of the `CatalogObject` being tracked.Tracking is only supported for the `ITEM_VARIATION` type. | [optional] -**quantity** | **String** | The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. | [optional] [beta] +**quantity** | **String** | The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. | [optional] [beta] **occurredAt** | **String** | A client-generated timestamp in RFC 3339 format that indicates when the transfer took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional] **createdAt** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request. | [optional] **source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that initiated the inventory transfer. | [optional] diff --git a/docs/ItemVariationLocationOverrides.md b/docs/ItemVariationLocationOverrides.md index ff2c46e..7e354b1 100644 --- a/docs/ItemVariationLocationOverrides.md +++ b/docs/ItemVariationLocationOverrides.md @@ -3,15 +3,15 @@ ### Description -Price and inventory alerting overrides for a [CatalogItemVariation](#type-catalogitemvariation) at a specific [location](#type-location). +Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**locationId** | **String** | The ID of the `location`. | [optional] -**priceMoney** | [**Money**](Money.md) | The price of the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`, or blank for variable pricing. | [optional] -**pricingType** | **String** | The pricing type (fixed or variable) for the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values | [optional] -**trackInventory** | **Boolean** | If `true`, inventory tracking is active for the `CatalogItemVariation](#type-catalogitemvariation) at this [location`. | [optional] +**locationId** | **String** | The ID of the `Location`. | [optional] +**priceMoney** | [**Money**](Money.md) | The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing. | [optional] +**pricingType** | **String** | The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values | [optional] +**trackInventory** | **Boolean** | If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`. | [optional] **inventoryAlertType** | **String** | Indicates whether the `CatalogItemVariation` displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values | [optional] **inventoryAlertThreshold** | **Long** | 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] diff --git a/docs/ListAdditionalRecipientReceivableRefundsRequest.md b/docs/ListAdditionalRecipientReceivableRefundsRequest.md index 32c4569..c58c24d 100644 --- a/docs/ListAdditionalRecipientReceivableRefundsRequest.md +++ b/docs/ListAdditionalRecipientReceivableRefundsRequest.md @@ -3,7 +3,7 @@ ### Description -Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivableRefunds endpoint. +Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. **Note: This model is deprecated.** ## Properties @@ -12,7 +12,7 @@ Name | Type | Description | Notes **beginTime** | **String** | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **String** | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivableRefundsResponse.md b/docs/ListAdditionalRecipientReceivableRefundsResponse.md index 06f7444..514ee46 100644 --- a/docs/ListAdditionalRecipientReceivableRefundsResponse.md +++ b/docs/ListAdditionalRecipientReceivableRefundsResponse.md @@ -3,7 +3,7 @@ ### Description -Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivableRefunds endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both). +Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both). **Note: This model is deprecated.** ## Properties @@ -11,7 +11,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **receivableRefunds** | [**List<AdditionalRecipientReceivableRefund>**](AdditionalRecipientReceivableRefund.md) | An array of AdditionalRecipientReceivableRefunds that match your query. | [optional] -**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivablesRequest.md b/docs/ListAdditionalRecipientReceivablesRequest.md index e6f6099..fa93895 100644 --- a/docs/ListAdditionalRecipientReceivablesRequest.md +++ b/docs/ListAdditionalRecipientReceivablesRequest.md @@ -3,7 +3,7 @@ ### Description -Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivables endpoint. +Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. **Note: This model is deprecated.** ## Properties @@ -12,7 +12,7 @@ Name | Type | Description | Notes **beginTime** | **String** | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **String** | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivablesResponse.md b/docs/ListAdditionalRecipientReceivablesResponse.md index d48ab62..3f8700d 100644 --- a/docs/ListAdditionalRecipientReceivablesResponse.md +++ b/docs/ListAdditionalRecipientReceivablesResponse.md @@ -3,7 +3,7 @@ ### Description -Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivables endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both). +Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both). **Note: This model is deprecated.** ## Properties @@ -11,7 +11,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **receivables** | [**List<AdditionalRecipientReceivable>**](AdditionalRecipientReceivable.md) | An array of AdditionalRecipientReceivables that match your query. | [optional] -**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListCatalogRequest.md b/docs/ListCatalogRequest.md index bdb52ee..22f7a57 100644 --- a/docs/ListCatalogRequest.md +++ b/docs/ListCatalogRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**types** | **String** | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] +**types** | **String** | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] diff --git a/docs/ListCatalogResponse.md b/docs/ListCatalogResponse.md index 5ea6269..56d799f 100644 --- a/docs/ListCatalogResponse.md +++ b/docs/ListCatalogResponse.md @@ -8,9 +8,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] +**errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] **cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**objects** | [**List<CatalogObject>**](CatalogObject.md) | The `CatalogObject`s returned. | [optional] +**objects** | [**List<CatalogObject>**](CatalogObject.md) | The CatalogObjects returned. | [optional] diff --git a/docs/ListCustomersRequest.md b/docs/ListCustomersRequest.md index 5b7d293..11ddd2e 100644 --- a/docs/ListCustomersRequest.md +++ b/docs/ListCustomersRequest.md @@ -8,9 +8,9 @@ Defines the query parameters that can be provided in a request to the ListCustom ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**sortField** | **String** | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] -**sortOrder** | **String** | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] +**sortField** | **String** | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] +**sortOrder** | **String** | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] diff --git a/docs/ListCustomersResponse.md b/docs/ListCustomersResponse.md index cf3ace2..9d95eaa 100644 --- a/docs/ListCustomersResponse.md +++ b/docs/ListCustomersResponse.md @@ -9,8 +9,8 @@ Defines the fields that are included in the response body of a request to the Li Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] -**customers** | [**List<Customer>**](Customer.md) | An array of `Customer` objects that match your query. | [optional] -**cursor** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**customers** | [**List<Customer>**](Customer.md) | An array of `Customer` objects that match the provided query. | [optional] +**cursor** | **String** | A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] diff --git a/docs/ListEmployeesRequest.md b/docs/ListEmployeesRequest.md index 5c2b887..caf7400 100644 --- a/docs/ListEmployeesRequest.md +++ b/docs/ListEmployeesRequest.md @@ -3,7 +3,7 @@ ### Description -Retrieve a paged-list of employees for a Square account + ## Properties Name | Type | Description | Notes diff --git a/docs/ListEmployeesResponse.md b/docs/ListEmployeesResponse.md index 1c99767..4d103a7 100644 --- a/docs/ListEmployeesResponse.md +++ b/docs/ListEmployeesResponse.md @@ -3,7 +3,7 @@ ### Description -Defines the fields that are included in the response body of a request to the ListEmployees endpoint. One of `errors` or `employees` is present in a given response (never both). + ## Properties Name | Type | Description | Notes diff --git a/docs/ListLocationsRequest.md b/docs/ListLocationsRequest.md index ebf320e..38dc86d 100644 --- a/docs/ListLocationsRequest.md +++ b/docs/ListLocationsRequest.md @@ -3,7 +3,7 @@ ### Description -Defines the fields that are included in requests to the ListLocations endpoint. +Defines the fields that are included in requests to the __ListLocations__ endpoint. ## Properties Name | Type | Description | Notes diff --git a/docs/ListLocationsResponse.md b/docs/ListLocationsResponse.md index 08e214a..67845a5 100644 --- a/docs/ListLocationsResponse.md +++ b/docs/ListLocationsResponse.md @@ -3,13 +3,13 @@ ### Description -Defines the fields that are included in the response body of a request to the ListLocations endpoint. One of `errors` or `locations` is present in a given response (never both). +Defines the fields that are included in the response body of a request to the __ListLocations__ endpoint. One of `errors` or `locations` is present in a given response (never both). ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] -**locations** | [**List<Location>**](Location.md) | The business's locations. | [optional] +**locations** | [**List<Location>**](Location.md) | The business locations. | [optional] diff --git a/docs/ListPaymentRefundsRequest.md b/docs/ListPaymentRefundsRequest.md index ddfe027..4d4233c 100644 --- a/docs/ListPaymentRefundsRequest.md +++ b/docs/ListPaymentRefundsRequest.md @@ -13,8 +13,8 @@ Name | Type | Description | Notes **sortOrder** | **String** | The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). | [optional] **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] **locationId** | **String** | ID of location associated with payment. | [optional] -**status** | **String** | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] -**sourceType** | **String** | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] +**status** | **String** | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] +**sourceType** | **String** | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] diff --git a/docs/ListRefundsRequest.md b/docs/ListRefundsRequest.md index a6308f6..33cd00a 100644 --- a/docs/ListRefundsRequest.md +++ b/docs/ListRefundsRequest.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **beginTime** | **String** | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **String** | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListRefundsResponse.md b/docs/ListRefundsResponse.md index 5859081..c1542ed 100644 --- a/docs/ListRefundsResponse.md +++ b/docs/ListRefundsResponse.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **refunds** | [**List<Refund>**](Refund.md) | An array of refunds that match your query. | [optional] -**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListTransactionsRequest.md b/docs/ListTransactionsRequest.md index 15dc520..9322bf8 100644 --- a/docs/ListTransactionsRequest.md +++ b/docs/ListTransactionsRequest.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **beginTime** | **String** | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **String** | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListTransactionsResponse.md b/docs/ListTransactionsResponse.md index fc24a62..a35125d 100644 --- a/docs/ListTransactionsResponse.md +++ b/docs/ListTransactionsResponse.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **transactions** | [**List<Transaction>**](Transaction.md) | An array of transactions that match your query. | [optional] -**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/Location.md b/docs/Location.md index a7802c0..4aa5b77 100644 --- a/docs/Location.md +++ b/docs/Location.md @@ -3,35 +3,35 @@ ### Description -Represents one of a business's locations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The Square-issued ID of the location. | [optional] -**name** | **String** | The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname | [optional] -**address** | [**Address**](Address.md) | The location's physical address. | [optional] -**timezone** | **String** | The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone. | [optional] +**name** | **String** | The name of the location. This information appears in the dashboard as the nickname. | [optional] +**address** | [**Address**](Address.md) | The physical address of the location. | [optional] +**timezone** | **String** | The [IANA Timezone](https://www.iana.org/time-zones) identifier for the timezone of the location. | [optional] **capabilities** | **List<String>** | The Square features that are enabled for the location. See `LocationCapability` for possible values. See [LocationCapability](#type-locationcapability) for possible values | [optional] -**status** | **String** | The location's status See [LocationStatus](#type-locationstatus) for possible values | [optional] +**status** | **String** | The status of the location, either active or inactive. See [LocationStatus](#type-locationstatus) for possible values | [optional] **createdAt** | **String** | The time when the location was created, in RFC 3339 format. | [optional] **merchantId** | **String** | The ID of the merchant that owns the location. | [optional] **country** | **String** | The country of the location, in ISO 3166-1-alpha-2 format. See `Country` for possible values. See [Country](#type-country) for possible values | [optional] -**languageCode** | **String** | The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). | [optional] -**currency** | **String** | The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values | [optional] -**phoneNumber** | **String** | The location's phone_number. | [optional] -**businessName** | **String** | The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts. | [optional] -**type** | **String** | The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values | [optional] -**websiteUrl** | **String** | The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set. | [optional] -**businessHours** | [**BusinessHours**](BusinessHours.md) | The hours of operation for a business location. Default: none; only exists if explicitly set. | [optional] -**businessEmail** | **String** | The email of the location. | [optional] -**description** | **String** | The business description of the location. | [optional] +**languageCode** | **String** | The language associated with the location, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). | [optional] +**currency** | **String** | The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values | [optional] +**phoneNumber** | **String** | The phone number of the location in human readable format. | [optional] +**businessName** | **String** | The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts. | [optional] +**type** | **String** | The type of the location, either physical or mobile. See [LocationType](#type-locationtype) for possible values | [optional] +**websiteUrl** | **String** | The website URL of the location. | [optional] +**businessHours** | [**BusinessHours**](BusinessHours.md) | Represents the hours of operation for the location. | [optional] +**businessEmail** | **String** | The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts. | [optional] +**description** | **String** | The description of the location. | [optional] **twitterUsername** | **String** | The Twitter username of the location without the '&#64;' symbol. | [optional] **instagramUsername** | **String** | The Instagram username of the location without the '&#64;' symbol. | [optional] **facebookUrl** | **String** | The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. | [optional] **coordinates** | [**Coordinates**](Coordinates.md) | The physical coordinates (latitude and longitude) of the location. | [optional] -**logoUrl** | **String** | The logo image URL of the location. | [optional] -**posBackgroundUrl** | **String** | The Point of Sale background image URL of the location. | [optional] +**logoUrl** | **String** | The URL of the logo image for the location. | [optional] +**posBackgroundUrl** | **String** | The URL of the Point of Sale background image for the location. | [optional] **mcc** | **String** | The merchant category code (MCC) of the location, as standardized by ISO 18245. The MCC describes the kind of goods or services sold at the location. | [optional] [beta] diff --git a/docs/LocationsApi.md b/docs/LocationsApi.md index 9cfdabd..e1a7915 100644 --- a/docs/LocationsApi.md +++ b/docs/LocationsApi.md @@ -4,18 +4,73 @@ All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**createLocation**](LocationsApi.md#createLocation) | **POST** /v2/locations | CreateLocation [**listLocations**](LocationsApi.md#listLocations) | **GET** /v2/locations | ListLocations [**retrieveLocation**](LocationsApi.md#retrieveLocation) | **GET** /v2/locations/{location_id} | RetrieveLocation [**updateLocation**](LocationsApi.md#updateLocation) | **PUT** /v2/locations/{location_id} | UpdateLocation + +# **createLocation** +**Note: This endpoint is in beta.** +> CreateLocationResponse createLocation(body) + +CreateLocation + +Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + +### Example +```java +// Import classes: +//import com.squareup.connect.ApiClient; +//import com.squareup.connect.ApiException; +//import com.squareup.connect.Configuration; +//import com.squareup.connect.auth.*; +//import com.squareup.connect.api.LocationsApi; + +ApiClient defaultClient = Configuration.getDefaultApiClient(); + +// Configure OAuth2 access token for authorization: oauth2 +OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); +oauth2.setAccessToken("YOUR ACCESS TOKEN"); + +LocationsApi apiInstance = new LocationsApi(); +CreateLocationRequest body = new CreateLocationRequest(); // CreateLocationRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. +try { + CreateLocationResponse result = apiInstance.createLocation(body); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling LocationsApi#createLocation"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateLocationRequest**](CreateLocationRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**CreateLocationResponse**](CreateLocationResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + # **listLocations** > ListLocationsResponse listLocations() ListLocations -Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. +Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. ### Example ```java @@ -60,7 +115,6 @@ This endpoint does not need any parameter. # **retrieveLocation** -**Note: This endpoint is in beta.** > RetrieveLocationResponse retrieveLocation(locationId) RetrieveLocation @@ -119,7 +173,7 @@ Name | Type | Description | Notes UpdateLocation -Updates the `Location` specified by the given ID. +Updates a location. ### Example ```java diff --git a/docs/MerchantsApi.md b/docs/MerchantsApi.md index 8740f29..5164997 100644 --- a/docs/MerchantsApi.md +++ b/docs/MerchantsApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description ListMerchants -Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. +Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. ### Example ```java diff --git a/docs/MobileAuthorizationApi.md b/docs/MobileAuthorizationApi.md index 8e8bc46..fef6841 100644 --- a/docs/MobileAuthorizationApi.md +++ b/docs/MobileAuthorizationApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description CreateMobileAuthorizationCode -Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). +Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/docs/build-basics/access-tokens). ### Example ```java diff --git a/docs/Money.md b/docs/Money.md index 11884ed..ab26103 100644 --- a/docs/Money.md +++ b/docs/Money.md @@ -3,12 +3,12 @@ ### Description -Represents an amount of money. `Money` fields can be signed or unsigned. +Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](/build-basics/working-with-monetary-amounts) for more information. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**amount** | **Long** | The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case. | [optional] +**amount** | **Long** | The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case. | [optional] **currency** | **String** | The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See `Currency` for possible values. See [Currency](#type-currency) for possible values | [optional] diff --git a/docs/OAuthApi.md b/docs/OAuthApi.md index 2ea0cf6..4285b93 100644 --- a/docs/OAuthApi.md +++ b/docs/OAuthApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description ObtainToken -Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. +Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. ### Example ```java @@ -61,7 +61,7 @@ No authorization required RenewToken -`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). +`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). ### Example ```java @@ -81,7 +81,7 @@ oauth2ClientSecret.setApiKey("APPLICATION SECRET"); oauth2ClientSecret.setApiKeyPrefix("Client"); OAuthApi apiInstance = new OAuthApi(); -String clientId = "clientId_example"; // String | Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). +String clientId = "clientId_example"; // String | Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). RenewTokenRequest body = new RenewTokenRequest(); // RenewTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. try { RenewTokenResponse result = apiInstance.renewToken(clientId, body); @@ -96,7 +96,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **clientId** | **String**| Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). | + **clientId** | **String**| Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). | **body** | [**RenewTokenRequest**](RenewTokenRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | ### Return type diff --git a/docs/ObtainTokenResponse.md b/docs/ObtainTokenResponse.md index 5399315..a0877b9 100644 --- a/docs/ObtainTokenResponse.md +++ b/docs/ObtainTokenResponse.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **expiresAt** | **String** | The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. | [optional] **merchantId** | **String** | The ID of the authorizing merchant's business. | [optional] **subscriptionId** | **String** | __LEGACY FIELD__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] -**planId** | **String** | __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] +**planId** | **String** | T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] **idToken** | **String** | Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request. | [optional] **refreshToken** | **String** | A refresh token. For more information, see [OAuth access token management](https://developer.squareup.com/docs/authz/oauth/how-it-works#oauth-access-token-management). | [optional] diff --git a/docs/Payment.md b/docs/Payment.md index 09808fd..29c927a 100644 --- a/docs/Payment.md +++ b/docs/Payment.md @@ -11,10 +11,10 @@ Name | Type | Description | Notes **id** | **String** | Unique ID for the payment. | [optional] **createdAt** | **String** | Timestamp of when the payment was created, in RFC 3339 format. | [optional] **updatedAt** | **String** | Timestamp of when the payment was last updated, in RFC 3339 format. | [optional] -**amountMoney** | [**Money**](Money.md) | The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] +**amountMoney** | [**Money**](Money.md) | The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] **tipMoney** | [**Money**](Money.md) | The amount designated as a tip. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] -**totalMoney** | [**Money**](Money.md) | The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] -**appFeeMoney** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. | [optional] +**totalMoney** | [**Money**](Money.md) | The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] +**appFeeMoney** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. | [optional] **processingFee** | [**List<ProcessingFee>**](ProcessingFee.md) | Processing fees and fee adjustments assessed by Square on this payment. | [optional] **refundedMoney** | [**Money**](Money.md) | Total amount of the payment refunded to-date. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] **status** | **String** | Indicates whether the payment is `APPROVED`, `COMPLETED`, `CANCELED`, or `FAILED`. | [optional] @@ -30,6 +30,7 @@ Name | Type | Description | Notes **billingAddress** | [**Address**](Address.md) | The buyer's billing address | [optional] **shippingAddress** | [**Address**](Address.md) | The buyer's shipping address | [optional] **note** | **String** | An optional note to include when creating a payment | [optional] +**statementDescriptionIdentifier** | **String** | Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. | [optional] [beta] diff --git a/docs/PaymentsApi.md b/docs/PaymentsApi.md index 97965d2..db55c2e 100644 --- a/docs/PaymentsApi.md +++ b/docs/PaymentsApi.md @@ -18,7 +18,7 @@ Method | HTTP request | Description CancelPayment -Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). +Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). ### Example ```java @@ -71,7 +71,7 @@ Name | Type | Description | Notes CancelPaymentByIdempotencyKey -Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. +Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. ### Example ```java diff --git a/docs/RefundPaymentRequest.md b/docs/RefundPaymentRequest.md index 75a3b33..8250f52 100644 --- a/docs/RefundPaymentRequest.md +++ b/docs/RefundPaymentRequest.md @@ -8,9 +8,9 @@ Refunds a payment. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotencyKey** | **String** | A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency). | +**idempotencyKey** | **String** | A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). | **amountMoney** | [**Money**](Money.md) | The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card. | -**appFeeMoney** | [**Money**](Money.md) | Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) | [optional] +**appFeeMoney** | [**Money**](Money.md) | Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) | [optional] **paymentId** | **String** | Unique ID of the payment being refunded. | [optional] **reason** | **String** | A description of the reason for the refund. | [optional] diff --git a/docs/RefundsApi.md b/docs/RefundsApi.md index 22139f2..bc35fbf 100644 --- a/docs/RefundsApi.md +++ b/docs/RefundsApi.md @@ -91,8 +91,8 @@ String endTime = "endTime_example"; // String | Timestamp for the end of the req String sortOrder = "sortOrder_example"; // String | The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. String locationId = "locationId_example"; // String | ID of location associated with payment. -String status = "status_example"; // String | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. -String sourceType = "sourceType_example"; // String | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. +String status = "status_example"; // String | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. +String sourceType = "sourceType_example"; // String | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. try { ListPaymentRefundsResponse result = apiInstance.listPaymentRefunds(beginTime, endTime, sortOrder, cursor, locationId, status, sourceType); System.out.println(result); @@ -111,8 +111,8 @@ Name | Type | Description | Notes **sortOrder** | **String**| The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). | [optional] **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] **locationId** | **String**| ID of location associated with payment. | [optional] - **status** | **String**| If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] - **sourceType** | **String**| If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] + **status** | **String**| If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] + **sourceType** | **String**| If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] ### Return type diff --git a/docs/RegisterDomainRequest.md b/docs/RegisterDomainRequest.md index 6fb27b0..022e0a5 100644 --- a/docs/RegisterDomainRequest.md +++ b/docs/RegisterDomainRequest.md @@ -3,7 +3,7 @@ ### Description -Defines the parameters that can be included in the body of a request to the RegisterDomain endpoint. +Defines the parameters that can be included in the body of a request to the __RegisterDomain__ endpoint. ## Properties Name | Type | Description | Notes diff --git a/docs/RegisterDomainResponse.md b/docs/RegisterDomainResponse.md index 67ff9b7..c275c8f 100644 --- a/docs/RegisterDomainResponse.md +++ b/docs/RegisterDomainResponse.md @@ -3,13 +3,13 @@ ### Description -Defines the fields that are included in the response body of a request to the RegisterDomain endpoint. Either `errors` or `status` will be present in a given response (never both). +Defines the fields that are included in the response body of a request to the __RegisterDomain__ endpoint. Either `errors` or `status` will be present in a given response (never both). ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] -**status** | **String** | Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values | [optional] +**status** | **String** | Status of the domain registration. See `RegisterDomainResponseStatus` for possible values. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values | [optional] diff --git a/docs/RenewTokenResponse.md b/docs/RenewTokenResponse.md index 72051eb..7bd72ca 100644 --- a/docs/RenewTokenResponse.md +++ b/docs/RenewTokenResponse.md @@ -9,11 +9,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**accessToken** | **String** | The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://docs.connect.squareup.com/api/connect/v2/#requestandresponseheaders) for the format of this header. | [optional] +**accessToken** | **String** | The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://developer.squareup.com/docs/api/connect/v2/#requestandresponseheaders) for the format of this header. | [optional] **tokenType** | **String** | This value is always _bearer_. | [optional] **expiresAt** | **String** | The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. | [optional] **merchantId** | **String** | The ID of the authorizing merchant's business. | [optional] -**subscriptionId** | **String** | __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization. | [optional] +**subscriptionId** | **String** | __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization.. | [optional] **planId** | **String** | __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] diff --git a/docs/ReportingApi.md b/docs/ReportingApi.md index 4dcbbfa..8b8ab03 100644 --- a/docs/ReportingApi.md +++ b/docs/ReportingApi.md @@ -37,7 +37,7 @@ String locationId = "locationId_example"; // String | The ID of the location to String beginTime = "beginTime_example"; // String | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. String endTime = "endTime_example"; // String | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. String sortOrder = "sortOrder_example"; // String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` -String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. +String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. try { ListAdditionalRecipientReceivableRefundsResponse result = apiInstance.listAdditionalRecipientReceivableRefunds(locationId, beginTime, endTime, sortOrder, cursor); System.out.println(result); @@ -55,7 +55,7 @@ Name | Type | Description | Notes **beginTime** | **String**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **String**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] ### Return type @@ -99,7 +99,7 @@ String locationId = "locationId_example"; // String | The ID of the location to String beginTime = "beginTime_example"; // String | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. String endTime = "endTime_example"; // String | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. String sortOrder = "sortOrder_example"; // String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` -String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. +String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. try { ListAdditionalRecipientReceivablesResponse result = apiInstance.listAdditionalRecipientReceivables(locationId, beginTime, endTime, sortOrder, cursor); System.out.println(result); @@ -117,7 +117,7 @@ Name | Type | Description | Notes **beginTime** | **String**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **String**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] ### Return type diff --git a/docs/RetrieveCatalogObjectRequest.md b/docs/RetrieveCatalogObjectRequest.md index 68e9603..4c9b5ca 100644 --- a/docs/RetrieveCatalogObjectRequest.md +++ b/docs/RetrieveCatalogObjectRequest.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**includeRelatedObjects** | **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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` | [optional] +**includeRelatedObjects** | **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, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` | [optional] diff --git a/docs/RetrieveCatalogObjectResponse.md b/docs/RetrieveCatalogObjectResponse.md index 97cea05..5d5ed5b 100644 --- a/docs/RetrieveCatalogObjectResponse.md +++ b/docs/RetrieveCatalogObjectResponse.md @@ -8,9 +8,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**object** | [**CatalogObject**](CatalogObject.md) | The `CatalogObject`s returned. | [optional] -**relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s referenced by the object in the `object` field. | [optional] +**errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**object** | [**CatalogObject**](CatalogObject.md) | The CatalogObjects returned. | [optional] +**relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects referenced by the object in the `object` field. | [optional] diff --git a/docs/RetrieveEmployeeRequest.md b/docs/RetrieveEmployeeRequest.md index cdb25e4..961bbdb 100644 --- a/docs/RetrieveEmployeeRequest.md +++ b/docs/RetrieveEmployeeRequest.md @@ -3,7 +3,7 @@ ### Description -Retrieve an employee by `Employee.id` + ## Properties Name | Type | Description | Notes diff --git a/docs/RetrieveEmployeeResponse.md b/docs/RetrieveEmployeeResponse.md index b93827a..3f053fb 100644 --- a/docs/RetrieveEmployeeResponse.md +++ b/docs/RetrieveEmployeeResponse.md @@ -3,7 +3,7 @@ ### Description -Defines the fields that are included in the response body of a request to the RetrieveEmployee endpoint. One of `errors` or `employee` is present in a given response (never both). + ## Properties Name | Type | Description | Notes diff --git a/docs/RetrieveInventoryChangesRequest.md b/docs/RetrieveInventoryChangesRequest.md index 93405a2..a2c5761 100644 --- a/docs/RetrieveInventoryChangesRequest.md +++ b/docs/RetrieveInventoryChangesRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **locationIds** | **String** | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/RetrieveInventoryChangesResponse.md b/docs/RetrieveInventoryChangesResponse.md index 17cdc08..b984e4e 100644 --- a/docs/RetrieveInventoryChangesResponse.md +++ b/docs/RetrieveInventoryChangesResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **changes** | [**List<InventoryChange>**](InventoryChange.md) | The set of inventory changes for the requested object and locations. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/RetrieveInventoryCountRequest.md b/docs/RetrieveInventoryCountRequest.md index aff23cd..6117b93 100644 --- a/docs/RetrieveInventoryCountRequest.md +++ b/docs/RetrieveInventoryCountRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **locationIds** | **String** | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/RetrieveInventoryCountResponse.md b/docs/RetrieveInventoryCountResponse.md index 3e54b55..207ca3f 100644 --- a/docs/RetrieveInventoryCountResponse.md +++ b/docs/RetrieveInventoryCountResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **counts** | [**List<InventoryCount>**](InventoryCount.md) | The current calculated inventory counts for the requested object and locations. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/RetrieveLocationRequest.md b/docs/RetrieveLocationRequest.md index 6e180fd..185a645 100644 --- a/docs/RetrieveLocationRequest.md +++ b/docs/RetrieveLocationRequest.md @@ -3,7 +3,7 @@ ### Description -Defines the fields that are included in the request body for the [RetrieveLocation](#endpoint-locations-retrievelocation) endpoint. +Defines the fields that are included in the request body for the __RetrieveLocation__ endpoint. ## Properties Name | Type | Description | Notes diff --git a/docs/RetrieveLocationResponse.md b/docs/RetrieveLocationResponse.md index fe5c583..8bc8d7a 100644 --- a/docs/RetrieveLocationResponse.md +++ b/docs/RetrieveLocationResponse.md @@ -3,7 +3,7 @@ ### Description -Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. +Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. ## Properties Name | Type | Description | Notes diff --git a/docs/RetrieveMerchantResponse.md b/docs/RetrieveMerchantResponse.md index dfc8f08..d6fc1ad 100644 --- a/docs/RetrieveMerchantResponse.md +++ b/docs/RetrieveMerchantResponse.md @@ -3,7 +3,7 @@ ### Description -The response obeject returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. +The response object returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. ## Properties Name | Type | Description | Notes diff --git a/docs/RetrieveTransactionRequest.md b/docs/RetrieveTransactionRequest.md index 6215c99..6349d32 100644 --- a/docs/RetrieveTransactionRequest.md +++ b/docs/RetrieveTransactionRequest.md @@ -3,7 +3,7 @@ ### Description -Defines the request body fields for calls to the RetrieveTransaction endpoint. + **Note: This model is deprecated.** ## Properties diff --git a/docs/RevokeTokenRequest.md b/docs/RevokeTokenRequest.md index e32afb2..9f34261 100644 --- a/docs/RevokeTokenRequest.md +++ b/docs/RevokeTokenRequest.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientId** | **String** | Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] +**clientId** | **String** | The Square issued ID for your application, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] **accessToken** | **String** | The access token of the merchant whose token you want to revoke. Do not provide a value for merchant_id if you provide this parameter. | [optional] **merchantId** | **String** | The ID of the merchant whose token you want to revoke. Do not provide a value for access_token if you provide this parameter. | [optional] diff --git a/docs/SearchCatalogObjectsRequest.md b/docs/SearchCatalogObjectsRequest.md index 364f85e..af118ab 100644 --- a/docs/SearchCatalogObjectsRequest.md +++ b/docs/SearchCatalogObjectsRequest.md @@ -9,10 +9,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**objectTypes** | **List<String>** | The desired set of object types to appear in the search results. The legal values are taken from the `CatalogObjectType` enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values | [optional] +**objectTypes** | **List<String>** | The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values | [optional] **includeDeletedObjects** | **Boolean** | If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`. | [optional] -**includeRelatedObjects** | **Boolean** | If `true`, the response will include additional objects that are related to the requested object, as follows: If a `CatalogItem` is returned in the object field of the response, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be included in the `related_objects` field of the response. If a `CatalogItemVariation` is returned in the object field of the response, its parent `CatalogItem` will be included in the `related_objects` field of the response. | [optional] -**beginTime** | **String** | Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. | [optional] +**includeRelatedObjects** | **Boolean** | If `true`, the response will include additional objects that are related to the requested object, as follows: If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response. If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response. | [optional] +**beginTime** | **String** | Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. | [optional] **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] **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] diff --git a/docs/SearchCatalogObjectsResponse.md b/docs/SearchCatalogObjectsResponse.md index 70cd550..1135196 100644 --- a/docs/SearchCatalogObjectsResponse.md +++ b/docs/SearchCatalogObjectsResponse.md @@ -8,11 +8,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] +**errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] **cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**objects** | [**List<CatalogObject>**](CatalogObject.md) | The `CatalogObject`s returned. | [optional] -**relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s referenced by the objects in the `objects` field. | [optional] -**latestTime** | **String** | When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. | [optional] [beta] +**objects** | [**List<CatalogObject>**](CatalogObject.md) | The CatalogObjects returned. | [optional] +**relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects referenced by the objects in the `objects` field. | [optional] +**latestTime** | **String** | When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. | [optional] [beta] diff --git a/docs/SearchCustomersRequest.md b/docs/SearchCustomersRequest.md index 5e4dc12..9f8cca4 100644 --- a/docs/SearchCustomersRequest.md +++ b/docs/SearchCustomersRequest.md @@ -8,7 +8,7 @@ Defines the fields included in the request body for the SearchCustomers endpoint ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cursor** | **String** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] **limit** | **Long** | 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] **query** | [**CustomerQuery**](CustomerQuery.md) | Query customers based on the given conditions and sort order. Calling SearchCustomers without an explicit query parameter will return all customers ordered alphabetically based on `given_name` and `family_name`. | [optional] diff --git a/docs/SearchCustomersResponse.md b/docs/SearchCustomersResponse.md index d6657a6..82fc5f0 100644 --- a/docs/SearchCustomersResponse.md +++ b/docs/SearchCustomersResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **customers** | [**List<Customer>**](Customer.md) | An array of `Customer` objects that match a query. | [optional] -**cursor** | **String** | A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] diff --git a/docs/Shift.md b/docs/Shift.md index f6e8220..66bb453 100644 --- a/docs/Shift.md +++ b/docs/Shift.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **timezone** | **String** | Read-only convenience value that is calculated from the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone. | [optional] **startAt** | **String** | RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated. | **endAt** | **String** | RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the shift length is calculated. For example, a shift from `00:00` to `08:01` is considered an 8 hour shift (midnight to 8am). | [optional] -**wage** | [**ShiftWage**](ShiftWage.md) | Job and pay related information. | [optional] +**wage** | [**ShiftWage**](ShiftWage.md) | Job and pay related information. If wage is not set on create, will default to a wage of zero money. If title is not set on create, will default to the name of the role the employee is assigned to, if any. | [optional] **breaks** | [**List<ModelBreak>**](ModelBreak.md) | A list of any paid or unpaid breaks that were taken during this shift. | [optional] **status** | **String** | Describes working state of the current `Shift`. See [ShiftStatus](#type-shiftstatus) for possible values | [optional] **version** | **Integer** | Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write. | [optional] diff --git a/docs/ShiftFilter.md b/docs/ShiftFilter.md index 150ef29..1c34298 100644 --- a/docs/ShiftFilter.md +++ b/docs/ShiftFilter.md @@ -8,8 +8,8 @@ Defines a filter used in a search for `Shift` records. `AND` logic is used by Sq ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**locationId** | **List<String>** | Fetch shifts for the specified location. | [optional] -**employeeId** | **List<String>** | Fetch shifts for the specified employee. | [optional] +**locationIds** | **List<String>** | Fetch shifts for the specified location. | [optional] +**employeeIds** | **List<String>** | Fetch shifts for the specified employee. | [optional] **status** | **String** | Fetch a `Shift` instance by `Shift.status`. See [ShiftFilterStatus](#type-shiftfilterstatus) for possible values | [optional] **start** | [**TimeRange**](TimeRange.md) | Fetch `Shift`s that start in the time range - Inclusive. | [optional] **end** | [**TimeRange**](TimeRange.md) | Fetch the `Shift`s that end in the time range - Inclusive. | [optional] diff --git a/docs/StandardUnitDescription.md b/docs/StandardUnitDescription.md index 7773262..77b39c4 100644 --- a/docs/StandardUnitDescription.md +++ b/docs/StandardUnitDescription.md @@ -9,8 +9,8 @@ Contains the name and abbreviation for standard measurement unit. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **unit** | [**MeasurementUnit**](MeasurementUnit.md) | Identifies the measurement unit being described. | [optional] -**name** | **String** | Display name of the measurement unit. For example, 'Pound'. | [optional] -**abbreviation** | **String** | Abbreviation for the measurement unit. For example, 'lb'. | [optional] +**name** | **String** | UI display name of the measurement unit. For example, 'Pound'. | [optional] +**abbreviation** | **String** | UI display abbreviation for the measurement unit. For example, 'lb'. | [optional] diff --git a/docs/StandardUnitDescriptionGroup.md b/docs/StandardUnitDescriptionGroup.md index 6d0187a..e8a412b 100644 --- a/docs/StandardUnitDescriptionGroup.md +++ b/docs/StandardUnitDescriptionGroup.md @@ -8,7 +8,7 @@ Group of standard measurement units. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**standardUnitDescriptions** | [**List<StandardUnitDescription>**](StandardUnitDescription.md) | List of measurement units in this description group. | [optional] +**standardUnitDescriptions** | [**List<StandardUnitDescription>**](StandardUnitDescription.md) | List of standard (non-custom) measurement units in this description group. | [optional] **languageCode** | **String** | IETF language tag. | [optional] diff --git a/docs/TenderCardDetails.md b/docs/TenderCardDetails.md index 6b6434c..974b515 100644 --- a/docs/TenderCardDetails.md +++ b/docs/TenderCardDetails.md @@ -8,7 +8,7 @@ Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CAR ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **String** | The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values | [optional] +**status** | **String** | The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See `TenderCardDetailsStatus` for possible values. See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values | [optional] **card** | [**Card**](Card.md) | The credit card's non-confidential details. | [optional] **entryMethod** | **String** | The method used to enter the card's details for the transaction. See [TenderCardDetailsEntryMethod](#type-tendercarddetailsentrymethod) for possible values | [optional] diff --git a/docs/TransactionsApi.md b/docs/TransactionsApi.md index d89d1b2..02711ff 100644 --- a/docs/TransactionsApi.md +++ b/docs/TransactionsApi.md @@ -20,7 +20,7 @@ Method | HTTP request | Description CaptureTransaction -Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. +Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. ### Example ```java @@ -76,7 +76,7 @@ Name | Type | Description | Notes Charge -Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. +Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. ### Example ```java @@ -212,7 +212,7 @@ String locationId = "locationId_example"; // String | The ID of the location to String beginTime = "beginTime_example"; // String | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. String endTime = "endTime_example"; // String | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. String sortOrder = "sortOrder_example"; // String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` -String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. +String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. try { ListRefundsResponse result = apiInstance.listRefunds(locationId, beginTime, endTime, sortOrder, cursor); System.out.println(result); @@ -230,7 +230,7 @@ Name | Type | Description | Notes **beginTime** | **String**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **String**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] ### Return type @@ -274,7 +274,7 @@ String locationId = "locationId_example"; // String | The ID of the location to String beginTime = "beginTime_example"; // String | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. String endTime = "endTime_example"; // String | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. String sortOrder = "sortOrder_example"; // String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` -String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. +String cursor = "cursor_example"; // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. try { ListTransactionsResponse result = apiInstance.listTransactions(locationId, beginTime, endTime, sortOrder, cursor); System.out.println(result); @@ -292,7 +292,7 @@ Name | Type | Description | Notes **beginTime** | **String**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **String**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] ### Return type @@ -370,7 +370,7 @@ Name | Type | Description | Notes VoidTransaction -Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. +Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. ### Example ```java diff --git a/docs/UpdateBreakTypeRequest.md b/docs/UpdateBreakTypeRequest.md index b9f4fbc..fdc104b 100644 --- a/docs/UpdateBreakTypeRequest.md +++ b/docs/UpdateBreakTypeRequest.md @@ -8,7 +8,7 @@ A request to update a `BreakType` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**breakType** | [**BreakType**](BreakType.md) | The updated `BreakType`. | [optional] +**breakType** | [**BreakType**](BreakType.md) | The updated `BreakType`. | diff --git a/docs/UpdateCustomerRequest.md b/docs/UpdateCustomerRequest.md index f093dd0..a632117 100644 --- a/docs/UpdateCustomerRequest.md +++ b/docs/UpdateCustomerRequest.md @@ -8,16 +8,16 @@ Defines the body parameters that can be provided in a request to the UpdateCusto ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**givenName** | **String** | The customer's given (i.e., first) name. | [optional] -**familyName** | **String** | The customer's family (i.e., last) name. | [optional] -**companyName** | **String** | The name of the customer's company. | [optional] -**nickname** | **String** | A nickname for the customer. | [optional] -**emailAddress** | **String** | The customer's email address. | [optional] -**address** | [**Address**](Address.md) | The customer's physical address. | [optional] -**phoneNumber** | **String** | The customer's phone number. | [optional] -**referenceId** | **String** | An optional second ID you can set to associate the customer with an entity in another system. | [optional] -**note** | **String** | An optional note to associate with the customer. | [optional] -**birthday** | **String** | The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. | [optional] +**givenName** | **String** | The given (i.e., first) name associated with the customer profile. | [optional] +**familyName** | **String** | The family (i.e., last) name associated with the customer profile. | [optional] +**companyName** | **String** | A business name associated with the customer profile. | [optional] +**nickname** | **String** | A nickname for the customer profile. | [optional] +**emailAddress** | **String** | The email address associated with the customer profile. | [optional] +**address** | [**Address**](Address.md) | The physical address associated with the customer profile. | [optional] +**phoneNumber** | **String** | The 11-digit phone number associated with the customer profile. | [optional] +**referenceId** | **String** | An optional, second ID used to associate the customer profile with an entity in another system. | [optional] +**note** | **String** | A custom note associated with the customer profile. | [optional] +**birthday** | **String** | The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. | [optional] diff --git a/docs/UpdateItemModifierListsRequest.md b/docs/UpdateItemModifierListsRequest.md index fd0a2c7..7d8a1db 100644 --- a/docs/UpdateItemModifierListsRequest.md +++ b/docs/UpdateItemModifierListsRequest.md @@ -8,9 +8,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**itemIds** | **List<String>** | The `CatalogItem](#type-catalogitem)s whose [CatalogModifierList`s are being updated. | -**modifierListsToEnable** | **List<String>** | The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem`. | [optional] -**modifierListsToDisable** | **List<String>** | The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem`. | [optional] +**itemIds** | **List<String>** | The IDs of the catalog items associated with the CatalogModifierList objects being updated. | +**modifierListsToEnable** | **List<String>** | The IDs of the CatalogModifierList objects to enable for the CatalogItem. | [optional] +**modifierListsToDisable** | **List<String>** | The IDs of the CatalogModifierList objects to disable for the CatalogItem. | [optional] diff --git a/docs/UpdateItemModifierListsResponse.md b/docs/UpdateItemModifierListsResponse.md index 34cfdf1..e1d978c 100644 --- a/docs/UpdateItemModifierListsResponse.md +++ b/docs/UpdateItemModifierListsResponse.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**updatedAt** | **String** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**updatedAt** | **String** | | [optional] diff --git a/docs/UpdateItemTaxesRequest.md b/docs/UpdateItemTaxesRequest.md index f92a7e9..d4be11e 100644 --- a/docs/UpdateItemTaxesRequest.md +++ b/docs/UpdateItemTaxesRequest.md @@ -8,9 +8,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**itemIds** | **List<String>** | The `CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax`es are being updated. | -**taxesToEnable** | **List<String>** | The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem`. | [optional] -**taxesToDisable** | **List<String>** | The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem`. | [optional] +**itemIds** | **List<String>** | IDs for the CatalogItems associated with the CatalogTax objects being updated. | +**taxesToEnable** | **List<String>** | IDs of the CatalogTax objects to enable. | [optional] +**taxesToDisable** | **List<String>** | IDs of the CatalogTax objects to disable. | [optional] diff --git a/docs/UpdateItemTaxesResponse.md b/docs/UpdateItemTaxesResponse.md index 418e649..ffcae93 100644 --- a/docs/UpdateItemTaxesResponse.md +++ b/docs/UpdateItemTaxesResponse.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**updatedAt** | **String** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**updatedAt** | **String** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-date) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. | [optional] diff --git a/docs/UpdateWorkweekConfigRequest.md b/docs/UpdateWorkweekConfigRequest.md index 31f95c1..ff010a4 100644 --- a/docs/UpdateWorkweekConfigRequest.md +++ b/docs/UpdateWorkweekConfigRequest.md @@ -8,7 +8,7 @@ A request to update a `WorkweekConfig` object ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**workweekConfig** | [**WorkweekConfig**](WorkweekConfig.md) | The updated `WorkweekConfig` object. | [optional] +**workweekConfig** | [**WorkweekConfig**](WorkweekConfig.md) | The updated `WorkweekConfig` object. | diff --git a/docs/UpsertCatalogObjectRequest.md b/docs/UpsertCatalogObjectRequest.md index 08d4571..b64096d 100644 --- a/docs/UpsertCatalogObjectRequest.md +++ b/docs/UpsertCatalogObjectRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **idempotencyKey** | **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](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | -**object** | [**CatalogObject**](CatalogObject.md) | A `CatalogObject` to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. | +**object** | [**CatalogObject**](CatalogObject.md) | A CatalogObject to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. | diff --git a/docs/UpsertCatalogObjectResponse.md b/docs/UpsertCatalogObjectResponse.md index 6726a3e..7887b22 100644 --- a/docs/UpsertCatalogObjectResponse.md +++ b/docs/UpsertCatalogObjectResponse.md @@ -8,9 +8,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**catalogObject** | [**CatalogObject**](CatalogObject.md) | The created `CatalogObject`. | [optional] -**idMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this Upsert. | [optional] +**errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**catalogObject** | [**CatalogObject**](CatalogObject.md) | The successfully created or updated CatalogObject. | [optional] +**idMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this upsert. | [optional] diff --git a/docs/V1AdjustInventoryRequest.md b/docs/V1AdjustInventoryRequest.md index 3f85e34..08f85fc 100644 --- a/docs/V1AdjustInventoryRequest.md +++ b/docs/V1AdjustInventoryRequest.md @@ -4,6 +4,7 @@ ### Description V1AdjustInventoryRequest +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ApplyFeeRequest.md b/docs/V1ApplyFeeRequest.md index a168354..ebbd716 100644 --- a/docs/V1ApplyFeeRequest.md +++ b/docs/V1ApplyFeeRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ApplyModifierListRequest.md b/docs/V1ApplyModifierListRequest.md index 1385870..57a9d8d 100644 --- a/docs/V1ApplyModifierListRequest.md +++ b/docs/V1ApplyModifierListRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1Category.md b/docs/V1Category.md index 4e24df1..7078cf6 100644 --- a/docs/V1Category.md +++ b/docs/V1Category.md @@ -4,6 +4,7 @@ ### Description V1Category +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1CreateCategoryRequest.md b/docs/V1CreateCategoryRequest.md index 537eacd..36ba5ed 100644 --- a/docs/V1CreateCategoryRequest.md +++ b/docs/V1CreateCategoryRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1CreateDiscountRequest.md b/docs/V1CreateDiscountRequest.md index 65a5291..6bf8e16 100644 --- a/docs/V1CreateDiscountRequest.md +++ b/docs/V1CreateDiscountRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1CreateFeeRequest.md b/docs/V1CreateFeeRequest.md index 60125d6..736952b 100644 --- a/docs/V1CreateFeeRequest.md +++ b/docs/V1CreateFeeRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1CreateItemRequest.md b/docs/V1CreateItemRequest.md index 0e1feb9..f9c1b97 100644 --- a/docs/V1CreateItemRequest.md +++ b/docs/V1CreateItemRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1CreateModifierListRequest.md b/docs/V1CreateModifierListRequest.md index 763792d..3e653b7 100644 --- a/docs/V1CreateModifierListRequest.md +++ b/docs/V1CreateModifierListRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1CreateModifierOptionRequest.md b/docs/V1CreateModifierOptionRequest.md index 3ca4d4c..d59a90a 100644 --- a/docs/V1CreateModifierOptionRequest.md +++ b/docs/V1CreateModifierOptionRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1CreatePageRequest.md b/docs/V1CreatePageRequest.md index f4590ed..fadf277 100644 --- a/docs/V1CreatePageRequest.md +++ b/docs/V1CreatePageRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1CreateVariationRequest.md b/docs/V1CreateVariationRequest.md index 33fcbbb..09aece9 100644 --- a/docs/V1CreateVariationRequest.md +++ b/docs/V1CreateVariationRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1DeleteCategoryRequest.md b/docs/V1DeleteCategoryRequest.md index 6f02eed..6708e86 100644 --- a/docs/V1DeleteCategoryRequest.md +++ b/docs/V1DeleteCategoryRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1DeleteDiscountRequest.md b/docs/V1DeleteDiscountRequest.md index 35ab180..c9b63bd 100644 --- a/docs/V1DeleteDiscountRequest.md +++ b/docs/V1DeleteDiscountRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1DeleteFeeRequest.md b/docs/V1DeleteFeeRequest.md index ccfeba5..a5ca16f 100644 --- a/docs/V1DeleteFeeRequest.md +++ b/docs/V1DeleteFeeRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1DeleteItemRequest.md b/docs/V1DeleteItemRequest.md index a15831e..f7b9872 100644 --- a/docs/V1DeleteItemRequest.md +++ b/docs/V1DeleteItemRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1DeleteModifierListRequest.md b/docs/V1DeleteModifierListRequest.md index 92a3717..81b11f3 100644 --- a/docs/V1DeleteModifierListRequest.md +++ b/docs/V1DeleteModifierListRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1DeleteModifierOptionRequest.md b/docs/V1DeleteModifierOptionRequest.md index 75fcff6..598a401 100644 --- a/docs/V1DeleteModifierOptionRequest.md +++ b/docs/V1DeleteModifierOptionRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1DeletePageCellRequest.md b/docs/V1DeletePageCellRequest.md index 130c897..ef8a413 100644 --- a/docs/V1DeletePageCellRequest.md +++ b/docs/V1DeletePageCellRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1DeletePageRequest.md b/docs/V1DeletePageRequest.md index 7130057..a106fef 100644 --- a/docs/V1DeletePageRequest.md +++ b/docs/V1DeletePageRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1DeleteVariationRequest.md b/docs/V1DeleteVariationRequest.md index fdef6fb..7a44953 100644 --- a/docs/V1DeleteVariationRequest.md +++ b/docs/V1DeleteVariationRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1Discount.md b/docs/V1Discount.md index 3d3afe4..d38a6b3 100644 --- a/docs/V1Discount.md +++ b/docs/V1Discount.md @@ -4,6 +4,7 @@ ### Description V1Discount +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes @@ -14,7 +15,7 @@ Name | Type | Description | Notes **amountMoney** | [**V1Money**](V1Money.md) | The amount of the discount. This amount is 0 if discount_type is VARIABLE_AMOUNT. This field is not included for rate-based discounts. | [optional] **discountType** | **String** | Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values | [optional] **pinRequired** | **Boolean** | Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment. | [optional] -**color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values | [optional] +**color** | **String** | The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values | [optional] **v2Id** | **String** | The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. | [optional] diff --git a/docs/V1Fee.md b/docs/V1Fee.md index cb19205..d6f42e5 100644 --- a/docs/V1Fee.md +++ b/docs/V1Fee.md @@ -4,6 +4,7 @@ ### Description V1Fee +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes @@ -13,7 +14,7 @@ Name | Type | Description | Notes **rate** | **String** | The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. | [optional] **calculationPhase** | **String** | Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values | [optional] **adjustmentType** | **String** | The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values | [optional] -**appliesToCustomAmounts** | **Boolean** | If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item. | [optional] +**appliesToCustomAmounts** | **Boolean** | If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item. | [optional] **enabled** | **Boolean** | If true, the fee is applied to all appropriate items. If false, the fee is not applied at all. | [optional] **inclusionType** | **String** | Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values | [optional] **type** | **String** | In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values | [optional] diff --git a/docs/V1InventoryEntry.md b/docs/V1InventoryEntry.md index 6355d8e..9961b92 100644 --- a/docs/V1InventoryEntry.md +++ b/docs/V1InventoryEntry.md @@ -4,6 +4,7 @@ ### Description V1InventoryEntry +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1Item.md b/docs/V1Item.md index c6a1373..30ed203 100644 --- a/docs/V1Item.md +++ b/docs/V1Item.md @@ -4,6 +4,7 @@ ### Description V1Item +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes @@ -12,8 +13,8 @@ Name | Type | Description | Notes **name** | **String** | The item's name. | [optional] **description** | **String** | The item's description. | [optional] **type** | **String** | The item's type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values | [optional] -**color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values | [optional] -**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] +**color** | **String** | The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values | [optional] +**abbreviation** | **String** | The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used. | [optional] **visibility** | **String** | Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values | [optional] **availableOnline** | **Boolean** | If true, the item can be added to shipping orders from the merchant's online store. | [optional] **masterImage** | [**V1ItemImage**](V1ItemImage.md) | The item's master image, if any. | [optional] diff --git a/docs/V1ItemImage.md b/docs/V1ItemImage.md index c2133dc..648cdaf 100644 --- a/docs/V1ItemImage.md +++ b/docs/V1ItemImage.md @@ -4,6 +4,7 @@ ### Description V1ItemImage +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ItemsApi.md b/docs/V1ItemsApi.md index d672b27..be36568 100644 --- a/docs/V1ItemsApi.md +++ b/docs/V1ItemsApi.md @@ -48,11 +48,12 @@ Method | HTTP request | Description # **adjustInventory** +**Note: This endpoint is deprecated.** > V1InventoryEntry adjustInventory(locationId, variationId, body) AdjustInventory -Adjusts an item variation's current available inventory. +Adjusts the current available inventory of an item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -105,11 +106,12 @@ Name | Type | Description | Notes # **applyFee** +**Note: This endpoint is deprecated.** > V1Item applyFee(locationId, itemId, feeId) ApplyFee -Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. +Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -162,11 +164,12 @@ Name | Type | Description | Notes # **applyModifierList** +**Note: This endpoint is deprecated.** > V1Item applyModifierList(locationId, modifierListId, itemId) ApplyModifierList -Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. +Associates a modifier list with an item so the associated modifier options can be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -219,11 +222,12 @@ Name | Type | Description | Notes # **createCategory** +**Note: This endpoint is deprecated.** > V1Category createCategory(locationId, body) CreateCategory -Creates an item category. +Creates an item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -274,11 +278,12 @@ Name | Type | Description | Notes # **createDiscount** +**Note: This endpoint is deprecated.** > V1Discount createDiscount(locationId, body) CreateDiscount -Creates a discount. +Creates a discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -329,11 +334,12 @@ Name | Type | Description | Notes # **createFee** +**Note: This endpoint is deprecated.** > V1Fee createFee(locationId, body) CreateFee -Creates a fee (tax). +Creates a fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -384,11 +390,12 @@ Name | Type | Description | Notes # **createItem** +**Note: This endpoint is deprecated.** > V1Item createItem(locationId, body) CreateItem -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. +Creates an item and at least one variation for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- 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 `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 ```java @@ -439,11 +446,12 @@ Name | Type | Description | Notes # **createModifierList** +**Note: This endpoint is deprecated.** > V1ModifierList createModifierList(locationId, body) CreateModifierList -Creates an item modifier list and at least one modifier option for it. +Creates an item modifier list and at least 1 modifier option for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -494,11 +502,12 @@ Name | Type | Description | Notes # **createModifierOption** +**Note: This endpoint is deprecated.** > V1ModifierOption createModifierOption(locationId, modifierListId, body) CreateModifierOption -Creates an item modifier option and adds it to a modifier list. +Creates an item modifier option and adds it to a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -551,11 +560,12 @@ Name | Type | Description | Notes # **createPage** +**Note: This endpoint is deprecated.** > V1Page createPage(locationId, body) CreatePage -Creates a Favorites page in Square Register. +Creates a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -606,11 +616,12 @@ Name | Type | Description | Notes # **createVariation** +**Note: This endpoint is deprecated.** > V1Variation createVariation(locationId, itemId, body) CreateVariation -Creates an item variation for an existing item. +Creates an item variation for an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -663,11 +674,12 @@ Name | Type | Description | Notes # **deleteCategory** +**Note: This endpoint is deprecated.** > V1Category deleteCategory(locationId, categoryId) DeleteCategory -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. +Deletes an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. ### Example ```java @@ -718,11 +730,12 @@ Name | Type | Description | Notes # **deleteDiscount** +**Note: This endpoint is deprecated.** > V1Discount deleteDiscount(locationId, discountId) DeleteDiscount -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. +Deletes an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. ### Example ```java @@ -773,11 +786,12 @@ Name | Type | Description | Notes # **deleteFee** +**Note: This endpoint is deprecated.** > V1Fee deleteFee(locationId, feeId) DeleteFee -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. +Deletes an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. ### Example ```java @@ -828,11 +842,12 @@ Name | Type | Description | Notes # **deleteItem** +**Note: This endpoint is deprecated.** > V1Item deleteItem(locationId, itemId) DeleteItem -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. +Deletes an existing item and all item variations associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. ### Example ```java @@ -883,11 +898,12 @@ Name | Type | Description | Notes # **deleteModifierList** +**Note: This endpoint is deprecated.** > V1ModifierList deleteModifierList(locationId, modifierListId) DeleteModifierList -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. +Deletes an existing item modifier list and all modifier options associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. ### Example ```java @@ -938,11 +954,12 @@ Name | Type | Description | Notes # **deleteModifierOption** +**Note: This endpoint is deprecated.** > V1ModifierOption deleteModifierOption(locationId, modifierListId, modifierOptionId) DeleteModifierOption -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. +Deletes an existing item modifier option from a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. ### Example ```java @@ -995,11 +1012,12 @@ Name | Type | Description | Notes # **deletePage** +**Note: This endpoint is deprecated.** > V1Page deletePage(locationId, pageId) DeletePage -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. +Deletes an existing Favorites page and all of its cells. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. ### Example ```java @@ -1050,11 +1068,12 @@ Name | Type | Description | Notes # **deletePageCell** +**Note: This endpoint is deprecated.** > V1Page deletePageCell(locationId, pageId, row, column) DeletePageCell -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. +Deletes a cell from a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. ### Example ```java @@ -1109,11 +1128,12 @@ Name | Type | Description | Notes # **deleteVariation** +**Note: This endpoint is deprecated.** > V1Variation deleteVariation(locationId, itemId, variationId) DeleteVariation -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. +Deletes an existing item variation from an item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. ### Example ```java @@ -1166,11 +1186,12 @@ Name | Type | Description | Notes # **listCategories** +**Note: This endpoint is deprecated.** > List<V1Category> listCategories(locationId) ListCategories -Lists all of a location's item categories. +Lists all the item categories for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1219,11 +1240,12 @@ Name | Type | Description | Notes # **listDiscounts** +**Note: This endpoint is deprecated.** > List<V1Discount> listDiscounts(locationId) ListDiscounts -Lists all of a location's discounts. +Lists all the discounts for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1272,11 +1294,12 @@ Name | Type | Description | Notes # **listFees** +**Note: This endpoint is deprecated.** > List<V1Fee> listFees(locationId) ListFees -Lists all of a location's fees (taxes). +Lists all the fees (taxes) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1325,11 +1348,12 @@ Name | Type | Description | Notes # **listInventory** +**Note: This endpoint is deprecated.** > List<V1InventoryEntry> listInventory(locationId, limit, batchToken) ListInventory -Provides inventory information for all of a merchant's inventory-enabled item variations. +Provides inventory information for all inventory-enabled item variations. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1382,11 +1406,12 @@ Name | Type | Description | Notes # **listItems** +**Note: This endpoint is deprecated.** > List<V1Item> listItems(locationId, batchToken) ListItems -Provides summary information for all of a location's items. +Provides summary information of all items for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1437,11 +1462,12 @@ Name | Type | Description | Notes # **listModifierLists** +**Note: This endpoint is deprecated.** > List<V1ModifierList> listModifierLists(locationId) ListModifierLists -Lists all of a location's modifier lists. +Lists all the modifier lists for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1490,11 +1516,12 @@ Name | Type | Description | Notes # **listPages** +**Note: This endpoint is deprecated.** > List<V1Page> listPages(locationId) ListPages -Lists all of a location's Favorites pages in Square Register. +Lists all Favorites pages (in Square Point of Sale) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1543,11 +1570,12 @@ Name | Type | Description | Notes # **removeFee** +**Note: This endpoint is deprecated.** > V1Item removeFee(locationId, itemId, feeId) RemoveFee -Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. +Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1600,11 +1628,12 @@ Name | Type | Description | Notes # **removeModifierList** +**Note: This endpoint is deprecated.** > V1Item removeModifierList(locationId, modifierListId, itemId) RemoveModifierList -Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. +Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1657,11 +1686,12 @@ Name | Type | Description | Notes # **retrieveItem** +**Note: This endpoint is deprecated.** > V1Item retrieveItem(locationId, itemId) RetrieveItem -Provides the details for a single item, including associated modifier lists and fees. +Provides the details for a single item, including associated modifier lists and fees. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1712,11 +1742,12 @@ Name | Type | Description | Notes # **retrieveModifierList** +**Note: This endpoint is deprecated.** > V1ModifierList retrieveModifierList(locationId, modifierListId) RetrieveModifierList -Provides the details for a single modifier list. +Provides the details for a single modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1767,11 +1798,12 @@ Name | Type | Description | Notes # **updateCategory** +**Note: This endpoint is deprecated.** > V1Category updateCategory(locationId, categoryId, body) UpdateCategory -Modifies the details of an existing item category. +Modifies the details of an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1824,11 +1856,12 @@ Name | Type | Description | Notes # **updateDiscount** +**Note: This endpoint is deprecated.** > V1Discount updateDiscount(locationId, discountId, body) UpdateDiscount -Modifies the details of an existing discount. +Modifies the details of an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1881,11 +1914,12 @@ Name | Type | Description | Notes # **updateFee** +**Note: This endpoint is deprecated.** > V1Fee updateFee(locationId, feeId, body) UpdateFee -Modifies the details of an existing fee (tax). +Modifies the details of an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1938,11 +1972,12 @@ Name | Type | Description | Notes # **updateItem** +**Note: This endpoint is deprecated.** > V1Item updateItem(locationId, itemId, body) UpdateItem -Modifies the core details of an existing item. +Modifies the core details of an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -1995,11 +2030,12 @@ Name | Type | Description | Notes # **updateModifierList** +**Note: This endpoint is deprecated.** > V1ModifierList updateModifierList(locationId, modifierListId, body) UpdateModifierList -Modifies the details of an existing item modifier list. +Modifies the details of an existing item modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -2052,11 +2088,12 @@ Name | Type | Description | Notes # **updateModifierOption** +**Note: This endpoint is deprecated.** > V1ModifierOption updateModifierOption(locationId, modifierListId, modifierOptionId, body) UpdateModifierOption -Modifies the details of an existing item modifier option. +Modifies the details of an existing item modifier option. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -2111,11 +2148,12 @@ Name | Type | Description | Notes # **updatePage** +**Note: This endpoint is deprecated.** > V1Page updatePage(locationId, pageId, body) UpdatePage -Modifies the details of a Favorites page in Square Register. +Modifies the details of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -2168,11 +2206,12 @@ Name | Type | Description | Notes # **updatePageCell** +**Note: This endpoint is deprecated.** > V1Page updatePageCell(locationId, pageId, body) UpdatePageCell -Modifies a cell of a Favorites page in Square Register. +Modifies a cell of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java @@ -2225,11 +2264,12 @@ Name | Type | Description | Notes # **updateVariation** +**Note: This endpoint is deprecated.** > V1Variation updateVariation(locationId, itemId, variationId, body) UpdateVariation -Modifies the details of an existing item variation. +Modifies the details of an existing item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- ### Example ```java diff --git a/docs/V1ListCategoriesRequest.md b/docs/V1ListCategoriesRequest.md index 0eda993..c651531 100644 --- a/docs/V1ListCategoriesRequest.md +++ b/docs/V1ListCategoriesRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListCategoriesResponse.md b/docs/V1ListCategoriesResponse.md index e25cf9c..d088cd0 100644 --- a/docs/V1ListCategoriesResponse.md +++ b/docs/V1ListCategoriesResponse.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListDiscountsRequest.md b/docs/V1ListDiscountsRequest.md index c34e661..4b1b949 100644 --- a/docs/V1ListDiscountsRequest.md +++ b/docs/V1ListDiscountsRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListDiscountsResponse.md b/docs/V1ListDiscountsResponse.md index bce95a8..30a2b3b 100644 --- a/docs/V1ListDiscountsResponse.md +++ b/docs/V1ListDiscountsResponse.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListFeesRequest.md b/docs/V1ListFeesRequest.md index 1857f09..cf2b521 100644 --- a/docs/V1ListFeesRequest.md +++ b/docs/V1ListFeesRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListFeesResponse.md b/docs/V1ListFeesResponse.md index bc7da2a..bf02e68 100644 --- a/docs/V1ListFeesResponse.md +++ b/docs/V1ListFeesResponse.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListInventoryRequest.md b/docs/V1ListInventoryRequest.md index ede9312..a029d8f 100644 --- a/docs/V1ListInventoryRequest.md +++ b/docs/V1ListInventoryRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListInventoryResponse.md b/docs/V1ListInventoryResponse.md index b1ec460..b7f5c06 100644 --- a/docs/V1ListInventoryResponse.md +++ b/docs/V1ListInventoryResponse.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListItemsRequest.md b/docs/V1ListItemsRequest.md index dc0dd8b..8489cf3 100644 --- a/docs/V1ListItemsRequest.md +++ b/docs/V1ListItemsRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListItemsResponse.md b/docs/V1ListItemsResponse.md index 30e0e12..b76fa75 100644 --- a/docs/V1ListItemsResponse.md +++ b/docs/V1ListItemsResponse.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListLocationsRequest.md b/docs/V1ListLocationsRequest.md index 59b0e0b..e4a26ee 100644 --- a/docs/V1ListLocationsRequest.md +++ b/docs/V1ListLocationsRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListLocationsResponse.md b/docs/V1ListLocationsResponse.md index c56f7aa..2bb7d8d 100644 --- a/docs/V1ListLocationsResponse.md +++ b/docs/V1ListLocationsResponse.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListModifierListsRequest.md b/docs/V1ListModifierListsRequest.md index 2d7ccde..7a8fdd1 100644 --- a/docs/V1ListModifierListsRequest.md +++ b/docs/V1ListModifierListsRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListModifierListsResponse.md b/docs/V1ListModifierListsResponse.md index ec80c64..6c66c22 100644 --- a/docs/V1ListModifierListsResponse.md +++ b/docs/V1ListModifierListsResponse.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListPagesRequest.md b/docs/V1ListPagesRequest.md index 063dbfd..3c25cb3 100644 --- a/docs/V1ListPagesRequest.md +++ b/docs/V1ListPagesRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ListPagesResponse.md b/docs/V1ListPagesResponse.md index a58a880..2c4d9f2 100644 --- a/docs/V1ListPagesResponse.md +++ b/docs/V1ListPagesResponse.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1LocationsApi.md b/docs/V1LocationsApi.md index 460777b..928dead 100644 --- a/docs/V1LocationsApi.md +++ b/docs/V1LocationsApi.md @@ -10,11 +10,12 @@ Method | HTTP request | Description # **listLocations** +**Note: This endpoint is deprecated.** > List<V1Merchant> listLocations() ListLocations -Provides details for a business's locations, including their IDs. +Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- ### Example ```java @@ -59,11 +60,12 @@ This endpoint does not need any parameter. # **retrieveBusiness** +**Note: This endpoint is deprecated.** > V1Merchant retrieveBusiness() RetrieveBusiness -Get a business's information. +Get the general information for a business. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- ### Example ```java diff --git a/docs/V1Merchant.md b/docs/V1Merchant.md index 2d8d8a9..f08e365 100644 --- a/docs/V1Merchant.md +++ b/docs/V1Merchant.md @@ -4,6 +4,7 @@ ### Description Defines the fields that are included in the response body of a request to the **RetrieveBusiness** endpoint. +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1MerchantLocationDetails.md b/docs/V1MerchantLocationDetails.md index 63759d5..1708280 100644 --- a/docs/V1MerchantLocationDetails.md +++ b/docs/V1MerchantLocationDetails.md @@ -4,6 +4,7 @@ ### Description Additional information for a single-location account specified by its associated business account, if it has one. +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ModifierList.md b/docs/V1ModifierList.md index 7ca4e56..83fc3d0 100644 --- a/docs/V1ModifierList.md +++ b/docs/V1ModifierList.md @@ -4,6 +4,7 @@ ### Description V1ModifierList +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1ModifierOption.md b/docs/V1ModifierOption.md index badb62a..3c963e7 100644 --- a/docs/V1ModifierOption.md +++ b/docs/V1ModifierOption.md @@ -4,6 +4,7 @@ ### Description V1ModifierOption +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes @@ -12,7 +13,7 @@ Name | Type | Description | Notes **name** | **String** | The modifier option's name. | [optional] **priceMoney** | [**V1Money**](V1Money.md) | The modifier option's price. | [optional] **onByDefault** | **Boolean** | If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE. | [optional] -**ordinal** | **Integer** | Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. | [optional] +**ordinal** | **Integer** | Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. | [optional] **modifierListId** | **String** | The ID of the modifier list the option belongs to. | [optional] **v2Id** | **String** | The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. | [optional] diff --git a/docs/V1Money.md b/docs/V1Money.md index 8cf53ca..b5edc77 100644 --- a/docs/V1Money.md +++ b/docs/V1Money.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1Page.md b/docs/V1Page.md index d1d60a7..4f76dc0 100644 --- a/docs/V1Page.md +++ b/docs/V1Page.md @@ -4,6 +4,7 @@ ### Description V1Page +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1PageCell.md b/docs/V1PageCell.md index 8583743..4a06434 100644 --- a/docs/V1PageCell.md +++ b/docs/V1PageCell.md @@ -4,6 +4,7 @@ ### Description V1PageCell +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1PhoneNumber.md b/docs/V1PhoneNumber.md index bd748dc..50537f2 100644 --- a/docs/V1PhoneNumber.md +++ b/docs/V1PhoneNumber.md @@ -4,6 +4,7 @@ ### Description Represents a phone number. +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1RemoveFeeRequest.md b/docs/V1RemoveFeeRequest.md index 565d491..7179f75 100644 --- a/docs/V1RemoveFeeRequest.md +++ b/docs/V1RemoveFeeRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1RemoveModifierListRequest.md b/docs/V1RemoveModifierListRequest.md index 9300aee..2fd502c 100644 --- a/docs/V1RemoveModifierListRequest.md +++ b/docs/V1RemoveModifierListRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1RetrieveBusinessRequest.md b/docs/V1RetrieveBusinessRequest.md index 361ffd2..a576686 100644 --- a/docs/V1RetrieveBusinessRequest.md +++ b/docs/V1RetrieveBusinessRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1RetrieveItemRequest.md b/docs/V1RetrieveItemRequest.md index 6612595..7f6a959 100644 --- a/docs/V1RetrieveItemRequest.md +++ b/docs/V1RetrieveItemRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1RetrieveModifierListRequest.md b/docs/V1RetrieveModifierListRequest.md index 2db3972..bd1206d 100644 --- a/docs/V1RetrieveModifierListRequest.md +++ b/docs/V1RetrieveModifierListRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1Tender.md b/docs/V1Tender.md index 35174f2..380ceba 100644 --- a/docs/V1Tender.md +++ b/docs/V1Tender.md @@ -4,6 +4,7 @@ ### Description A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The `tender` field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url fields of the corresponding Tender objects. *A note on gift cards**: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A `Tender` object with a type of `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the associated payment. +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1UpdateCategoryRequest.md b/docs/V1UpdateCategoryRequest.md index 76832fb..b5ffb9e 100644 --- a/docs/V1UpdateCategoryRequest.md +++ b/docs/V1UpdateCategoryRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1UpdateDiscountRequest.md b/docs/V1UpdateDiscountRequest.md index 9e1ff6d..f642ab0 100644 --- a/docs/V1UpdateDiscountRequest.md +++ b/docs/V1UpdateDiscountRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1UpdateFeeRequest.md b/docs/V1UpdateFeeRequest.md index 949fedc..4e47eb3 100644 --- a/docs/V1UpdateFeeRequest.md +++ b/docs/V1UpdateFeeRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1UpdateItemRequest.md b/docs/V1UpdateItemRequest.md index c3af986..452c092 100644 --- a/docs/V1UpdateItemRequest.md +++ b/docs/V1UpdateItemRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1UpdateModifierListRequest.md b/docs/V1UpdateModifierListRequest.md index c91f3b8..be16c9d 100644 --- a/docs/V1UpdateModifierListRequest.md +++ b/docs/V1UpdateModifierListRequest.md @@ -4,6 +4,7 @@ ### Description V1UpdateModifierListRequest +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1UpdateModifierOptionRequest.md b/docs/V1UpdateModifierOptionRequest.md index 1676f0d..d990940 100644 --- a/docs/V1UpdateModifierOptionRequest.md +++ b/docs/V1UpdateModifierOptionRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1UpdatePageCellRequest.md b/docs/V1UpdatePageCellRequest.md index 072227c..e12994e 100644 --- a/docs/V1UpdatePageCellRequest.md +++ b/docs/V1UpdatePageCellRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1UpdatePageRequest.md b/docs/V1UpdatePageRequest.md index 5cc76e0..c653e3c 100644 --- a/docs/V1UpdatePageRequest.md +++ b/docs/V1UpdatePageRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1UpdateVariationRequest.md b/docs/V1UpdateVariationRequest.md index 766f019..03bdcfa 100644 --- a/docs/V1UpdateVariationRequest.md +++ b/docs/V1UpdateVariationRequest.md @@ -4,6 +4,7 @@ ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes diff --git a/docs/V1Variation.md b/docs/V1Variation.md index 2ce9ab0..c995cd7 100644 --- a/docs/V1Variation.md +++ b/docs/V1Variation.md @@ -4,6 +4,7 @@ ### Description V1Variation +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes @@ -11,7 +12,7 @@ Name | Type | Description | Notes **id** | **String** | The item variation's unique ID. | [optional] **name** | **String** | The item variation's name. | [optional] **itemId** | **String** | The ID of the variation's associated item. | [optional] -**ordinal** | **Integer** | Indicates 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] +**ordinal** | **Integer** | Indicates the variation's list position when displayed in Square Point of Sale 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] **pricingType** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values | [optional] **priceMoney** | [**V1Money**](V1Money.md) | The item variation's price, if any. | [optional] **sku** | **String** | The item variation's SKU, if any. | [optional] diff --git a/docs/VoidTransactionRequest.md b/docs/VoidTransactionRequest.md index 839c4ea..2d4d34e 100644 --- a/docs/VoidTransactionRequest.md +++ b/docs/VoidTransactionRequest.md @@ -3,7 +3,7 @@ ### Description -Defines the request body for calls to the VoidTransaction endpoint. + **Note: This model is deprecated.** ## Properties diff --git a/docs/WebhookEvents.md b/docs/WebhookEvents.md deleted file mode 100644 index f550ef2..0000000 --- a/docs/WebhookEvents.md +++ /dev/null @@ -1,10 +0,0 @@ - -# WebhookEvents - - -* `"inventory.count.updated"` - -* `"catalog.version.updated"` - - - diff --git a/pom.xml b/pom.xml index 1ed00c3..40152a1 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ connect jar connect - 2.20191023.0 + 2.20191120.0 https://github.com/square/connect-java-sdk/ Java client library for the Square Connect API diff --git a/src/main/java/com/squareup/connect/ApiClient.java b/src/main/java/com/squareup/connect/ApiClient.java index 2806876..8da3c8b 100644 --- a/src/main/java/com/squareup/connect/ApiClient.java +++ b/src/main/java/com/squareup/connect/ApiClient.java @@ -74,7 +74,7 @@ public ApiClient() { this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("Square-Connect-Java/2.20191023.0"); + setUserAgent("Square-Connect-Java/2.20191120.0"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap(); diff --git a/src/main/java/com/squareup/connect/api/ApplePayApi.java b/src/main/java/com/squareup/connect/api/ApplePayApi.java index 105aa7c..c0a7c1c 100644 --- a/src/main/java/com/squareup/connect/api/ApplePayApi.java +++ b/src/main/java/com/squareup/connect/api/ApplePayApi.java @@ -38,7 +38,7 @@ public void setApiClient(ApiClient apiClient) { /** * RegisterDomain - * Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + * Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return RegisterDomainResponse * @throws ApiException if fails to make API call @@ -58,7 +58,7 @@ public RegisterDomainResponse registerDomain(RegisterDomainRequest body) throws List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -81,7 +81,7 @@ public RegisterDomainResponse registerDomain(RegisterDomainRequest body) throws /** * RegisterDomain - * Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + * Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse * @throws ApiException if fails to make API call @@ -101,7 +101,7 @@ public RegisterDomainResponse registerDomain(RegisterDomainRequest body) throws List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/CatalogApi.java b/src/main/java/com/squareup/connect/api/CatalogApi.java index 0b50b32..7403f84 100644 --- a/src/main/java/com/squareup/connect/api/CatalogApi.java +++ b/src/main/java/com/squareup/connect/api/CatalogApi.java @@ -74,7 +74,7 @@ public BatchDeleteCatalogObjectsResponse batchDeleteCatalogObjects(BatchDeleteCa List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -117,7 +117,7 @@ public BatchDeleteCatalogObjectsResponse batchDeleteCatalogObjects(BatchDeleteCa List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -158,7 +158,7 @@ public BatchRetrieveCatalogObjectsResponse batchRetrieveCatalogObjects(BatchRetr List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -201,7 +201,7 @@ public BatchRetrieveCatalogObjectsResponse batchRetrieveCatalogObjects(BatchRetr List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -242,7 +242,7 @@ public BatchUpsertCatalogObjectsResponse batchUpsertCatalogObjects(BatchUpsertCa List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -285,7 +285,7 @@ public BatchUpsertCatalogObjectsResponse batchUpsertCatalogObjects(BatchUpsertCa List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -320,7 +320,7 @@ public CatalogInfoResponse catalogInfo() throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -357,7 +357,7 @@ public CatalogInfoResponse catalogInfo() throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -379,7 +379,7 @@ public CatalogInfoResponse catalogInfo() throws ApiException { /** * 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. - * @param objectId The ID of the `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`. (required) + * @param objectId The ID of the catalog object 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 catalog item will delete its catalog item variations). (required) * @return DeleteCatalogObjectResponse * @throws ApiException if fails to make API call */ @@ -399,7 +399,7 @@ public DeleteCatalogObjectResponse deleteCatalogObject(String objectId) throws A List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -423,7 +423,7 @@ public DeleteCatalogObjectResponse deleteCatalogObject(String objectId) throws A /** * 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. - * @param objectId The ID of the `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`. (required) + * @param objectId The ID of the catalog object 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 catalog item will delete its catalog item variations). (required) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -443,7 +443,7 @@ public DeleteCatalogObjectResponse deleteCatalogObject(String objectId) throws A List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -466,7 +466,7 @@ public DeleteCatalogObjectResponse deleteCatalogObject(String objectId) throws A * 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`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects` to `true`. * @param cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) - * @param types An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) + * @param types An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) * @return ListCatalogResponse * @throws ApiException if fails to make API call */ @@ -480,7 +480,7 @@ public ListCatalogResponse listCatalog(String cursor, String types) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "types", types)); @@ -507,7 +507,7 @@ public ListCatalogResponse listCatalog(String cursor, String types) throws ApiEx * 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`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects` to `true`. * @param cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) - * @param types An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) + * @param types An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -521,7 +521,7 @@ public ListCatalogResponse listCatalog(String cursor, String types) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "types", types)); @@ -545,8 +545,8 @@ public ListCatalogResponse listCatalog(String cursor, String types) throws ApiEx /** * 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. - * @param objectId The object ID of any type of `CatalogObject`s to be retrieved. (required) - * @param includeRelatedObjects 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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` (optional) + * @param objectId The object ID of any type of catalog objects to be retrieved. (required) + * @param includeRelatedObjects 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, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) * @return RetrieveCatalogObjectResponse * @throws ApiException if fails to make API call */ @@ -566,7 +566,7 @@ public RetrieveCatalogObjectResponse retrieveCatalogObject(String objectId, Bool List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "include_related_objects", includeRelatedObjects)); @@ -591,8 +591,8 @@ public RetrieveCatalogObjectResponse retrieveCatalogObject(String objectId, Bool /** * 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. - * @param objectId The object ID of any type of `CatalogObject`s to be retrieved. (required) - * @param includeRelatedObjects 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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` (optional) + * @param objectId The object ID of any type of catalog objects to be retrieved. (required) + * @param includeRelatedObjects 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, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -612,7 +612,7 @@ public RetrieveCatalogObjectResponse retrieveCatalogObject(String objectId, Bool List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "include_related_objects", includeRelatedObjects)); @@ -634,7 +634,7 @@ public RetrieveCatalogObjectResponse retrieveCatalogObject(String objectId, Bool } /** * 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), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + * 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), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). -- -- Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return SearchCatalogObjectsResponse * @throws ApiException if fails to make API call @@ -654,7 +654,7 @@ public SearchCatalogObjectsResponse searchCatalogObjects(SearchCatalogObjectsReq List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -677,7 +677,7 @@ public SearchCatalogObjectsResponse searchCatalogObjects(SearchCatalogObjectsReq /** * 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), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + * 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), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). -- -- Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse * @throws ApiException if fails to make API call @@ -697,7 +697,7 @@ public SearchCatalogObjectsResponse searchCatalogObjects(SearchCatalogObjectsReq List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -738,7 +738,7 @@ public UpdateItemModifierListsResponse updateItemModifierLists(UpdateItemModifie List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -781,7 +781,7 @@ public UpdateItemModifierListsResponse updateItemModifierLists(UpdateItemModifie List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -822,7 +822,7 @@ public UpdateItemTaxesResponse updateItemTaxes(UpdateItemTaxesRequest body) thro List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -865,7 +865,7 @@ public UpdateItemTaxesResponse updateItemTaxes(UpdateItemTaxesRequest body) thro List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -906,7 +906,7 @@ public UpsertCatalogObjectResponse upsertCatalogObject(UpsertCatalogObjectReques List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -949,7 +949,7 @@ public UpsertCatalogObjectResponse upsertCatalogObject(UpsertCatalogObjectReques List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/CheckoutApi.java b/src/main/java/com/squareup/connect/api/CheckoutApi.java index 9f02197..139ba27 100644 --- a/src/main/java/com/squareup/connect/api/CheckoutApi.java +++ b/src/main/java/com/squareup/connect/api/CheckoutApi.java @@ -65,7 +65,7 @@ public CreateCheckoutResponse createCheckout(String locationId, CreateCheckoutRe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -115,7 +115,7 @@ public CreateCheckoutResponse createCheckout(String locationId, CreateCheckoutRe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/CustomersApi.java b/src/main/java/com/squareup/connect/api/CustomersApi.java index efee86d..3b21c27 100644 --- a/src/main/java/com/squareup/connect/api/CustomersApi.java +++ b/src/main/java/com/squareup/connect/api/CustomersApi.java @@ -68,7 +68,7 @@ public CreateCustomerResponse createCustomer(CreateCustomerRequest body) throws List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -111,7 +111,7 @@ public CreateCustomerResponse createCustomer(CreateCustomerRequest body) throws List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -132,7 +132,7 @@ public CreateCustomerResponse createCustomer(CreateCustomerRequest body) throws } /** * CreateCustomerCard - * Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + * Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. * @param customerId The Square ID of the customer profile the card is linked to. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CreateCustomerCardResponse @@ -159,7 +159,7 @@ public CreateCustomerCardResponse createCustomerCard(String customerId, CreateCu List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -182,7 +182,7 @@ public CreateCustomerCardResponse createCustomerCard(String customerId, CreateCu /** * CreateCustomerCard - * Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + * Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. * @param customerId The Square ID of the customer profile the card is linked to. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -209,7 +209,7 @@ public CreateCustomerCardResponse createCustomerCard(String customerId, CreateCu List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -251,7 +251,7 @@ public DeleteCustomerResponse deleteCustomer(String customerId) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -295,7 +295,7 @@ public DeleteCustomerResponse deleteCustomer(String customerId) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -344,7 +344,7 @@ public DeleteCustomerCardResponse deleteCustomerCard(String customerId, String c List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -395,7 +395,7 @@ public DeleteCustomerCardResponse deleteCustomerCard(String customerId, String c List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -417,9 +417,9 @@ public DeleteCustomerCardResponse deleteCustomerCard(String customerId, String c /** * ListCustomers * Lists a business's customers. - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) - * @param sortField Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - * @param sortOrder Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + * @param sortField Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + * @param sortOrder Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) * @return ListCustomersResponse * @throws ApiException if fails to make API call */ @@ -433,7 +433,7 @@ public ListCustomersResponse listCustomers(String cursor, String sortField, Stri List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_field", sortField)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -460,9 +460,9 @@ public ListCustomersResponse listCustomers(String cursor, String sortField, Stri /** * ListCustomers * Lists a business's customers. - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) - * @param sortField Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - * @param sortOrder Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + * @param sortField Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + * @param sortOrder Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -476,7 +476,7 @@ public ListCustomersResponse listCustomers(String cursor, String sortField, Stri List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_field", sortField)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -521,7 +521,7 @@ public RetrieveCustomerResponse retrieveCustomer(String customerId) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -565,7 +565,7 @@ public RetrieveCustomerResponse retrieveCustomer(String customerId) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -606,7 +606,7 @@ public SearchCustomersResponse searchCustomers(SearchCustomersRequest body) thro List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -649,7 +649,7 @@ public SearchCustomersResponse searchCustomers(SearchCustomersRequest body) thro List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -670,7 +670,7 @@ public SearchCustomersResponse searchCustomers(SearchCustomersRequest body) thro } /** * UpdateCustomer - * Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + * Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. * @param customerId The ID of the customer to update. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return UpdateCustomerResponse @@ -697,7 +697,7 @@ public UpdateCustomerResponse updateCustomer(String customerId, UpdateCustomerRe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -720,7 +720,7 @@ public UpdateCustomerResponse updateCustomer(String customerId, UpdateCustomerRe /** * UpdateCustomer - * Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + * Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. * @param customerId The ID of the customer to update. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -747,7 +747,7 @@ public UpdateCustomerResponse updateCustomer(String customerId, UpdateCustomerRe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/EmployeesApi.java b/src/main/java/com/squareup/connect/api/EmployeesApi.java index 23d7ee0..035f6ac 100644 --- a/src/main/java/com/squareup/connect/api/EmployeesApi.java +++ b/src/main/java/com/squareup/connect/api/EmployeesApi.java @@ -38,7 +38,7 @@ public void setApiClient(ApiClient apiClient) { /** * ListEmployees - * Gets a list of `Employee` objects for a business. + * * @param locationId Filter employees returned to only those that are associated with the specified location. (optional) * @param status Specifies the EmployeeStatus to filter the employee by. (optional) * @param limit The number of employees to be returned on each page. (optional) @@ -56,7 +56,7 @@ public ListEmployeesResponse listEmployees(String locationId, String status, Int List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_id", locationId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "status", status)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); @@ -83,7 +83,7 @@ public ListEmployeesResponse listEmployees(String locationId, String status, Int /** * ListEmployees - * Gets a list of `Employee` objects for a business. + * * @param locationId Filter employees returned to only those that are associated with the specified location. (optional) * @param status Specifies the EmployeeStatus to filter the employee by. (optional) * @param limit The number of employees to be returned on each page. (optional) @@ -101,7 +101,7 @@ public ListEmployeesResponse listEmployees(String locationId, String status, Int List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_id", locationId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "status", status)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); @@ -126,7 +126,7 @@ public ListEmployeesResponse listEmployees(String locationId, String status, Int } /** * RetrieveEmployee - * Gets an `Employee` by Square-assigned employee `ID` (UUID) + * * @param id UUID for the employee that was requested. (required) * @return RetrieveEmployeeResponse * @throws ApiException if fails to make API call @@ -147,7 +147,7 @@ public RetrieveEmployeeResponse retrieveEmployee(String id) throws ApiException List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -170,7 +170,7 @@ public RetrieveEmployeeResponse retrieveEmployee(String id) throws ApiException /** * RetrieveEmployee - * Gets an `Employee` by Square-assigned employee `ID` (UUID) + * * @param id UUID for the employee that was requested. (required) * @return CompleteResponse * @throws ApiException if fails to make API call @@ -191,7 +191,7 @@ public RetrieveEmployeeResponse retrieveEmployee(String id) throws ApiException List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/InventoryApi.java b/src/main/java/com/squareup/connect/api/InventoryApi.java index 6feb5d9..7d9bb99 100644 --- a/src/main/java/com/squareup/connect/api/InventoryApi.java +++ b/src/main/java/com/squareup/connect/api/InventoryApi.java @@ -66,7 +66,7 @@ public BatchChangeInventoryResponse batchChangeInventory(BatchChangeInventoryReq List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -109,7 +109,7 @@ public BatchChangeInventoryResponse batchChangeInventory(BatchChangeInventoryReq List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -150,7 +150,7 @@ public BatchRetrieveInventoryChangesResponse batchRetrieveInventoryChanges(Batch List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -193,7 +193,7 @@ public BatchRetrieveInventoryChangesResponse batchRetrieveInventoryChanges(Batch List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -234,7 +234,7 @@ public BatchRetrieveInventoryCountsResponse batchRetrieveInventoryCounts(BatchRe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -277,7 +277,7 @@ public BatchRetrieveInventoryCountsResponse batchRetrieveInventoryCounts(BatchRe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -319,7 +319,7 @@ public RetrieveInventoryAdjustmentResponse retrieveInventoryAdjustment(String ad List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -363,7 +363,7 @@ public RetrieveInventoryAdjustmentResponse retrieveInventoryAdjustment(String ad List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -387,7 +387,7 @@ public RetrieveInventoryAdjustmentResponse retrieveInventoryAdjustment(String ad * Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](#type-catalogobject) at the requested [Location](#type-location)s. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint is useful when displaying recent changes for a specific item. For more sophisticated queries, use a batch endpoint. * @param catalogObjectId ID of the `CatalogObject` to retrieve. (required) * @param locationIds The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) * @return RetrieveInventoryChangesResponse * @throws ApiException if fails to make API call */ @@ -407,7 +407,7 @@ public RetrieveInventoryChangesResponse retrieveInventoryChanges(String catalogO List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_ids", locationIds)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -435,7 +435,7 @@ public RetrieveInventoryChangesResponse retrieveInventoryChanges(String catalogO * Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](#type-catalogobject) at the requested [Location](#type-location)s. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint is useful when displaying recent changes for a specific item. For more sophisticated queries, use a batch endpoint. * @param catalogObjectId ID of the `CatalogObject` to retrieve. (required) * @param locationIds The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -455,7 +455,7 @@ public RetrieveInventoryChangesResponse retrieveInventoryChanges(String catalogO List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_ids", locationIds)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -481,7 +481,7 @@ public RetrieveInventoryChangesResponse retrieveInventoryChanges(String catalogO * Retrieves the current calculated stock count for a given [CatalogObject](#type-catalogobject) at a given set of [Location](#type-location)s. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint. * @param catalogObjectId ID of the `CatalogObject` to retrieve. (required) * @param locationIds The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) * @return RetrieveInventoryCountResponse * @throws ApiException if fails to make API call */ @@ -501,7 +501,7 @@ public RetrieveInventoryCountResponse retrieveInventoryCount(String catalogObjec List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_ids", locationIds)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -529,7 +529,7 @@ public RetrieveInventoryCountResponse retrieveInventoryCount(String catalogObjec * Retrieves the current calculated stock count for a given [CatalogObject](#type-catalogobject) at a given set of [Location](#type-location)s. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint. * @param catalogObjectId ID of the `CatalogObject` to retrieve. (required) * @param locationIds The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -549,7 +549,7 @@ public RetrieveInventoryCountResponse retrieveInventoryCount(String catalogObjec List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_ids", locationIds)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -593,7 +593,7 @@ public RetrieveInventoryPhysicalCountResponse retrieveInventoryPhysicalCount(Str List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -637,7 +637,7 @@ public RetrieveInventoryPhysicalCountResponse retrieveInventoryPhysicalCount(Str List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/LaborApi.java b/src/main/java/com/squareup/connect/api/LaborApi.java index 8f6b47d..647b842 100644 --- a/src/main/java/com/squareup/connect/api/LaborApi.java +++ b/src/main/java/com/squareup/connect/api/LaborApi.java @@ -76,7 +76,7 @@ public CreateBreakTypeResponse createBreakType(CreateBreakTypeRequest body) thro List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -119,7 +119,7 @@ public CreateBreakTypeResponse createBreakType(CreateBreakTypeRequest body) thro List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -160,7 +160,7 @@ public CreateShiftResponse createShift(CreateShiftRequest body) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -203,7 +203,7 @@ public CreateShiftResponse createShift(CreateShiftRequest body) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -245,7 +245,7 @@ public DeleteBreakTypeResponse deleteBreakType(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -289,7 +289,7 @@ public DeleteBreakTypeResponse deleteBreakType(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -331,7 +331,7 @@ public DeleteShiftResponse deleteShift(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -375,7 +375,7 @@ public DeleteShiftResponse deleteShift(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -417,7 +417,7 @@ public GetBreakTypeResponse getBreakType(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -461,7 +461,7 @@ public GetBreakTypeResponse getBreakType(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -503,7 +503,7 @@ public GetEmployeeWageResponse getEmployeeWage(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -547,7 +547,7 @@ public GetEmployeeWageResponse getEmployeeWage(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -589,7 +589,7 @@ public GetShiftResponse getShift(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -633,7 +633,7 @@ public GetShiftResponse getShift(String id) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -671,7 +671,7 @@ public ListBreakTypesResponse listBreakTypes(String locationId, Integer limit, S List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_id", locationId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -714,7 +714,7 @@ public ListBreakTypesResponse listBreakTypes(String locationId, Integer limit, S List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_id", locationId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -755,7 +755,7 @@ public ListEmployeeWagesResponse listEmployeeWages(String employeeId, Integer li List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "employee_id", employeeId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -798,7 +798,7 @@ public ListEmployeeWagesResponse listEmployeeWages(String employeeId, Integer li List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "employee_id", employeeId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -838,7 +838,7 @@ public ListWorkweekConfigsResponse listWorkweekConfigs(Integer limit, String cur List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -879,7 +879,7 @@ public ListWorkweekConfigsResponse listWorkweekConfigs(Integer limit, String cur List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -922,7 +922,7 @@ public SearchShiftsResponse searchShifts(SearchShiftsRequest body) throws ApiExc List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -965,7 +965,7 @@ public SearchShiftsResponse searchShifts(SearchShiftsRequest body) throws ApiExc List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1013,7 +1013,7 @@ public UpdateBreakTypeResponse updateBreakType(String id, UpdateBreakTypeRequest List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1063,7 +1063,7 @@ public UpdateBreakTypeResponse updateBreakType(String id, UpdateBreakTypeRequest List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1111,7 +1111,7 @@ public UpdateShiftResponse updateShift(String id, UpdateShiftRequest body) throw List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1161,7 +1161,7 @@ public UpdateShiftResponse updateShift(String id, UpdateShiftRequest body) throw List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1209,7 +1209,7 @@ public UpdateWorkweekConfigResponse updateWorkweekConfig(String id, UpdateWorkwe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1259,7 +1259,7 @@ public UpdateWorkweekConfigResponse updateWorkweekConfig(String id, UpdateWorkwe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/LocationsApi.java b/src/main/java/com/squareup/connect/api/LocationsApi.java index e808ed1..04f6ab1 100644 --- a/src/main/java/com/squareup/connect/api/LocationsApi.java +++ b/src/main/java/com/squareup/connect/api/LocationsApi.java @@ -8,6 +8,8 @@ import javax.ws.rs.core.GenericType; +import com.squareup.connect.models.CreateLocationRequest; +import com.squareup.connect.models.CreateLocationResponse; import com.squareup.connect.models.ListLocationsResponse; import com.squareup.connect.models.RetrieveLocationResponse; import com.squareup.connect.models.UpdateLocationRequest; @@ -38,9 +40,94 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * CreateLocation + * Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + * Note: This endpoint is in beta. + * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) + * @return CreateLocationResponse + * @throws ApiException if fails to make API call + */ + public CreateLocationResponse createLocation(CreateLocationRequest body) throws ApiException { + Object localVarPostBody = body; + + // verify the required parameter 'body' is set + if (body == null) { + throw new ApiException(400, "Missing the required parameter 'body' when calling createLocation"); + } + + // create path and map variables + String localVarPath = "/v2/locations"; + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarFormParams = new HashMap(); + localVarHeaderParams.put("Square-Version", "2019-11-20"); + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "oauth2" }; + + GenericType localVarReturnType = new GenericType() {}; + CompleteResponse completeResponse = (CompleteResponse)apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + return completeResponse.getData(); + } + + /** + * CreateLocation + * Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) + * @return CompleteResponse + * @throws ApiException if fails to make API call + */ + public CompleteResponsecreateLocationWithHttpInfo(CreateLocationRequest body) throws ApiException { + Object localVarPostBody = body; + + // verify the required parameter 'body' is set + if (body == null) { + throw new ApiException(400, "Missing the required parameter 'body' when calling createLocation"); + } + + // create path and map variables + String localVarPath = "/v2/locations"; + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarFormParams = new HashMap(); + localVarHeaderParams.put("Square-Version", "2019-11-20"); + + + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { "oauth2" }; + + GenericType localVarReturnType = new GenericType() {}; + return (CompleteResponse)apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + } /** * ListLocations - * Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + * Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. * @return ListLocationsResponse * @throws ApiException if fails to make API call */ @@ -54,7 +141,7 @@ public ListLocationsResponse listLocations() throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -77,7 +164,7 @@ public ListLocationsResponse listLocations() throws ApiException { /** * ListLocations - * Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + * Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -91,7 +178,7 @@ public ListLocationsResponse listLocations() throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -113,7 +200,6 @@ public ListLocationsResponse listLocations() throws ApiException { /** * RetrieveLocation * Retrieves details of a location. - * Note: This endpoint is in beta. * @param locationId The ID of the location to retrieve. (required) * @return RetrieveLocationResponse * @throws ApiException if fails to make API call @@ -134,7 +220,7 @@ public RetrieveLocationResponse retrieveLocation(String locationId) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -178,7 +264,7 @@ public RetrieveLocationResponse retrieveLocation(String locationId) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -199,7 +285,7 @@ public RetrieveLocationResponse retrieveLocation(String locationId) throws ApiEx } /** * UpdateLocation - * Updates the `Location` specified by the given ID. + * Updates a location. * Note: This endpoint is in beta. * @param locationId The ID of the location to update. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -227,7 +313,7 @@ public UpdateLocationResponse updateLocation(String locationId, UpdateLocationRe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -250,7 +336,7 @@ public UpdateLocationResponse updateLocation(String locationId, UpdateLocationRe /** * UpdateLocation - * Updates the `Location` specified by the given ID. + * Updates a location. * @param locationId The ID of the location to update. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -277,7 +363,7 @@ public UpdateLocationResponse updateLocation(String locationId, UpdateLocationRe List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/MerchantsApi.java b/src/main/java/com/squareup/connect/api/MerchantsApi.java index ca7cfcc..c5f5e9a 100644 --- a/src/main/java/com/squareup/connect/api/MerchantsApi.java +++ b/src/main/java/com/squareup/connect/api/MerchantsApi.java @@ -38,14 +38,14 @@ public void setApiClient(ApiClient apiClient) { /** * ListMerchants - * Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + * Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. * @param cursor The cursor generated by the previous response. (optional) * @return ListMerchantsResponse * @throws ApiException if fails to make API call */ public ListMerchantsResponse listMerchants(Integer cursor) throws ApiException { Object localVarPostBody = null; - + // create path and map variables String localVarPath = "/v2/merchants"; @@ -53,11 +53,11 @@ public ListMerchantsResponse listMerchants(Integer cursor) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); - - + + final String[] localVarAccepts = { "application/json" }; @@ -77,14 +77,14 @@ public ListMerchantsResponse listMerchants(Integer cursor) throws ApiException { /** * ListMerchants - * Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + * Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. * @param cursor The cursor generated by the previous response. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ public CompleteResponselistMerchantsWithHttpInfo(Integer cursor) throws ApiException { Object localVarPostBody = null; - + // create path and map variables String localVarPath = "/v2/merchants"; @@ -92,11 +92,11 @@ public ListMerchantsResponse listMerchants(Integer cursor) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); - - + + final String[] localVarAccepts = { "application/json" }; @@ -121,12 +121,12 @@ public ListMerchantsResponse listMerchants(Integer cursor) throws ApiException { */ public RetrieveMerchantResponse retrieveMerchant(String merchantId) throws ApiException { Object localVarPostBody = null; - + // verify the required parameter 'merchantId' is set if (merchantId == null) { throw new ApiException(400, "Missing the required parameter 'merchantId' when calling retrieveMerchant"); } - + // create path and map variables String localVarPath = "/v2/merchants/{merchant_id}" .replaceAll("\\{" + "merchant_id" + "\\}", apiClient.escapeString(merchantId.toString())); @@ -135,10 +135,10 @@ public RetrieveMerchantResponse retrieveMerchant(String merchantId) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); - - + localVarHeaderParams.put("Square-Version", "2019-11-20"); + + final String[] localVarAccepts = { "application/json" }; @@ -165,12 +165,12 @@ public RetrieveMerchantResponse retrieveMerchant(String merchantId) throws ApiEx */ public CompleteResponseretrieveMerchantWithHttpInfo(String merchantId) throws ApiException { Object localVarPostBody = null; - + // verify the required parameter 'merchantId' is set if (merchantId == null) { throw new ApiException(400, "Missing the required parameter 'merchantId' when calling retrieveMerchant"); } - + // create path and map variables String localVarPath = "/v2/merchants/{merchant_id}" .replaceAll("\\{" + "merchant_id" + "\\}", apiClient.escapeString(merchantId.toString())); @@ -179,10 +179,10 @@ public RetrieveMerchantResponse retrieveMerchant(String merchantId) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); - - + localVarHeaderParams.put("Square-Version", "2019-11-20"); + + final String[] localVarAccepts = { "application/json" }; diff --git a/src/main/java/com/squareup/connect/api/MobileAuthorizationApi.java b/src/main/java/com/squareup/connect/api/MobileAuthorizationApi.java index 1f3826b..432dd45 100644 --- a/src/main/java/com/squareup/connect/api/MobileAuthorizationApi.java +++ b/src/main/java/com/squareup/connect/api/MobileAuthorizationApi.java @@ -38,7 +38,7 @@ public void setApiClient(ApiClient apiClient) { /** * CreateMobileAuthorizationCode - * Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + * Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/docs/build-basics/access-tokens). * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CreateMobileAuthorizationCodeResponse * @throws ApiException if fails to make API call @@ -58,7 +58,7 @@ public CreateMobileAuthorizationCodeResponse createMobileAuthorizationCode(Creat List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -81,7 +81,7 @@ public CreateMobileAuthorizationCodeResponse createMobileAuthorizationCode(Creat /** * CreateMobileAuthorizationCode - * Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + * Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/docs/build-basics/access-tokens). * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse * @throws ApiException if fails to make API call @@ -101,7 +101,7 @@ public CreateMobileAuthorizationCodeResponse createMobileAuthorizationCode(Creat List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/OAuthApi.java b/src/main/java/com/squareup/connect/api/OAuthApi.java index f0e2194..502da24 100644 --- a/src/main/java/com/squareup/connect/api/OAuthApi.java +++ b/src/main/java/com/squareup/connect/api/OAuthApi.java @@ -42,7 +42,7 @@ public void setApiClient(ApiClient apiClient) { /** * ObtainToken - * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return ObtainTokenResponse * @throws ApiException if fails to make API call @@ -62,7 +62,7 @@ public ObtainTokenResponse obtainToken(ObtainTokenRequest body) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -85,7 +85,7 @@ public ObtainTokenResponse obtainToken(ObtainTokenRequest body) throws ApiExcept /** * ObtainToken - * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse * @throws ApiException if fails to make API call @@ -105,7 +105,7 @@ public ObtainTokenResponse obtainToken(ObtainTokenRequest body) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -126,8 +126,8 @@ public ObtainTokenResponse obtainToken(ObtainTokenRequest body) throws ApiExcept } /** * RenewToken - * `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). - * @param clientId Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). (required) + * `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + * @param clientId Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return RenewTokenResponse * @throws ApiException if fails to make API call @@ -154,7 +154,7 @@ public RenewTokenResponse renewToken(String clientId, RenewTokenRequest body) th List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -177,8 +177,8 @@ public RenewTokenResponse renewToken(String clientId, RenewTokenRequest body) th /** * RenewToken - * `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). - * @param clientId Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). (required) + * `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + * @param clientId Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse * @throws ApiException if fails to make API call @@ -204,7 +204,7 @@ public RenewTokenResponse renewToken(String clientId, RenewTokenRequest body) th List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -245,7 +245,7 @@ public RevokeTokenResponse revokeToken(RevokeTokenRequest body) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -288,7 +288,7 @@ public RevokeTokenResponse revokeToken(RevokeTokenRequest body) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/OrdersApi.java b/src/main/java/com/squareup/connect/api/OrdersApi.java index 4c065c0..ac63850 100644 --- a/src/main/java/com/squareup/connect/api/OrdersApi.java +++ b/src/main/java/com/squareup/connect/api/OrdersApi.java @@ -73,7 +73,7 @@ public BatchRetrieveOrdersResponse batchRetrieveOrders(String locationId, BatchR List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -123,7 +123,7 @@ public BatchRetrieveOrdersResponse batchRetrieveOrders(String locationId, BatchR List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -171,7 +171,7 @@ public CreateOrderResponse createOrder(String locationId, CreateOrderRequest bod List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -221,7 +221,7 @@ public CreateOrderResponse createOrder(String locationId, CreateOrderRequest bod List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -270,7 +270,7 @@ public PayOrderResponse payOrder(String orderId, PayOrderRequest body) throws Ap List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -320,7 +320,7 @@ public PayOrderResponse payOrder(String orderId, PayOrderRequest body) throws Ap List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -361,7 +361,7 @@ public SearchOrdersResponse searchOrders(SearchOrdersRequest body) throws ApiExc List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -404,7 +404,7 @@ public SearchOrdersResponse searchOrders(SearchOrdersRequest body) throws ApiExc List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -460,7 +460,7 @@ public UpdateOrderResponse updateOrder(String locationId, String orderId, Update List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -517,7 +517,7 @@ public UpdateOrderResponse updateOrder(String locationId, String orderId, Update List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/PaymentsApi.java b/src/main/java/com/squareup/connect/api/PaymentsApi.java index bc2f394..788d32c 100644 --- a/src/main/java/com/squareup/connect/api/PaymentsApi.java +++ b/src/main/java/com/squareup/connect/api/PaymentsApi.java @@ -44,7 +44,7 @@ public void setApiClient(ApiClient apiClient) { /** * CancelPayment - * Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + * Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). * @param paymentId `payment_id` identifying the payment to be canceled. (required) * @return CancelPaymentResponse * @throws ApiException if fails to make API call @@ -65,7 +65,7 @@ public CancelPaymentResponse cancelPayment(String paymentId) throws ApiException List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -88,7 +88,7 @@ public CancelPaymentResponse cancelPayment(String paymentId) throws ApiException /** * CancelPayment - * Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + * Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). * @param paymentId `payment_id` identifying the payment to be canceled. (required) * @return CompleteResponse * @throws ApiException if fails to make API call @@ -109,7 +109,7 @@ public CancelPaymentResponse cancelPayment(String paymentId) throws ApiException List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -130,7 +130,7 @@ public CancelPaymentResponse cancelPayment(String paymentId) throws ApiException } /** * CancelPaymentByIdempotencyKey - * Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + * Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CancelPaymentByIdempotencyKeyResponse * @throws ApiException if fails to make API call @@ -150,7 +150,7 @@ public CancelPaymentByIdempotencyKeyResponse cancelPaymentByIdempotencyKey(Cance List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -173,7 +173,7 @@ public CancelPaymentByIdempotencyKeyResponse cancelPaymentByIdempotencyKey(Cance /** * CancelPaymentByIdempotencyKey - * Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + * Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse * @throws ApiException if fails to make API call @@ -193,7 +193,7 @@ public CancelPaymentByIdempotencyKeyResponse cancelPaymentByIdempotencyKey(Cance List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -235,7 +235,7 @@ public CompletePaymentResponse completePayment(String paymentId) throws ApiExcep List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -279,7 +279,7 @@ public CompletePaymentResponse completePayment(String paymentId) throws ApiExcep List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -320,7 +320,7 @@ public CreatePaymentResponse createPayment(CreatePaymentRequest body) throws Api List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -363,7 +363,7 @@ public CreatePaymentResponse createPayment(CreatePaymentRequest body) throws Api List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -405,7 +405,7 @@ public GetPaymentResponse getPayment(String paymentId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -449,7 +449,7 @@ public GetPaymentResponse getPayment(String paymentId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -492,7 +492,7 @@ public ListPaymentsResponse listPayments(String beginTime, String endTime, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -545,7 +545,7 @@ public ListPaymentsResponse listPayments(String beginTime, String endTime, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); diff --git a/src/main/java/com/squareup/connect/api/RefundsApi.java b/src/main/java/com/squareup/connect/api/RefundsApi.java index a96f760..51e6f16 100644 --- a/src/main/java/com/squareup/connect/api/RefundsApi.java +++ b/src/main/java/com/squareup/connect/api/RefundsApi.java @@ -61,7 +61,7 @@ public GetPaymentRefundResponse getPaymentRefund(String refundId) throws ApiExce List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -105,7 +105,7 @@ public GetPaymentRefundResponse getPaymentRefund(String refundId) throws ApiExce List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -132,8 +132,8 @@ public GetPaymentRefundResponse getPaymentRefund(String refundId) throws ApiExce * @param sortOrder The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) * @param locationId ID of location associated with payment. (optional) - * @param status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. (optional) - * @param sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. (optional) + * @param status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. (optional) + * @param sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. (optional) * @return ListPaymentRefundsResponse * @throws ApiException if fails to make API call */ @@ -147,7 +147,7 @@ public ListPaymentRefundsResponse listPaymentRefunds(String beginTime, String en List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -183,8 +183,8 @@ public ListPaymentRefundsResponse listPaymentRefunds(String beginTime, String en * @param sortOrder The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) * @param locationId ID of location associated with payment. (optional) - * @param status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. (optional) - * @param sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. (optional) + * @param status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. (optional) + * @param sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -198,7 +198,7 @@ public ListPaymentRefundsResponse listPaymentRefunds(String beginTime, String en List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -246,7 +246,7 @@ public RefundPaymentResponse refundPayment(RefundPaymentRequest body) throws Api List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -289,7 +289,7 @@ public RefundPaymentResponse refundPayment(RefundPaymentRequest body) throws Api List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/ReportingApi.java b/src/main/java/com/squareup/connect/api/ReportingApi.java index 095b613..cc5322a 100644 --- a/src/main/java/com/squareup/connect/api/ReportingApi.java +++ b/src/main/java/com/squareup/connect/api/ReportingApi.java @@ -43,7 +43,7 @@ public void setApiClient(ApiClient apiClient) { * @param beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. (optional) * @param endTime The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. (optional) * @param sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) * @return ListAdditionalRecipientReceivableRefundsResponse * @throws ApiException if fails to make API call */ @@ -64,7 +64,7 @@ public ListAdditionalRecipientReceivableRefundsResponse listAdditionalRecipientR List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -96,7 +96,7 @@ public ListAdditionalRecipientReceivableRefundsResponse listAdditionalRecipientR * @param beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. (optional) * @param endTime The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. (optional) * @param sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -116,7 +116,7 @@ public ListAdditionalRecipientReceivableRefundsResponse listAdditionalRecipientR List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -146,7 +146,7 @@ public ListAdditionalRecipientReceivableRefundsResponse listAdditionalRecipientR * @param beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. (optional) * @param endTime The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. (optional) * @param sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) * @return ListAdditionalRecipientReceivablesResponse * @throws ApiException if fails to make API call */ @@ -167,7 +167,7 @@ public ListAdditionalRecipientReceivablesResponse listAdditionalRecipientReceiva List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -199,7 +199,7 @@ public ListAdditionalRecipientReceivablesResponse listAdditionalRecipientReceiva * @param beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. (optional) * @param endTime The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. (optional) * @param sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -219,7 +219,7 @@ public ListAdditionalRecipientReceivablesResponse listAdditionalRecipientReceiva List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); diff --git a/src/main/java/com/squareup/connect/api/TransactionsApi.java b/src/main/java/com/squareup/connect/api/TransactionsApi.java index d152c6c..1e91867 100644 --- a/src/main/java/com/squareup/connect/api/TransactionsApi.java +++ b/src/main/java/com/squareup/connect/api/TransactionsApi.java @@ -45,7 +45,7 @@ public void setApiClient(ApiClient apiClient) { /** * CaptureTransaction - * Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + * Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. * @param locationId (required) * @param transactionId (required) * @return CaptureTransactionResponse @@ -74,7 +74,7 @@ public CaptureTransactionResponse captureTransaction(String locationId, String t List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -97,7 +97,7 @@ public CaptureTransactionResponse captureTransaction(String locationId, String t /** * CaptureTransaction - * Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + * Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. * @param locationId (required) * @param transactionId (required) * @return CompleteResponse @@ -125,7 +125,7 @@ public CaptureTransactionResponse captureTransaction(String locationId, String t List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -146,7 +146,7 @@ public CaptureTransactionResponse captureTransaction(String locationId, String t } /** * Charge - * Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + * Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. * @param locationId The ID of the location to associate the created transaction with. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return ChargeResponse @@ -174,7 +174,7 @@ public ChargeResponse charge(String locationId, ChargeRequest body) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -197,7 +197,7 @@ public ChargeResponse charge(String locationId, ChargeRequest body) throws ApiEx /** * Charge - * Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + * Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. * @param locationId The ID of the location to associate the created transaction with. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -224,7 +224,7 @@ public ChargeResponse charge(String locationId, ChargeRequest body) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -280,7 +280,7 @@ public CreateRefundResponse createRefund(String locationId, String transactionId List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -337,7 +337,7 @@ public CreateRefundResponse createRefund(String locationId, String transactionId List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -363,7 +363,7 @@ public CreateRefundResponse createRefund(String locationId, String transactionId * @param beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. (optional) * @param endTime The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. (optional) * @param sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) * @return ListRefundsResponse * @throws ApiException if fails to make API call */ @@ -384,7 +384,7 @@ public ListRefundsResponse listRefunds(String locationId, String beginTime, Stri List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -416,7 +416,7 @@ public ListRefundsResponse listRefunds(String locationId, String beginTime, Stri * @param beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. (optional) * @param endTime The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. (optional) * @param sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -436,7 +436,7 @@ public ListRefundsResponse listRefunds(String locationId, String beginTime, Stri List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -466,7 +466,7 @@ public ListRefundsResponse listRefunds(String locationId, String beginTime, Stri * @param beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. (optional) * @param endTime The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. (optional) * @param sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) * @return ListTransactionsResponse * @throws ApiException if fails to make API call */ @@ -487,7 +487,7 @@ public ListTransactionsResponse listTransactions(String locationId, String begin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -519,7 +519,7 @@ public ListTransactionsResponse listTransactions(String locationId, String begin * @param beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. (optional) * @param endTime The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. (optional) * @param sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) + * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -539,7 +539,7 @@ public ListTransactionsResponse listTransactions(String locationId, String begin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -593,7 +593,7 @@ public RetrieveTransactionResponse retrieveTransaction(String locationId, String List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -644,7 +644,7 @@ public RetrieveTransactionResponse retrieveTransaction(String locationId, String List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -665,7 +665,7 @@ public RetrieveTransactionResponse retrieveTransaction(String locationId, String } /** * VoidTransaction - * Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + * Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. * @param locationId (required) * @param transactionId (required) * @return VoidTransactionResponse @@ -694,7 +694,7 @@ public VoidTransactionResponse voidTransaction(String locationId, String transac List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -717,7 +717,7 @@ public VoidTransactionResponse voidTransaction(String locationId, String transac /** * VoidTransaction - * Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + * Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. * @param locationId (required) * @param transactionId (required) * @return CompleteResponse @@ -745,7 +745,7 @@ public VoidTransactionResponse voidTransaction(String locationId, String transac List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/V1EmployeesApi.java b/src/main/java/com/squareup/connect/api/V1EmployeesApi.java index 71850cc..b974f44 100644 --- a/src/main/java/com/squareup/connect/api/V1EmployeesApi.java +++ b/src/main/java/com/squareup/connect/api/V1EmployeesApi.java @@ -61,7 +61,7 @@ public V1Employee createEmployee(V1Employee body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -104,7 +104,7 @@ public V1Employee createEmployee(V1Employee body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -145,7 +145,7 @@ public V1EmployeeRole createEmployeeRole(V1EmployeeRole employeeRole) throws Api List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -188,7 +188,7 @@ public V1EmployeeRole createEmployeeRole(V1EmployeeRole employeeRole) throws Api List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -229,7 +229,7 @@ public V1Timecard createTimecard(V1Timecard body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -272,7 +272,7 @@ public V1Timecard createTimecard(V1Timecard body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -314,7 +314,7 @@ public Object deleteTimecard(String timecardId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -358,7 +358,7 @@ public Object deleteTimecard(String timecardId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -403,7 +403,7 @@ public List listCashDrawerShifts(String locationId, String or List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -453,7 +453,7 @@ public List listCashDrawerShifts(String locationId, String or List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -494,7 +494,7 @@ public List listEmployeeRoles(String order, Integer limit, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -537,7 +537,7 @@ public List listEmployeeRoles(String order, Integer limit, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -584,7 +584,7 @@ public List listEmployees(String order, String beginUpdatedAt, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_updated_at", beginUpdatedAt)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_updated_at", endUpdatedAt)); @@ -639,7 +639,7 @@ public List listEmployees(String order, String beginUpdatedAt, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_updated_at", beginUpdatedAt)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_updated_at", endUpdatedAt)); @@ -690,7 +690,7 @@ public List listTimecardEvents(String timecardId) throws ApiExc List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -734,7 +734,7 @@ public List listTimecardEvents(String timecardId) throws ApiExc List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -780,7 +780,7 @@ public List listTimecards(String order, String employeeId, String be List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "employee_id", employeeId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_clockin_time", beginClockinTime)); @@ -839,7 +839,7 @@ public List listTimecards(String order, String employeeId, String be List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "employee_id", employeeId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_clockin_time", beginClockinTime)); @@ -899,7 +899,7 @@ public V1CashDrawerShift retrieveCashDrawerShift(String locationId, String shift List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -950,7 +950,7 @@ public V1CashDrawerShift retrieveCashDrawerShift(String locationId, String shift List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -992,7 +992,7 @@ public V1Employee retrieveEmployee(String employeeId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1036,7 +1036,7 @@ public V1Employee retrieveEmployee(String employeeId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1078,7 +1078,7 @@ public V1EmployeeRole retrieveEmployeeRole(String roleId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1122,7 +1122,7 @@ public V1EmployeeRole retrieveEmployeeRole(String roleId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1164,7 +1164,7 @@ public V1Timecard retrieveTimecard(String timecardId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1208,7 +1208,7 @@ public V1Timecard retrieveTimecard(String timecardId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1256,7 +1256,7 @@ public V1Employee updateEmployee(String employeeId, V1Employee body) throws ApiE List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1306,7 +1306,7 @@ public V1Employee updateEmployee(String employeeId, V1Employee body) throws ApiE List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1354,7 +1354,7 @@ public V1EmployeeRole updateEmployeeRole(String roleId, V1EmployeeRole body) thr List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1404,7 +1404,7 @@ public V1EmployeeRole updateEmployeeRole(String roleId, V1EmployeeRole body) thr List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1452,7 +1452,7 @@ public V1Timecard updateTimecard(String timecardId, V1Timecard body) throws ApiE List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1502,7 +1502,7 @@ public V1Timecard updateTimecard(String timecardId, V1Timecard body) throws ApiE List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/V1ItemsApi.java b/src/main/java/com/squareup/connect/api/V1ItemsApi.java index cb3056e..662d71c 100644 --- a/src/main/java/com/squareup/connect/api/V1ItemsApi.java +++ b/src/main/java/com/squareup/connect/api/V1ItemsApi.java @@ -48,13 +48,14 @@ public void setApiClient(ApiClient apiClient) { /** * AdjustInventory - * Adjusts an item variation's current available inventory. + * Adjusts the current available inventory of an item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param variationId The ID of the variation to adjust inventory information for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1InventoryEntry * @throws ApiException if fails to make API call */ + @Deprecated public V1InventoryEntry adjustInventory(String locationId, String variationId, V1AdjustInventoryRequest body) throws ApiException { Object localVarPostBody = body; @@ -82,7 +83,7 @@ public V1InventoryEntry adjustInventory(String locationId, String variationId, V List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -105,7 +106,7 @@ public V1InventoryEntry adjustInventory(String locationId, String variationId, V /** * AdjustInventory - * Adjusts an item variation's current available inventory. + * Adjusts the current available inventory of an item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param variationId The ID of the variation to adjust inventory information for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -139,7 +140,7 @@ public V1InventoryEntry adjustInventory(String locationId, String variationId, V List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -160,13 +161,14 @@ public V1InventoryEntry adjustInventory(String locationId, String variationId, V } /** * ApplyFee - * Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + * Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the fee's associated location. (required) * @param itemId The ID of the item to add the fee to. (required) * @param feeId The ID of the fee to apply. (required) * @return V1Item * @throws ApiException if fails to make API call */ + @Deprecated public V1Item applyFee(String locationId, String itemId, String feeId) throws ApiException { Object localVarPostBody = null; @@ -195,7 +197,7 @@ public V1Item applyFee(String locationId, String itemId, String feeId) throws Ap List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -218,7 +220,7 @@ public V1Item applyFee(String locationId, String itemId, String feeId) throws Ap /** * ApplyFee - * Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + * Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the fee's associated location. (required) * @param itemId The ID of the item to add the fee to. (required) * @param feeId The ID of the fee to apply. (required) @@ -253,7 +255,7 @@ public V1Item applyFee(String locationId, String itemId, String feeId) throws Ap List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -274,13 +276,14 @@ public V1Item applyFee(String locationId, String itemId, String feeId) throws Ap } /** * ApplyModifierList - * Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + * Associates a modifier list with an item so the associated modifier options can be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to apply. (required) * @param itemId The ID of the item to add the modifier list to. (required) * @return V1Item * @throws ApiException if fails to make API call */ + @Deprecated public V1Item applyModifierList(String locationId, String modifierListId, String itemId) throws ApiException { Object localVarPostBody = null; @@ -309,7 +312,7 @@ public V1Item applyModifierList(String locationId, String modifierListId, String List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -332,7 +335,7 @@ public V1Item applyModifierList(String locationId, String modifierListId, String /** * ApplyModifierList - * Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + * Associates a modifier list with an item so the associated modifier options can be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to apply. (required) * @param itemId The ID of the item to add the modifier list to. (required) @@ -367,7 +370,7 @@ public V1Item applyModifierList(String locationId, String modifierListId, String List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -388,12 +391,13 @@ public V1Item applyModifierList(String locationId, String modifierListId, String } /** * CreateCategory - * Creates an item category. + * Creates an item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create an item for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Category * @throws ApiException if fails to make API call */ + @Deprecated public V1Category createCategory(String locationId, V1Category body) throws ApiException { Object localVarPostBody = body; @@ -415,7 +419,7 @@ public V1Category createCategory(String locationId, V1Category body) throws ApiE List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -438,7 +442,7 @@ public V1Category createCategory(String locationId, V1Category body) throws ApiE /** * CreateCategory - * Creates an item category. + * Creates an item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create an item for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -465,7 +469,7 @@ public V1Category createCategory(String locationId, V1Category body) throws ApiE List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -486,12 +490,13 @@ public V1Category createCategory(String locationId, V1Category body) throws ApiE } /** * CreateDiscount - * Creates a discount. + * Creates a discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create an item for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Discount * @throws ApiException if fails to make API call */ + @Deprecated public V1Discount createDiscount(String locationId, V1Discount body) throws ApiException { Object localVarPostBody = body; @@ -513,7 +518,7 @@ public V1Discount createDiscount(String locationId, V1Discount body) throws ApiE List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -536,7 +541,7 @@ public V1Discount createDiscount(String locationId, V1Discount body) throws ApiE /** * CreateDiscount - * Creates a discount. + * Creates a discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create an item for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -563,7 +568,7 @@ public V1Discount createDiscount(String locationId, V1Discount body) throws ApiE List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -584,12 +589,13 @@ public V1Discount createDiscount(String locationId, V1Discount body) throws ApiE } /** * CreateFee - * Creates a fee (tax). + * Creates a fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create a fee for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Fee * @throws ApiException if fails to make API call */ + @Deprecated public V1Fee createFee(String locationId, V1Fee body) throws ApiException { Object localVarPostBody = body; @@ -611,7 +617,7 @@ public V1Fee createFee(String locationId, V1Fee body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -634,7 +640,7 @@ public V1Fee createFee(String locationId, V1Fee body) throws ApiException { /** * CreateFee - * Creates a fee (tax). + * Creates a fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create a fee for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -661,7 +667,7 @@ public V1Fee createFee(String locationId, V1Fee body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -682,12 +688,13 @@ public V1Fee createFee(String locationId, V1Fee body) throws ApiException { } /** * CreateItem - * 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. + * Creates an item and at least one variation for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- 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 `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. * @param locationId The ID of the location to create an item for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Item * @throws ApiException if fails to make API call */ + @Deprecated public V1Item createItem(String locationId, V1Item body) throws ApiException { Object localVarPostBody = body; @@ -709,7 +716,7 @@ public V1Item createItem(String locationId, V1Item body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -732,7 +739,7 @@ public V1Item createItem(String locationId, V1Item body) throws ApiException { /** * CreateItem - * 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. + * Creates an item and at least one variation for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- 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 `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. * @param locationId The ID of the location to create an item for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -759,7 +766,7 @@ public V1Item createItem(String locationId, V1Item body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -780,12 +787,13 @@ public V1Item createItem(String locationId, V1Item body) throws ApiException { } /** * CreateModifierList - * Creates an item modifier list and at least one modifier option for it. + * Creates an item modifier list and at least 1 modifier option for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create a modifier list for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1ModifierList * @throws ApiException if fails to make API call */ + @Deprecated public V1ModifierList createModifierList(String locationId, V1ModifierList body) throws ApiException { Object localVarPostBody = body; @@ -807,7 +815,7 @@ public V1ModifierList createModifierList(String locationId, V1ModifierList body) List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -830,7 +838,7 @@ public V1ModifierList createModifierList(String locationId, V1ModifierList body) /** * CreateModifierList - * Creates an item modifier list and at least one modifier option for it. + * Creates an item modifier list and at least 1 modifier option for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create a modifier list for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -857,7 +865,7 @@ public V1ModifierList createModifierList(String locationId, V1ModifierList body) List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -878,13 +886,14 @@ public V1ModifierList createModifierList(String locationId, V1ModifierList body) } /** * CreateModifierOption - * Creates an item modifier option and adds it to a modifier list. + * Creates an item modifier option and adds it to a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1ModifierOption * @throws ApiException if fails to make API call */ + @Deprecated public V1ModifierOption createModifierOption(String locationId, String modifierListId, V1ModifierOption body) throws ApiException { Object localVarPostBody = body; @@ -912,7 +921,7 @@ public V1ModifierOption createModifierOption(String locationId, String modifierL List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -935,7 +944,7 @@ public V1ModifierOption createModifierOption(String locationId, String modifierL /** * CreateModifierOption - * Creates an item modifier option and adds it to a modifier list. + * Creates an item modifier option and adds it to a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -969,7 +978,7 @@ public V1ModifierOption createModifierOption(String locationId, String modifierL List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -990,12 +999,13 @@ public V1ModifierOption createModifierOption(String locationId, String modifierL } /** * CreatePage - * Creates a Favorites page in Square Register. + * Creates a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create an item for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Page * @throws ApiException if fails to make API call */ + @Deprecated public V1Page createPage(String locationId, V1Page body) throws ApiException { Object localVarPostBody = body; @@ -1017,7 +1027,7 @@ public V1Page createPage(String locationId, V1Page body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1040,7 +1050,7 @@ public V1Page createPage(String locationId, V1Page body) throws ApiException { /** * CreatePage - * Creates a Favorites page in Square Register. + * Creates a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to create an item for. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return CompleteResponse @@ -1067,7 +1077,7 @@ public V1Page createPage(String locationId, V1Page body) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1088,13 +1098,14 @@ public V1Page createPage(String locationId, V1Page body) throws ApiException { } /** * CreateVariation - * Creates an item variation for an existing item. + * Creates an item variation for an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param itemId The item's ID. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Variation * @throws ApiException if fails to make API call */ + @Deprecated public V1Variation createVariation(String locationId, String itemId, V1Variation body) throws ApiException { Object localVarPostBody = body; @@ -1122,7 +1133,7 @@ public V1Variation createVariation(String locationId, String itemId, V1Variation List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1145,7 +1156,7 @@ public V1Variation createVariation(String locationId, String itemId, V1Variation /** * CreateVariation - * Creates an item variation for an existing item. + * Creates an item variation for an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param itemId The item's ID. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -1179,7 +1190,7 @@ public V1Variation createVariation(String locationId, String itemId, V1Variation List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1200,12 +1211,13 @@ public V1Variation createVariation(String locationId, String itemId, V1Variation } /** * DeleteCategory - * 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. + * Deletes an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param categoryId The ID of the category to delete. (required) * @return V1Category * @throws ApiException if fails to make API call */ + @Deprecated public V1Category deleteCategory(String locationId, String categoryId) throws ApiException { Object localVarPostBody = null; @@ -1228,7 +1240,7 @@ public V1Category deleteCategory(String locationId, String categoryId) throws Ap List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1251,7 +1263,7 @@ public V1Category deleteCategory(String locationId, String categoryId) throws Ap /** * DeleteCategory - * 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. + * Deletes an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param categoryId The ID of the category to delete. (required) * @return CompleteResponse @@ -1279,7 +1291,7 @@ public V1Category deleteCategory(String locationId, String categoryId) throws Ap List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1300,12 +1312,13 @@ public V1Category deleteCategory(String locationId, String categoryId) throws Ap } /** * DeleteDiscount - * 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. + * Deletes an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param discountId The ID of the discount to delete. (required) * @return V1Discount * @throws ApiException if fails to make API call */ + @Deprecated public V1Discount deleteDiscount(String locationId, String discountId) throws ApiException { Object localVarPostBody = null; @@ -1328,7 +1341,7 @@ public V1Discount deleteDiscount(String locationId, String discountId) throws Ap List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1351,7 +1364,7 @@ public V1Discount deleteDiscount(String locationId, String discountId) throws Ap /** * DeleteDiscount - * 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. + * Deletes an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param discountId The ID of the discount to delete. (required) * @return CompleteResponse @@ -1379,7 +1392,7 @@ public V1Discount deleteDiscount(String locationId, String discountId) throws Ap List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1400,12 +1413,13 @@ public V1Discount deleteDiscount(String locationId, String discountId) throws Ap } /** * DeleteFee - * 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. + * Deletes an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. * @param locationId The ID of the fee's associated location. (required) * @param feeId The ID of the fee to delete. (required) * @return V1Fee * @throws ApiException if fails to make API call */ + @Deprecated public V1Fee deleteFee(String locationId, String feeId) throws ApiException { Object localVarPostBody = null; @@ -1428,7 +1442,7 @@ public V1Fee deleteFee(String locationId, String feeId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1451,7 +1465,7 @@ public V1Fee deleteFee(String locationId, String feeId) throws ApiException { /** * DeleteFee - * 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. + * Deletes an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. * @param locationId The ID of the fee's associated location. (required) * @param feeId The ID of the fee to delete. (required) * @return CompleteResponse @@ -1479,7 +1493,7 @@ public V1Fee deleteFee(String locationId, String feeId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1500,12 +1514,13 @@ public V1Fee deleteFee(String locationId, String feeId) throws ApiException { } /** * DeleteItem - * 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. + * Deletes an existing item and all item variations associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param itemId The ID of the item to modify. (required) * @return V1Item * @throws ApiException if fails to make API call */ + @Deprecated public V1Item deleteItem(String locationId, String itemId) throws ApiException { Object localVarPostBody = null; @@ -1528,7 +1543,7 @@ public V1Item deleteItem(String locationId, String itemId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1551,7 +1566,7 @@ public V1Item deleteItem(String locationId, String itemId) throws ApiException { /** * DeleteItem - * 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. + * Deletes an existing item and all item variations associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param itemId The ID of the item to modify. (required) * @return CompleteResponse @@ -1579,7 +1594,7 @@ public V1Item deleteItem(String locationId, String itemId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1600,12 +1615,13 @@ public V1Item deleteItem(String locationId, String itemId) throws ApiException { } /** * DeleteModifierList - * 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. + * Deletes an existing item modifier list and all modifier options associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to delete. (required) * @return V1ModifierList * @throws ApiException if fails to make API call */ + @Deprecated public V1ModifierList deleteModifierList(String locationId, String modifierListId) throws ApiException { Object localVarPostBody = null; @@ -1628,7 +1644,7 @@ public V1ModifierList deleteModifierList(String locationId, String modifierListI List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1651,7 +1667,7 @@ public V1ModifierList deleteModifierList(String locationId, String modifierListI /** * DeleteModifierList - * 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. + * Deletes an existing item modifier list and all modifier options associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to delete. (required) * @return CompleteResponse @@ -1679,7 +1695,7 @@ public V1ModifierList deleteModifierList(String locationId, String modifierListI List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1700,13 +1716,14 @@ public V1ModifierList deleteModifierList(String locationId, String modifierListI } /** * DeleteModifierOption - * 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. + * Deletes an existing item modifier option from a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to delete. (required) * @param modifierOptionId The ID of the modifier list to edit. (required) * @return V1ModifierOption * @throws ApiException if fails to make API call */ + @Deprecated public V1ModifierOption deleteModifierOption(String locationId, String modifierListId, String modifierOptionId) throws ApiException { Object localVarPostBody = null; @@ -1735,7 +1752,7 @@ public V1ModifierOption deleteModifierOption(String locationId, String modifierL List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1758,7 +1775,7 @@ public V1ModifierOption deleteModifierOption(String locationId, String modifierL /** * DeleteModifierOption - * 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. + * Deletes an existing item modifier option from a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to delete. (required) * @param modifierOptionId The ID of the modifier list to edit. (required) @@ -1793,7 +1810,7 @@ public V1ModifierOption deleteModifierOption(String locationId, String modifierL List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1814,12 +1831,13 @@ public V1ModifierOption deleteModifierOption(String locationId, String modifierL } /** * DeletePage - * 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. + * Deletes an existing Favorites page and all of its cells. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. * @param locationId The ID of the Favorites page's associated location. (required) * @param pageId The ID of the page to delete. (required) * @return V1Page * @throws ApiException if fails to make API call */ + @Deprecated public V1Page deletePage(String locationId, String pageId) throws ApiException { Object localVarPostBody = null; @@ -1842,7 +1860,7 @@ public V1Page deletePage(String locationId, String pageId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1865,7 +1883,7 @@ public V1Page deletePage(String locationId, String pageId) throws ApiException { /** * DeletePage - * 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. + * Deletes an existing Favorites page and all of its cells. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. * @param locationId The ID of the Favorites page's associated location. (required) * @param pageId The ID of the page to delete. (required) * @return CompleteResponse @@ -1893,7 +1911,7 @@ public V1Page deletePage(String locationId, String pageId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1914,7 +1932,7 @@ public V1Page deletePage(String locationId, String pageId) throws ApiException { } /** * DeletePageCell - * 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. + * Deletes a cell from a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. * @param locationId The ID of the Favorites page's associated location. (required) * @param pageId The ID of the page to delete. (required) * @param row The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row. (optional) @@ -1922,6 +1940,7 @@ public V1Page deletePage(String locationId, String pageId) throws ApiException { * @return V1Page * @throws ApiException if fails to make API call */ + @Deprecated public V1Page deletePageCell(String locationId, String pageId, String row, String column) throws ApiException { Object localVarPostBody = null; @@ -1944,7 +1963,7 @@ public V1Page deletePageCell(String locationId, String pageId, String row, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "row", row)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "column", column)); @@ -1969,7 +1988,7 @@ public V1Page deletePageCell(String locationId, String pageId, String row, Strin /** * DeletePageCell - * 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. + * Deletes a cell from a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. * @param locationId The ID of the Favorites page's associated location. (required) * @param pageId The ID of the page to delete. (required) * @param row The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row. (optional) @@ -1999,7 +2018,7 @@ public V1Page deletePageCell(String locationId, String pageId, String row, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "row", row)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "column", column)); @@ -2022,13 +2041,14 @@ public V1Page deletePageCell(String locationId, String pageId, String row, Strin } /** * DeleteVariation - * 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. + * Deletes an existing item variation from an item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param itemId The ID of the item to delete. (required) * @param variationId The ID of the variation to delete. (required) * @return V1Variation * @throws ApiException if fails to make API call */ + @Deprecated public V1Variation deleteVariation(String locationId, String itemId, String variationId) throws ApiException { Object localVarPostBody = null; @@ -2057,7 +2077,7 @@ public V1Variation deleteVariation(String locationId, String itemId, String vari List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2080,7 +2100,7 @@ public V1Variation deleteVariation(String locationId, String itemId, String vari /** * DeleteVariation - * 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. + * Deletes an existing item variation from an item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. * @param locationId The ID of the item's associated location. (required) * @param itemId The ID of the item to delete. (required) * @param variationId The ID of the variation to delete. (required) @@ -2115,7 +2135,7 @@ public V1Variation deleteVariation(String locationId, String itemId, String vari List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2136,11 +2156,12 @@ public V1Variation deleteVariation(String locationId, String itemId, String vari } /** * ListCategories - * Lists all of a location's item categories. + * Lists all the item categories for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list categories for. (required) * @return List<V1Category> * @throws ApiException if fails to make API call */ + @Deprecated public List listCategories(String locationId) throws ApiException { Object localVarPostBody = null; @@ -2157,7 +2178,7 @@ public List listCategories(String locationId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2180,7 +2201,7 @@ public List listCategories(String locationId) throws ApiException { /** * ListCategories - * Lists all of a location's item categories. + * Lists all the item categories for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list categories for. (required) * @return CompleteResponse> * @throws ApiException if fails to make API call @@ -2201,7 +2222,7 @@ public List listCategories(String locationId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2222,11 +2243,12 @@ public List listCategories(String locationId) throws ApiException { } /** * ListDiscounts - * Lists all of a location's discounts. + * Lists all the discounts for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list categories for. (required) * @return List<V1Discount> * @throws ApiException if fails to make API call */ + @Deprecated public List listDiscounts(String locationId) throws ApiException { Object localVarPostBody = null; @@ -2243,7 +2265,7 @@ public List listDiscounts(String locationId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2266,7 +2288,7 @@ public List listDiscounts(String locationId) throws ApiException { /** * ListDiscounts - * Lists all of a location's discounts. + * Lists all the discounts for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list categories for. (required) * @return CompleteResponse> * @throws ApiException if fails to make API call @@ -2287,7 +2309,7 @@ public List listDiscounts(String locationId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2308,11 +2330,12 @@ public List listDiscounts(String locationId) throws ApiException { } /** * ListFees - * Lists all of a location's fees (taxes). + * Lists all the fees (taxes) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list fees for. (required) * @return List<V1Fee> * @throws ApiException if fails to make API call */ + @Deprecated public List listFees(String locationId) throws ApiException { Object localVarPostBody = null; @@ -2329,7 +2352,7 @@ public List listFees(String locationId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2352,7 +2375,7 @@ public List listFees(String locationId) throws ApiException { /** * ListFees - * Lists all of a location's fees (taxes). + * Lists all the fees (taxes) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list fees for. (required) * @return CompleteResponse> * @throws ApiException if fails to make API call @@ -2373,7 +2396,7 @@ public List listFees(String locationId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2394,13 +2417,14 @@ public List listFees(String locationId) throws ApiException { } /** * ListInventory - * Provides inventory information for all of a merchant's inventory-enabled item variations. + * Provides inventory information for all inventory-enabled item variations. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param limit The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. (optional) * @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) * @return List<V1InventoryEntry> * @throws ApiException if fails to make API call */ + @Deprecated public List listInventory(String locationId, Integer limit, String batchToken) throws ApiException { Object localVarPostBody = null; @@ -2417,7 +2441,7 @@ public List listInventory(String locationId, Integer limit, St List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -2442,7 +2466,7 @@ public List listInventory(String locationId, Integer limit, St /** * ListInventory - * Provides inventory information for all of a merchant's inventory-enabled item variations. + * Provides inventory information for all inventory-enabled item variations. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param limit The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. (optional) * @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) @@ -2465,7 +2489,7 @@ public List listInventory(String locationId, Integer limit, St List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -2488,12 +2512,13 @@ public List listInventory(String locationId, Integer limit, St } /** * ListItems - * Provides summary information for all of a location's items. + * Provides summary information of all items for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list items for. (required) * @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) * @return List<V1Item> * @throws ApiException if fails to make API call */ + @Deprecated public List listItems(String locationId, String batchToken) throws ApiException { Object localVarPostBody = null; @@ -2510,7 +2535,7 @@ public List listItems(String locationId, String batchToken) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -2534,7 +2559,7 @@ public List listItems(String locationId, String batchToken) throws ApiEx /** * ListItems - * Provides summary information for all of a location's items. + * Provides summary information of all items for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list items for. (required) * @param batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) * @return CompleteResponse> @@ -2556,7 +2581,7 @@ public List listItems(String locationId, String batchToken) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -2578,11 +2603,12 @@ public List listItems(String locationId, String batchToken) throws ApiEx } /** * ListModifierLists - * Lists all of a location's modifier lists. + * Lists all the modifier lists for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list modifier lists for. (required) * @return List<V1ModifierList> * @throws ApiException if fails to make API call */ + @Deprecated public List listModifierLists(String locationId) throws ApiException { Object localVarPostBody = null; @@ -2599,7 +2625,7 @@ public List listModifierLists(String locationId) throws ApiExcep List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2622,7 +2648,7 @@ public List listModifierLists(String locationId) throws ApiExcep /** * ListModifierLists - * Lists all of a location's modifier lists. + * Lists all the modifier lists for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list modifier lists for. (required) * @return CompleteResponse> * @throws ApiException if fails to make API call @@ -2643,7 +2669,7 @@ public List listModifierLists(String locationId) throws ApiExcep List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2664,11 +2690,12 @@ public List listModifierLists(String locationId) throws ApiExcep } /** * ListPages - * Lists all of a location's Favorites pages in Square Register. + * Lists all Favorites pages (in Square Point of Sale) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list Favorites pages for. (required) * @return List<V1Page> * @throws ApiException if fails to make API call */ + @Deprecated public List listPages(String locationId) throws ApiException { Object localVarPostBody = null; @@ -2685,7 +2712,7 @@ public List listPages(String locationId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2708,7 +2735,7 @@ public List listPages(String locationId) throws ApiException { /** * ListPages - * Lists all of a location's Favorites pages in Square Register. + * Lists all Favorites pages (in Square Point of Sale) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the location to list Favorites pages for. (required) * @return CompleteResponse> * @throws ApiException if fails to make API call @@ -2729,7 +2756,7 @@ public List listPages(String locationId) throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2750,13 +2777,14 @@ public List listPages(String locationId) throws ApiException { } /** * RemoveFee - * Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + * Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the fee's associated location. (required) * @param itemId The ID of the item to add the fee to. (required) * @param feeId The ID of the fee to apply. (required) * @return V1Item * @throws ApiException if fails to make API call */ + @Deprecated public V1Item removeFee(String locationId, String itemId, String feeId) throws ApiException { Object localVarPostBody = null; @@ -2785,7 +2813,7 @@ public V1Item removeFee(String locationId, String itemId, String feeId) throws A List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2808,7 +2836,7 @@ public V1Item removeFee(String locationId, String itemId, String feeId) throws A /** * RemoveFee - * Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + * Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the fee's associated location. (required) * @param itemId The ID of the item to add the fee to. (required) * @param feeId The ID of the fee to apply. (required) @@ -2843,7 +2871,7 @@ public V1Item removeFee(String locationId, String itemId, String feeId) throws A List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2864,13 +2892,14 @@ public V1Item removeFee(String locationId, String itemId, String feeId) throws A } /** * RemoveModifierList - * Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + * Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to remove. (required) * @param itemId The ID of the item to remove the modifier list from. (required) * @return V1Item * @throws ApiException if fails to make API call */ + @Deprecated public V1Item removeModifierList(String locationId, String modifierListId, String itemId) throws ApiException { Object localVarPostBody = null; @@ -2899,7 +2928,7 @@ public V1Item removeModifierList(String locationId, String modifierListId, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2922,7 +2951,7 @@ public V1Item removeModifierList(String locationId, String modifierListId, Strin /** * RemoveModifierList - * Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + * Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to remove. (required) * @param itemId The ID of the item to remove the modifier list from. (required) @@ -2957,7 +2986,7 @@ public V1Item removeModifierList(String locationId, String modifierListId, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -2978,12 +3007,13 @@ public V1Item removeModifierList(String locationId, String modifierListId, Strin } /** * RetrieveItem - * Provides the details for a single item, including associated modifier lists and fees. + * Provides the details for a single item, including associated modifier lists and fees. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param itemId The item's ID. (required) * @return V1Item * @throws ApiException if fails to make API call */ + @Deprecated public V1Item retrieveItem(String locationId, String itemId) throws ApiException { Object localVarPostBody = null; @@ -3006,7 +3036,7 @@ public V1Item retrieveItem(String locationId, String itemId) throws ApiException List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3029,7 +3059,7 @@ public V1Item retrieveItem(String locationId, String itemId) throws ApiException /** * RetrieveItem - * Provides the details for a single item, including associated modifier lists and fees. + * Provides the details for a single item, including associated modifier lists and fees. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param itemId The item's ID. (required) * @return CompleteResponse @@ -3057,7 +3087,7 @@ public V1Item retrieveItem(String locationId, String itemId) throws ApiException List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3078,12 +3108,13 @@ public V1Item retrieveItem(String locationId, String itemId) throws ApiException } /** * RetrieveModifierList - * Provides the details for a single modifier list. + * Provides the details for a single modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The modifier list's ID. (required) * @return V1ModifierList * @throws ApiException if fails to make API call */ + @Deprecated public V1ModifierList retrieveModifierList(String locationId, String modifierListId) throws ApiException { Object localVarPostBody = null; @@ -3106,7 +3137,7 @@ public V1ModifierList retrieveModifierList(String locationId, String modifierLis List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3129,7 +3160,7 @@ public V1ModifierList retrieveModifierList(String locationId, String modifierLis /** * RetrieveModifierList - * Provides the details for a single modifier list. + * Provides the details for a single modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The modifier list's ID. (required) * @return CompleteResponse @@ -3157,7 +3188,7 @@ public V1ModifierList retrieveModifierList(String locationId, String modifierLis List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3178,13 +3209,14 @@ public V1ModifierList retrieveModifierList(String locationId, String modifierLis } /** * UpdateCategory - * Modifies the details of an existing item category. + * Modifies the details of an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the category's associated location. (required) * @param categoryId The ID of the category to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Category * @throws ApiException if fails to make API call */ + @Deprecated public V1Category updateCategory(String locationId, String categoryId, V1Category body) throws ApiException { Object localVarPostBody = body; @@ -3212,7 +3244,7 @@ public V1Category updateCategory(String locationId, String categoryId, V1Categor List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3235,7 +3267,7 @@ public V1Category updateCategory(String locationId, String categoryId, V1Categor /** * UpdateCategory - * Modifies the details of an existing item category. + * Modifies the details of an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the category's associated location. (required) * @param categoryId The ID of the category to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -3269,7 +3301,7 @@ public V1Category updateCategory(String locationId, String categoryId, V1Categor List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3290,13 +3322,14 @@ public V1Category updateCategory(String locationId, String categoryId, V1Categor } /** * UpdateDiscount - * Modifies the details of an existing discount. + * Modifies the details of an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the category's associated location. (required) * @param discountId The ID of the discount to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Discount * @throws ApiException if fails to make API call */ + @Deprecated public V1Discount updateDiscount(String locationId, String discountId, V1Discount body) throws ApiException { Object localVarPostBody = body; @@ -3324,7 +3357,7 @@ public V1Discount updateDiscount(String locationId, String discountId, V1Discoun List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3347,7 +3380,7 @@ public V1Discount updateDiscount(String locationId, String discountId, V1Discoun /** * UpdateDiscount - * Modifies the details of an existing discount. + * Modifies the details of an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the category's associated location. (required) * @param discountId The ID of the discount to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -3381,7 +3414,7 @@ public V1Discount updateDiscount(String locationId, String discountId, V1Discoun List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3402,13 +3435,14 @@ public V1Discount updateDiscount(String locationId, String discountId, V1Discoun } /** * UpdateFee - * Modifies the details of an existing fee (tax). + * Modifies the details of an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the fee's associated location. (required) * @param feeId The ID of the fee to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Fee * @throws ApiException if fails to make API call */ + @Deprecated public V1Fee updateFee(String locationId, String feeId, V1Fee body) throws ApiException { Object localVarPostBody = body; @@ -3436,7 +3470,7 @@ public V1Fee updateFee(String locationId, String feeId, V1Fee body) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3459,7 +3493,7 @@ public V1Fee updateFee(String locationId, String feeId, V1Fee body) throws ApiEx /** * UpdateFee - * Modifies the details of an existing fee (tax). + * Modifies the details of an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the fee's associated location. (required) * @param feeId The ID of the fee to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -3493,7 +3527,7 @@ public V1Fee updateFee(String locationId, String feeId, V1Fee body) throws ApiEx List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3514,13 +3548,14 @@ public V1Fee updateFee(String locationId, String feeId, V1Fee body) throws ApiEx } /** * UpdateItem - * Modifies the core details of an existing item. + * Modifies the core details of an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param itemId The ID of the item to modify. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Item * @throws ApiException if fails to make API call */ + @Deprecated public V1Item updateItem(String locationId, String itemId, V1Item body) throws ApiException { Object localVarPostBody = body; @@ -3548,7 +3583,7 @@ public V1Item updateItem(String locationId, String itemId, V1Item body) throws A List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3571,7 +3606,7 @@ public V1Item updateItem(String locationId, String itemId, V1Item body) throws A /** * UpdateItem - * Modifies the core details of an existing item. + * Modifies the core details of an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param itemId The ID of the item to modify. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -3605,7 +3640,7 @@ public V1Item updateItem(String locationId, String itemId, V1Item body) throws A List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3626,13 +3661,14 @@ public V1Item updateItem(String locationId, String itemId, V1Item body) throws A } /** * UpdateModifierList - * Modifies the details of an existing item modifier list. + * Modifies the details of an existing item modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1ModifierList * @throws ApiException if fails to make API call */ + @Deprecated public V1ModifierList updateModifierList(String locationId, String modifierListId, V1UpdateModifierListRequest body) throws ApiException { Object localVarPostBody = body; @@ -3660,7 +3696,7 @@ public V1ModifierList updateModifierList(String locationId, String modifierListI List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3683,7 +3719,7 @@ public V1ModifierList updateModifierList(String locationId, String modifierListI /** * UpdateModifierList - * Modifies the details of an existing item modifier list. + * Modifies the details of an existing item modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to edit. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -3717,7 +3753,7 @@ public V1ModifierList updateModifierList(String locationId, String modifierListI List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3738,7 +3774,7 @@ public V1ModifierList updateModifierList(String locationId, String modifierListI } /** * UpdateModifierOption - * Modifies the details of an existing item modifier option. + * Modifies the details of an existing item modifier option. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to edit. (required) * @param modifierOptionId The ID of the modifier list to edit. (required) @@ -3746,6 +3782,7 @@ public V1ModifierList updateModifierList(String locationId, String modifierListI * @return V1ModifierOption * @throws ApiException if fails to make API call */ + @Deprecated public V1ModifierOption updateModifierOption(String locationId, String modifierListId, String modifierOptionId, V1ModifierOption body) throws ApiException { Object localVarPostBody = body; @@ -3779,7 +3816,7 @@ public V1ModifierOption updateModifierOption(String locationId, String modifierL List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3802,7 +3839,7 @@ public V1ModifierOption updateModifierOption(String locationId, String modifierL /** * UpdateModifierOption - * Modifies the details of an existing item modifier option. + * Modifies the details of an existing item modifier option. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param modifierListId The ID of the modifier list to edit. (required) * @param modifierOptionId The ID of the modifier list to edit. (required) @@ -3843,7 +3880,7 @@ public V1ModifierOption updateModifierOption(String locationId, String modifierL List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3864,13 +3901,14 @@ public V1ModifierOption updateModifierOption(String locationId, String modifierL } /** * UpdatePage - * Modifies the details of a Favorites page in Square Register. + * Modifies the details of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the Favorites page's associated location (required) * @param pageId The ID of the page to modify. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Page * @throws ApiException if fails to make API call */ + @Deprecated public V1Page updatePage(String locationId, String pageId, V1Page body) throws ApiException { Object localVarPostBody = body; @@ -3898,7 +3936,7 @@ public V1Page updatePage(String locationId, String pageId, V1Page body) throws A List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3921,7 +3959,7 @@ public V1Page updatePage(String locationId, String pageId, V1Page body) throws A /** * UpdatePage - * Modifies the details of a Favorites page in Square Register. + * Modifies the details of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the Favorites page's associated location (required) * @param pageId The ID of the page to modify. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -3955,7 +3993,7 @@ public V1Page updatePage(String locationId, String pageId, V1Page body) throws A List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -3976,13 +4014,14 @@ public V1Page updatePage(String locationId, String pageId, V1Page body) throws A } /** * UpdatePageCell - * Modifies a cell of a Favorites page in Square Register. + * Modifies a cell of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the Favorites page's associated location. (required) * @param pageId The ID of the page the cell belongs to. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) * @return V1Page * @throws ApiException if fails to make API call */ + @Deprecated public V1Page updatePageCell(String locationId, String pageId, V1PageCell body) throws ApiException { Object localVarPostBody = body; @@ -4010,7 +4049,7 @@ public V1Page updatePageCell(String locationId, String pageId, V1PageCell body) List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -4033,7 +4072,7 @@ public V1Page updatePageCell(String locationId, String pageId, V1PageCell body) /** * UpdatePageCell - * Modifies a cell of a Favorites page in Square Register. + * Modifies a cell of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the Favorites page's associated location. (required) * @param pageId The ID of the page the cell belongs to. (required) * @param body An object containing the fields to POST for the request. See the corresponding object definition for field details. (required) @@ -4067,7 +4106,7 @@ public V1Page updatePageCell(String locationId, String pageId, V1PageCell body) List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -4088,7 +4127,7 @@ public V1Page updatePageCell(String locationId, String pageId, V1PageCell body) } /** * UpdateVariation - * Modifies the details of an existing item variation. + * Modifies the details of an existing item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param itemId The ID of the item to modify. (required) * @param variationId The ID of the variation to modify. (required) @@ -4096,6 +4135,7 @@ public V1Page updatePageCell(String locationId, String pageId, V1PageCell body) * @return V1Variation * @throws ApiException if fails to make API call */ + @Deprecated public V1Variation updateVariation(String locationId, String itemId, String variationId, V1Variation body) throws ApiException { Object localVarPostBody = body; @@ -4129,7 +4169,7 @@ public V1Variation updateVariation(String locationId, String itemId, String vari List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -4152,7 +4192,7 @@ public V1Variation updateVariation(String locationId, String itemId, String vari /** * UpdateVariation - * Modifies the details of an existing item variation. + * Modifies the details of an existing item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- * @param locationId The ID of the item's associated location. (required) * @param itemId The ID of the item to modify. (required) * @param variationId The ID of the variation to modify. (required) @@ -4193,7 +4233,7 @@ public V1Variation updateVariation(String locationId, String itemId, String vari List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/V1LocationsApi.java b/src/main/java/com/squareup/connect/api/V1LocationsApi.java index 510d4ff..7e80516 100644 --- a/src/main/java/com/squareup/connect/api/V1LocationsApi.java +++ b/src/main/java/com/squareup/connect/api/V1LocationsApi.java @@ -37,10 +37,11 @@ public void setApiClient(ApiClient apiClient) { /** * ListLocations - * Provides details for a business's locations, including their IDs. + * Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- * @return List<V1Merchant> * @throws ApiException if fails to make API call */ + @Deprecated public List listLocations() throws ApiException { Object localVarPostBody = null; @@ -51,7 +52,7 @@ public List listLocations() throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -74,7 +75,7 @@ public List listLocations() throws ApiException { /** * ListLocations - * Provides details for a business's locations, including their IDs. + * Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- * @return CompleteResponse> * @throws ApiException if fails to make API call */ @@ -88,7 +89,7 @@ public List listLocations() throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -109,10 +110,11 @@ public List listLocations() throws ApiException { } /** * RetrieveBusiness - * Get a business's information. + * Get the general information for a business. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- * @return V1Merchant * @throws ApiException if fails to make API call */ + @Deprecated public V1Merchant retrieveBusiness() throws ApiException { Object localVarPostBody = null; @@ -123,7 +125,7 @@ public V1Merchant retrieveBusiness() throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -146,7 +148,7 @@ public V1Merchant retrieveBusiness() throws ApiException { /** * RetrieveBusiness - * Get a business's information. + * Get the general information for a business. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -160,7 +162,7 @@ public V1Merchant retrieveBusiness() throws ApiException { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/api/V1TransactionsApi.java b/src/main/java/com/squareup/connect/api/V1TransactionsApi.java index ff0543e..df46cd7 100644 --- a/src/main/java/com/squareup/connect/api/V1TransactionsApi.java +++ b/src/main/java/com/squareup/connect/api/V1TransactionsApi.java @@ -70,7 +70,7 @@ public V1Refund createRefund(String locationId, V1CreateRefundRequest body) thro List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -120,7 +120,7 @@ public V1Refund createRefund(String locationId, V1CreateRefundRequest body) thro List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -162,7 +162,7 @@ public List listBankAccounts(String locationId) throws ApiExcepti List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -206,7 +206,7 @@ public List listBankAccounts(String locationId) throws ApiExcepti List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -251,7 +251,7 @@ public List listOrders(String locationId, String order, Integer limit, List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -301,7 +301,7 @@ public List listOrders(String locationId, String order, Integer limit, List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -352,7 +352,7 @@ public List listPayments(String locationId, String order, String begi List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -408,7 +408,7 @@ public List listPayments(String locationId, String order, String begi List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -461,7 +461,7 @@ public List listRefunds(String locationId, String order, String beginT List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -515,7 +515,7 @@ public List listRefunds(String locationId, String order, String beginT List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -568,7 +568,7 @@ public List listSettlements(String locationId, String order, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -624,7 +624,7 @@ public List listSettlements(String locationId, String order, Strin List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -679,7 +679,7 @@ public V1BankAccount retrieveBankAccount(String locationId, String bankAccountId List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -730,7 +730,7 @@ public V1BankAccount retrieveBankAccount(String locationId, String bankAccountId List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -779,7 +779,7 @@ public V1Order retrieveOrder(String locationId, String orderId) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -830,7 +830,7 @@ public V1Order retrieveOrder(String locationId, String orderId) throws ApiExcept List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -879,7 +879,7 @@ public V1Payment retrievePayment(String locationId, String paymentId) throws Api List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -930,7 +930,7 @@ public V1Payment retrievePayment(String locationId, String paymentId) throws Api List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -979,7 +979,7 @@ public V1Settlement retrieveSettlement(String locationId, String settlementId) t List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1030,7 +1030,7 @@ public V1Settlement retrieveSettlement(String locationId, String settlementId) t List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1085,7 +1085,7 @@ public V1Order updateOrder(String locationId, String orderId, V1UpdateOrderReque List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); @@ -1142,7 +1142,7 @@ public V1Order updateOrder(String locationId, String orderId, V1UpdateOrderReque List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-10-23"); + localVarHeaderParams.put("Square-Version", "2019-11-20"); diff --git a/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsRequest.java b/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsRequest.java index a127dc5..04b01ee 100644 --- a/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsRequest.java +++ b/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsRequest.java @@ -42,10 +42,10 @@ public BatchDeleteCatalogObjectsRequest addObjectIdsItem(String objectIdsItem) { } /** - * The IDs of the `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`. + * The IDs of the CatalogObjects 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 will delete its CatalogItemVariation. * @return objectIds **/ - @ApiModelProperty(value = "The IDs of the `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`.") + @ApiModelProperty(value = "The IDs of the CatalogObjects 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 will delete its CatalogItemVariation.") public List getObjectIds() { return objectIds; } diff --git a/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsResponse.java b/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsResponse.java index 8657ac7..1ae4824 100644 --- a/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsResponse.java +++ b/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsResponse.java @@ -49,10 +49,10 @@ public BatchDeleteCatalogObjectsResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * The set of Errors encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "The set of Errors encountered.") public List getErrors() { return errors; } @@ -72,10 +72,10 @@ public BatchDeleteCatalogObjectsResponse addDeletedObjectIdsItem(String deletedO } /** - * The IDs of all `CatalogObject`s deleted by this request. + * The IDs of all CatalogObjects deleted by this request. * @return deletedObjectIds **/ - @ApiModelProperty(value = "The IDs of all `CatalogObject`s deleted by this request.") + @ApiModelProperty(value = "The IDs of all CatalogObjects deleted by this request.") public List getDeletedObjectIds() { return deletedObjectIds; } @@ -90,10 +90,10 @@ public BatchDeleteCatalogObjectsResponse deletedAt(String deletedAt) { } /** - * The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + * The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". * @return deletedAt **/ - @ApiModelProperty(value = "The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".") + @ApiModelProperty(value = "The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".") public String getDeletedAt() { return deletedAt; } diff --git a/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsRequest.java b/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsRequest.java index b35ff75..133a4c5 100644 --- a/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsRequest.java +++ b/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsRequest.java @@ -45,10 +45,10 @@ public BatchRetrieveCatalogObjectsRequest addObjectIdsItem(String objectIdsItem) } /** - * The IDs of the `CatalogObject`s to be retrieved. + * The IDs of the CatalogObjects to be retrieved. * @return objectIds **/ - @ApiModelProperty(required = true, value = "The IDs of the `CatalogObject`s to be retrieved.") + @ApiModelProperty(required = true, value = "The IDs of the CatalogObjects to be retrieved.") public List getObjectIds() { return objectIds; } @@ -63,10 +63,10 @@ public BatchRetrieveCatalogObjectsRequest includeRelatedObjects(Boolean includeR } /** - * 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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. + * 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, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. * @return includeRelatedObjects **/ - @ApiModelProperty(value = "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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response.") + @ApiModelProperty(value = "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, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response.") public Boolean getIncludeRelatedObjects() { return includeRelatedObjects; } diff --git a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesRequest.java b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesRequest.java index 92b8519..68eb338 100644 --- a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesRequest.java +++ b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesRequest.java @@ -183,10 +183,10 @@ public BatchRetrieveInventoryChangesRequest cursor(String cursor) { } /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesResponse.java b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesResponse.java index 68eedc6..07e2f28 100644 --- a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesResponse.java +++ b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesResponse.java @@ -91,10 +91,10 @@ public BatchRetrieveInventoryChangesResponse cursor(String cursor) { } /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsRequest.java b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsRequest.java index 283a729..52750d7 100644 --- a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsRequest.java +++ b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsRequest.java @@ -110,10 +110,10 @@ public BatchRetrieveInventoryCountsRequest cursor(String cursor) { } /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsResponse.java b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsResponse.java index c8f5afa..94adf43 100644 --- a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsResponse.java +++ b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsResponse.java @@ -91,10 +91,10 @@ public BatchRetrieveInventoryCountsResponse cursor(String cursor) { } /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsRequest.java b/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsRequest.java index bf0204c..0b9b876 100644 --- a/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsRequest.java +++ b/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsRequest.java @@ -64,10 +64,10 @@ public BatchUpsertCatalogObjectsRequest addBatchesItem(CatalogObjectBatch batche } /** - * A batch of `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` with ID `#ABC` and a `CatalogItemVariation` with its `item_id` attribute set to `#ABC` in order to associate the `CatalogItemVariation` with its parent `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. + * A batch of CatalogObjects 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](https://developer.squareup.com/docs/build-basics/working-with-dates), 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 with ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to `#ABC` in order to associate the CatalogItemVariation with its parent 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. * @return batches **/ - @ApiModelProperty(value = "A batch of `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` with ID `#ABC` and a `CatalogItemVariation` with its `item_id` attribute set to `#ABC` in order to associate the `CatalogItemVariation` with its parent `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.") + @ApiModelProperty(value = "A batch of CatalogObjects 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](https://developer.squareup.com/docs/build-basics/working-with-dates), 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 with ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to `#ABC` in order to associate the CatalogItemVariation with its parent 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.") public List getBatches() { return batches; } diff --git a/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsResponse.java b/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsResponse.java index b3befbb..61b8cff 100644 --- a/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsResponse.java +++ b/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsResponse.java @@ -54,10 +54,10 @@ public BatchUpsertCatalogObjectsResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * Information on any errors that encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "Information on any errors that encountered.") public List getErrors() { return errors; } @@ -77,10 +77,10 @@ public BatchUpsertCatalogObjectsResponse addObjectsItem(CatalogObject objectsIte } /** - * The created `CatalogObject`s + * The created successfully created CatalogObjects. * @return objects **/ - @ApiModelProperty(value = "The created `CatalogObject`s") + @ApiModelProperty(value = "The created successfully created CatalogObjects.") public List getObjects() { return objects; } @@ -95,10 +95,10 @@ public BatchUpsertCatalogObjectsResponse updatedAt(String updatedAt) { } /** - * The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + * The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". * @return updatedAt **/ - @ApiModelProperty(value = "The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".") + @ApiModelProperty(value = "The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".") public String getUpdatedAt() { return updatedAt; } @@ -118,10 +118,10 @@ public BatchUpsertCatalogObjectsResponse addIdMappingsItem(CatalogIdMapping idMa } /** - * The mapping between client and server IDs for this Upsert. + * The mapping between client and server IDs for this upsert. * @return idMappings **/ - @ApiModelProperty(value = "The mapping between client and server IDs for this Upsert.") + @ApiModelProperty(value = "The mapping between client and server IDs for this upsert.") public List getIdMappings() { return idMappings; } diff --git a/src/main/java/com/squareup/connect/models/BusinessHours.java b/src/main/java/com/squareup/connect/models/BusinessHours.java index 9eebeb5..7ef50dd 100644 --- a/src/main/java/com/squareup/connect/models/BusinessHours.java +++ b/src/main/java/com/squareup/connect/models/BusinessHours.java @@ -24,9 +24,9 @@ import java.util.List; /** - * Represents the hours of operation for a business location. + * Represents the hours of operation for a business location. */ -@ApiModel(description = " Represents the hours of operation for a business location.") +@ApiModel(description = "Represents the hours of operation for a business location.") public class BusinessHours { @JsonProperty("periods") diff --git a/src/main/java/com/squareup/connect/models/BusinessHoursPeriod.java b/src/main/java/com/squareup/connect/models/BusinessHoursPeriod.java index c245c40..204c26e 100644 --- a/src/main/java/com/squareup/connect/models/BusinessHoursPeriod.java +++ b/src/main/java/com/squareup/connect/models/BusinessHoursPeriod.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Represents a period of time during which a business location is open. + * Represents a period of time during which a business location is open. */ -@ApiModel(description = " Represents a period of time during which a business location is open.") +@ApiModel(description = "Represents a period of time during which a business location is open.") public class BusinessHoursPeriod { @JsonProperty("day_of_week") diff --git a/src/main/java/com/squareup/connect/models/CaptureTransactionRequest.java b/src/main/java/com/squareup/connect/models/CaptureTransactionRequest.java index d644a10..1a4a372 100644 --- a/src/main/java/com/squareup/connect/models/CaptureTransactionRequest.java +++ b/src/main/java/com/squareup/connect/models/CaptureTransactionRequest.java @@ -17,9 +17,9 @@ import io.swagger.annotations.ApiModel; /** - * Defines the query parameters for calls to the CaptureTransaction endpoint. + * */ -@ApiModel(description = "Defines the query parameters for calls to the CaptureTransaction endpoint.") +@ApiModel(description = "") public class CaptureTransactionRequest { diff --git a/src/main/java/com/squareup/connect/models/Card.java b/src/main/java/com/squareup/connect/models/Card.java index 7bcd706..b652675 100644 --- a/src/main/java/com/squareup/connect/models/Card.java +++ b/src/main/java/com/squareup/connect/models/Card.java @@ -78,10 +78,10 @@ public Card cardBrand(String cardBrand) { } /** - * The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for possible values + * The card's brand (such as `VISA`). See `CardBrand` for all possible values. See [CardBrand](#type-cardbrand) for possible values * @return cardBrand **/ - @ApiModelProperty(value = "The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for possible values") + @ApiModelProperty(value = "The card's brand (such as `VISA`). See `CardBrand` for all possible values. See [CardBrand](#type-cardbrand) for possible values") public String getCardBrand() { return cardBrand; } @@ -186,10 +186,10 @@ public Card fingerprint(String fingerprint) { } /** - * A unique, Square-assigned ID that identifies the card across multiple locations and applications for a single Square account. + * __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. * @return fingerprint **/ - @ApiModelProperty(value = "A unique, Square-assigned ID that identifies the card across multiple locations and applications for a single Square account.") + @ApiModelProperty(value = "__Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.") public String getFingerprint() { return fingerprint; } diff --git a/src/main/java/com/squareup/connect/models/CashPaymentDetails.java b/src/main/java/com/squareup/connect/models/CashPaymentDetails.java new file mode 100644 index 0000000..9d6af43 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/CashPaymentDetails.java @@ -0,0 +1,115 @@ +/* + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.squareup.connect.models; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.squareup.connect.models.Money; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +/** + * Additional details about CASH type payments. + */ +@ApiModel(description = "Additional details about CASH type payments.") + +public class CashPaymentDetails { + @JsonProperty("buyer_supplied_money") + private Money buyerSuppliedMoney = null; + + @JsonProperty("change_back_money") + private Money changeBackMoney = null; + + public CashPaymentDetails buyerSuppliedMoney(Money buyerSuppliedMoney) { + this.buyerSuppliedMoney = buyerSuppliedMoney; + return this; + } + + /** + * The amount and currency of the money supplied by the buyer. + * @return buyerSuppliedMoney + **/ + @ApiModelProperty(required = true, value = "The amount and currency of the money supplied by the buyer.") + public Money getBuyerSuppliedMoney() { + return buyerSuppliedMoney; + } + + public void setBuyerSuppliedMoney(Money buyerSuppliedMoney) { + this.buyerSuppliedMoney = buyerSuppliedMoney; + } + + public CashPaymentDetails changeBackMoney(Money changeBackMoney) { + this.changeBackMoney = changeBackMoney; + return this; + } + + /** + * The amount of change due back to the buyer. Read Only field calculated from the amount_money and buyer_supplied_money fields. + * @return changeBackMoney + **/ + @ApiModelProperty(value = "The amount of change due back to the buyer. Read Only field calculated from the amount_money and buyer_supplied_money fields.") + public Money getChangeBackMoney() { + return changeBackMoney; + } + + public void setChangeBackMoney(Money changeBackMoney) { + this.changeBackMoney = changeBackMoney; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CashPaymentDetails cashPaymentDetails = (CashPaymentDetails) o; + return Objects.equals(this.buyerSuppliedMoney, cashPaymentDetails.buyerSuppliedMoney) && + Objects.equals(this.changeBackMoney, cashPaymentDetails.changeBackMoney); + } + + @Override + public int hashCode() { + return Objects.hash(buyerSuppliedMoney, changeBackMoney); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CashPaymentDetails {\n"); + + sb.append(" buyerSuppliedMoney: ").append(toIndentedString(buyerSuppliedMoney)).append("\n"); + sb.append(" changeBackMoney: ").append(toIndentedString(changeBackMoney)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/squareup/connect/models/CatalogCategory.java b/src/main/java/com/squareup/connect/models/CatalogCategory.java index 9561d6b..8c07db1 100644 --- a/src/main/java/com/squareup/connect/models/CatalogCategory.java +++ b/src/main/java/com/squareup/connect/models/CatalogCategory.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model. + * A category to which a `CatalogItem` belongs in the `Catalog` object model. */ -@ApiModel(description = "A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model.") +@ApiModel(description = "A category to which a `CatalogItem` belongs in the `Catalog` object model.") public class CatalogCategory { @JsonProperty("name") @@ -35,10 +35,10 @@ public CatalogCategory name(String name) { } /** - * The category's name. Searchable. This field has max length of 255 Unicode code points. + * The category name. Searchable. This field has max length of 255 Unicode code points. * @return name **/ - @ApiModelProperty(value = "The category's name. Searchable. This field has max length of 255 Unicode code points.") + @ApiModelProperty(value = "The category name. Searchable. This field has max length of 255 Unicode code points.") public String getName() { return name; } diff --git a/src/main/java/com/squareup/connect/models/CatalogDiscount.java b/src/main/java/com/squareup/connect/models/CatalogDiscount.java index 042b560..66e79af 100644 --- a/src/main/java/com/squareup/connect/models/CatalogDiscount.java +++ b/src/main/java/com/squareup/connect/models/CatalogDiscount.java @@ -45,16 +45,19 @@ public class CatalogDiscount { @JsonProperty("label_color") private String labelColor = null; + @JsonProperty("modify_tax_basis") + private String modifyTaxBasis = null; + public CatalogDiscount name(String name) { this.name = name; return this; } /** - * The discount's name. Searchable. This field has max length of 255 Unicode code points. + * The discount name. Searchable. This field has max length of 255 Unicode code points. * @return name **/ - @ApiModelProperty(value = "The discount's name. Searchable. This field has max length of 255 Unicode code points.") + @ApiModelProperty(value = "The discount name. Searchable. This field has max length of 255 Unicode code points.") public String getName() { return name; } @@ -141,10 +144,10 @@ public CatalogDiscount labelColor(String labelColor) { } /** - * The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code. + * The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code. * @return labelColor **/ - @ApiModelProperty(value = "The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code.") + @ApiModelProperty(value = "The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code.") public String getLabelColor() { return labelColor; } @@ -153,6 +156,24 @@ public void setLabelColor(String labelColor) { this.labelColor = labelColor; } + public CatalogDiscount modifyTaxBasis(String modifyTaxBasis) { + this.modifyTaxBasis = modifyTaxBasis; + return this; + } + + /** + * Indicates whether this discount should reduce the price used to calculate tax. Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must be calculated based on an item's price, ignoring a particular discount. For example, in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a customer pays but does not reduce the sale price used to calculate how much sales tax is due. In this case, the discount representing that manufacturer coupon should have `DO_NOT_MODIFY_TAX_BASIS` for this field. If you are unsure whether you need to use this field, consult your tax professional. See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values + * @return modifyTaxBasis + **/ + @ApiModelProperty(value = "Indicates whether this discount should reduce the price used to calculate tax. Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must be calculated based on an item's price, ignoring a particular discount. For example, in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a customer pays but does not reduce the sale price used to calculate how much sales tax is due. In this case, the discount representing that manufacturer coupon should have `DO_NOT_MODIFY_TAX_BASIS` for this field. If you are unsure whether you need to use this field, consult your tax professional. See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values") + public String getModifyTaxBasis() { + return modifyTaxBasis; + } + + public void setModifyTaxBasis(String modifyTaxBasis) { + this.modifyTaxBasis = modifyTaxBasis; + } + @Override public boolean equals(java.lang.Object o) { @@ -168,12 +189,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.percentage, catalogDiscount.percentage) && Objects.equals(this.amountMoney, catalogDiscount.amountMoney) && Objects.equals(this.pinRequired, catalogDiscount.pinRequired) && - Objects.equals(this.labelColor, catalogDiscount.labelColor); + Objects.equals(this.labelColor, catalogDiscount.labelColor) && + Objects.equals(this.modifyTaxBasis, catalogDiscount.modifyTaxBasis); } @Override public int hashCode() { - return Objects.hash(name, discountType, percentage, amountMoney, pinRequired, labelColor); + return Objects.hash(name, discountType, percentage, amountMoney, pinRequired, labelColor, modifyTaxBasis); } @@ -188,6 +210,7 @@ public String toString() { sb.append(" amountMoney: ").append(toIndentedString(amountMoney)).append("\n"); sb.append(" pinRequired: ").append(toIndentedString(pinRequired)).append("\n"); sb.append(" labelColor: ").append(toIndentedString(labelColor)).append("\n"); + sb.append(" modifyTaxBasis: ").append(toIndentedString(modifyTaxBasis)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/squareup/connect/models/CatalogIdMapping.java b/src/main/java/com/squareup/connect/models/CatalogIdMapping.java index adf421c..eb2d74a 100644 --- a/src/main/java/com/squareup/connect/models/CatalogIdMapping.java +++ b/src/main/java/com/squareup/connect/models/CatalogIdMapping.java @@ -56,10 +56,10 @@ public CatalogIdMapping objectId(String objectId) { } /** - * The permanent ID for the `CatalogObject` created by the server. + * The permanent ID for the CatalogObject created by the server. * @return objectId **/ - @ApiModelProperty(value = "The permanent ID for the `CatalogObject` created by the server.") + @ApiModelProperty(value = "The permanent ID for the CatalogObject created by the server.") public String getObjectId() { return objectId; } diff --git a/src/main/java/com/squareup/connect/models/CatalogInfoResponse.java b/src/main/java/com/squareup/connect/models/CatalogInfoResponse.java index b1f716e..ebadece 100644 --- a/src/main/java/com/squareup/connect/models/CatalogInfoResponse.java +++ b/src/main/java/com/squareup/connect/models/CatalogInfoResponse.java @@ -51,10 +51,10 @@ public CatalogInfoResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * The set of errors encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "The set of errors encountered.") public List getErrors() { return errors; } diff --git a/src/main/java/com/squareup/connect/models/CatalogItem.java b/src/main/java/com/squareup/connect/models/CatalogItem.java index 4c1af46..7ec2fc2 100644 --- a/src/main/java/com/squareup/connect/models/CatalogItem.java +++ b/src/main/java/com/squareup/connect/models/CatalogItem.java @@ -228,10 +228,10 @@ public CatalogItem addTaxIdsItem(String taxIdsItem) { } /** - * A set of IDs indicating the `CatalogTax`es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. `CatalogTax`es may also be added to or deleted from an item using `UpdateItemTaxes`. + * A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item. Taxes may also be added to or deleted from an item using `UpdateItemTaxes`. * @return taxIds **/ - @ApiModelProperty(value = "A set of IDs indicating the `CatalogTax`es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. `CatalogTax`es may also be added to or deleted from an item using `UpdateItemTaxes`.") + @ApiModelProperty(value = "A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item. Taxes may also be added to or deleted from an item using `UpdateItemTaxes`.") public List getTaxIds() { return taxIds; } @@ -251,10 +251,10 @@ public CatalogItem addModifierListInfoItem(CatalogItemModifierListInfo modifierL } /** - * A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. `CatalogModifierList`s may also be added to or deleted from an item using `UpdateItemModifierLists`. + * A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. Modifier lists may also be added to or deleted from an item using `UpdateItemModifierLists`. * @return modifierListInfo **/ - @ApiModelProperty(value = "A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. `CatalogModifierList`s may also be added to or deleted from an item using `UpdateItemModifierLists`.") + @ApiModelProperty(value = "A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. Modifier lists may also be added to or deleted from an item using `UpdateItemModifierLists`.") public List getModifierListInfo() { return modifierListInfo; } @@ -274,10 +274,10 @@ public CatalogItem addVariationsItem(CatalogObject variationsItem) { } /** - * A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations + * A list of CatalogObjects containing the `CatalogItemVariation`s for this item. * @return variations **/ - @ApiModelProperty(value = "A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations") + @ApiModelProperty(value = "A list of CatalogObjects containing the `CatalogItemVariation`s for this item.") public List getVariations() { return variations; } diff --git a/src/main/java/com/squareup/connect/models/CatalogItemModifierListInfo.java b/src/main/java/com/squareup/connect/models/CatalogItemModifierListInfo.java index 687c067..8e61def 100644 --- a/src/main/java/com/squareup/connect/models/CatalogItemModifierListInfo.java +++ b/src/main/java/com/squareup/connect/models/CatalogItemModifierListInfo.java @@ -24,9 +24,9 @@ import java.util.List; /** - * Controls the properties of a [CatalogModifierList](#type-catalogmodifierlist) as it applies to this [CatalogItem](#type-catalogitem). + * Controls the properties of a `CatalogModifierList` as it applies to this `CatalogItem`. */ -@ApiModel(description = "Controls the properties of a [CatalogModifierList](#type-catalogmodifierlist) as it applies to this [CatalogItem](#type-catalogitem).") +@ApiModel(description = "Controls the properties of a `CatalogModifierList` as it applies to this `CatalogItem`.") public class CatalogItemModifierListInfo { @JsonProperty("modifier_list_id") @@ -50,10 +50,10 @@ public CatalogItemModifierListInfo modifierListId(String modifierListId) { } /** - * The ID of the `CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo`. + * The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`. * @return modifierListId **/ - @ApiModelProperty(required = true, value = "The ID of the `CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo`.") + @ApiModelProperty(required = true, value = "The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`.") public String getModifierListId() { return modifierListId; } @@ -73,10 +73,10 @@ public CatalogItemModifierListInfo addModifierOverridesItem(CatalogModifierOverr } /** - * A set of `CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier` is enabled by default. + * A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. * @return modifierOverrides **/ - @ApiModelProperty(value = "A set of `CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier` is enabled by default.") + @ApiModelProperty(value = "A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default.") public List getModifierOverrides() { return modifierOverrides; } @@ -91,10 +91,10 @@ public CatalogItemModifierListInfo minSelectedModifiers(Integer minSelectedModif } /** - * If zero or larger, the smallest number of `CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList`. + * If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. * @return minSelectedModifiers **/ - @ApiModelProperty(value = "If zero or larger, the smallest number of `CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList`.") + @ApiModelProperty(value = "If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`.") public Integer getMinSelectedModifiers() { return minSelectedModifiers; } @@ -109,10 +109,10 @@ public CatalogItemModifierListInfo maxSelectedModifiers(Integer maxSelectedModif } /** - * If zero or larger, the largest number of `CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList`. + * If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. * @return maxSelectedModifiers **/ - @ApiModelProperty(value = "If zero or larger, the largest number of `CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList`.") + @ApiModelProperty(value = "If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`.") public Integer getMaxSelectedModifiers() { return maxSelectedModifiers; } diff --git a/src/main/java/com/squareup/connect/models/CatalogItemOption.java b/src/main/java/com/squareup/connect/models/CatalogItemOption.java index f0dc4e1..1db554c 100644 --- a/src/main/java/com/squareup/connect/models/CatalogItemOption.java +++ b/src/main/java/com/squareup/connect/models/CatalogItemOption.java @@ -24,9 +24,9 @@ import java.util.List; /** - * A group of variations for a [CatalogItem](#type-catalogitem)'s. + * A group of variations for a `CatalogItem`. */ -@ApiModel(description = "A group of variations for a [CatalogItem](#type-catalogitem)'s.") +@ApiModel(description = "A group of variations for a `CatalogItem`.") public class CatalogItemOption { @JsonProperty("name") @@ -89,10 +89,10 @@ public CatalogItemOption description(String description) { } /** - * The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. + * The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. * @return description **/ - @ApiModelProperty(value = "The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer.") + @ApiModelProperty(value = "The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer.") public String getDescription() { return description; } @@ -130,10 +130,10 @@ public CatalogItemOption addValuesItem(CatalogObject valuesItem) { } /** - * A list of `CatalogObject`s containing the `CatalogItemOptionValue`s for this item. + * A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item. * @return values **/ - @ApiModelProperty(value = "A list of `CatalogObject`s containing the `CatalogItemOptionValue`s for this item.") + @ApiModelProperty(value = "A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item.") public List getValues() { return values; } diff --git a/src/main/java/com/squareup/connect/models/CatalogItemOptionValue.java b/src/main/java/com/squareup/connect/models/CatalogItemOptionValue.java index ffbffb8..8e15817 100644 --- a/src/main/java/com/squareup/connect/models/CatalogItemOptionValue.java +++ b/src/main/java/com/squareup/connect/models/CatalogItemOptionValue.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * An enumerated value that can link a [CatalogItemVariation(#type-catalogitemvariation) to an item option as one of its item option values. + * An enumerated value that can link a `CatalogItemVariation` to an item option as one of its item option values. */ -@ApiModel(description = "An enumerated value that can link a [CatalogItemVariation(#type-catalogitemvariation) to an item option as one of its item option values.") +@ApiModel(description = "An enumerated value that can link a `CatalogItemVariation` to an item option as one of its item option values.") public class CatalogItemOptionValue { @JsonProperty("item_option_id") @@ -86,10 +86,10 @@ public CatalogItemOptionValue description(String description) { } /** - * The option value's human-readable description. + * A human-readable description for the option value. * @return description **/ - @ApiModelProperty(value = "The option value's human-readable description.") + @ApiModelProperty(value = "A human-readable description for the option value.") public String getDescription() { return description; } @@ -140,10 +140,10 @@ public CatalogItemOptionValue itemVariationCount(Long itemVariationCount) { } /** - * The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. + * The number of `CatalogItemVariation`s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. * @return itemVariationCount **/ - @ApiModelProperty(value = "The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts.") + @ApiModelProperty(value = "The number of `CatalogItemVariation`s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts.") public Long getItemVariationCount() { return itemVariationCount; } diff --git a/src/main/java/com/squareup/connect/models/CatalogItemOptionValueForItemVariation.java b/src/main/java/com/squareup/connect/models/CatalogItemOptionValueForItemVariation.java index 08ad080..0347e63 100644 --- a/src/main/java/com/squareup/connect/models/CatalogItemOptionValueForItemVariation.java +++ b/src/main/java/com/squareup/connect/models/CatalogItemOptionValueForItemVariation.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * A [CatalogItemOptionValue](#type-catalogitemoptionvalue) links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, “Color:Red, Size:Small” or “Color:Blue, Size:Medium”. + * A `CatalogItemOptionValue` links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, \"Color:Red, Size:Small\" or \"Color:Blue, Size:Medium\". */ -@ApiModel(description = "A [CatalogItemOptionValue](#type-catalogitemoptionvalue) links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, “Color:Red, Size:Small” or “Color:Blue, Size:Medium”.") +@ApiModel(description = "A `CatalogItemOptionValue` links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, \"Color:Red, Size:Small\" or \"Color:Blue, Size:Medium\".") public class CatalogItemOptionValueForItemVariation { @JsonProperty("item_option_id") diff --git a/src/main/java/com/squareup/connect/models/CatalogItemVariation.java b/src/main/java/com/squareup/connect/models/CatalogItemVariation.java index 4dad5c3..38d97aa 100644 --- a/src/main/java/com/squareup/connect/models/CatalogItemVariation.java +++ b/src/main/java/com/squareup/connect/models/CatalogItemVariation.java @@ -213,10 +213,10 @@ public CatalogItemVariation addLocationOverridesItem(ItemVariationLocationOverri } /** - * Per-`location` price and inventory overrides. + * Per-location price and inventory overrides. * @return locationOverrides **/ - @ApiModelProperty(value = "Per-`location` price and inventory overrides.") + @ApiModelProperty(value = "Per-location price and inventory overrides.") public List getLocationOverrides() { return locationOverrides; } @@ -285,10 +285,10 @@ public CatalogItemVariation userData(String userData) { } /** - * Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. + * Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. * @return userData **/ - @ApiModelProperty(value = "Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable.") + @ApiModelProperty(value = "Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points.") public String getUserData() { return userData; } diff --git a/src/main/java/com/squareup/connect/models/CatalogMeasurementUnit.java b/src/main/java/com/squareup/connect/models/CatalogMeasurementUnit.java index 84426ba..ba9aaa3 100644 --- a/src/main/java/com/squareup/connect/models/CatalogMeasurementUnit.java +++ b/src/main/java/com/squareup/connect/models/CatalogMeasurementUnit.java @@ -22,9 +22,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Represents the unit used to measure a [CatalogItemVariation](#type-catalogitemvariation) and specifies the precision for decimal quantities. + * Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities. */ -@ApiModel(description = "Represents the unit used to measure a [CatalogItemVariation](#type-catalogitemvariation) and specifies the precision for decimal quantities.") +@ApiModel(description = "Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities.") public class CatalogMeasurementUnit { @JsonProperty("measurement_unit") @@ -57,10 +57,10 @@ public CatalogMeasurementUnit precision(Integer precision) { } /** - * Represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example, if the precision is 2, then an itemization’s quantity can be 0.01, 0.12, etc. Min: 0 Max: 5 Default: 3 + * An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3 * @return precision **/ - @ApiModelProperty(value = " Represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example, if the precision is 2, then an itemization’s quantity can be 0.01, 0.12, etc. Min: 0 Max: 5 Default: 3") + @ApiModelProperty(value = "An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3") public Integer getPrecision() { return precision; } diff --git a/src/main/java/com/squareup/connect/models/CatalogModifier.java b/src/main/java/com/squareup/connect/models/CatalogModifier.java index 280d883..87dd94f 100644 --- a/src/main/java/com/squareup/connect/models/CatalogModifier.java +++ b/src/main/java/com/squareup/connect/models/CatalogModifier.java @@ -39,10 +39,10 @@ public CatalogModifier name(String name) { } /** - * The modifier's name. Searchable. This field has max length of 255 Unicode code points. + * The modifier name. Searchable. This field has max length of 255 Unicode code points. * @return name **/ - @ApiModelProperty(value = "The modifier's name. Searchable. This field has max length of 255 Unicode code points.") + @ApiModelProperty(value = "The modifier name. Searchable. This field has max length of 255 Unicode code points.") public String getName() { return name; } @@ -57,10 +57,10 @@ public CatalogModifier priceMoney(Money priceMoney) { } /** - * The modifier's price. + * The modifier price. * @return priceMoney **/ - @ApiModelProperty(value = "The modifier's price.") + @ApiModelProperty(value = "The modifier price.") public Money getPriceMoney() { return priceMoney; } diff --git a/src/main/java/com/squareup/connect/models/CatalogModifierList.java b/src/main/java/com/squareup/connect/models/CatalogModifierList.java index 6e3ac56..373b1a6 100644 --- a/src/main/java/com/squareup/connect/models/CatalogModifierList.java +++ b/src/main/java/com/squareup/connect/models/CatalogModifierList.java @@ -24,9 +24,9 @@ import java.util.List; /** - * A modifier list in the Catalog object model. A [CatalogModifierList](#type-catalogmodifierlist) contains [Modifier](#type-catalogmodifier)s that can be applied to a [CatalogItem](#type-catalogitem) at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" [CatalogItem](#type-catalogitem) might contain [CatalogModifier](#type-catalogmodifier)s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed. + * A modifier list in the Catalog object model. A `CatalogModifierList` contains `CatalogModifier` objects that can be applied to a `CatalogItem` at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" `CatalogItem` might contain `CatalogModifier`s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed. */ -@ApiModel(description = "A modifier list in the Catalog object model. A [CatalogModifierList](#type-catalogmodifierlist) contains [Modifier](#type-catalogmodifier)s that can be applied to a [CatalogItem](#type-catalogitem) at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" [CatalogItem](#type-catalogitem) might contain [CatalogModifier](#type-catalogmodifier)s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed.") +@ApiModel(description = "A modifier list in the Catalog object model. A `CatalogModifierList` contains `CatalogModifier` objects that can be applied to a `CatalogItem` at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" `CatalogItem` might contain `CatalogModifier`s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed.") public class CatalogModifierList { @JsonProperty("name") @@ -44,10 +44,10 @@ public CatalogModifierList name(String name) { } /** - * The `CatalogModifierList`'s name. Searchable. This field has max length of 255 Unicode code points. + * A searchable name for the `CatalogModifierList`. This field has max length of 255 Unicode code points. * @return name **/ - @ApiModelProperty(value = "The `CatalogModifierList`'s name. Searchable. This field has max length of 255 Unicode code points.") + @ApiModelProperty(value = "A searchable name for the `CatalogModifierList`. This field has max length of 255 Unicode code points.") public String getName() { return name; } @@ -85,10 +85,10 @@ public CatalogModifierList addModifiersItem(CatalogObject modifiersItem) { } /** - * The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each `CatalogObject` must have type `MODIFIER` and contain `CatalogModifier` data. + * The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each CatalogObject must have type `MODIFIER` and contain `CatalogModifier` data. * @return modifiers **/ - @ApiModelProperty(value = "The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each `CatalogObject` must have type `MODIFIER` and contain `CatalogModifier` data.") + @ApiModelProperty(value = "The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each CatalogObject must have type `MODIFIER` and contain `CatalogModifier` data.") public List getModifiers() { return modifiers; } diff --git a/src/main/java/com/squareup/connect/models/CatalogModifierOverride.java b/src/main/java/com/squareup/connect/models/CatalogModifierOverride.java index 4f3a9bd..f54a130 100644 --- a/src/main/java/com/squareup/connect/models/CatalogModifierOverride.java +++ b/src/main/java/com/squareup/connect/models/CatalogModifierOverride.java @@ -56,10 +56,10 @@ public CatalogModifierOverride onByDefault(Boolean onByDefault) { } /** - * If `true`, this `CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem`. + * If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`. * @return onByDefault **/ - @ApiModelProperty(value = "If `true`, this `CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem`.") + @ApiModelProperty(value = "If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`.") public Boolean getOnByDefault() { return onByDefault; } diff --git a/src/main/java/com/squareup/connect/models/CatalogObject.java b/src/main/java/com/squareup/connect/models/CatalogObject.java index aaf8df0..5b45ee4 100644 --- a/src/main/java/com/squareup/connect/models/CatalogObject.java +++ b/src/main/java/com/squareup/connect/models/CatalogObject.java @@ -38,9 +38,9 @@ import java.util.List; /** - * The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid [CatalogItem](#type-catalogitem) object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid [CatalogItemVariation](#type-catalogitemvariation) object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid [CatalogModifier](#type-catalogmodifier) object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid [CatalogModifierList](#type-catalogmodifierlist) object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid [CatalogCategory](#type-catalogcategory) object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid [CatalogDiscount](#type-catalogdiscount) object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid [CatalogTax](#type-catalogtax) object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid [CatalogImage](#type-catalogimage) object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. + * The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid `CatalogItem` object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid `CatalogItemVariation` object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid `CatalogModifier` object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid `CatalogModifierList` object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid `CatalogCategory` object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid `CatalogDiscount` object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid `CatalogTax` object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid `CatalogImage` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. */ -@ApiModel(description = "The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid [CatalogItem](#type-catalogitem) object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid [CatalogItemVariation](#type-catalogitemvariation) object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid [CatalogModifier](#type-catalogmodifier) object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid [CatalogModifierList](#type-catalogmodifierlist) object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid [CatalogCategory](#type-catalogcategory) object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid [CatalogDiscount](#type-catalogdiscount) object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid [CatalogTax](#type-catalogtax) object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid [CatalogImage](#type-catalogimage) object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide.") +@ApiModel(description = "The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid `CatalogItem` object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid `CatalogItemVariation` object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid `CatalogModifier` object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid `CatalogModifierList` object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid `CatalogCategory` object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid `CatalogDiscount` object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid `CatalogTax` object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid `CatalogImage` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide.") public class CatalogObject { @JsonProperty("type") @@ -139,10 +139,10 @@ public CatalogObject id(String id) { } /** - * An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. + * An identifier to reference this object in the catalog. When a new `CatalogObject` is inserted, the client should set the id to a temporary identifier starting with a \"`#`\" character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. * @return id **/ - @ApiModelProperty(required = true, value = "An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references.") + @ApiModelProperty(required = true, value = "An identifier to reference this object in the catalog. When a new `CatalogObject` is inserted, the client should set the id to a temporary identifier starting with a \"`#`\" character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references.") public String getId() { return id; } @@ -157,10 +157,10 @@ public CatalogObject updatedAt(String updatedAt) { } /** - * Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. + * Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. * @return updatedAt **/ - @ApiModelProperty(value = "Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds.") + @ApiModelProperty(value = "Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds.") public String getUpdatedAt() { return updatedAt; } @@ -216,10 +216,10 @@ public CatalogObject addCatalogV1IdsItem(CatalogV1Id catalogV1IdsItem) { } /** - * The Connect V1 IDs for this object at each `location` where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. + * The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. * @return catalogV1Ids **/ - @ApiModelProperty(value = "The Connect V1 IDs for this object at each `location` where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs.") + @ApiModelProperty(value = "The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs.") public List getCatalogV1Ids() { return catalogV1Ids; } diff --git a/src/main/java/com/squareup/connect/models/CatalogObjectBatch.java b/src/main/java/com/squareup/connect/models/CatalogObjectBatch.java index 32025f9..f18b75d 100644 --- a/src/main/java/com/squareup/connect/models/CatalogObjectBatch.java +++ b/src/main/java/com/squareup/connect/models/CatalogObjectBatch.java @@ -24,9 +24,9 @@ import java.util.List; /** - * A batch of [CatalogObject](#type-catalogobject)s. + * A batch of catalog objects. */ -@ApiModel(description = "A batch of [CatalogObject](#type-catalogobject)s.") +@ApiModel(description = "A batch of catalog objects.") public class CatalogObjectBatch { @JsonProperty("objects") @@ -43,10 +43,10 @@ public CatalogObjectBatch addObjectsItem(CatalogObject objectsItem) { } /** - * A list of `CatalogObject`s belonging to this batch. + * A list of CatalogObjects belonging to this batch. * @return objects **/ - @ApiModelProperty(value = "A list of `CatalogObject`s belonging to this batch.") + @ApiModelProperty(value = "A list of CatalogObjects belonging to this batch.") public List getObjects() { return objects; } diff --git a/src/main/java/com/squareup/connect/models/CatalogPricingRule.java b/src/main/java/com/squareup/connect/models/CatalogPricingRule.java index e77b3f7..078bcc1 100644 --- a/src/main/java/com/squareup/connect/models/CatalogPricingRule.java +++ b/src/main/java/com/squareup/connect/models/CatalogPricingRule.java @@ -90,10 +90,10 @@ public CatalogPricingRule addTimePeriodIdsItem(String timePeriodIdsItem) { } /** - * Unique ID for the `CatalogTimePeriod`s when this pricing rule is in effect. If left unset, the pricing rule is always in effect. + * A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect. * @return timePeriodIds **/ - @ApiModelProperty(value = "Unique ID for the `CatalogTimePeriod`s when this pricing rule is in effect. If left unset, the pricing rule is always in effect.") + @ApiModelProperty(value = "A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect.") public List getTimePeriodIds() { return timePeriodIds; } @@ -126,10 +126,10 @@ public CatalogPricingRule matchProductsId(String matchProductsId) { } /** - * Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. + * Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. A match rule can match multiple times in the cart. If no `ProductSet` is present, the rule will match all products. * @return matchProductsId **/ - @ApiModelProperty(value = "Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart.") + @ApiModelProperty(value = "Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. A match rule can match multiple times in the cart. If no `ProductSet` is present, the rule will match all products.") public String getMatchProductsId() { return matchProductsId; } @@ -144,10 +144,10 @@ public CatalogPricingRule applyProductsId(String applyProductsId) { } /** - * `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. This field has been deprecated: new pricing rules should prefer the exclude_products_id field. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. + * __Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. * @return applyProductsId **/ - @ApiModelProperty(value = "`CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. This field has been deprecated: new pricing rules should prefer the exclude_products_id field. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount.") + @ApiModelProperty(value = "__Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.") @Deprecated public String getApplyProductsId() { @@ -164,10 +164,10 @@ public CatalogPricingRule excludeProductsId(String excludeProductsId) { } /** - * Identifies the `CatalogProductSet` to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. + * `CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. * @return excludeProductsId **/ - @ApiModelProperty(value = "Identifies the `CatalogProductSet` to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.") + @ApiModelProperty(value = "`CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.") public String getExcludeProductsId() { return excludeProductsId; } @@ -200,10 +200,10 @@ public CatalogPricingRule validFromLocalTime(String validFromLocalTime) { } /** - * Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. + * Represents the local time the pricing rule should be valid from. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. * @return validFromLocalTime **/ - @ApiModelProperty(value = "Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.") + @ApiModelProperty(value = "Represents the local time the pricing rule should be valid from. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.") public String getValidFromLocalTime() { return validFromLocalTime; } @@ -218,10 +218,10 @@ public CatalogPricingRule validUntilDate(String validUntilDate) { } /** - * Represents the date the pricing rule will become inactive. Represented in RFC3339 full-date format (YYYY-MM-DD). + * Represents the date the Pricing Rule is valid until. Represented in RFC3339 full-date format (YYYY-MM-DD). * @return validUntilDate **/ - @ApiModelProperty(value = "Represents the date the pricing rule will become inactive. Represented in RFC3339 full-date format (YYYY-MM-DD).") + @ApiModelProperty(value = "Represents the date the Pricing Rule is valid until. Represented in RFC3339 full-date format (YYYY-MM-DD).") public String getValidUntilDate() { return validUntilDate; } @@ -236,10 +236,10 @@ public CatalogPricingRule validUntilLocalTime(String validUntilLocalTime) { } /** - * Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. + * Represents the local time the pricing rule should be valid until. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. * @return validUntilLocalTime **/ - @ApiModelProperty(value = "Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.") + @ApiModelProperty(value = "Represents the local time the pricing rule should be valid until. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.") public String getValidUntilLocalTime() { return validUntilLocalTime; } @@ -254,10 +254,10 @@ public CatalogPricingRule excludeStrategy(String excludeStrategy) { } /** - * If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. See `ExcludeStrategy` for all possible values. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values + * If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values * @return excludeStrategy **/ - @ApiModelProperty(value = "If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. See `ExcludeStrategy` for all possible values. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values") + @ApiModelProperty(value = "If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values") public String getExcludeStrategy() { return excludeStrategy; } diff --git a/src/main/java/com/squareup/connect/models/CatalogProductSet.java b/src/main/java/com/squareup/connect/models/CatalogProductSet.java index f5fe5d9..59b93e4 100644 --- a/src/main/java/com/squareup/connect/models/CatalogProductSet.java +++ b/src/main/java/com/squareup/connect/models/CatalogProductSet.java @@ -23,9 +23,9 @@ import java.util.List; /** - * Represents a collection of catalog objects for the purpose of applying a [PricingRule](#type-pricingrule). Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations. + * Represents a collection of catalog objects for the purpose of applying a `PricingRule`. Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations. */ -@ApiModel(description = "Represents a collection of catalog objects for the purpose of applying a [PricingRule](#type-pricingrule). Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations.") +@ApiModel(description = "Represents a collection of catalog objects for the purpose of applying a `PricingRule`. Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations.") public class CatalogProductSet { @JsonProperty("name") @@ -55,10 +55,10 @@ public CatalogProductSet name(String name) { } /** - * User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". + * User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". * @return name **/ - @ApiModelProperty(value = " User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\".") + @ApiModelProperty(value = "User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\".") public String getName() { return name; } @@ -78,10 +78,10 @@ public CatalogProductSet addProductIdsAnyItem(String productIdsAnyItem) { } /** - * Unique IDs for any `CatalogObjects`s to include in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. + * Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. * @return productIdsAny **/ - @ApiModelProperty(value = "Unique IDs for any `CatalogObjects`s to include in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.") + @ApiModelProperty(value = " Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.") public List getProductIdsAny() { return productIdsAny; } @@ -101,10 +101,10 @@ public CatalogProductSet addProductIdsAllItem(String productIdsAllItem) { } /** - * Unique IDs for `CatalogObjects` to include in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. + * Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. * @return productIdsAll **/ - @ApiModelProperty(value = "Unique IDs for `CatalogObjects` to include in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.") + @ApiModelProperty(value = "Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.") public List getProductIdsAll() { return productIdsAll; } diff --git a/src/main/java/com/squareup/connect/models/CatalogQuery.java b/src/main/java/com/squareup/connect/models/CatalogQuery.java index c478b42..acfaeee 100644 --- a/src/main/java/com/squareup/connect/models/CatalogQuery.java +++ b/src/main/java/com/squareup/connect/models/CatalogQuery.java @@ -30,9 +30,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest). Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. + * A query to be applied to a `SearchCatalogObjectsRequest`. Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) (`CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifierList`, `CatalogModifier`). For example, a query that should return Items may specify attribute names from any of the searchable fields of the `CatalogItem` data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. */ -@ApiModel(description = "A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest). Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`.") +@ApiModel(description = "A query to be applied to a `SearchCatalogObjectsRequest`. Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) (`CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifierList`, `CatalogModifier`). For example, a query that should return Items may specify attribute names from any of the searchable fields of the `CatalogItem` data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`.") public class CatalogQuery { @JsonProperty("sorted_attribute_query") @@ -158,10 +158,10 @@ public CatalogQuery itemsForTaxQuery(CatalogQueryItemsForTax itemsForTaxQuery) { } /** - * A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax`es enabled. + * A query that returns all `CatalogItem`s that have any of the given `CatalogTax`es enabled. * @return itemsForTaxQuery **/ - @ApiModelProperty(value = "A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax`es enabled.") + @ApiModelProperty(value = "A query that returns all `CatalogItem`s that have any of the given `CatalogTax`es enabled.") public CatalogQueryItemsForTax getItemsForTaxQuery() { return itemsForTaxQuery; } @@ -176,10 +176,10 @@ public CatalogQuery itemsForModifierListQuery(CatalogQueryItemsForModifierList i } /** - * A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList`s enabled. + * A query that returns all `CatalogItem`s that have any of the given `CatalogModifierList`s enabled. * @return itemsForModifierListQuery **/ - @ApiModelProperty(value = "A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList`s enabled.") + @ApiModelProperty(value = "A query that returns all `CatalogItem`s that have any of the given `CatalogModifierList`s enabled.") public CatalogQueryItemsForModifierList getItemsForModifierListQuery() { return itemsForModifierListQuery; } @@ -194,10 +194,10 @@ public CatalogQuery itemsForItemOptionsQuery(CatalogQueryItemsForItemOptions ite } /** - * A query that returns all `CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption`s. + * A query that returns all `CatalogItem`s that have all of the given `CatalogItemOption`s. * @return itemsForItemOptionsQuery **/ - @ApiModelProperty(value = "A query that returns all `CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption`s.") + @ApiModelProperty(value = "A query that returns all `CatalogItem`s that have all of the given `CatalogItemOption`s.") public CatalogQueryItemsForItemOptions getItemsForItemOptionsQuery() { return itemsForItemOptionsQuery; } @@ -212,10 +212,10 @@ public CatalogQuery itemVariationsForItemOptionValuesQuery(CatalogQueryItemVaria } /** - * A query that returns all `CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption` values. + * A query that returns all `CatalogItemVariation`s that have all of the given `CatalogItemOption` values. * @return itemVariationsForItemOptionValuesQuery **/ - @ApiModelProperty(value = "A query that returns all `CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption` values.") + @ApiModelProperty(value = "A query that returns all `CatalogItemVariation`s that have all of the given `CatalogItemOption` values.") public CatalogQueryItemVariationsForItemOptionValues getItemVariationsForItemOptionValuesQuery() { return itemVariationsForItemOptionValuesQuery; } diff --git a/src/main/java/com/squareup/connect/models/CatalogQueryCustomAttributeUsage.java b/src/main/java/com/squareup/connect/models/CatalogQueryCustomAttributeUsage.java new file mode 100644 index 0000000..3c7014f --- /dev/null +++ b/src/main/java/com/squareup/connect/models/CatalogQueryCustomAttributeUsage.java @@ -0,0 +1,121 @@ +/* + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.squareup.connect.models; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.util.ArrayList; +import java.util.List; + +/** + * + */ +@ApiModel(description = "") + +public class CatalogQueryCustomAttributeUsage { + @JsonProperty("custom_attribute_definition_ids") + private List customAttributeDefinitionIds = new ArrayList(); + + @JsonProperty("has_value") + private Boolean hasValue = null; + + public CatalogQueryCustomAttributeUsage customAttributeDefinitionIds(List customAttributeDefinitionIds) { + this.customAttributeDefinitionIds = customAttributeDefinitionIds; + return this; + } + + public CatalogQueryCustomAttributeUsage addCustomAttributeDefinitionIdsItem(String customAttributeDefinitionIdsItem) { + this.customAttributeDefinitionIds.add(customAttributeDefinitionIdsItem); + return this; + } + + /** + * + * @return customAttributeDefinitionIds + **/ + @ApiModelProperty(value = "") + public List getCustomAttributeDefinitionIds() { + return customAttributeDefinitionIds; + } + + public void setCustomAttributeDefinitionIds(List customAttributeDefinitionIds) { + this.customAttributeDefinitionIds = customAttributeDefinitionIds; + } + + public CatalogQueryCustomAttributeUsage hasValue(Boolean hasValue) { + this.hasValue = hasValue; + return this; + } + + /** + * + * @return hasValue + **/ + @ApiModelProperty(value = "") + public Boolean getHasValue() { + return hasValue; + } + + public void setHasValue(Boolean hasValue) { + this.hasValue = hasValue; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CatalogQueryCustomAttributeUsage catalogQueryCustomAttributeUsage = (CatalogQueryCustomAttributeUsage) o; + return Objects.equals(this.customAttributeDefinitionIds, catalogQueryCustomAttributeUsage.customAttributeDefinitionIds) && + Objects.equals(this.hasValue, catalogQueryCustomAttributeUsage.hasValue); + } + + @Override + public int hashCode() { + return Objects.hash(customAttributeDefinitionIds, hasValue); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CatalogQueryCustomAttributeUsage {\n"); + + sb.append(" customAttributeDefinitionIds: ").append(toIndentedString(customAttributeDefinitionIds)).append("\n"); + sb.append(" hasValue: ").append(toIndentedString(hasValue)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/squareup/connect/models/CatalogQueryFilteredItems.java b/src/main/java/com/squareup/connect/models/CatalogQueryFilteredItems.java new file mode 100644 index 0000000..94b4c62 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/CatalogQueryFilteredItems.java @@ -0,0 +1,336 @@ +/* + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.squareup.connect.models; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.squareup.connect.models.CatalogQueryFilteredItemsCustomAttributeFilter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.util.ArrayList; +import java.util.List; + +/** + * + */ +@ApiModel(description = "") + +public class CatalogQueryFilteredItems { + @JsonProperty("text_filter") + private String textFilter = null; + + @JsonProperty("search_vendor_code") + private Boolean searchVendorCode = null; + + @JsonProperty("category_ids") + private List categoryIds = new ArrayList(); + + @JsonProperty("stock_levels") + private List stockLevels = new ArrayList(); + + @JsonProperty("enabled_location_ids") + private List enabledLocationIds = new ArrayList(); + + @JsonProperty("vendor_ids") + private List vendorIds = new ArrayList(); + + @JsonProperty("product_types") + private List productTypes = new ArrayList(); + + @JsonProperty("custom_attribute_filters") + private List customAttributeFilters = new ArrayList(); + + @JsonProperty("does_not_exist") + private List doesNotExist = new ArrayList(); + + @JsonProperty("sort_order") + private String sortOrder = null; + + public CatalogQueryFilteredItems textFilter(String textFilter) { + this.textFilter = textFilter; + return this; + } + + /** + * + * @return textFilter + **/ + @ApiModelProperty(value = "") + public String getTextFilter() { + return textFilter; + } + + public void setTextFilter(String textFilter) { + this.textFilter = textFilter; + } + + public CatalogQueryFilteredItems searchVendorCode(Boolean searchVendorCode) { + this.searchVendorCode = searchVendorCode; + return this; + } + + /** + * + * @return searchVendorCode + **/ + @ApiModelProperty(value = "") + public Boolean getSearchVendorCode() { + return searchVendorCode; + } + + public void setSearchVendorCode(Boolean searchVendorCode) { + this.searchVendorCode = searchVendorCode; + } + + public CatalogQueryFilteredItems categoryIds(List categoryIds) { + this.categoryIds = categoryIds; + return this; + } + + public CatalogQueryFilteredItems addCategoryIdsItem(String categoryIdsItem) { + this.categoryIds.add(categoryIdsItem); + return this; + } + + /** + * + * @return categoryIds + **/ + @ApiModelProperty(value = "") + public List getCategoryIds() { + return categoryIds; + } + + public void setCategoryIds(List categoryIds) { + this.categoryIds = categoryIds; + } + + public CatalogQueryFilteredItems stockLevels(List stockLevels) { + this.stockLevels = stockLevels; + return this; + } + + public CatalogQueryFilteredItems addStockLevelsItem(String stockLevelsItem) { + this.stockLevels.add(stockLevelsItem); + return this; + } + + /** + * See [CatalogQueryFilteredItemsStockLevel](#type-catalogqueryfiltereditemsstocklevel) for possible values + * @return stockLevels + **/ + @ApiModelProperty(value = " See [CatalogQueryFilteredItemsStockLevel](#type-catalogqueryfiltereditemsstocklevel) for possible values") + public List getStockLevels() { + return stockLevels; + } + + public void setStockLevels(List stockLevels) { + this.stockLevels = stockLevels; + } + + public CatalogQueryFilteredItems enabledLocationIds(List enabledLocationIds) { + this.enabledLocationIds = enabledLocationIds; + return this; + } + + public CatalogQueryFilteredItems addEnabledLocationIdsItem(String enabledLocationIdsItem) { + this.enabledLocationIds.add(enabledLocationIdsItem); + return this; + } + + /** + * + * @return enabledLocationIds + **/ + @ApiModelProperty(value = "") + public List getEnabledLocationIds() { + return enabledLocationIds; + } + + public void setEnabledLocationIds(List enabledLocationIds) { + this.enabledLocationIds = enabledLocationIds; + } + + public CatalogQueryFilteredItems vendorIds(List vendorIds) { + this.vendorIds = vendorIds; + return this; + } + + public CatalogQueryFilteredItems addVendorIdsItem(String vendorIdsItem) { + this.vendorIds.add(vendorIdsItem); + return this; + } + + /** + * + * @return vendorIds + **/ + @ApiModelProperty(value = "") + public List getVendorIds() { + return vendorIds; + } + + public void setVendorIds(List vendorIds) { + this.vendorIds = vendorIds; + } + + public CatalogQueryFilteredItems productTypes(List productTypes) { + this.productTypes = productTypes; + return this; + } + + public CatalogQueryFilteredItems addProductTypesItem(String productTypesItem) { + this.productTypes.add(productTypesItem); + return this; + } + + /** + * See [CatalogItemProductType](#type-catalogitemproducttype) for possible values + * @return productTypes + **/ + @ApiModelProperty(value = " See [CatalogItemProductType](#type-catalogitemproducttype) for possible values") + public List getProductTypes() { + return productTypes; + } + + public void setProductTypes(List productTypes) { + this.productTypes = productTypes; + } + + public CatalogQueryFilteredItems customAttributeFilters(List customAttributeFilters) { + this.customAttributeFilters = customAttributeFilters; + return this; + } + + public CatalogQueryFilteredItems addCustomAttributeFiltersItem(CatalogQueryFilteredItemsCustomAttributeFilter customAttributeFiltersItem) { + this.customAttributeFilters.add(customAttributeFiltersItem); + return this; + } + + /** + * + * @return customAttributeFilters + **/ + @ApiModelProperty(value = "") + public List getCustomAttributeFilters() { + return customAttributeFilters; + } + + public void setCustomAttributeFilters(List customAttributeFilters) { + this.customAttributeFilters = customAttributeFilters; + } + + public CatalogQueryFilteredItems doesNotExist(List doesNotExist) { + this.doesNotExist = doesNotExist; + return this; + } + + public CatalogQueryFilteredItems addDoesNotExistItem(String doesNotExistItem) { + this.doesNotExist.add(doesNotExistItem); + return this; + } + + /** + * See [CatalogQueryFilteredItemsNullableAttribute](#type-catalogqueryfiltereditemsnullableattribute) for possible values + * @return doesNotExist + **/ + @ApiModelProperty(value = " See [CatalogQueryFilteredItemsNullableAttribute](#type-catalogqueryfiltereditemsnullableattribute) for possible values") + public List getDoesNotExist() { + return doesNotExist; + } + + public void setDoesNotExist(List doesNotExist) { + this.doesNotExist = doesNotExist; + } + + public CatalogQueryFilteredItems sortOrder(String sortOrder) { + this.sortOrder = sortOrder; + return this; + } + + /** + * See [SortOrder](#type-sortorder) for possible values + * @return sortOrder + **/ + @ApiModelProperty(value = " See [SortOrder](#type-sortorder) for possible values") + public String getSortOrder() { + return sortOrder; + } + + public void setSortOrder(String sortOrder) { + this.sortOrder = sortOrder; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CatalogQueryFilteredItems catalogQueryFilteredItems = (CatalogQueryFilteredItems) o; + return Objects.equals(this.textFilter, catalogQueryFilteredItems.textFilter) && + Objects.equals(this.searchVendorCode, catalogQueryFilteredItems.searchVendorCode) && + Objects.equals(this.categoryIds, catalogQueryFilteredItems.categoryIds) && + Objects.equals(this.stockLevels, catalogQueryFilteredItems.stockLevels) && + Objects.equals(this.enabledLocationIds, catalogQueryFilteredItems.enabledLocationIds) && + Objects.equals(this.vendorIds, catalogQueryFilteredItems.vendorIds) && + Objects.equals(this.productTypes, catalogQueryFilteredItems.productTypes) && + Objects.equals(this.customAttributeFilters, catalogQueryFilteredItems.customAttributeFilters) && + Objects.equals(this.doesNotExist, catalogQueryFilteredItems.doesNotExist) && + Objects.equals(this.sortOrder, catalogQueryFilteredItems.sortOrder); + } + + @Override + public int hashCode() { + return Objects.hash(textFilter, searchVendorCode, categoryIds, stockLevels, enabledLocationIds, vendorIds, productTypes, customAttributeFilters, doesNotExist, sortOrder); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CatalogQueryFilteredItems {\n"); + + sb.append(" textFilter: ").append(toIndentedString(textFilter)).append("\n"); + sb.append(" searchVendorCode: ").append(toIndentedString(searchVendorCode)).append("\n"); + sb.append(" categoryIds: ").append(toIndentedString(categoryIds)).append("\n"); + sb.append(" stockLevels: ").append(toIndentedString(stockLevels)).append("\n"); + sb.append(" enabledLocationIds: ").append(toIndentedString(enabledLocationIds)).append("\n"); + sb.append(" vendorIds: ").append(toIndentedString(vendorIds)).append("\n"); + sb.append(" productTypes: ").append(toIndentedString(productTypes)).append("\n"); + sb.append(" customAttributeFilters: ").append(toIndentedString(customAttributeFilters)).append("\n"); + sb.append(" doesNotExist: ").append(toIndentedString(doesNotExist)).append("\n"); + sb.append(" sortOrder: ").append(toIndentedString(sortOrder)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/squareup/connect/models/CatalogQueryFilteredItemsCustomAttributeFilter.java b/src/main/java/com/squareup/connect/models/CatalogQueryFilteredItemsCustomAttributeFilter.java new file mode 100644 index 0000000..7eb954b --- /dev/null +++ b/src/main/java/com/squareup/connect/models/CatalogQueryFilteredItemsCustomAttributeFilter.java @@ -0,0 +1,213 @@ +/* + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.squareup.connect.models; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.util.ArrayList; +import java.util.List; + +/** + * + */ +@ApiModel(description = "") + +public class CatalogQueryFilteredItemsCustomAttributeFilter { + @JsonProperty("filter_type") + private String filterType = null; + + @JsonProperty("custom_attribute_definition_ids") + private List customAttributeDefinitionIds = new ArrayList(); + + @JsonProperty("custom_attribute_value_exact") + private String customAttributeValueExact = null; + + @JsonProperty("custom_attribute_value_prefix") + private String customAttributeValuePrefix = null; + + @JsonProperty("custom_attribute_min_value") + private String customAttributeMinValue = null; + + @JsonProperty("custom_attribute_max_value") + private String customAttributeMaxValue = null; + + public CatalogQueryFilteredItemsCustomAttributeFilter filterType(String filterType) { + this.filterType = filterType; + return this; + } + + /** + * See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values + * @return filterType + **/ + @ApiModelProperty(value = " See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values") + public String getFilterType() { + return filterType; + } + + public void setFilterType(String filterType) { + this.filterType = filterType; + } + + public CatalogQueryFilteredItemsCustomAttributeFilter customAttributeDefinitionIds(List customAttributeDefinitionIds) { + this.customAttributeDefinitionIds = customAttributeDefinitionIds; + return this; + } + + public CatalogQueryFilteredItemsCustomAttributeFilter addCustomAttributeDefinitionIdsItem(String customAttributeDefinitionIdsItem) { + this.customAttributeDefinitionIds.add(customAttributeDefinitionIdsItem); + return this; + } + + /** + * + * @return customAttributeDefinitionIds + **/ + @ApiModelProperty(value = "") + public List getCustomAttributeDefinitionIds() { + return customAttributeDefinitionIds; + } + + public void setCustomAttributeDefinitionIds(List customAttributeDefinitionIds) { + this.customAttributeDefinitionIds = customAttributeDefinitionIds; + } + + public CatalogQueryFilteredItemsCustomAttributeFilter customAttributeValueExact(String customAttributeValueExact) { + this.customAttributeValueExact = customAttributeValueExact; + return this; + } + + /** + * + * @return customAttributeValueExact + **/ + @ApiModelProperty(value = "") + public String getCustomAttributeValueExact() { + return customAttributeValueExact; + } + + public void setCustomAttributeValueExact(String customAttributeValueExact) { + this.customAttributeValueExact = customAttributeValueExact; + } + + public CatalogQueryFilteredItemsCustomAttributeFilter customAttributeValuePrefix(String customAttributeValuePrefix) { + this.customAttributeValuePrefix = customAttributeValuePrefix; + return this; + } + + /** + * + * @return customAttributeValuePrefix + **/ + @ApiModelProperty(value = "") + public String getCustomAttributeValuePrefix() { + return customAttributeValuePrefix; + } + + public void setCustomAttributeValuePrefix(String customAttributeValuePrefix) { + this.customAttributeValuePrefix = customAttributeValuePrefix; + } + + public CatalogQueryFilteredItemsCustomAttributeFilter customAttributeMinValue(String customAttributeMinValue) { + this.customAttributeMinValue = customAttributeMinValue; + return this; + } + + /** + * + * @return customAttributeMinValue + **/ + @ApiModelProperty(value = "") + public String getCustomAttributeMinValue() { + return customAttributeMinValue; + } + + public void setCustomAttributeMinValue(String customAttributeMinValue) { + this.customAttributeMinValue = customAttributeMinValue; + } + + public CatalogQueryFilteredItemsCustomAttributeFilter customAttributeMaxValue(String customAttributeMaxValue) { + this.customAttributeMaxValue = customAttributeMaxValue; + return this; + } + + /** + * + * @return customAttributeMaxValue + **/ + @ApiModelProperty(value = "") + public String getCustomAttributeMaxValue() { + return customAttributeMaxValue; + } + + public void setCustomAttributeMaxValue(String customAttributeMaxValue) { + this.customAttributeMaxValue = customAttributeMaxValue; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CatalogQueryFilteredItemsCustomAttributeFilter catalogQueryFilteredItemsCustomAttributeFilter = (CatalogQueryFilteredItemsCustomAttributeFilter) o; + return Objects.equals(this.filterType, catalogQueryFilteredItemsCustomAttributeFilter.filterType) && + Objects.equals(this.customAttributeDefinitionIds, catalogQueryFilteredItemsCustomAttributeFilter.customAttributeDefinitionIds) && + Objects.equals(this.customAttributeValueExact, catalogQueryFilteredItemsCustomAttributeFilter.customAttributeValueExact) && + Objects.equals(this.customAttributeValuePrefix, catalogQueryFilteredItemsCustomAttributeFilter.customAttributeValuePrefix) && + Objects.equals(this.customAttributeMinValue, catalogQueryFilteredItemsCustomAttributeFilter.customAttributeMinValue) && + Objects.equals(this.customAttributeMaxValue, catalogQueryFilteredItemsCustomAttributeFilter.customAttributeMaxValue); + } + + @Override + public int hashCode() { + return Objects.hash(filterType, customAttributeDefinitionIds, customAttributeValueExact, customAttributeValuePrefix, customAttributeMinValue, customAttributeMaxValue); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CatalogQueryFilteredItemsCustomAttributeFilter {\n"); + + sb.append(" filterType: ").append(toIndentedString(filterType)).append("\n"); + sb.append(" customAttributeDefinitionIds: ").append(toIndentedString(customAttributeDefinitionIds)).append("\n"); + sb.append(" customAttributeValueExact: ").append(toIndentedString(customAttributeValueExact)).append("\n"); + sb.append(" customAttributeValuePrefix: ").append(toIndentedString(customAttributeValuePrefix)).append("\n"); + sb.append(" customAttributeMinValue: ").append(toIndentedString(customAttributeMinValue)).append("\n"); + sb.append(" customAttributeMaxValue: ").append(toIndentedString(customAttributeMaxValue)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/squareup/connect/models/CatalogQueryItemsForItemOptions.java b/src/main/java/com/squareup/connect/models/CatalogQueryItemsForItemOptions.java index d011fff..ac2819b 100644 --- a/src/main/java/com/squareup/connect/models/CatalogQueryItemsForItemOptions.java +++ b/src/main/java/com/squareup/connect/models/CatalogQueryItemsForItemOptions.java @@ -42,10 +42,10 @@ public CatalogQueryItemsForItemOptions addItemOptionIdsItem(String itemOptionIds } /** - * A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` will be returned. + * A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem`s. All Items that contain all of the given Item Options (in any order) will be returned. * @return itemOptionIds **/ - @ApiModelProperty(value = "A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` will be returned.") + @ApiModelProperty(value = "A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem`s. All Items that contain all of the given Item Options (in any order) will be returned.") public List getItemOptionIds() { return itemOptionIds; } diff --git a/src/main/java/com/squareup/connect/models/CatalogQueryItemsForModifierList.java b/src/main/java/com/squareup/connect/models/CatalogQueryItemsForModifierList.java index b7c05ef..fbe24b2 100644 --- a/src/main/java/com/squareup/connect/models/CatalogQueryItemsForModifierList.java +++ b/src/main/java/com/squareup/connect/models/CatalogQueryItemsForModifierList.java @@ -42,10 +42,10 @@ public CatalogQueryItemsForModifierList addModifierListIdsItem(String modifierLi } /** - * A set of `CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem`s. + * A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. * @return modifierListIds **/ - @ApiModelProperty(required = true, value = "A set of `CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem`s.") + @ApiModelProperty(required = true, value = "A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s.") public List getModifierListIds() { return modifierListIds; } diff --git a/src/main/java/com/squareup/connect/models/CatalogQueryItemsForTax.java b/src/main/java/com/squareup/connect/models/CatalogQueryItemsForTax.java index 2099dc5..11348b5 100644 --- a/src/main/java/com/squareup/connect/models/CatalogQueryItemsForTax.java +++ b/src/main/java/com/squareup/connect/models/CatalogQueryItemsForTax.java @@ -42,10 +42,10 @@ public CatalogQueryItemsForTax addTaxIdsItem(String taxIdsItem) { } /** - * A set of `CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem`s. + * A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. * @return taxIds **/ - @ApiModelProperty(required = true, value = "A set of `CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem`s.") + @ApiModelProperty(required = true, value = "A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s.") public List getTaxIds() { return taxIds; } diff --git a/src/main/java/com/squareup/connect/models/CatalogQuerySortedAttribute.java b/src/main/java/com/squareup/connect/models/CatalogQuerySortedAttribute.java index edda6d9..7caeda8 100644 --- a/src/main/java/com/squareup/connect/models/CatalogQuerySortedAttribute.java +++ b/src/main/java/com/squareup/connect/models/CatalogQuerySortedAttribute.java @@ -77,10 +77,10 @@ public CatalogQuerySortedAttribute sortOrder(String sortOrder) { } /** - * The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values + * The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values * @return sortOrder **/ - @ApiModelProperty(value = "The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values") + @ApiModelProperty(value = "The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values") public String getSortOrder() { return sortOrder; } diff --git a/src/main/java/com/squareup/connect/models/CatalogQueryText.java b/src/main/java/com/squareup/connect/models/CatalogQueryText.java index 8528fce..59e0bb0 100644 --- a/src/main/java/com/squareup/connect/models/CatalogQueryText.java +++ b/src/main/java/com/squareup/connect/models/CatalogQueryText.java @@ -42,10 +42,10 @@ public CatalogQueryText addKeywordsItem(String keywordsItem) { } /** - * A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored. + * A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 characters are ignored. * @return keywords **/ - @ApiModelProperty(required = true, value = "A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored.") + @ApiModelProperty(required = true, value = "A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 characters are ignored.") public List getKeywords() { return keywords; } diff --git a/src/main/java/com/squareup/connect/models/CatalogV1Id.java b/src/main/java/com/squareup/connect/models/CatalogV1Id.java index ef0efce..b2fabd7 100644 --- a/src/main/java/com/squareup/connect/models/CatalogV1Id.java +++ b/src/main/java/com/squareup/connect/models/CatalogV1Id.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * An Items Connect V1 object ID along with its associated [location](#type-location) ID. + * An Items Connect V1 object ID along with its associated location ID. */ -@ApiModel(description = "An Items Connect V1 object ID along with its associated [location](#type-location) ID.") +@ApiModel(description = "An Items Connect V1 object ID along with its associated location ID.") public class CatalogV1Id { @JsonProperty("catalog_v1_id") @@ -56,10 +56,10 @@ public CatalogV1Id locationId(String locationId) { } /** - * The ID of the `location` this Connect V1 ID is associated with. + * The ID of the `Location` this Connect V1 ID is associated with. * @return locationId **/ - @ApiModelProperty(value = "The ID of the `location` this Connect V1 ID is associated with.") + @ApiModelProperty(value = "The ID of the `Location` this Connect V1 ID is associated with.") public String getLocationId() { return locationId; } diff --git a/src/main/java/com/squareup/connect/models/ChargeRequest.java b/src/main/java/com/squareup/connect/models/ChargeRequest.java index 726ff08..2a0c6bf 100644 --- a/src/main/java/com/squareup/connect/models/ChargeRequest.java +++ b/src/main/java/com/squareup/connect/models/ChargeRequest.java @@ -79,10 +79,10 @@ public ChargeRequest idempotencyKey(String idempotencyKey) { } /** - * A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + * A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. * @return idempotencyKey **/ - @ApiModelProperty(required = true, value = "A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") + @ApiModelProperty(required = true, value = "A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information.") public String getIdempotencyKey() { return idempotencyKey; } @@ -223,10 +223,10 @@ public ChargeRequest billingAddress(Address billingAddress) { } /** - * The buyer's billing address. + * The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided. * @return billingAddress **/ - @ApiModelProperty(value = "The buyer's billing address.") + @ApiModelProperty(value = "The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided.") public Address getBillingAddress() { return billingAddress; } @@ -241,10 +241,10 @@ public ChargeRequest shippingAddress(Address shippingAddress) { } /** - * The buyer's shipping address, if available. + * The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. * @return shippingAddress **/ - @ApiModelProperty(value = "The buyer's shipping address, if available.") + @ApiModelProperty(value = "The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided.") public Address getShippingAddress() { return shippingAddress; } @@ -259,10 +259,10 @@ public ChargeRequest buyerEmailAddress(String buyerEmailAddress) { } /** - * The buyer's email address, if available. + * The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. * @return buyerEmailAddress **/ - @ApiModelProperty(value = "The buyer's email address, if available.") + @ApiModelProperty(value = "The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided.") public String getBuyerEmailAddress() { return buyerEmailAddress; } @@ -318,10 +318,10 @@ public ChargeRequest verificationToken(String verificationToken) { } /** - * An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. + * A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result. * @return verificationToken **/ - @ApiModelProperty(value = "An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity.") + @ApiModelProperty(value = "A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result.") public String getVerificationToken() { return verificationToken; } diff --git a/src/main/java/com/squareup/connect/models/Coordinates.java b/src/main/java/com/squareup/connect/models/Coordinates.java index 4d92c47..44bbdee 100644 --- a/src/main/java/com/squareup/connect/models/Coordinates.java +++ b/src/main/java/com/squareup/connect/models/Coordinates.java @@ -39,10 +39,10 @@ public Coordinates latitude(BigDecimal latitude) { } /** - * The coordinate's latitude expressed in degrees. + * The latitude of the coordinate expressed in degrees. * @return latitude **/ - @ApiModelProperty(value = "The coordinate's latitude expressed in degrees.") + @ApiModelProperty(value = "The latitude of the coordinate expressed in degrees.") public BigDecimal getLatitude() { return latitude; } @@ -57,10 +57,10 @@ public Coordinates longitude(BigDecimal longitude) { } /** - * The coordinate's longitude expressed in degrees. + * The longitude of the coordinate expressed in degrees. * @return longitude **/ - @ApiModelProperty(value = "The coordinate's longitude expressed in degrees.") + @ApiModelProperty(value = "The longitude of the coordinate expressed in degrees.") public BigDecimal getLongitude() { return longitude; } diff --git a/src/main/java/com/squareup/connect/models/CreateCatalogImageRequest.java b/src/main/java/com/squareup/connect/models/CreateCatalogImageRequest.java new file mode 100644 index 0000000..176fd74 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/CreateCatalogImageRequest.java @@ -0,0 +1,138 @@ +/* + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.squareup.connect.models; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.squareup.connect.models.CatalogObject; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +/** + * + */ +@ApiModel(description = "") + +public class CreateCatalogImageRequest { + @JsonProperty("idempotency_key") + private String idempotencyKey = null; + + @JsonProperty("object_id") + private String objectId = null; + + @JsonProperty("image") + private CatalogObject image = null; + + public CreateCatalogImageRequest idempotencyKey(String idempotencyKey) { + this.idempotencyKey = idempotencyKey; + return this; + } + + /** + * A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + * @return idempotencyKey + **/ + @ApiModelProperty(required = true, value = "A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") + public String getIdempotencyKey() { + return idempotencyKey; + } + + public void setIdempotencyKey(String idempotencyKey) { + this.idempotencyKey = idempotencyKey; + } + + public CreateCatalogImageRequest objectId(String objectId) { + this.objectId = objectId; + return this; + } + + /** + * Unique ID of the `CatalogObject` to attach to this `CatalogImage`. Leave this field empty to create unattached images, for example if you are building an integration where these images can be attached to catalog items at a later time. + * @return objectId + **/ + @ApiModelProperty(value = "Unique ID of the `CatalogObject` to attach to this `CatalogImage`. Leave this field empty to create unattached images, for example if you are building an integration where these images can be attached to catalog items at a later time.") + public String getObjectId() { + return objectId; + } + + public void setObjectId(String objectId) { + this.objectId = objectId; + } + + public CreateCatalogImageRequest image(CatalogObject image) { + this.image = image; + return this; + } + + /** + * The new `IMAGE`-type `CatalogObject` to be attached to this `CatalogImage`. If the `CatalogObject` already has a `CatalogImage`, this call will overwrite it. + * @return image + **/ + @ApiModelProperty(value = "The new `IMAGE`-type `CatalogObject` to be attached to this `CatalogImage`. If the `CatalogObject` already has a `CatalogImage`, this call will overwrite it.") + public CatalogObject getImage() { + return image; + } + + public void setImage(CatalogObject image) { + this.image = image; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CreateCatalogImageRequest createCatalogImageRequest = (CreateCatalogImageRequest) o; + return Objects.equals(this.idempotencyKey, createCatalogImageRequest.idempotencyKey) && + Objects.equals(this.objectId, createCatalogImageRequest.objectId) && + Objects.equals(this.image, createCatalogImageRequest.image); + } + + @Override + public int hashCode() { + return Objects.hash(idempotencyKey, objectId, image); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CreateCatalogImageRequest {\n"); + + sb.append(" idempotencyKey: ").append(toIndentedString(idempotencyKey)).append("\n"); + sb.append(" objectId: ").append(toIndentedString(objectId)).append("\n"); + sb.append(" image: ").append(toIndentedString(image)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/squareup/connect/models/CreateCatalogImageResponse.java b/src/main/java/com/squareup/connect/models/CreateCatalogImageResponse.java new file mode 100644 index 0000000..6d2b3d9 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/CreateCatalogImageResponse.java @@ -0,0 +1,123 @@ +/* + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.squareup.connect.models; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.squareup.connect.models.CatalogObject; +import com.squareup.connect.models.Error; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.util.ArrayList; +import java.util.List; + +/** + * + */ +@ApiModel(description = "") + +public class CreateCatalogImageResponse { + @JsonProperty("errors") + private List errors = new ArrayList(); + + @JsonProperty("image") + private CatalogObject image = null; + + public CreateCatalogImageResponse errors(List errors) { + this.errors = errors; + return this; + } + + public CreateCatalogImageResponse addErrorsItem(Error errorsItem) { + this.errors.add(errorsItem); + return this; + } + + /** + * Information on any errors encountered. + * @return errors + **/ + @ApiModelProperty(value = "Information on any errors encountered.") + public List getErrors() { + return errors; + } + + public void setErrors(List errors) { + this.errors = errors; + } + + public CreateCatalogImageResponse image(CatalogObject image) { + this.image = image; + return this; + } + + /** + * The newly created `CatalogImage` including a Square-generated URL for each image. + * @return image + **/ + @ApiModelProperty(value = "The newly created `CatalogImage` including a Square-generated URL for each image.") + public CatalogObject getImage() { + return image; + } + + public void setImage(CatalogObject image) { + this.image = image; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CreateCatalogImageResponse createCatalogImageResponse = (CreateCatalogImageResponse) o; + return Objects.equals(this.errors, createCatalogImageResponse.errors) && + Objects.equals(this.image, createCatalogImageResponse.image); + } + + @Override + public int hashCode() { + return Objects.hash(errors, image); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CreateCatalogImageResponse {\n"); + + sb.append(" errors: ").append(toIndentedString(errors)).append("\n"); + sb.append(" image: ").append(toIndentedString(image)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/squareup/connect/models/CreateCheckoutRequest.java b/src/main/java/com/squareup/connect/models/CreateCheckoutRequest.java index 4ceb6b3..8494795 100644 --- a/src/main/java/com/squareup/connect/models/CreateCheckoutRequest.java +++ b/src/main/java/com/squareup/connect/models/CreateCheckoutRequest.java @@ -26,9 +26,9 @@ import java.util.List; /** - * Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint. + * Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. */ -@ApiModel(description = "Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint.") +@ApiModel(description = "Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint.") public class CreateCheckoutRequest { @JsonProperty("idempotency_key") @@ -64,10 +64,10 @@ public CreateCheckoutRequest idempotencyKey(String idempotencyKey) { } /** - * 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](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + * 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. * @return idempotencyKey **/ - @ApiModelProperty(required = true, value = "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](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") + @ApiModelProperty(required = true, value = "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.") public String getIdempotencyKey() { return idempotencyKey; } diff --git a/src/main/java/com/squareup/connect/models/CreateCheckoutResponse.java b/src/main/java/com/squareup/connect/models/CreateCheckoutResponse.java index c80cd57..79b89a2 100644 --- a/src/main/java/com/squareup/connect/models/CreateCheckoutResponse.java +++ b/src/main/java/com/squareup/connect/models/CreateCheckoutResponse.java @@ -25,9 +25,9 @@ import java.util.List; /** - * Defines the fields that are included in the response body of a request to the CreateCheckout endpoint. + * Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. */ -@ApiModel(description = "Defines the fields that are included in the response body of a request to the CreateCheckout endpoint.") +@ApiModel(description = "Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint.") public class CreateCheckoutResponse { @JsonProperty("checkout") diff --git a/src/main/java/com/squareup/connect/models/CreateCustomerCardRequest.java b/src/main/java/com/squareup/connect/models/CreateCustomerCardRequest.java index 708ab2c..668129b 100644 --- a/src/main/java/com/squareup/connect/models/CreateCustomerCardRequest.java +++ b/src/main/java/com/squareup/connect/models/CreateCustomerCardRequest.java @@ -45,10 +45,10 @@ public CreateCustomerCardRequest cardNonce(String cardNonce) { } /** - * A card nonce representing the credit card to link to the customer. Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __Note:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. + * A card nonce representing the credit card to link to the customer. Card nonces are generated by the Square Payment Form when customers enter their card information. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __NOTE:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. * @return cardNonce **/ - @ApiModelProperty(required = true, value = "A card nonce representing the credit card to link to the customer. Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __Note:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card.") + @ApiModelProperty(required = true, value = "A card nonce representing the credit card to link to the customer. Card nonces are generated by the Square Payment Form when customers enter their card information. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __NOTE:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card.") public String getCardNonce() { return cardNonce; } diff --git a/src/main/java/com/squareup/connect/models/CreateCustomerRequest.java b/src/main/java/com/squareup/connect/models/CreateCustomerRequest.java index 463f6f1..484dc3b 100644 --- a/src/main/java/com/squareup/connect/models/CreateCustomerRequest.java +++ b/src/main/java/com/squareup/connect/models/CreateCustomerRequest.java @@ -66,10 +66,10 @@ public CreateCustomerRequest idempotencyKey(String idempotencyKey) { } /** - * The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information. + * The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) guide for more information. * @return idempotencyKey **/ - @ApiModelProperty(value = "The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information.") + @ApiModelProperty(value = "The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) guide for more information.") public String getIdempotencyKey() { return idempotencyKey; } @@ -84,10 +84,10 @@ public CreateCustomerRequest givenName(String givenName) { } /** - * The customer's given (i.e., first) name. + * The given (i.e., first) name associated with the customer profile. * @return givenName **/ - @ApiModelProperty(value = "The customer's given (i.e., first) name.") + @ApiModelProperty(value = "The given (i.e., first) name associated with the customer profile.") public String getGivenName() { return givenName; } @@ -102,10 +102,10 @@ public CreateCustomerRequest familyName(String familyName) { } /** - * The customer's family (i.e., last) name. + * The family (i.e., last) name associated with the customer profile. * @return familyName **/ - @ApiModelProperty(value = "The customer's family (i.e., last) name.") + @ApiModelProperty(value = "The family (i.e., last) name associated with the customer profile.") public String getFamilyName() { return familyName; } @@ -120,10 +120,10 @@ public CreateCustomerRequest companyName(String companyName) { } /** - * The name of the customer's company. + * A business name associated with the customer profile. * @return companyName **/ - @ApiModelProperty(value = "The name of the customer's company.") + @ApiModelProperty(value = "A business name associated with the customer profile.") public String getCompanyName() { return companyName; } @@ -138,10 +138,10 @@ public CreateCustomerRequest nickname(String nickname) { } /** - * A nickname for the customer. + * A nickname for the customer profile. * @return nickname **/ - @ApiModelProperty(value = "A nickname for the customer.") + @ApiModelProperty(value = "A nickname for the customer profile.") public String getNickname() { return nickname; } @@ -156,10 +156,10 @@ public CreateCustomerRequest emailAddress(String emailAddress) { } /** - * The customer's email address. + * The email address associated with the customer profile. * @return emailAddress **/ - @ApiModelProperty(value = "The customer's email address.") + @ApiModelProperty(value = "The email address associated with the customer profile.") public String getEmailAddress() { return emailAddress; } @@ -174,10 +174,10 @@ public CreateCustomerRequest address(Address address) { } /** - * The customer's physical address. + * The physical address associated with the customer profile. * @return address **/ - @ApiModelProperty(value = "The customer's physical address.") + @ApiModelProperty(value = "The physical address associated with the customer profile.") public Address getAddress() { return address; } @@ -192,10 +192,10 @@ public CreateCustomerRequest phoneNumber(String phoneNumber) { } /** - * The customer's phone number. + * The 11-digit phone number associated with the customer profile. * @return phoneNumber **/ - @ApiModelProperty(value = "The customer's phone number.") + @ApiModelProperty(value = "The 11-digit phone number associated with the customer profile.") public String getPhoneNumber() { return phoneNumber; } @@ -210,10 +210,10 @@ public CreateCustomerRequest referenceId(String referenceId) { } /** - * An optional second ID you can set to associate the customer with an entity in another system. + * An optional, second ID used to associate the customer profile with an entity in another system. * @return referenceId **/ - @ApiModelProperty(value = "An optional second ID you can set to associate the customer with an entity in another system.") + @ApiModelProperty(value = "An optional, second ID used to associate the customer profile with an entity in another system.") public String getReferenceId() { return referenceId; } @@ -228,10 +228,10 @@ public CreateCustomerRequest note(String note) { } /** - * An optional note to associate with the customer. + * A custom note associated with the customer profile. * @return note **/ - @ApiModelProperty(value = "An optional note to associate with the customer.") + @ApiModelProperty(value = "A custom note associated with the customer profile.") public String getNote() { return note; } @@ -246,10 +246,10 @@ public CreateCustomerRequest birthday(String birthday) { } /** - * The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. + * The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. * @return birthday **/ - @ApiModelProperty(value = "The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.") + @ApiModelProperty(value = "The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__.") public String getBirthday() { return birthday; } diff --git a/src/main/java/com/squareup/connect/models/CreateLocationRequest.java b/src/main/java/com/squareup/connect/models/CreateLocationRequest.java new file mode 100644 index 0000000..ad494b1 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/CreateLocationRequest.java @@ -0,0 +1,92 @@ +/* + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.squareup.connect.models; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.squareup.connect.models.Location; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +/** + * Request object for the [CreateLocation](#endpoint-createlocation) endpoint. + */ +@ApiModel(description = "Request object for the [CreateLocation](#endpoint-createlocation) endpoint.") + +public class CreateLocationRequest { + @JsonProperty("location") + private Location location = null; + + public CreateLocationRequest location(Location location) { + this.location = location; + return this; + } + + /** + * The initial values of the location being created. The `name` field is required. All other fields are optional. Unspecified fields will be set to default values using existing location data. + * @return location + **/ + @ApiModelProperty(value = "The initial values of the location being created. The `name` field is required. All other fields are optional. Unspecified fields will be set to default values using existing location data.") + public Location getLocation() { + return location; + } + + public void setLocation(Location location) { + this.location = location; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CreateLocationRequest createLocationRequest = (CreateLocationRequest) o; + return Objects.equals(this.location, createLocationRequest.location); + } + + @Override + public int hashCode() { + return Objects.hash(location); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CreateLocationRequest {\n"); + + sb.append(" location: ").append(toIndentedString(location)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/squareup/connect/models/CreateLocationResponse.java b/src/main/java/com/squareup/connect/models/CreateLocationResponse.java new file mode 100644 index 0000000..9f7ad09 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/CreateLocationResponse.java @@ -0,0 +1,123 @@ +/* + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.squareup.connect.models; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.squareup.connect.models.Error; +import com.squareup.connect.models.Location; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.util.ArrayList; +import java.util.List; + +/** + * Response object returned by the [CreateLocation](#endpoint-createlocation) endpoint. + */ +@ApiModel(description = "Response object returned by the [CreateLocation](#endpoint-createlocation) endpoint.") + +public class CreateLocationResponse { + @JsonProperty("errors") + private List errors = new ArrayList(); + + @JsonProperty("location") + private Location location = null; + + public CreateLocationResponse errors(List errors) { + this.errors = errors; + return this; + } + + public CreateLocationResponse addErrorsItem(Error errorsItem) { + this.errors.add(errorsItem); + return this; + } + + /** + * Information on errors encountered during the request. + * @return errors + **/ + @ApiModelProperty(value = "Information on errors encountered during the request.") + public List getErrors() { + return errors; + } + + public void setErrors(List errors) { + this.errors = errors; + } + + public CreateLocationResponse location(Location location) { + this.location = location; + return this; + } + + /** + * The newly created `Location`. + * @return location + **/ + @ApiModelProperty(value = "The newly created `Location`.") + public Location getLocation() { + return location; + } + + public void setLocation(Location location) { + this.location = location; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CreateLocationResponse createLocationResponse = (CreateLocationResponse) o; + return Objects.equals(this.errors, createLocationResponse.errors) && + Objects.equals(this.location, createLocationResponse.location); + } + + @Override + public int hashCode() { + return Objects.hash(errors, location); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CreateLocationResponse {\n"); + + sb.append(" errors: ").append(toIndentedString(errors)).append("\n"); + sb.append(" location: ").append(toIndentedString(location)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/squareup/connect/models/CreateMobileAuthorizationCodeRequest.java b/src/main/java/com/squareup/connect/models/CreateMobileAuthorizationCodeRequest.java index 6305e24..8d06525 100644 --- a/src/main/java/com/squareup/connect/models/CreateMobileAuthorizationCodeRequest.java +++ b/src/main/java/com/squareup/connect/models/CreateMobileAuthorizationCodeRequest.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Defines the body parameters that can be provided in a request to the CreateMobileAuthorizationCode endpoint. + * Defines the body parameters that can be provided in a request to the __CreateMobileAuthorizationCode__ endpoint. */ -@ApiModel(description = "Defines the body parameters that can be provided in a request to the CreateMobileAuthorizationCode endpoint.") +@ApiModel(description = "Defines the body parameters that can be provided in a request to the __CreateMobileAuthorizationCode__ endpoint.") public class CreateMobileAuthorizationCodeRequest { @JsonProperty("location_id") diff --git a/src/main/java/com/squareup/connect/models/CreateMobileAuthorizationCodeResponse.java b/src/main/java/com/squareup/connect/models/CreateMobileAuthorizationCodeResponse.java index e630fc8..f56257c 100644 --- a/src/main/java/com/squareup/connect/models/CreateMobileAuthorizationCodeResponse.java +++ b/src/main/java/com/squareup/connect/models/CreateMobileAuthorizationCodeResponse.java @@ -22,9 +22,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Defines the fields that are included in the response body of a request to the CreateMobileAuthorizationCode endpoint. + * Defines the fields that are included in the response body of a request to the __CreateMobileAuthorizationCode__ endpoint. */ -@ApiModel(description = "Defines the fields that are included in the response body of a request to the CreateMobileAuthorizationCode endpoint.") +@ApiModel(description = "Defines the fields that are included in the response body of a request to the __CreateMobileAuthorizationCode__ endpoint.") public class CreateMobileAuthorizationCodeResponse { @JsonProperty("authorization_code") diff --git a/src/main/java/com/squareup/connect/models/CreatePaymentRequest.java b/src/main/java/com/squareup/connect/models/CreatePaymentRequest.java index 649d2d3..a435abe 100644 --- a/src/main/java/com/squareup/connect/models/CreatePaymentRequest.java +++ b/src/main/java/com/squareup/connect/models/CreatePaymentRequest.java @@ -23,9 +23,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees). + * Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees). */ -@ApiModel(description = "Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees).") +@ApiModel(description = "Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees).") public class CreatePaymentRequest { @JsonProperty("source_id") @@ -76,6 +76,9 @@ public class CreatePaymentRequest { @JsonProperty("note") private String note = null; + @JsonProperty("statement_description_identifier") + private String statementDescriptionIdentifier = null; + public CreatePaymentRequest sourceId(String sourceId) { this.sourceId = sourceId; return this; @@ -100,10 +103,10 @@ public CreatePaymentRequest idempotencyKey(String idempotencyKey) { } /** - * A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + * A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. * @return idempotencyKey **/ - @ApiModelProperty(required = true, value = "A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") + @ApiModelProperty(required = true, value = "A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") public String getIdempotencyKey() { return idempotencyKey; } @@ -154,10 +157,10 @@ public CreatePaymentRequest appFeeMoney(Money appFeeMoney) { } /** - * The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + * The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). * @return appFeeMoney **/ - @ApiModelProperty(value = "The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).") + @ApiModelProperty(value = "The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).") public Money getAppFeeMoney() { return appFeeMoney; } @@ -262,10 +265,10 @@ public CreatePaymentRequest verificationToken(String verificationToken) { } /** - * An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/docs/sca-overview) for more. + * An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/sca-overview) for more. * @return verificationToken **/ - @ApiModelProperty(value = "An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/docs/sca-overview) for more.") + @ApiModelProperty(value = "An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/sca-overview) for more.") public String getVerificationToken() { return verificationToken; } @@ -280,11 +283,11 @@ public CreatePaymentRequest acceptPartialAuthorization(Boolean acceptPartialAuth } /** - * If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false + * If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true`. For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false * Note: This model is in beta. * @return acceptPartialAuthorization **/ - @ApiModelProperty(value = "If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false") + @ApiModelProperty(value = "If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true`. For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false") public Boolean getAcceptPartialAuthorization() { return acceptPartialAuthorization; } @@ -365,6 +368,25 @@ public void setNote(String note) { this.note = note; } + public CreatePaymentRequest statementDescriptionIdentifier(String statementDescriptionIdentifier) { + this.statementDescriptionIdentifier = statementDescriptionIdentifier; + return this; + } + + /** + * Optional additional payment information to include on the customer's card statement as part of statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Limit 20 characters. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. + * Note: This model is in beta. + * @return statementDescriptionIdentifier + **/ + @ApiModelProperty(value = "Optional additional payment information to include on the customer's card statement as part of statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Limit 20 characters. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment.") + public String getStatementDescriptionIdentifier() { + return statementDescriptionIdentifier; + } + + public void setStatementDescriptionIdentifier(String statementDescriptionIdentifier) { + this.statementDescriptionIdentifier = statementDescriptionIdentifier; + } + @Override public boolean equals(java.lang.Object o) { @@ -390,12 +412,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.buyerEmailAddress, createPaymentRequest.buyerEmailAddress) && Objects.equals(this.billingAddress, createPaymentRequest.billingAddress) && Objects.equals(this.shippingAddress, createPaymentRequest.shippingAddress) && - Objects.equals(this.note, createPaymentRequest.note); + Objects.equals(this.note, createPaymentRequest.note) && + Objects.equals(this.statementDescriptionIdentifier, createPaymentRequest.statementDescriptionIdentifier); } @Override public int hashCode() { - return Objects.hash(sourceId, idempotencyKey, amountMoney, tipMoney, appFeeMoney, autocomplete, orderId, customerId, locationId, referenceId, verificationToken, acceptPartialAuthorization, buyerEmailAddress, billingAddress, shippingAddress, note); + return Objects.hash(sourceId, idempotencyKey, amountMoney, tipMoney, appFeeMoney, autocomplete, orderId, customerId, locationId, referenceId, verificationToken, acceptPartialAuthorization, buyerEmailAddress, billingAddress, shippingAddress, note, statementDescriptionIdentifier); } @@ -420,6 +443,7 @@ public String toString() { sb.append(" billingAddress: ").append(toIndentedString(billingAddress)).append("\n"); sb.append(" shippingAddress: ").append(toIndentedString(shippingAddress)).append("\n"); sb.append(" note: ").append(toIndentedString(note)).append("\n"); + sb.append(" statementDescriptionIdentifier: ").append(toIndentedString(statementDescriptionIdentifier)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/squareup/connect/models/CreateRefundRequest.java b/src/main/java/com/squareup/connect/models/CreateRefundRequest.java index c634510..560b41d 100644 --- a/src/main/java/com/squareup/connect/models/CreateRefundRequest.java +++ b/src/main/java/com/squareup/connect/models/CreateRefundRequest.java @@ -45,10 +45,10 @@ public CreateRefundRequest idempotencyKey(String idempotencyKey) { } /** - * A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + * A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information. * @return idempotencyKey **/ - @ApiModelProperty(required = true, value = "A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") + @ApiModelProperty(required = true, value = "A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information.") public String getIdempotencyKey() { return idempotencyKey; } diff --git a/src/main/java/com/squareup/connect/models/Customer.java b/src/main/java/com/squareup/connect/models/Customer.java index 3118917..0b06d0e 100644 --- a/src/main/java/com/squareup/connect/models/Customer.java +++ b/src/main/java/com/squareup/connect/models/Customer.java @@ -27,9 +27,9 @@ import java.util.List; /** - * Represents one of a business's customers, which can have one or more cards on file associated with it. + * Represents a Square customer profile, which can have one or more cards on file associated with it. */ -@ApiModel(description = "Represents one of a business's customers, which can have one or more cards on file associated with it.") +@ApiModel(description = "Represents a Square customer profile, which can have one or more cards on file associated with it.") public class Customer { @JsonProperty("id") @@ -89,10 +89,10 @@ public Customer id(String id) { } /** - * The customer's unique ID. + * A unique, Square-assigned object ID. * @return id **/ - @ApiModelProperty(required = true, value = "The customer's unique ID.") + @ApiModelProperty(required = true, value = "A unique, Square-assigned object ID.") public String getId() { return id; } @@ -107,10 +107,10 @@ public Customer createdAt(String createdAt) { } /** - * The time when the customer was created, in RFC 3339 format. + * The time when the customer profile was created, in RFC 3339 format. * @return createdAt **/ - @ApiModelProperty(required = true, value = "The time when the customer was created, in RFC 3339 format.") + @ApiModelProperty(required = true, value = "The time when the customer profile was created, in RFC 3339 format.") public String getCreatedAt() { return createdAt; } @@ -125,10 +125,10 @@ public Customer updatedAt(String updatedAt) { } /** - * The time when the customer was last updated, in RFC 3339 format. + * The time when the customer profile was last updated, in RFC 3339 format. * @return updatedAt **/ - @ApiModelProperty(required = true, value = "The time when the customer was last updated, in RFC 3339 format.") + @ApiModelProperty(required = true, value = "The time when the customer profile was last updated, in RFC 3339 format.") public String getUpdatedAt() { return updatedAt; } @@ -148,10 +148,10 @@ public Customer addCardsItem(Card cardsItem) { } /** - * The payment details of the customer's cards on file. + * Payment details of cards stored on file for the customer profile. * @return cards **/ - @ApiModelProperty(value = "The payment details of the customer's cards on file.") + @ApiModelProperty(value = "Payment details of cards stored on file for the customer profile.") public List getCards() { return cards; } @@ -166,10 +166,10 @@ public Customer givenName(String givenName) { } /** - * The customer's given (i.e., first) name. + * The given (i.e., first) name associated with the customer profile. * @return givenName **/ - @ApiModelProperty(value = "The customer's given (i.e., first) name.") + @ApiModelProperty(value = "The given (i.e., first) name associated with the customer profile.") public String getGivenName() { return givenName; } @@ -184,10 +184,10 @@ public Customer familyName(String familyName) { } /** - * The customer's family (i.e., last) name. + * The family (i.e., last) name associated with the customer profile. * @return familyName **/ - @ApiModelProperty(value = "The customer's family (i.e., last) name.") + @ApiModelProperty(value = "The family (i.e., last) name associated with the customer profile.") public String getFamilyName() { return familyName; } @@ -202,10 +202,10 @@ public Customer nickname(String nickname) { } /** - * The customer's nickname. + * A nickname for the customer profile. * @return nickname **/ - @ApiModelProperty(value = "The customer's nickname.") + @ApiModelProperty(value = "A nickname for the customer profile.") public String getNickname() { return nickname; } @@ -220,10 +220,10 @@ public Customer companyName(String companyName) { } /** - * The name of the customer's company. + * A business name associated with the customer profile. * @return companyName **/ - @ApiModelProperty(value = "The name of the customer's company.") + @ApiModelProperty(value = "A business name associated with the customer profile.") public String getCompanyName() { return companyName; } @@ -238,10 +238,10 @@ public Customer emailAddress(String emailAddress) { } /** - * The customer's email address. + * The email address associated with the customer profile. * @return emailAddress **/ - @ApiModelProperty(value = "The customer's email address.") + @ApiModelProperty(value = "The email address associated with the customer profile.") public String getEmailAddress() { return emailAddress; } @@ -256,10 +256,10 @@ public Customer address(Address address) { } /** - * The customer's physical address. + * The physical address associated with the customer profile. * @return address **/ - @ApiModelProperty(value = "The customer's physical address.") + @ApiModelProperty(value = "The physical address associated with the customer profile.") public Address getAddress() { return address; } @@ -274,10 +274,10 @@ public Customer phoneNumber(String phoneNumber) { } /** - * The customer's phone number. + * The 11-digit phone number associated with the customer profile. * @return phoneNumber **/ - @ApiModelProperty(value = "The customer's phone number.") + @ApiModelProperty(value = "The 11-digit phone number associated with the customer profile.") public String getPhoneNumber() { return phoneNumber; } @@ -292,10 +292,10 @@ public Customer birthday(String birthday) { } /** - * The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. + * The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. * @return birthday **/ - @ApiModelProperty(value = "The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.") + @ApiModelProperty(value = "The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__.") public String getBirthday() { return birthday; } @@ -310,10 +310,10 @@ public Customer referenceId(String referenceId) { } /** - * A second ID you can set to associate the customer with an entity in another system. + * An optional, second ID used to associate the customer profile with an entity in another system. * @return referenceId **/ - @ApiModelProperty(value = "A second ID you can set to associate the customer with an entity in another system.") + @ApiModelProperty(value = "An optional, second ID used to associate the customer profile with an entity in another system.") public String getReferenceId() { return referenceId; } @@ -328,10 +328,10 @@ public Customer note(String note) { } /** - * A note to associate with the customer. + * A custom note associated with the customer profile. * @return note **/ - @ApiModelProperty(value = "A note to associate with the customer.") + @ApiModelProperty(value = "A custom note associated with the customer profile.") public String getNote() { return note; } @@ -346,10 +346,10 @@ public Customer preferences(CustomerPreferences preferences) { } /** - * The customer's preferences. + * Represents general customer preferences. * @return preferences **/ - @ApiModelProperty(value = "The customer's preferences.") + @ApiModelProperty(value = "Represents general customer preferences.") public CustomerPreferences getPreferences() { return preferences; } diff --git a/src/main/java/com/squareup/connect/models/CustomerCreationSourceFilter.java b/src/main/java/com/squareup/connect/models/CustomerCreationSourceFilter.java index 75ef9ee..609f2d0 100644 --- a/src/main/java/com/squareup/connect/models/CustomerCreationSourceFilter.java +++ b/src/main/java/com/squareup/connect/models/CustomerCreationSourceFilter.java @@ -63,10 +63,10 @@ public CustomerCreationSourceFilter rule(String rule) { } /** - * Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values + * Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values * @return rule **/ - @ApiModelProperty(value = "Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values") + @ApiModelProperty(value = "Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values") public String getRule() { return rule; } diff --git a/src/main/java/com/squareup/connect/models/CustomerFilter.java b/src/main/java/com/squareup/connect/models/CustomerFilter.java index 06a1a3f..ec545f0 100644 --- a/src/main/java/com/squareup/connect/models/CustomerFilter.java +++ b/src/main/java/com/squareup/connect/models/CustomerFilter.java @@ -23,9 +23,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Represents a set of `CustomerQuery` filters used to limit the set of Customers returned by SearchCustomers. + * Represents a set of `CustomerQuery` filters used to limit the set of `Customers` returned by SearchCustomers. */ -@ApiModel(description = "Represents a set of `CustomerQuery` filters used to limit the set of Customers returned by SearchCustomers.") +@ApiModel(description = "Represents a set of `CustomerQuery` filters used to limit the set of `Customers` returned by SearchCustomers.") public class CustomerFilter { @JsonProperty("creation_source") diff --git a/src/main/java/com/squareup/connect/models/CustomerPreferences.java b/src/main/java/com/squareup/connect/models/CustomerPreferences.java index e875af8..7f87bd1 100644 --- a/src/main/java/com/squareup/connect/models/CustomerPreferences.java +++ b/src/main/java/com/squareup/connect/models/CustomerPreferences.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Represents a particular customer's preferences. + * Represents communication preferences for the customer profile. */ -@ApiModel(description = "Represents a particular customer's preferences.") +@ApiModel(description = "Represents communication preferences for the customer profile.") public class CustomerPreferences { @JsonProperty("email_unsubscribed") diff --git a/src/main/java/com/squareup/connect/models/CustomerSort.java b/src/main/java/com/squareup/connect/models/CustomerSort.java index bedb832..f4e54aa 100644 --- a/src/main/java/com/squareup/connect/models/CustomerSort.java +++ b/src/main/java/com/squareup/connect/models/CustomerSort.java @@ -38,10 +38,10 @@ public CustomerSort field(String field) { } /** - * Indicates the information used to sort the results. For example, by creation date. Default value: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values + * Indicates the information used to sort the results. For example, by creation date. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values * @return field **/ - @ApiModelProperty(value = "Indicates the information used to sort the results. For example, by creation date. Default value: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values") + @ApiModelProperty(value = "Indicates the information used to sort the results. For example, by creation date. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values") public String getField() { return field; } @@ -56,10 +56,10 @@ public CustomerSort order(String order) { } /** - * Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default value: `ASC`. See [SortOrder](#type-sortorder) for possible values + * Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values * @return order **/ - @ApiModelProperty(value = "Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default value: `ASC`. See [SortOrder](#type-sortorder) for possible values") + @ApiModelProperty(value = "Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values") public String getOrder() { return order; } diff --git a/src/main/java/com/squareup/connect/models/DeleteCatalogObjectResponse.java b/src/main/java/com/squareup/connect/models/DeleteCatalogObjectResponse.java index 9e9adf7..899b629 100644 --- a/src/main/java/com/squareup/connect/models/DeleteCatalogObjectResponse.java +++ b/src/main/java/com/squareup/connect/models/DeleteCatalogObjectResponse.java @@ -49,10 +49,10 @@ public DeleteCatalogObjectResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * Information on any errors encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "Information on any errors encountered.") public List getErrors() { return errors; } @@ -72,10 +72,10 @@ public DeleteCatalogObjectResponse addDeletedObjectIdsItem(String deletedObjectI } /** - * The IDs of all `CatalogObject`s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a `CatalogItemVariation` when its parent `CatalogItem` is deleted. + * The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted. * @return deletedObjectIds **/ - @ApiModelProperty(value = "The IDs of all `CatalogObject`s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a `CatalogItemVariation` when its parent `CatalogItem` is deleted.") + @ApiModelProperty(value = "The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted.") public List getDeletedObjectIds() { return deletedObjectIds; } @@ -90,10 +90,10 @@ public DeleteCatalogObjectResponse deletedAt(String deletedAt) { } /** - * The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + * The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. * @return deletedAt **/ - @ApiModelProperty(value = "The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".") + @ApiModelProperty(value = "The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`.") public String getDeletedAt() { return deletedAt; } diff --git a/src/main/java/com/squareup/connect/models/Employee.java b/src/main/java/com/squareup/connect/models/Employee.java index f70f3ae..f925f17 100644 --- a/src/main/java/com/squareup/connect/models/Employee.java +++ b/src/main/java/com/squareup/connect/models/Employee.java @@ -23,9 +23,9 @@ import java.util.List; /** - * An employee created in the **Square Dashboard** account of a business. Used by the Labor API. + * An employee object that is used by the external API. */ -@ApiModel(description = "An employee created in the **Square Dashboard** account of a business. Used by the Labor API.") +@ApiModel(description = "An employee object that is used by the external API.") public class Employee { @JsonProperty("id") @@ -61,10 +61,10 @@ public Employee id(String id) { } /** - * UUID for this `Employee`. + * UUID for this object. * @return id **/ - @ApiModelProperty(value = "UUID for this `Employee`.") + @ApiModelProperty(value = "UUID for this object.") public String getId() { return id; } @@ -79,10 +79,10 @@ public Employee firstName(String firstName) { } /** - * Given (first) name of the employee. + * The employee's first name. * @return firstName **/ - @ApiModelProperty(value = "Given (first) name of the employee.") + @ApiModelProperty(value = "The employee's first name.") public String getFirstName() { return firstName; } @@ -97,10 +97,10 @@ public Employee lastName(String lastName) { } /** - * Family (last) name of the employee + * The employee's last name. * @return lastName **/ - @ApiModelProperty(value = "Family (last) name of the employee") + @ApiModelProperty(value = "The employee's last name.") public String getLastName() { return lastName; } @@ -115,10 +115,10 @@ public Employee email(String email) { } /** - * Email of the employee + * The employee's email address * @return email **/ - @ApiModelProperty(value = "Email of the employee") + @ApiModelProperty(value = "The employee's email address") public String getEmail() { return email; } @@ -133,10 +133,10 @@ public Employee phoneNumber(String phoneNumber) { } /** - * Phone number of the employee in E.164 format, i.e. \"+12125554250\" + * The employee's phone number in E.164 format, i.e. \"+12125554250\" * @return phoneNumber **/ - @ApiModelProperty(value = "Phone number of the employee in E.164 format, i.e. \"+12125554250\"") + @ApiModelProperty(value = "The employee's phone number in E.164 format, i.e. \"+12125554250\"") public String getPhoneNumber() { return phoneNumber; } @@ -156,10 +156,10 @@ public Employee addLocationIdsItem(String locationIdsItem) { } /** - * A list of location IDs where this employee has access. + * A list of location IDs where this employee has access to. * @return locationIds **/ - @ApiModelProperty(value = "A list of location IDs where this employee has access.") + @ApiModelProperty(value = "A list of location IDs where this employee has access to.") public List getLocationIds() { return locationIds; } @@ -174,10 +174,10 @@ public Employee status(String status) { } /** - * Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values + * Specifies the status of the employees being fetched. See [EmployeeStatus](#type-employeestatus) for possible values * @return status **/ - @ApiModelProperty(value = "Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values") + @ApiModelProperty(value = "Specifies the status of the employees being fetched. See [EmployeeStatus](#type-employeestatus) for possible values") public String getStatus() { return status; } diff --git a/src/main/java/com/squareup/connect/models/Error.java b/src/main/java/com/squareup/connect/models/Error.java index b1aeb38..497a8d2 100644 --- a/src/main/java/com/squareup/connect/models/Error.java +++ b/src/main/java/com/squareup/connect/models/Error.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Represents an error encountered during a request to the Connect API. + * Represents an error encountered during a request to the Connect API. See [Handling errors](#handlingerrors) for more information. */ -@ApiModel(description = "Represents an error encountered during a request to the Connect API.") +@ApiModel(description = "Represents an error encountered during a request to the Connect API. See [Handling errors](#handlingerrors) for more information.") public class Error { @JsonProperty("category") @@ -44,10 +44,10 @@ public Error category(String category) { } /** - * The high-level category for the error. See [ErrorCategory](#type-errorcategory) for possible values + * The high-level category for the error. See `ErrorCategory` for possible values. See [ErrorCategory](#type-errorcategory) for possible values * @return category **/ - @ApiModelProperty(required = true, value = "The high-level category for the error. See [ErrorCategory](#type-errorcategory) for possible values") + @ApiModelProperty(required = true, value = "The high-level category for the error. See `ErrorCategory` for possible values. See [ErrorCategory](#type-errorcategory) for possible values") public String getCategory() { return category; } @@ -62,10 +62,10 @@ public Error code(String code) { } /** - * The specific code of the error. See [ErrorCode](#type-errorcode) for possible values + * The specific code of the error. See `ErrorCode` for possible values See [ErrorCode](#type-errorcode) for possible values * @return code **/ - @ApiModelProperty(required = true, value = "The specific code of the error. See [ErrorCode](#type-errorcode) for possible values") + @ApiModelProperty(required = true, value = "The specific code of the error. See `ErrorCode` for possible values See [ErrorCode](#type-errorcode) for possible values") public String getCode() { return code; } diff --git a/src/main/java/com/squareup/connect/models/ExternalPaymentDetails.java b/src/main/java/com/squareup/connect/models/ExternalPaymentDetails.java new file mode 100644 index 0000000..bfdfd31 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/ExternalPaymentDetails.java @@ -0,0 +1,161 @@ +/* + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.squareup.connect.models; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.squareup.connect.models.Money; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +/** + * Additional details about EXTERNAL type payments. + */ +@ApiModel(description = "Additional details about EXTERNAL type payments.") + +public class ExternalPaymentDetails { + @JsonProperty("type") + private String type = null; + + @JsonProperty("source") + private String source = null; + + @JsonProperty("source_id") + private String sourceId = null; + + @JsonProperty("source_fee_money") + private Money sourceFeeMoney = null; + + public ExternalPaymentDetails type(String type) { + this.type = type; + return this; + } + + /** + * The type of External payment which can be one of: CHECK - Paid by a physical check BANK_TRANSFER - Paid by ACH or other bank transfer OTHER_GIFT_CARD - Paid by a non-square gift card CRYPTO - Paid via a crypto currency SQUARE_CASH - Paid via Square Cash app SOCIAL - Venmo, WeChatPay, AliPay, etc. EXTERNAL - A 3rd party application gathered this payment outside of Square EMONEY - A Japanese e-money brand Square doesn’t support CREDIT/DEBIT - A credit/debit card Square doesn’t support OTHER - A type not listed here + * @return type + **/ + @ApiModelProperty(required = true, value = "The type of External payment which can be one of: CHECK - Paid by a physical check BANK_TRANSFER - Paid by ACH or other bank transfer OTHER_GIFT_CARD - Paid by a non-square gift card CRYPTO - Paid via a crypto currency SQUARE_CASH - Paid via Square Cash app SOCIAL - Venmo, WeChatPay, AliPay, etc. EXTERNAL - A 3rd party application gathered this payment outside of Square EMONEY - A Japanese e-money brand Square doesn’t support CREDIT/DEBIT - A credit/debit card Square doesn’t support OTHER - A type not listed here") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public ExternalPaymentDetails source(String source) { + this.source = source; + return this; + } + + /** + * A description of the source of the external payment, e.g. “Uber Eats”, “Stripe”, “Shopify”. Limit 255 characters + * @return source + **/ + @ApiModelProperty(required = true, value = "A description of the source of the external payment, e.g. “Uber Eats”, “Stripe”, “Shopify”. Limit 255 characters") + public String getSource() { + return source; + } + + public void setSource(String source) { + this.source = source; + } + + public ExternalPaymentDetails sourceId(String sourceId) { + this.sourceId = sourceId; + return this; + } + + /** + * An ID to associate this payment to its originating source Limit 255 characters. + * @return sourceId + **/ + @ApiModelProperty(value = "An ID to associate this payment to its originating source Limit 255 characters.") + public String getSourceId() { + return sourceId; + } + + public void setSourceId(String sourceId) { + this.sourceId = sourceId; + } + + public ExternalPaymentDetails sourceFeeMoney(Money sourceFeeMoney) { + this.sourceFeeMoney = sourceFeeMoney; + return this; + } + + /** + * The total of fees paid to the source. (amount_money - source_fee_money) = net money to the merchant + * @return sourceFeeMoney + **/ + @ApiModelProperty(value = "The total of fees paid to the source. (amount_money - source_fee_money) = net money to the merchant") + public Money getSourceFeeMoney() { + return sourceFeeMoney; + } + + public void setSourceFeeMoney(Money sourceFeeMoney) { + this.sourceFeeMoney = sourceFeeMoney; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ExternalPaymentDetails externalPaymentDetails = (ExternalPaymentDetails) o; + return Objects.equals(this.type, externalPaymentDetails.type) && + Objects.equals(this.source, externalPaymentDetails.source) && + Objects.equals(this.sourceId, externalPaymentDetails.sourceId) && + Objects.equals(this.sourceFeeMoney, externalPaymentDetails.sourceFeeMoney); + } + + @Override + public int hashCode() { + return Objects.hash(type, source, sourceId, sourceFeeMoney); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ExternalPaymentDetails {\n"); + + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append(" sourceId: ").append(toIndentedString(sourceId)).append("\n"); + sb.append(" sourceFeeMoney: ").append(toIndentedString(sourceFeeMoney)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/squareup/connect/models/InventoryAdjustment.java b/src/main/java/com/squareup/connect/models/InventoryAdjustment.java index 0a6b1bc..906c700 100644 --- a/src/main/java/com/squareup/connect/models/InventoryAdjustment.java +++ b/src/main/java/com/squareup/connect/models/InventoryAdjustment.java @@ -211,11 +211,11 @@ public InventoryAdjustment quantity(String quantity) { } /** - * The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + * The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. * Note: This model is in beta. * @return quantity **/ - @ApiModelProperty(value = "The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information.") + @ApiModelProperty(value = "The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information.") public String getQuantity() { return quantity; } diff --git a/src/main/java/com/squareup/connect/models/InventoryChange.java b/src/main/java/com/squareup/connect/models/InventoryChange.java index 72c749e..ee2075b 100644 --- a/src/main/java/com/squareup/connect/models/InventoryChange.java +++ b/src/main/java/com/squareup/connect/models/InventoryChange.java @@ -24,9 +24,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular [CatalogObject](#type-catalogobject). + * Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular `CatalogObject`. */ -@ApiModel(description = "Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular [CatalogObject](#type-catalogobject).") +@ApiModel(description = "Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular `CatalogObject`.") public class InventoryChange { @JsonProperty("type") @@ -47,10 +47,10 @@ public InventoryChange type(String type) { } /** - * Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for possible values + * Indicates how the inventory change was applied. See `InventoryChangeType` for all possible values. See [InventoryChangeType](#type-inventorychangetype) for possible values * @return type **/ - @ApiModelProperty(value = "Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for possible values") + @ApiModelProperty(value = "Indicates how the inventory change was applied. See `InventoryChangeType` for all possible values. See [InventoryChangeType](#type-inventorychangetype) for possible values") public String getType() { return type; } diff --git a/src/main/java/com/squareup/connect/models/InventoryCount.java b/src/main/java/com/squareup/connect/models/InventoryCount.java index 90d5e4a..dbb047b 100644 --- a/src/main/java/com/squareup/connect/models/InventoryCount.java +++ b/src/main/java/com/squareup/connect/models/InventoryCount.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments + * Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments. */ -@ApiModel(description = "Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments") +@ApiModel(description = "Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments.") public class InventoryCount { @JsonProperty("catalog_object_id") @@ -122,11 +122,11 @@ public InventoryCount quantity(String quantity) { } /** - * The number of items in the count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + * The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. * Note: This model is in beta. * @return quantity **/ - @ApiModelProperty(value = "The number of items in the count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information.") + @ApiModelProperty(value = "The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information.") public String getQuantity() { return quantity; } diff --git a/src/main/java/com/squareup/connect/models/InventoryPhysicalCount.java b/src/main/java/com/squareup/connect/models/InventoryPhysicalCount.java index d735822..01637bc 100644 --- a/src/main/java/com/squareup/connect/models/InventoryPhysicalCount.java +++ b/src/main/java/com/squareup/connect/models/InventoryPhysicalCount.java @@ -174,11 +174,11 @@ public InventoryPhysicalCount quantity(String quantity) { } /** - * The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + * The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. * Note: This model is in beta. * @return quantity **/ - @ApiModelProperty(value = "The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information.") + @ApiModelProperty(value = "The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information.") public String getQuantity() { return quantity; } diff --git a/src/main/java/com/squareup/connect/models/InventoryTransfer.java b/src/main/java/com/squareup/connect/models/InventoryTransfer.java index 0b12a86..86ec050 100644 --- a/src/main/java/com/squareup/connect/models/InventoryTransfer.java +++ b/src/main/java/com/squareup/connect/models/InventoryTransfer.java @@ -195,11 +195,11 @@ public InventoryTransfer quantity(String quantity) { } /** - * The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + * The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. * Note: This model is in beta. * @return quantity **/ - @ApiModelProperty(value = "The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information.") + @ApiModelProperty(value = "The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information.") public String getQuantity() { return quantity; } diff --git a/src/main/java/com/squareup/connect/models/ItemVariationLocationOverrides.java b/src/main/java/com/squareup/connect/models/ItemVariationLocationOverrides.java index 2b17c53..a56f176 100644 --- a/src/main/java/com/squareup/connect/models/ItemVariationLocationOverrides.java +++ b/src/main/java/com/squareup/connect/models/ItemVariationLocationOverrides.java @@ -22,9 +22,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Price and inventory alerting overrides for a [CatalogItemVariation](#type-catalogitemvariation) at a specific [location](#type-location). + * Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`. */ -@ApiModel(description = "Price and inventory alerting overrides for a [CatalogItemVariation](#type-catalogitemvariation) at a specific [location](#type-location).") +@ApiModel(description = "Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`.") public class ItemVariationLocationOverrides { @JsonProperty("location_id") @@ -51,10 +51,10 @@ public ItemVariationLocationOverrides locationId(String locationId) { } /** - * The ID of the `location`. + * The ID of the `Location`. * @return locationId **/ - @ApiModelProperty(value = "The ID of the `location`.") + @ApiModelProperty(value = "The ID of the `Location`.") public String getLocationId() { return locationId; } @@ -69,10 +69,10 @@ public ItemVariationLocationOverrides priceMoney(Money priceMoney) { } /** - * The price of the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`, or blank for variable pricing. + * The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing. * @return priceMoney **/ - @ApiModelProperty(value = "The price of the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`, or blank for variable pricing.") + @ApiModelProperty(value = "The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing.") public Money getPriceMoney() { return priceMoney; } @@ -87,10 +87,10 @@ public ItemVariationLocationOverrides pricingType(String pricingType) { } /** - * The pricing type (fixed or variable) for the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values + * The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values * @return pricingType **/ - @ApiModelProperty(value = "The pricing type (fixed or variable) for the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values") + @ApiModelProperty(value = "The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values") public String getPricingType() { return pricingType; } @@ -105,10 +105,10 @@ public ItemVariationLocationOverrides trackInventory(Boolean trackInventory) { } /** - * If `true`, inventory tracking is active for the `CatalogItemVariation](#type-catalogitemvariation) at this [location`. + * If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`. * @return trackInventory **/ - @ApiModelProperty(value = "If `true`, inventory tracking is active for the `CatalogItemVariation](#type-catalogitemvariation) at this [location`.") + @ApiModelProperty(value = "If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`.") public Boolean getTrackInventory() { return trackInventory; } diff --git a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsRequest.java b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsRequest.java index 1378e68..82261e3 100644 --- a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsRequest.java +++ b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsRequest.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivableRefunds endpoint. + * Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. */ -@ApiModel(description = "Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivableRefunds endpoint.") +@ApiModel(description = "Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint.") public class ListAdditionalRecipientReceivableRefundsRequest { @JsonProperty("begin_time") @@ -98,10 +98,10 @@ public ListAdditionalRecipientReceivableRefundsRequest cursor(String cursor) { } /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsResponse.java b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsResponse.java index 5889c51..bf80a86 100644 --- a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsResponse.java +++ b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsResponse.java @@ -25,9 +25,9 @@ import java.util.List; /** - * Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivableRefunds endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both). + * Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both). */ -@ApiModel(description = "Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivableRefunds endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both).") +@ApiModel(description = "Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both).") public class ListAdditionalRecipientReceivableRefundsResponse { @JsonProperty("errors") @@ -91,10 +91,10 @@ public ListAdditionalRecipientReceivableRefundsResponse cursor(String cursor) { } /** - * A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesRequest.java b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesRequest.java index 38f1d96..90af814 100644 --- a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesRequest.java +++ b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesRequest.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivables endpoint. + * Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. */ -@ApiModel(description = "Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivables endpoint.") +@ApiModel(description = "Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint.") public class ListAdditionalRecipientReceivablesRequest { @JsonProperty("begin_time") @@ -98,10 +98,10 @@ public ListAdditionalRecipientReceivablesRequest cursor(String cursor) { } /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesResponse.java b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesResponse.java index 9883793..c1c5ef6 100644 --- a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesResponse.java +++ b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesResponse.java @@ -25,9 +25,9 @@ import java.util.List; /** - * Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivables endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both). + * Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both). */ -@ApiModel(description = "Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivables endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both).") +@ApiModel(description = "Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both).") public class ListAdditionalRecipientReceivablesResponse { @JsonProperty("errors") @@ -91,10 +91,10 @@ public ListAdditionalRecipientReceivablesResponse cursor(String cursor) { } /** - * A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListCatalogRequest.java b/src/main/java/com/squareup/connect/models/ListCatalogRequest.java index 2f01053..9442c46 100644 --- a/src/main/java/com/squareup/connect/models/ListCatalogRequest.java +++ b/src/main/java/com/squareup/connect/models/ListCatalogRequest.java @@ -56,10 +56,10 @@ public ListCatalogRequest types(String types) { } /** - * An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. + * An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. * @return types **/ - @ApiModelProperty(value = "An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.") + @ApiModelProperty(value = "An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.") public String getTypes() { return types; } diff --git a/src/main/java/com/squareup/connect/models/ListCatalogResponse.java b/src/main/java/com/squareup/connect/models/ListCatalogResponse.java index 92d6fba..39d4289 100644 --- a/src/main/java/com/squareup/connect/models/ListCatalogResponse.java +++ b/src/main/java/com/squareup/connect/models/ListCatalogResponse.java @@ -50,10 +50,10 @@ public ListCatalogResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * Information on any errors encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "Information on any errors encountered.") public List getErrors() { return errors; } @@ -91,10 +91,10 @@ public ListCatalogResponse addObjectsItem(CatalogObject objectsItem) { } /** - * The `CatalogObject`s returned. + * The CatalogObjects returned. * @return objects **/ - @ApiModelProperty(value = "The `CatalogObject`s returned.") + @ApiModelProperty(value = "The CatalogObjects returned.") public List getObjects() { return objects; } diff --git a/src/main/java/com/squareup/connect/models/ListCustomersRequest.java b/src/main/java/com/squareup/connect/models/ListCustomersRequest.java index 476977e..989f9fd 100644 --- a/src/main/java/com/squareup/connect/models/ListCustomersRequest.java +++ b/src/main/java/com/squareup/connect/models/ListCustomersRequest.java @@ -41,10 +41,10 @@ public ListCustomersRequest cursor(String cursor) { } /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.") public String getCursor() { return cursor; } @@ -59,10 +59,10 @@ public ListCustomersRequest sortField(String sortField) { } /** - * Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values + * Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values * @return sortField **/ - @ApiModelProperty(value = "Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values") + @ApiModelProperty(value = "Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values") public String getSortField() { return sortField; } @@ -77,10 +77,10 @@ public ListCustomersRequest sortOrder(String sortOrder) { } /** - * Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values + * Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values * @return sortOrder **/ - @ApiModelProperty(value = "Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values") + @ApiModelProperty(value = "Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values") public String getSortOrder() { return sortOrder; } diff --git a/src/main/java/com/squareup/connect/models/ListCustomersResponse.java b/src/main/java/com/squareup/connect/models/ListCustomersResponse.java index cde4aca..3269698 100644 --- a/src/main/java/com/squareup/connect/models/ListCustomersResponse.java +++ b/src/main/java/com/squareup/connect/models/ListCustomersResponse.java @@ -73,10 +73,10 @@ public ListCustomersResponse addCustomersItem(Customer customersItem) { } /** - * An array of `Customer` objects that match your query. + * An array of `Customer` objects that match the provided query. * @return customers **/ - @ApiModelProperty(value = "An array of `Customer` objects that match your query.") + @ApiModelProperty(value = "An array of `Customer` objects that match the provided query.") public List getCustomers() { return customers; } @@ -91,10 +91,10 @@ public ListCustomersResponse cursor(String cursor) { } /** - * A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListEmployeesRequest.java b/src/main/java/com/squareup/connect/models/ListEmployeesRequest.java index 3788509..9ff0df0 100644 --- a/src/main/java/com/squareup/connect/models/ListEmployeesRequest.java +++ b/src/main/java/com/squareup/connect/models/ListEmployeesRequest.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Retrieve a paged-list of employees for a Square account + * */ -@ApiModel(description = "Retrieve a paged-list of employees for a Square account") +@ApiModel(description = "") public class ListEmployeesRequest { @JsonProperty("location_id") diff --git a/src/main/java/com/squareup/connect/models/ListEmployeesResponse.java b/src/main/java/com/squareup/connect/models/ListEmployeesResponse.java index a72b545..c5da214 100644 --- a/src/main/java/com/squareup/connect/models/ListEmployeesResponse.java +++ b/src/main/java/com/squareup/connect/models/ListEmployeesResponse.java @@ -25,9 +25,9 @@ import java.util.List; /** - * Defines the fields that are included in the response body of a request to the ListEmployees endpoint. One of `errors` or `employees` is present in a given response (never both). + * */ -@ApiModel(description = "Defines the fields that are included in the response body of a request to the ListEmployees endpoint. One of `errors` or `employees` is present in a given response (never both).") +@ApiModel(description = "") public class ListEmployeesResponse { @JsonProperty("employees") diff --git a/src/main/java/com/squareup/connect/models/ListLocationsRequest.java b/src/main/java/com/squareup/connect/models/ListLocationsRequest.java index 4e9c4f2..a272494 100644 --- a/src/main/java/com/squareup/connect/models/ListLocationsRequest.java +++ b/src/main/java/com/squareup/connect/models/ListLocationsRequest.java @@ -17,9 +17,9 @@ import io.swagger.annotations.ApiModel; /** - * Defines the fields that are included in requests to the ListLocations endpoint. + * Defines the fields that are included in requests to the __ListLocations__ endpoint. */ -@ApiModel(description = "Defines the fields that are included in requests to the ListLocations endpoint.") +@ApiModel(description = "Defines the fields that are included in requests to the __ListLocations__ endpoint.") public class ListLocationsRequest { diff --git a/src/main/java/com/squareup/connect/models/ListLocationsResponse.java b/src/main/java/com/squareup/connect/models/ListLocationsResponse.java index a1d0165..7f3a705 100644 --- a/src/main/java/com/squareup/connect/models/ListLocationsResponse.java +++ b/src/main/java/com/squareup/connect/models/ListLocationsResponse.java @@ -25,9 +25,9 @@ import java.util.List; /** - * Defines the fields that are included in the response body of a request to the ListLocations endpoint. One of `errors` or `locations` is present in a given response (never both). + * Defines the fields that are included in the response body of a request to the __ListLocations__ endpoint. One of `errors` or `locations` is present in a given response (never both). */ -@ApiModel(description = "Defines the fields that are included in the response body of a request to the ListLocations endpoint. One of `errors` or `locations` is present in a given response (never both).") +@ApiModel(description = "Defines the fields that are included in the response body of a request to the __ListLocations__ endpoint. One of `errors` or `locations` is present in a given response (never both).") public class ListLocationsResponse { @JsonProperty("errors") @@ -70,10 +70,10 @@ public ListLocationsResponse addLocationsItem(Location locationsItem) { } /** - * The business's locations. + * The business locations. * @return locations **/ - @ApiModelProperty(value = "The business's locations.") + @ApiModelProperty(value = "The business locations.") public List getLocations() { return locations; } diff --git a/src/main/java/com/squareup/connect/models/ListMerchantsRequest.java b/src/main/java/com/squareup/connect/models/ListMerchantsRequest.java index adfcb22..537f0c9 100644 --- a/src/main/java/com/squareup/connect/models/ListMerchantsRequest.java +++ b/src/main/java/com/squareup/connect/models/ListMerchantsRequest.java @@ -70,7 +70,7 @@ public int hashCode() { public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ListMerchantsRequest {\n"); - + sb.append(" cursor: ").append(toIndentedString(cursor)).append("\n"); sb.append("}"); return sb.toString(); @@ -86,6 +86,6 @@ private String toIndentedString(java.lang.Object o) { } return o.toString().replace("\n", "\n "); } - + } diff --git a/src/main/java/com/squareup/connect/models/ListMerchantsResponse.java b/src/main/java/com/squareup/connect/models/ListMerchantsResponse.java index 101f53f..e1b726e 100644 --- a/src/main/java/com/squareup/connect/models/ListMerchantsResponse.java +++ b/src/main/java/com/squareup/connect/models/ListMerchantsResponse.java @@ -128,7 +128,7 @@ public int hashCode() { public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ListMerchantsResponse {\n"); - + sb.append(" errors: ").append(toIndentedString(errors)).append("\n"); sb.append(" merchant: ").append(toIndentedString(merchant)).append("\n"); sb.append(" cursor: ").append(toIndentedString(cursor)).append("\n"); @@ -146,6 +146,6 @@ private String toIndentedString(java.lang.Object o) { } return o.toString().replace("\n", "\n "); } - + } diff --git a/src/main/java/com/squareup/connect/models/ListPaymentRefundsRequest.java b/src/main/java/com/squareup/connect/models/ListPaymentRefundsRequest.java index 0e7adb7..0eb3255 100644 --- a/src/main/java/com/squareup/connect/models/ListPaymentRefundsRequest.java +++ b/src/main/java/com/squareup/connect/models/ListPaymentRefundsRequest.java @@ -143,10 +143,10 @@ public ListPaymentRefundsRequest status(String status) { } /** - * If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. + * If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. * @return status **/ - @ApiModelProperty(value = "If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status.") + @ApiModelProperty(value = "If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status.") public String getStatus() { return status; } @@ -161,10 +161,10 @@ public ListPaymentRefundsRequest sourceType(String sourceType) { } /** - * If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. + * If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. * @return sourceType **/ - @ApiModelProperty(value = "If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type.") + @ApiModelProperty(value = "If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type.") public String getSourceType() { return sourceType; } diff --git a/src/main/java/com/squareup/connect/models/ListRefundsRequest.java b/src/main/java/com/squareup/connect/models/ListRefundsRequest.java index 03c2cfa..9e160c2 100644 --- a/src/main/java/com/squareup/connect/models/ListRefundsRequest.java +++ b/src/main/java/com/squareup/connect/models/ListRefundsRequest.java @@ -98,10 +98,10 @@ public ListRefundsRequest cursor(String cursor) { } /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListRefundsResponse.java b/src/main/java/com/squareup/connect/models/ListRefundsResponse.java index c0ac593..0fde957 100644 --- a/src/main/java/com/squareup/connect/models/ListRefundsResponse.java +++ b/src/main/java/com/squareup/connect/models/ListRefundsResponse.java @@ -91,10 +91,10 @@ public ListRefundsResponse cursor(String cursor) { } /** - * A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListTransactionsRequest.java b/src/main/java/com/squareup/connect/models/ListTransactionsRequest.java index 38ce5c2..a227477 100644 --- a/src/main/java/com/squareup/connect/models/ListTransactionsRequest.java +++ b/src/main/java/com/squareup/connect/models/ListTransactionsRequest.java @@ -98,10 +98,10 @@ public ListTransactionsRequest cursor(String cursor) { } /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListTransactionsResponse.java b/src/main/java/com/squareup/connect/models/ListTransactionsResponse.java index 773f95f..c48ae46 100644 --- a/src/main/java/com/squareup/connect/models/ListTransactionsResponse.java +++ b/src/main/java/com/squareup/connect/models/ListTransactionsResponse.java @@ -91,10 +91,10 @@ public ListTransactionsResponse cursor(String cursor) { } /** - * A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/Location.java b/src/main/java/com/squareup/connect/models/Location.java index 1a87d94..8b9fe2b 100644 --- a/src/main/java/com/squareup/connect/models/Location.java +++ b/src/main/java/com/squareup/connect/models/Location.java @@ -26,9 +26,9 @@ import java.util.List; /** - * Represents one of a business's locations. + * */ -@ApiModel(description = "Represents one of a business's locations.") +@ApiModel(description = "") public class Location { @JsonProperty("id") @@ -130,10 +130,10 @@ public Location name(String name) { } /** - * The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname + * The name of the location. This information appears in the dashboard as the nickname. * @return name **/ - @ApiModelProperty(value = "The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname") + @ApiModelProperty(value = "The name of the location. This information appears in the dashboard as the nickname.") public String getName() { return name; } @@ -148,10 +148,10 @@ public Location address(Address address) { } /** - * The location's physical address. + * The physical address of the location. * @return address **/ - @ApiModelProperty(value = "The location's physical address.") + @ApiModelProperty(value = "The physical address of the location.") public Address getAddress() { return address; } @@ -166,10 +166,10 @@ public Location timezone(String timezone) { } /** - * The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone. + * The [IANA Timezone](https://www.iana.org/time-zones) identifier for the timezone of the location. * @return timezone **/ - @ApiModelProperty(value = "The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone.") + @ApiModelProperty(value = "The [IANA Timezone](https://www.iana.org/time-zones) identifier for the timezone of the location.") public String getTimezone() { return timezone; } @@ -207,10 +207,10 @@ public Location status(String status) { } /** - * The location's status See [LocationStatus](#type-locationstatus) for possible values + * The status of the location, either active or inactive. See [LocationStatus](#type-locationstatus) for possible values * @return status **/ - @ApiModelProperty(value = "The location's status See [LocationStatus](#type-locationstatus) for possible values") + @ApiModelProperty(value = "The status of the location, either active or inactive. See [LocationStatus](#type-locationstatus) for possible values") public String getStatus() { return status; } @@ -279,10 +279,10 @@ public Location languageCode(String languageCode) { } /** - * The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). + * The language associated with the location, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). * @return languageCode **/ - @ApiModelProperty(value = "The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).") + @ApiModelProperty(value = "The language associated with the location, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).") public String getLanguageCode() { return languageCode; } @@ -297,10 +297,10 @@ public Location currency(String currency) { } /** - * The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values + * The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values * @return currency **/ - @ApiModelProperty(value = "The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values") + @ApiModelProperty(value = "The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values") public String getCurrency() { return currency; } @@ -315,10 +315,10 @@ public Location phoneNumber(String phoneNumber) { } /** - * The location's phone_number. + * The phone number of the location in human readable format. * @return phoneNumber **/ - @ApiModelProperty(value = "The location's phone_number.") + @ApiModelProperty(value = "The phone number of the location in human readable format.") public String getPhoneNumber() { return phoneNumber; } @@ -333,10 +333,10 @@ public Location businessName(String businessName) { } /** - * The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts. + * The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts. * @return businessName **/ - @ApiModelProperty(value = "The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts.") + @ApiModelProperty(value = "The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts.") public String getBusinessName() { return businessName; } @@ -351,10 +351,10 @@ public Location type(String type) { } /** - * The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values + * The type of the location, either physical or mobile. See [LocationType](#type-locationtype) for possible values * @return type **/ - @ApiModelProperty(value = "The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values") + @ApiModelProperty(value = "The type of the location, either physical or mobile. See [LocationType](#type-locationtype) for possible values") public String getType() { return type; } @@ -369,10 +369,10 @@ public Location websiteUrl(String websiteUrl) { } /** - * The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set. + * The website URL of the location. * @return websiteUrl **/ - @ApiModelProperty(value = "The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set.") + @ApiModelProperty(value = "The website URL of the location.") public String getWebsiteUrl() { return websiteUrl; } @@ -387,10 +387,10 @@ public Location businessHours(BusinessHours businessHours) { } /** - * The hours of operation for a business location. Default: none; only exists if explicitly set. + * Represents the hours of operation for the location. * @return businessHours **/ - @ApiModelProperty(value = " The hours of operation for a business location. Default: none; only exists if explicitly set.") + @ApiModelProperty(value = " Represents the hours of operation for the location.") public BusinessHours getBusinessHours() { return businessHours; } @@ -405,10 +405,10 @@ public Location businessEmail(String businessEmail) { } /** - * The email of the location. + * The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts. * @return businessEmail **/ - @ApiModelProperty(value = "The email of the location.") + @ApiModelProperty(value = "The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts.") public String getBusinessEmail() { return businessEmail; } @@ -423,10 +423,10 @@ public Location description(String description) { } /** - * The business description of the location. + * The description of the location. * @return description **/ - @ApiModelProperty(value = "The business description of the location.") + @ApiModelProperty(value = "The description of the location.") public String getDescription() { return description; } @@ -513,10 +513,10 @@ public Location logoUrl(String logoUrl) { } /** - * The logo image URL of the location. + * The URL of the logo image for the location. * @return logoUrl **/ - @ApiModelProperty(value = "The logo image URL of the location.") + @ApiModelProperty(value = "The URL of the logo image for the location.") public String getLogoUrl() { return logoUrl; } @@ -531,10 +531,10 @@ public Location posBackgroundUrl(String posBackgroundUrl) { } /** - * The Point of Sale background image URL of the location. + * The URL of the Point of Sale background image for the location. * @return posBackgroundUrl **/ - @ApiModelProperty(value = "The Point of Sale background image URL of the location.") + @ApiModelProperty(value = "The URL of the Point of Sale background image for the location.") public String getPosBackgroundUrl() { return posBackgroundUrl; } diff --git a/src/main/java/com/squareup/connect/models/Money.java b/src/main/java/com/squareup/connect/models/Money.java index 7a95131..3b7d058 100644 --- a/src/main/java/com/squareup/connect/models/Money.java +++ b/src/main/java/com/squareup/connect/models/Money.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Represents an amount of money. `Money` fields can be signed or unsigned. + * Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](/build-basics/working-with-monetary-amounts) for more information. */ -@ApiModel(description = "Represents an amount of money. `Money` fields can be signed or unsigned.") +@ApiModel(description = "Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](/build-basics/working-with-monetary-amounts) for more information.") public class Money { @JsonProperty("amount") @@ -38,10 +38,10 @@ public Money amount(Long amount) { } /** - * The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case. + * The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case. * @return amount **/ - @ApiModelProperty(value = "The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case.") + @ApiModelProperty(value = "The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.") public Long getAmount() { return amount; } diff --git a/src/main/java/com/squareup/connect/models/ObtainTokenResponse.java b/src/main/java/com/squareup/connect/models/ObtainTokenResponse.java index 1e66965..069ef16 100644 --- a/src/main/java/com/squareup/connect/models/ObtainTokenResponse.java +++ b/src/main/java/com/squareup/connect/models/ObtainTokenResponse.java @@ -146,10 +146,10 @@ public ObtainTokenResponse planId(String planId) { } /** - * __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. + * T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. * @return planId **/ - @ApiModelProperty(value = "__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.") + @ApiModelProperty(value = "T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.") public String getPlanId() { return planId; } diff --git a/src/main/java/com/squareup/connect/models/Payment.java b/src/main/java/com/squareup/connect/models/Payment.java index 5777472..2bb8873 100644 --- a/src/main/java/com/squareup/connect/models/Payment.java +++ b/src/main/java/com/squareup/connect/models/Payment.java @@ -98,6 +98,9 @@ public class Payment { @JsonProperty("note") private String note = null; + @JsonProperty("statement_description_identifier") + private String statementDescriptionIdentifier = null; + public Payment id(String id) { this.id = id; return this; @@ -158,10 +161,10 @@ public Payment amountMoney(Money amountMoney) { } /** - * The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + * The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). * @return amountMoney **/ - @ApiModelProperty(value = "The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).") + @ApiModelProperty(value = "The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).") public Money getAmountMoney() { return amountMoney; } @@ -194,10 +197,10 @@ public Payment totalMoney(Money totalMoney) { } /** - * The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. + * The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. * @return totalMoney **/ - @ApiModelProperty(value = "The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.") + @ApiModelProperty(value = "The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.") public Money getTotalMoney() { return totalMoney; } @@ -212,10 +215,10 @@ public Payment appFeeMoney(Money appFeeMoney) { } /** - * The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. + * The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. * @return appFeeMoney **/ - @ApiModelProperty(value = "The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value.") + @ApiModelProperty(value = "The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value.") public Money getAppFeeMoney() { return appFeeMoney; } @@ -504,6 +507,25 @@ public void setNote(String note) { this.note = note; } + public Payment statementDescriptionIdentifier(String statementDescriptionIdentifier) { + this.statementDescriptionIdentifier = statementDescriptionIdentifier; + return this; + } + + /** + * Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. + * Note: This model is in beta. + * @return statementDescriptionIdentifier + **/ + @ApiModelProperty(value = "Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment.") + public String getStatementDescriptionIdentifier() { + return statementDescriptionIdentifier; + } + + public void setStatementDescriptionIdentifier(String statementDescriptionIdentifier) { + this.statementDescriptionIdentifier = statementDescriptionIdentifier; + } + @Override public boolean equals(java.lang.Object o) { @@ -535,12 +557,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.buyerEmailAddress, payment.buyerEmailAddress) && Objects.equals(this.billingAddress, payment.billingAddress) && Objects.equals(this.shippingAddress, payment.shippingAddress) && - Objects.equals(this.note, payment.note); + Objects.equals(this.note, payment.note) && + Objects.equals(this.statementDescriptionIdentifier, payment.statementDescriptionIdentifier); } @Override public int hashCode() { - return Objects.hash(id, createdAt, updatedAt, amountMoney, tipMoney, totalMoney, appFeeMoney, processingFee, refundedMoney, status, sourceType, cardDetails, locationId, orderId, referenceId, customerId, employeeId, refundIds, buyerEmailAddress, billingAddress, shippingAddress, note); + return Objects.hash(id, createdAt, updatedAt, amountMoney, tipMoney, totalMoney, appFeeMoney, processingFee, refundedMoney, status, sourceType, cardDetails, locationId, orderId, referenceId, customerId, employeeId, refundIds, buyerEmailAddress, billingAddress, shippingAddress, note, statementDescriptionIdentifier); } @@ -571,6 +594,7 @@ public String toString() { sb.append(" billingAddress: ").append(toIndentedString(billingAddress)).append("\n"); sb.append(" shippingAddress: ").append(toIndentedString(shippingAddress)).append("\n"); sb.append(" note: ").append(toIndentedString(note)).append("\n"); + sb.append(" statementDescriptionIdentifier: ").append(toIndentedString(statementDescriptionIdentifier)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/squareup/connect/models/RefundPaymentRequest.java b/src/main/java/com/squareup/connect/models/RefundPaymentRequest.java index e19ae6c..7764bd9 100644 --- a/src/main/java/com/squareup/connect/models/RefundPaymentRequest.java +++ b/src/main/java/com/squareup/connect/models/RefundPaymentRequest.java @@ -48,10 +48,10 @@ public RefundPaymentRequest idempotencyKey(String idempotencyKey) { } /** - * A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency). + * A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). * @return idempotencyKey **/ - @ApiModelProperty(required = true, value = " A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency).") + @ApiModelProperty(required = true, value = " A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency).") public String getIdempotencyKey() { return idempotencyKey; } @@ -84,10 +84,10 @@ public RefundPaymentRequest appFeeMoney(Money appFeeMoney) { } /** - * Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) + * Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) * @return appFeeMoney **/ - @ApiModelProperty(value = "Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees)") + @ApiModelProperty(value = "Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees)") public Money getAppFeeMoney() { return appFeeMoney; } diff --git a/src/main/java/com/squareup/connect/models/RegisterDomainRequest.java b/src/main/java/com/squareup/connect/models/RegisterDomainRequest.java index 2a7145a..7cf4efd 100644 --- a/src/main/java/com/squareup/connect/models/RegisterDomainRequest.java +++ b/src/main/java/com/squareup/connect/models/RegisterDomainRequest.java @@ -21,9 +21,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Defines the parameters that can be included in the body of a request to the RegisterDomain endpoint. + * Defines the parameters that can be included in the body of a request to the __RegisterDomain__ endpoint. */ -@ApiModel(description = "Defines the parameters that can be included in the body of a request to the RegisterDomain endpoint.") +@ApiModel(description = "Defines the parameters that can be included in the body of a request to the __RegisterDomain__ endpoint.") public class RegisterDomainRequest { @JsonProperty("domain_name") diff --git a/src/main/java/com/squareup/connect/models/RegisterDomainResponse.java b/src/main/java/com/squareup/connect/models/RegisterDomainResponse.java index eb0750b..b407443 100644 --- a/src/main/java/com/squareup/connect/models/RegisterDomainResponse.java +++ b/src/main/java/com/squareup/connect/models/RegisterDomainResponse.java @@ -24,9 +24,9 @@ import java.util.List; /** - * Defines the fields that are included in the response body of a request to the RegisterDomain endpoint. Either `errors` or `status` will be present in a given response (never both). + * Defines the fields that are included in the response body of a request to the __RegisterDomain__ endpoint. Either `errors` or `status` will be present in a given response (never both). */ -@ApiModel(description = "Defines the fields that are included in the response body of a request to the RegisterDomain endpoint. Either `errors` or `status` will be present in a given response (never both).") +@ApiModel(description = "Defines the fields that are included in the response body of a request to the __RegisterDomain__ endpoint. Either `errors` or `status` will be present in a given response (never both).") public class RegisterDomainResponse { @JsonProperty("errors") @@ -64,10 +64,10 @@ public RegisterDomainResponse status(String status) { } /** - * Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values + * Status of the domain registration. See `RegisterDomainResponseStatus` for possible values. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values * @return status **/ - @ApiModelProperty(value = "Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values") + @ApiModelProperty(value = "Status of the domain registration. See `RegisterDomainResponseStatus` for possible values. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values") public String getStatus() { return status; } diff --git a/src/main/java/com/squareup/connect/models/RenewTokenResponse.java b/src/main/java/com/squareup/connect/models/RenewTokenResponse.java index cd3dfee..7a785c0 100644 --- a/src/main/java/com/squareup/connect/models/RenewTokenResponse.java +++ b/src/main/java/com/squareup/connect/models/RenewTokenResponse.java @@ -50,10 +50,10 @@ public RenewTokenResponse accessToken(String accessToken) { } /** - * The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://docs.connect.squareup.com/api/connect/v2/#requestandresponseheaders) for the format of this header. + * The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://developer.squareup.com/docs/api/connect/v2/#requestandresponseheaders) for the format of this header. * @return accessToken **/ - @ApiModelProperty(value = "The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://docs.connect.squareup.com/api/connect/v2/#requestandresponseheaders) for the format of this header.") + @ApiModelProperty(value = "The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://developer.squareup.com/docs/api/connect/v2/#requestandresponseheaders) for the format of this header.") public String getAccessToken() { return accessToken; } @@ -122,10 +122,10 @@ public RenewTokenResponse subscriptionId(String subscriptionId) { } /** - * __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization. + * __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization.. * @return subscriptionId **/ - @ApiModelProperty(value = "__LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization.") + @ApiModelProperty(value = "__LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization..") public String getSubscriptionId() { return subscriptionId; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveCatalogObjectRequest.java b/src/main/java/com/squareup/connect/models/RetrieveCatalogObjectRequest.java index 6fceb5c..7213019 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveCatalogObjectRequest.java +++ b/src/main/java/com/squareup/connect/models/RetrieveCatalogObjectRequest.java @@ -35,10 +35,10 @@ public RetrieveCatalogObjectRequest includeRelatedObjects(Boolean includeRelated } /** - * 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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` + * 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, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` * @return includeRelatedObjects **/ - @ApiModelProperty(value = "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`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false`") + @ApiModelProperty(value = "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, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false`") public Boolean getIncludeRelatedObjects() { return includeRelatedObjects; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveCatalogObjectResponse.java b/src/main/java/com/squareup/connect/models/RetrieveCatalogObjectResponse.java index 23fe68c..dc9824e 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveCatalogObjectResponse.java +++ b/src/main/java/com/squareup/connect/models/RetrieveCatalogObjectResponse.java @@ -50,10 +50,10 @@ public RetrieveCatalogObjectResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * Information on any errors encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "Information on any errors encountered.") public List getErrors() { return errors; } @@ -68,10 +68,10 @@ public RetrieveCatalogObjectResponse object(CatalogObject object) { } /** - * The `CatalogObject`s returned. + * The CatalogObjects returned. * @return object **/ - @ApiModelProperty(value = "The `CatalogObject`s returned.") + @ApiModelProperty(value = "The CatalogObjects returned.") public CatalogObject getObject() { return object; } @@ -91,10 +91,10 @@ public RetrieveCatalogObjectResponse addRelatedObjectsItem(CatalogObject related } /** - * A list of `CatalogObject`s referenced by the object in the `object` field. + * A list of CatalogObjects referenced by the object in the `object` field. * @return relatedObjects **/ - @ApiModelProperty(value = "A list of `CatalogObject`s referenced by the object in the `object` field.") + @ApiModelProperty(value = "A list of CatalogObjects referenced by the object in the `object` field.") public List getRelatedObjects() { return relatedObjects; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveEmployeeRequest.java b/src/main/java/com/squareup/connect/models/RetrieveEmployeeRequest.java index 66737d0..783502b 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveEmployeeRequest.java +++ b/src/main/java/com/squareup/connect/models/RetrieveEmployeeRequest.java @@ -17,9 +17,9 @@ import io.swagger.annotations.ApiModel; /** - * Retrieve an employee by `Employee.id` + * */ -@ApiModel(description = "Retrieve an employee by `Employee.id`") +@ApiModel(description = "") public class RetrieveEmployeeRequest { diff --git a/src/main/java/com/squareup/connect/models/RetrieveEmployeeResponse.java b/src/main/java/com/squareup/connect/models/RetrieveEmployeeResponse.java index 498f357..7ac72e4 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveEmployeeResponse.java +++ b/src/main/java/com/squareup/connect/models/RetrieveEmployeeResponse.java @@ -25,9 +25,9 @@ import java.util.List; /** - * Defines the fields that are included in the response body of a request to the RetrieveEmployee endpoint. One of `errors` or `employee` is present in a given response (never both). + * */ -@ApiModel(description = "Defines the fields that are included in the response body of a request to the RetrieveEmployee endpoint. One of `errors` or `employee` is present in a given response (never both).") +@ApiModel(description = "") public class RetrieveEmployeeResponse { @JsonProperty("employee") diff --git a/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesRequest.java b/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesRequest.java index 292b1a6..0fc76c0 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesRequest.java +++ b/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesRequest.java @@ -56,10 +56,10 @@ public RetrieveInventoryChangesRequest cursor(String cursor) { } /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesResponse.java b/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesResponse.java index 8e5adc8..273ab63 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesResponse.java +++ b/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesResponse.java @@ -91,10 +91,10 @@ public RetrieveInventoryChangesResponse cursor(String cursor) { } /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveInventoryCountRequest.java b/src/main/java/com/squareup/connect/models/RetrieveInventoryCountRequest.java index 6233f10..56c1b02 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveInventoryCountRequest.java +++ b/src/main/java/com/squareup/connect/models/RetrieveInventoryCountRequest.java @@ -56,10 +56,10 @@ public RetrieveInventoryCountRequest cursor(String cursor) { } /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveInventoryCountResponse.java b/src/main/java/com/squareup/connect/models/RetrieveInventoryCountResponse.java index 02af618..d2fa70e 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveInventoryCountResponse.java +++ b/src/main/java/com/squareup/connect/models/RetrieveInventoryCountResponse.java @@ -91,10 +91,10 @@ public RetrieveInventoryCountResponse cursor(String cursor) { } /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveLocationRequest.java b/src/main/java/com/squareup/connect/models/RetrieveLocationRequest.java index 8f97d64..a469328 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveLocationRequest.java +++ b/src/main/java/com/squareup/connect/models/RetrieveLocationRequest.java @@ -17,9 +17,9 @@ import io.swagger.annotations.ApiModel; /** - * Defines the fields that are included in the request body for the [RetrieveLocation](#endpoint-locations-retrievelocation) endpoint. + * Defines the fields that are included in the request body for the __RetrieveLocation__ endpoint. */ -@ApiModel(description = "Defines the fields that are included in the request body for the [RetrieveLocation](#endpoint-locations-retrievelocation) endpoint.") +@ApiModel(description = "Defines the fields that are included in the request body for the __RetrieveLocation__ endpoint.") public class RetrieveLocationRequest { diff --git a/src/main/java/com/squareup/connect/models/RetrieveLocationResponse.java b/src/main/java/com/squareup/connect/models/RetrieveLocationResponse.java index e1c6520..9715391 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveLocationResponse.java +++ b/src/main/java/com/squareup/connect/models/RetrieveLocationResponse.java @@ -25,9 +25,9 @@ import java.util.List; /** - * Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. + * Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. */ -@ApiModel(description = "Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response.") +@ApiModel(description = "Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response.") public class RetrieveLocationResponse { @JsonProperty("errors") diff --git a/src/main/java/com/squareup/connect/models/RetrieveMerchantResponse.java b/src/main/java/com/squareup/connect/models/RetrieveMerchantResponse.java index 1278f3a..f02f416 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveMerchantResponse.java +++ b/src/main/java/com/squareup/connect/models/RetrieveMerchantResponse.java @@ -25,9 +25,9 @@ import java.util.List; /** - * The response obeject returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. + * The response object returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. */ -@ApiModel(description = "The response obeject returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint.") +@ApiModel(description = "The response object returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint.") public class RetrieveMerchantResponse { @JsonProperty("errors") diff --git a/src/main/java/com/squareup/connect/models/RetrieveTransactionRequest.java b/src/main/java/com/squareup/connect/models/RetrieveTransactionRequest.java index 30fb53b..409f9b0 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveTransactionRequest.java +++ b/src/main/java/com/squareup/connect/models/RetrieveTransactionRequest.java @@ -17,9 +17,9 @@ import io.swagger.annotations.ApiModel; /** - * Defines the request body fields for calls to the RetrieveTransaction endpoint. + * */ -@ApiModel(description = "Defines the request body fields for calls to the RetrieveTransaction endpoint.") +@ApiModel(description = "") public class RetrieveTransactionRequest { diff --git a/src/main/java/com/squareup/connect/models/RevokeTokenRequest.java b/src/main/java/com/squareup/connect/models/RevokeTokenRequest.java index 6056609..8549b8c 100644 --- a/src/main/java/com/squareup/connect/models/RevokeTokenRequest.java +++ b/src/main/java/com/squareup/connect/models/RevokeTokenRequest.java @@ -41,10 +41,10 @@ public RevokeTokenRequest clientId(String clientId) { } /** - * Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + * The Square issued ID for your application, available from the [application dashboard](https://connect.squareup.com/apps). * @return clientId **/ - @ApiModelProperty(value = "Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps).") + @ApiModelProperty(value = "The Square issued ID for your application, available from the [application dashboard](https://connect.squareup.com/apps).") public String getClientId() { return clientId; } diff --git a/src/main/java/com/squareup/connect/models/SearchCatalogObjectsRequest.java b/src/main/java/com/squareup/connect/models/SearchCatalogObjectsRequest.java index 51e2940..c79ca5a 100644 --- a/src/main/java/com/squareup/connect/models/SearchCatalogObjectsRequest.java +++ b/src/main/java/com/squareup/connect/models/SearchCatalogObjectsRequest.java @@ -79,10 +79,10 @@ public SearchCatalogObjectsRequest addObjectTypesItem(String objectTypesItem) { } /** - * The desired set of object types to appear in the search results. The legal values are taken from the `CatalogObjectType` enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values + * The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values * @return objectTypes **/ - @ApiModelProperty(value = "The desired set of object types to appear in the search results. The legal values are taken from the `CatalogObjectType` enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values") + @ApiModelProperty(value = "The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values") public List getObjectTypes() { return objectTypes; } @@ -115,10 +115,10 @@ public SearchCatalogObjectsRequest includeRelatedObjects(Boolean includeRelatedO } /** - * If `true`, the response will include additional objects that are related to the requested object, as follows: If a `CatalogItem` is returned in the object field of the response, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be included in the `related_objects` field of the response. If a `CatalogItemVariation` is returned in the object field of the response, its parent `CatalogItem` will be included in the `related_objects` field of the response. + * If `true`, the response will include additional objects that are related to the requested object, as follows: If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response. If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response. * @return includeRelatedObjects **/ - @ApiModelProperty(value = "If `true`, the response will include additional objects that are related to the requested object, as follows: If a `CatalogItem` is returned in the object field of the response, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be included in the `related_objects` field of the response. If a `CatalogItemVariation` is returned in the object field of the response, its parent `CatalogItem` will be included in the `related_objects` field of the response.") + @ApiModelProperty(value = "If `true`, the response will include additional objects that are related to the requested object, as follows: If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response. If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response.") public Boolean getIncludeRelatedObjects() { return includeRelatedObjects; } @@ -133,10 +133,10 @@ public SearchCatalogObjectsRequest beginTime(String beginTime) { } /** - * Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. + * Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. * @return beginTime **/ - @ApiModelProperty(value = "Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response.") + @ApiModelProperty(value = "Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response.") public String getBeginTime() { return beginTime; } diff --git a/src/main/java/com/squareup/connect/models/SearchCatalogObjectsResponse.java b/src/main/java/com/squareup/connect/models/SearchCatalogObjectsResponse.java index 02a29fc..970c5e0 100644 --- a/src/main/java/com/squareup/connect/models/SearchCatalogObjectsResponse.java +++ b/src/main/java/com/squareup/connect/models/SearchCatalogObjectsResponse.java @@ -56,10 +56,10 @@ public SearchCatalogObjectsResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * Information on any errors encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "Information on any errors encountered.") public List getErrors() { return errors; } @@ -97,10 +97,10 @@ public SearchCatalogObjectsResponse addObjectsItem(CatalogObject objectsItem) { } /** - * The `CatalogObject`s returned. + * The CatalogObjects returned. * @return objects **/ - @ApiModelProperty(value = "The `CatalogObject`s returned.") + @ApiModelProperty(value = "The CatalogObjects returned.") public List getObjects() { return objects; } @@ -120,10 +120,10 @@ public SearchCatalogObjectsResponse addRelatedObjectsItem(CatalogObject relatedO } /** - * A list of `CatalogObject`s referenced by the objects in the `objects` field. + * A list of CatalogObjects referenced by the objects in the `objects` field. * @return relatedObjects **/ - @ApiModelProperty(value = "A list of `CatalogObject`s referenced by the objects in the `objects` field.") + @ApiModelProperty(value = "A list of CatalogObjects referenced by the objects in the `objects` field.") public List getRelatedObjects() { return relatedObjects; } @@ -138,11 +138,11 @@ public SearchCatalogObjectsResponse latestTime(String latestTime) { } /** - * When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. + * When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. * Note: This model is in beta. * @return latestTime **/ - @ApiModelProperty(value = " When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request.") + @ApiModelProperty(value = "When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request.") public String getLatestTime() { return latestTime; } diff --git a/src/main/java/com/squareup/connect/models/SearchCustomersRequest.java b/src/main/java/com/squareup/connect/models/SearchCustomersRequest.java index b79257c..f023ba9 100644 --- a/src/main/java/com/squareup/connect/models/SearchCustomersRequest.java +++ b/src/main/java/com/squareup/connect/models/SearchCustomersRequest.java @@ -42,10 +42,10 @@ public SearchCustomersRequest cursor(String cursor) { } /** - * Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. * @return cursor **/ - @ApiModelProperty(value = "Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/SearchCustomersResponse.java b/src/main/java/com/squareup/connect/models/SearchCustomersResponse.java index 0911ccb..b347346 100644 --- a/src/main/java/com/squareup/connect/models/SearchCustomersResponse.java +++ b/src/main/java/com/squareup/connect/models/SearchCustomersResponse.java @@ -91,10 +91,10 @@ public SearchCustomersResponse cursor(String cursor) { } /** - * A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. * @return cursor **/ - @ApiModelProperty(value = "A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/Shift.java b/src/main/java/com/squareup/connect/models/Shift.java index 66604d3..4c4254b 100644 --- a/src/main/java/com/squareup/connect/models/Shift.java +++ b/src/main/java/com/squareup/connect/models/Shift.java @@ -180,10 +180,10 @@ public Shift wage(ShiftWage wage) { } /** - * Job and pay related information. + * Job and pay related information. If wage is not set on create, will default to a wage of zero money. If title is not set on create, will default to the name of the role the employee is assigned to, if any. * @return wage **/ - @ApiModelProperty(value = "Job and pay related information.") + @ApiModelProperty(value = "Job and pay related information. If wage is not set on create, will default to a wage of zero money. If title is not set on create, will default to the name of the role the employee is assigned to, if any.") public ShiftWage getWage() { return wage; } diff --git a/src/main/java/com/squareup/connect/models/ShiftFilter.java b/src/main/java/com/squareup/connect/models/ShiftFilter.java index 1433f05..459d5d6 100644 --- a/src/main/java/com/squareup/connect/models/ShiftFilter.java +++ b/src/main/java/com/squareup/connect/models/ShiftFilter.java @@ -30,11 +30,11 @@ @ApiModel(description = "Defines a filter used in a search for `Shift` records. `AND` logic is used by Square's servers to apply each filter property specified.") public class ShiftFilter { - @JsonProperty("location_id") - private List locationId = new ArrayList(); + @JsonProperty("location_ids") + private List locationIds = new ArrayList(); - @JsonProperty("employee_id") - private List employeeId = new ArrayList(); + @JsonProperty("employee_ids") + private List employeeIds = new ArrayList(); @JsonProperty("status") private String status = null; @@ -48,50 +48,50 @@ public class ShiftFilter { @JsonProperty("workday") private ShiftWorkday workday = null; - public ShiftFilter locationId(List locationId) { - this.locationId = locationId; + public ShiftFilter locationIds(List locationIds) { + this.locationIds = locationIds; return this; } - public ShiftFilter addLocationIdItem(String locationIdItem) { - this.locationId.add(locationIdItem); + public ShiftFilter addLocationIdsItem(String locationIdsItem) { + this.locationIds.add(locationIdsItem); return this; } /** * Fetch shifts for the specified location. - * @return locationId + * @return locationIds **/ @ApiModelProperty(value = "Fetch shifts for the specified location.") - public List getLocationId() { - return locationId; + public List getLocationIds() { + return locationIds; } - public void setLocationId(List locationId) { - this.locationId = locationId; + public void setLocationIds(List locationIds) { + this.locationIds = locationIds; } - public ShiftFilter employeeId(List employeeId) { - this.employeeId = employeeId; + public ShiftFilter employeeIds(List employeeIds) { + this.employeeIds = employeeIds; return this; } - public ShiftFilter addEmployeeIdItem(String employeeIdItem) { - this.employeeId.add(employeeIdItem); + public ShiftFilter addEmployeeIdsItem(String employeeIdsItem) { + this.employeeIds.add(employeeIdsItem); return this; } /** * Fetch shifts for the specified employee. - * @return employeeId + * @return employeeIds **/ @ApiModelProperty(value = "Fetch shifts for the specified employee.") - public List getEmployeeId() { - return employeeId; + public List getEmployeeIds() { + return employeeIds; } - public void setEmployeeId(List employeeId) { - this.employeeId = employeeId; + public void setEmployeeIds(List employeeIds) { + this.employeeIds = employeeIds; } public ShiftFilter status(String status) { @@ -176,8 +176,8 @@ public boolean equals(java.lang.Object o) { return false; } ShiftFilter shiftFilter = (ShiftFilter) o; - return Objects.equals(this.locationId, shiftFilter.locationId) && - Objects.equals(this.employeeId, shiftFilter.employeeId) && + return Objects.equals(this.locationIds, shiftFilter.locationIds) && + Objects.equals(this.employeeIds, shiftFilter.employeeIds) && Objects.equals(this.status, shiftFilter.status) && Objects.equals(this.start, shiftFilter.start) && Objects.equals(this.end, shiftFilter.end) && @@ -186,7 +186,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(locationId, employeeId, status, start, end, workday); + return Objects.hash(locationIds, employeeIds, status, start, end, workday); } @@ -195,8 +195,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ShiftFilter {\n"); - sb.append(" locationId: ").append(toIndentedString(locationId)).append("\n"); - sb.append(" employeeId: ").append(toIndentedString(employeeId)).append("\n"); + sb.append(" locationIds: ").append(toIndentedString(locationIds)).append("\n"); + sb.append(" employeeIds: ").append(toIndentedString(employeeIds)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append(" start: ").append(toIndentedString(start)).append("\n"); sb.append(" end: ").append(toIndentedString(end)).append("\n"); diff --git a/src/main/java/com/squareup/connect/models/StandardUnitDescription.java b/src/main/java/com/squareup/connect/models/StandardUnitDescription.java index 32b4247..82b4864 100644 --- a/src/main/java/com/squareup/connect/models/StandardUnitDescription.java +++ b/src/main/java/com/squareup/connect/models/StandardUnitDescription.java @@ -60,10 +60,10 @@ public StandardUnitDescription name(String name) { } /** - * Display name of the measurement unit. For example, 'Pound'. + * UI display name of the measurement unit. For example, 'Pound'. * @return name **/ - @ApiModelProperty(value = "Display name of the measurement unit. For example, 'Pound'.") + @ApiModelProperty(value = "UI display name of the measurement unit. For example, 'Pound'.") public String getName() { return name; } @@ -78,10 +78,10 @@ public StandardUnitDescription abbreviation(String abbreviation) { } /** - * Abbreviation for the measurement unit. For example, 'lb'. + * UI display abbreviation for the measurement unit. For example, 'lb'. * @return abbreviation **/ - @ApiModelProperty(value = "Abbreviation for the measurement unit. For example, 'lb'.") + @ApiModelProperty(value = "UI display abbreviation for the measurement unit. For example, 'lb'.") public String getAbbreviation() { return abbreviation; } diff --git a/src/main/java/com/squareup/connect/models/StandardUnitDescriptionGroup.java b/src/main/java/com/squareup/connect/models/StandardUnitDescriptionGroup.java index 6f96de1..bee0ba7 100644 --- a/src/main/java/com/squareup/connect/models/StandardUnitDescriptionGroup.java +++ b/src/main/java/com/squareup/connect/models/StandardUnitDescriptionGroup.java @@ -46,10 +46,10 @@ public StandardUnitDescriptionGroup addStandardUnitDescriptionsItem(StandardUnit } /** - * List of measurement units in this description group. + * List of standard (non-custom) measurement units in this description group. * @return standardUnitDescriptions **/ - @ApiModelProperty(value = "List of measurement units in this description group.") + @ApiModelProperty(value = "List of standard (non-custom) measurement units in this description group.") public List getStandardUnitDescriptions() { return standardUnitDescriptions; } diff --git a/src/main/java/com/squareup/connect/models/TenderCardDetails.java b/src/main/java/com/squareup/connect/models/TenderCardDetails.java index 1fcf38f..e1a9eb6 100644 --- a/src/main/java/com/squareup/connect/models/TenderCardDetails.java +++ b/src/main/java/com/squareup/connect/models/TenderCardDetails.java @@ -42,10 +42,10 @@ public TenderCardDetails status(String status) { } /** - * The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values + * The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See `TenderCardDetailsStatus` for possible values. See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values * @return status **/ - @ApiModelProperty(value = "The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values") + @ApiModelProperty(value = "The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See `TenderCardDetailsStatus` for possible values. See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values") public String getStatus() { return status; } diff --git a/src/main/java/com/squareup/connect/models/UpdateBreakTypeRequest.java b/src/main/java/com/squareup/connect/models/UpdateBreakTypeRequest.java index df4c1f7..d33526d 100644 --- a/src/main/java/com/squareup/connect/models/UpdateBreakTypeRequest.java +++ b/src/main/java/com/squareup/connect/models/UpdateBreakTypeRequest.java @@ -39,7 +39,7 @@ public UpdateBreakTypeRequest breakType(BreakType breakType) { * The updated `BreakType`. * @return breakType **/ - @ApiModelProperty(value = "The updated `BreakType`.") + @ApiModelProperty(required = true, value = "The updated `BreakType`.") public BreakType getBreakType() { return breakType; } diff --git a/src/main/java/com/squareup/connect/models/UpdateCustomerRequest.java b/src/main/java/com/squareup/connect/models/UpdateCustomerRequest.java index 3500ee2..5dbbaa4 100644 --- a/src/main/java/com/squareup/connect/models/UpdateCustomerRequest.java +++ b/src/main/java/com/squareup/connect/models/UpdateCustomerRequest.java @@ -63,10 +63,10 @@ public UpdateCustomerRequest givenName(String givenName) { } /** - * The customer's given (i.e., first) name. + * The given (i.e., first) name associated with the customer profile. * @return givenName **/ - @ApiModelProperty(value = "The customer's given (i.e., first) name.") + @ApiModelProperty(value = "The given (i.e., first) name associated with the customer profile.") public String getGivenName() { return givenName; } @@ -81,10 +81,10 @@ public UpdateCustomerRequest familyName(String familyName) { } /** - * The customer's family (i.e., last) name. + * The family (i.e., last) name associated with the customer profile. * @return familyName **/ - @ApiModelProperty(value = "The customer's family (i.e., last) name.") + @ApiModelProperty(value = "The family (i.e., last) name associated with the customer profile.") public String getFamilyName() { return familyName; } @@ -99,10 +99,10 @@ public UpdateCustomerRequest companyName(String companyName) { } /** - * The name of the customer's company. + * A business name associated with the customer profile. * @return companyName **/ - @ApiModelProperty(value = "The name of the customer's company.") + @ApiModelProperty(value = "A business name associated with the customer profile.") public String getCompanyName() { return companyName; } @@ -117,10 +117,10 @@ public UpdateCustomerRequest nickname(String nickname) { } /** - * A nickname for the customer. + * A nickname for the customer profile. * @return nickname **/ - @ApiModelProperty(value = "A nickname for the customer.") + @ApiModelProperty(value = "A nickname for the customer profile.") public String getNickname() { return nickname; } @@ -135,10 +135,10 @@ public UpdateCustomerRequest emailAddress(String emailAddress) { } /** - * The customer's email address. + * The email address associated with the customer profile. * @return emailAddress **/ - @ApiModelProperty(value = "The customer's email address.") + @ApiModelProperty(value = "The email address associated with the customer profile.") public String getEmailAddress() { return emailAddress; } @@ -153,10 +153,10 @@ public UpdateCustomerRequest address(Address address) { } /** - * The customer's physical address. + * The physical address associated with the customer profile. * @return address **/ - @ApiModelProperty(value = "The customer's physical address.") + @ApiModelProperty(value = "The physical address associated with the customer profile.") public Address getAddress() { return address; } @@ -171,10 +171,10 @@ public UpdateCustomerRequest phoneNumber(String phoneNumber) { } /** - * The customer's phone number. + * The 11-digit phone number associated with the customer profile. * @return phoneNumber **/ - @ApiModelProperty(value = "The customer's phone number.") + @ApiModelProperty(value = "The 11-digit phone number associated with the customer profile.") public String getPhoneNumber() { return phoneNumber; } @@ -189,10 +189,10 @@ public UpdateCustomerRequest referenceId(String referenceId) { } /** - * An optional second ID you can set to associate the customer with an entity in another system. + * An optional, second ID used to associate the customer profile with an entity in another system. * @return referenceId **/ - @ApiModelProperty(value = "An optional second ID you can set to associate the customer with an entity in another system.") + @ApiModelProperty(value = "An optional, second ID used to associate the customer profile with an entity in another system.") public String getReferenceId() { return referenceId; } @@ -207,10 +207,10 @@ public UpdateCustomerRequest note(String note) { } /** - * An optional note to associate with the customer. + * A custom note associated with the customer profile. * @return note **/ - @ApiModelProperty(value = "An optional note to associate with the customer.") + @ApiModelProperty(value = "A custom note associated with the customer profile.") public String getNote() { return note; } @@ -225,10 +225,10 @@ public UpdateCustomerRequest birthday(String birthday) { } /** - * The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. + * The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. * @return birthday **/ - @ApiModelProperty(value = "The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.") + @ApiModelProperty(value = "The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__.") public String getBirthday() { return birthday; } diff --git a/src/main/java/com/squareup/connect/models/UpdateItemModifierListsRequest.java b/src/main/java/com/squareup/connect/models/UpdateItemModifierListsRequest.java index 3833ccb..d1e0c34 100644 --- a/src/main/java/com/squareup/connect/models/UpdateItemModifierListsRequest.java +++ b/src/main/java/com/squareup/connect/models/UpdateItemModifierListsRequest.java @@ -48,10 +48,10 @@ public UpdateItemModifierListsRequest addItemIdsItem(String itemIdsItem) { } /** - * The `CatalogItem](#type-catalogitem)s whose [CatalogModifierList`s are being updated. + * The IDs of the catalog items associated with the CatalogModifierList objects being updated. * @return itemIds **/ - @ApiModelProperty(required = true, value = "The `CatalogItem](#type-catalogitem)s whose [CatalogModifierList`s are being updated.") + @ApiModelProperty(required = true, value = "The IDs of the catalog items associated with the CatalogModifierList objects being updated.") public List getItemIds() { return itemIds; } @@ -71,10 +71,10 @@ public UpdateItemModifierListsRequest addModifierListsToEnableItem(String modifi } /** - * The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem`. + * The IDs of the CatalogModifierList objects to enable for the CatalogItem. * @return modifierListsToEnable **/ - @ApiModelProperty(value = "The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem`.") + @ApiModelProperty(value = "The IDs of the CatalogModifierList objects to enable for the CatalogItem.") public List getModifierListsToEnable() { return modifierListsToEnable; } @@ -94,10 +94,10 @@ public UpdateItemModifierListsRequest addModifierListsToDisableItem(String modif } /** - * The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem`. + * The IDs of the CatalogModifierList objects to disable for the CatalogItem. * @return modifierListsToDisable **/ - @ApiModelProperty(value = "The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem`.") + @ApiModelProperty(value = "The IDs of the CatalogModifierList objects to disable for the CatalogItem.") public List getModifierListsToDisable() { return modifierListsToDisable; } diff --git a/src/main/java/com/squareup/connect/models/UpdateItemModifierListsResponse.java b/src/main/java/com/squareup/connect/models/UpdateItemModifierListsResponse.java index a258102..59a10d5 100644 --- a/src/main/java/com/squareup/connect/models/UpdateItemModifierListsResponse.java +++ b/src/main/java/com/squareup/connect/models/UpdateItemModifierListsResponse.java @@ -46,10 +46,10 @@ public UpdateItemModifierListsResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * Information on any errors encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "Information on any errors encountered.") public List getErrors() { return errors; } @@ -64,10 +64,10 @@ public UpdateItemModifierListsResponse updatedAt(String updatedAt) { } /** - * The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + * * @return updatedAt **/ - @ApiModelProperty(value = "The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".") + @ApiModelProperty(value = "") public String getUpdatedAt() { return updatedAt; } diff --git a/src/main/java/com/squareup/connect/models/UpdateItemTaxesRequest.java b/src/main/java/com/squareup/connect/models/UpdateItemTaxesRequest.java index b800944..ab299e8 100644 --- a/src/main/java/com/squareup/connect/models/UpdateItemTaxesRequest.java +++ b/src/main/java/com/squareup/connect/models/UpdateItemTaxesRequest.java @@ -48,10 +48,10 @@ public UpdateItemTaxesRequest addItemIdsItem(String itemIdsItem) { } /** - * The `CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax`es are being updated. + * IDs for the CatalogItems associated with the CatalogTax objects being updated. * @return itemIds **/ - @ApiModelProperty(required = true, value = "The `CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax`es are being updated.") + @ApiModelProperty(required = true, value = "IDs for the CatalogItems associated with the CatalogTax objects being updated.") public List getItemIds() { return itemIds; } @@ -71,10 +71,10 @@ public UpdateItemTaxesRequest addTaxesToEnableItem(String taxesToEnableItem) { } /** - * The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem`. + * IDs of the CatalogTax objects to enable. * @return taxesToEnable **/ - @ApiModelProperty(value = "The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem`.") + @ApiModelProperty(value = "IDs of the CatalogTax objects to enable.") public List getTaxesToEnable() { return taxesToEnable; } @@ -94,10 +94,10 @@ public UpdateItemTaxesRequest addTaxesToDisableItem(String taxesToDisableItem) { } /** - * The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem`. + * IDs of the CatalogTax objects to disable. * @return taxesToDisable **/ - @ApiModelProperty(value = "The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem`.") + @ApiModelProperty(value = "IDs of the CatalogTax objects to disable.") public List getTaxesToDisable() { return taxesToDisable; } diff --git a/src/main/java/com/squareup/connect/models/UpdateItemTaxesResponse.java b/src/main/java/com/squareup/connect/models/UpdateItemTaxesResponse.java index bd0996b..13c49b4 100644 --- a/src/main/java/com/squareup/connect/models/UpdateItemTaxesResponse.java +++ b/src/main/java/com/squareup/connect/models/UpdateItemTaxesResponse.java @@ -46,10 +46,10 @@ public UpdateItemTaxesResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * Information on any errors encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "Information on any errors encountered.") public List getErrors() { return errors; } @@ -64,10 +64,10 @@ public UpdateItemTaxesResponse updatedAt(String updatedAt) { } /** - * The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + * The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-date) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. * @return updatedAt **/ - @ApiModelProperty(value = "The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".") + @ApiModelProperty(value = "The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-date) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`.") public String getUpdatedAt() { return updatedAt; } diff --git a/src/main/java/com/squareup/connect/models/UpdateWorkweekConfigRequest.java b/src/main/java/com/squareup/connect/models/UpdateWorkweekConfigRequest.java index a8849c2..9354eeb 100644 --- a/src/main/java/com/squareup/connect/models/UpdateWorkweekConfigRequest.java +++ b/src/main/java/com/squareup/connect/models/UpdateWorkweekConfigRequest.java @@ -39,7 +39,7 @@ public UpdateWorkweekConfigRequest workweekConfig(WorkweekConfig workweekConfig) * The updated `WorkweekConfig` object. * @return workweekConfig **/ - @ApiModelProperty(value = "The updated `WorkweekConfig` object.") + @ApiModelProperty(required = true, value = "The updated `WorkweekConfig` object.") public WorkweekConfig getWorkweekConfig() { return workweekConfig; } diff --git a/src/main/java/com/squareup/connect/models/UpsertCatalogObjectRequest.java b/src/main/java/com/squareup/connect/models/UpsertCatalogObjectRequest.java index 5f9a8c5..a2caedd 100644 --- a/src/main/java/com/squareup/connect/models/UpsertCatalogObjectRequest.java +++ b/src/main/java/com/squareup/connect/models/UpsertCatalogObjectRequest.java @@ -57,10 +57,10 @@ public UpsertCatalogObjectRequest object(CatalogObject object) { } /** - * A `CatalogObject` to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. + * A CatalogObject to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. * @return object **/ - @ApiModelProperty(required = true, value = "A `CatalogObject` to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID.") + @ApiModelProperty(required = true, value = "A CatalogObject to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID.") public CatalogObject getObject() { return object; } diff --git a/src/main/java/com/squareup/connect/models/UpsertCatalogObjectResponse.java b/src/main/java/com/squareup/connect/models/UpsertCatalogObjectResponse.java index 51f71b0..90f9f68 100644 --- a/src/main/java/com/squareup/connect/models/UpsertCatalogObjectResponse.java +++ b/src/main/java/com/squareup/connect/models/UpsertCatalogObjectResponse.java @@ -51,10 +51,10 @@ public UpsertCatalogObjectResponse addErrorsItem(Error errorsItem) { } /** - * The set of `Error`s encountered. + * Information on any errors encountered. * @return errors **/ - @ApiModelProperty(value = "The set of `Error`s encountered.") + @ApiModelProperty(value = "Information on any errors encountered.") public List getErrors() { return errors; } @@ -69,10 +69,10 @@ public UpsertCatalogObjectResponse catalogObject(CatalogObject catalogObject) { } /** - * The created `CatalogObject`. + * The successfully created or updated CatalogObject. * @return catalogObject **/ - @ApiModelProperty(value = "The created `CatalogObject`.") + @ApiModelProperty(value = "The successfully created or updated CatalogObject.") public CatalogObject getCatalogObject() { return catalogObject; } @@ -92,10 +92,10 @@ public UpsertCatalogObjectResponse addIdMappingsItem(CatalogIdMapping idMappings } /** - * The mapping between client and server IDs for this Upsert. + * The mapping between client and server IDs for this upsert. * @return idMappings **/ - @ApiModelProperty(value = "The mapping between client and server IDs for this Upsert.") + @ApiModelProperty(value = "The mapping between client and server IDs for this upsert.") public List getIdMappings() { return idMappings; } diff --git a/src/main/java/com/squareup/connect/models/V1Discount.java b/src/main/java/com/squareup/connect/models/V1Discount.java index 1d19195..b601a78 100644 --- a/src/main/java/com/squareup/connect/models/V1Discount.java +++ b/src/main/java/com/squareup/connect/models/V1Discount.java @@ -165,10 +165,10 @@ public V1Discount color(String color) { } /** - * The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values + * The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values * @return color **/ - @ApiModelProperty(value = "The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values") + @ApiModelProperty(value = "The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values") public String getColor() { return color; } diff --git a/src/main/java/com/squareup/connect/models/V1Fee.java b/src/main/java/com/squareup/connect/models/V1Fee.java index ab490b8..a4e6a7b 100644 --- a/src/main/java/com/squareup/connect/models/V1Fee.java +++ b/src/main/java/com/squareup/connect/models/V1Fee.java @@ -152,10 +152,10 @@ public V1Fee appliesToCustomAmounts(Boolean appliesToCustomAmounts) { } /** - * If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item. + * If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item. * @return appliesToCustomAmounts **/ - @ApiModelProperty(value = "If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item.") + @ApiModelProperty(value = "If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item.") public Boolean getAppliesToCustomAmounts() { return appliesToCustomAmounts; } diff --git a/src/main/java/com/squareup/connect/models/V1Item.java b/src/main/java/com/squareup/connect/models/V1Item.java index e5ffdea..bf08347 100644 --- a/src/main/java/com/squareup/connect/models/V1Item.java +++ b/src/main/java/com/squareup/connect/models/V1Item.java @@ -162,10 +162,10 @@ public V1Item color(String color) { } /** - * The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values + * The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values * @return color **/ - @ApiModelProperty(value = "The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values") + @ApiModelProperty(value = "The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values") public String getColor() { return color; } @@ -180,10 +180,10 @@ public V1Item abbreviation(String abbreviation) { } /** - * The text of the item's display label in Square Register. Only up to the first five characters of the string are used. + * The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used. * @return abbreviation **/ - @ApiModelProperty(value = "The text of the item's display label in Square Register. Only up to the first five characters of the string are used.") + @ApiModelProperty(value = "The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used.") public String getAbbreviation() { return abbreviation; } diff --git a/src/main/java/com/squareup/connect/models/V1ModifierOption.java b/src/main/java/com/squareup/connect/models/V1ModifierOption.java index d837b32..4b0b64b 100644 --- a/src/main/java/com/squareup/connect/models/V1ModifierOption.java +++ b/src/main/java/com/squareup/connect/models/V1ModifierOption.java @@ -126,10 +126,10 @@ public V1ModifierOption ordinal(Integer ordinal) { } /** - * Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. + * Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. * @return ordinal **/ - @ApiModelProperty(value = "Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.") + @ApiModelProperty(value = "Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.") public Integer getOrdinal() { return ordinal; } diff --git a/src/main/java/com/squareup/connect/models/V1Variation.java b/src/main/java/com/squareup/connect/models/V1Variation.java index f7f08d5..df09101 100644 --- a/src/main/java/com/squareup/connect/models/V1Variation.java +++ b/src/main/java/com/squareup/connect/models/V1Variation.java @@ -123,10 +123,10 @@ public V1Variation ordinal(Integer ordinal) { } /** - * Indicates 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 + * Indicates the variation's list position when displayed in Square Point of Sale 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 * @return ordinal **/ - @ApiModelProperty(value = "Indicates 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") + @ApiModelProperty(value = "Indicates the variation's list position when displayed in Square Point of Sale 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") public Integer getOrdinal() { return ordinal; } diff --git a/src/main/java/com/squareup/connect/models/VoidTransactionRequest.java b/src/main/java/com/squareup/connect/models/VoidTransactionRequest.java index 48bbf51..08ea533 100644 --- a/src/main/java/com/squareup/connect/models/VoidTransactionRequest.java +++ b/src/main/java/com/squareup/connect/models/VoidTransactionRequest.java @@ -17,9 +17,9 @@ import io.swagger.annotations.ApiModel; /** - * Defines the request body for calls to the VoidTransaction endpoint. + * */ -@ApiModel(description = "Defines the request body for calls to the VoidTransaction endpoint.") +@ApiModel(description = "") public class VoidTransactionRequest {