From 64a4a34757e10f2f9e147e8f48127aef3b64377d Mon Sep 17 00:00:00 2001 From: Connect API Specification Generator Date: Tue, 24 Sep 2019 23:15:16 +0000 Subject: [PATCH] Release 2.20190925.0 --- CHANGES.md | 15 ++ README.md | 16 +- build.gradle | 2 +- docs/AdditionalRecipient.md | 2 +- docs/BatchChangeInventoryRequest.md | 2 +- docs/BatchDeleteCatalogObjectsRequest.md | 2 +- docs/BatchDeleteCatalogObjectsResponse.md | 4 +- docs/BatchRetrieveCatalogObjectsRequest.md | 4 +- docs/BatchRetrieveCatalogObjectsResponse.md | 6 +- docs/BatchRetrieveInventoryChangesRequest.md | 10 +- docs/BatchRetrieveInventoryChangesResponse.md | 2 +- docs/BatchRetrieveInventoryCountsRequest.md | 6 +- docs/BatchRetrieveInventoryCountsResponse.md | 2 +- docs/BatchUpsertCatalogObjectsRequest.md | 4 +- docs/BatchUpsertCatalogObjectsResponse.md | 4 +- docs/CancelPaymentRequest.md | 2 +- docs/Card.md | 1 + docs/CardPaymentDetails.md | 9 +- docs/CatalogApi.md | 20 +- docs/CatalogIdMapping.md | 4 +- docs/CatalogInfoResponse.md | 2 +- docs/CatalogItem.md | 8 +- docs/CatalogItemModifierListInfo.md | 10 +- docs/CatalogItemOption.md | 4 +- docs/CatalogItemVariation.md | 8 +- docs/CatalogModifierList.md | 6 +- docs/CatalogModifierOverride.md | 4 +- docs/CatalogObject.md | 30 +-- docs/CatalogObjectBatch.md | 2 +- docs/CatalogPricingRule.md | 10 +- docs/CatalogProductSet.md | 4 +- docs/CatalogQuery.md | 10 +- ...gQueryItemVariationsForItemOptionValues.md | 2 +- docs/CatalogQueryItemsForItemOptions.md | 2 +- docs/CatalogQueryItemsForModifierList.md | 2 +- docs/CatalogQueryItemsForTax.md | 2 +- docs/CatalogQuerySortedAttribute.md | 2 +- docs/CatalogTax.md | 2 +- docs/CatalogV1Id.md | 2 +- docs/ChargeRequest.md | 4 +- docs/CompletePaymentRequest.md | 2 +- docs/CreateCheckoutRequest.md | 2 +- docs/CreateCustomerCardRequest.md | 2 +- docs/CreateCustomerRequest.md | 2 +- docs/CreateOrderRequest.md | 10 +- docs/CreateOrderRequestDiscount.md | 2 +- docs/CreateOrderRequestLineItem.md | 4 +- docs/CreateOrderRequestModifier.md | 4 +- docs/CreateOrderRequestTax.md | 4 +- docs/CreatePaymentRequest.md | 14 +- docs/CreateRefundRequest.md | 4 +- docs/CustomersApi.md | 4 +- docs/DeleteCatalogObjectResponse.md | 4 +- docs/Error.md | 4 +- docs/InventoryAdjustment.md | 18 +- docs/InventoryApi.md | 32 +-- docs/InventoryCount.md | 10 +- docs/InventoryPhysicalCount.md | 16 +- docs/InventoryTransfer.md | 18 +- docs/ItemVariationLocationOverrides.md | 10 +- ...tionalRecipientReceivableRefundsRequest.md | 2 +- ...ionalRecipientReceivableRefundsResponse.md | 2 +- ...stAdditionalRecipientReceivablesRequest.md | 2 +- ...tAdditionalRecipientReceivablesResponse.md | 2 +- docs/ListCatalogRequest.md | 4 +- docs/ListCatalogResponse.md | 6 +- docs/ListCustomersRequest.md | 2 +- docs/ListCustomersResponse.md | 2 +- docs/ListPaymentRefundsRequest.md | 4 +- docs/ListPaymentRefundsResponse.md | 2 +- docs/ListPaymentsRequest.md | 2 +- docs/ListPaymentsResponse.md | 2 +- docs/ListRefundsRequest.md | 2 +- docs/ListRefundsResponse.md | 2 +- docs/ListTransactionsRequest.md | 2 +- docs/ListTransactionsResponse.md | 2 +- docs/Location.md | 5 +- docs/LocationsApi.md | 110 ++++++++++ docs/MeasurementUnit.md | 3 +- docs/MeasurementUnitTime.md | 16 ++ docs/Merchant.md | 19 ++ docs/MerchantStatus.md | 10 + docs/MerchantsApi.md | 62 ++++++ docs/MobileAuthorizationApi.md | 2 +- docs/Money.md | 2 +- docs/ObtainTokenRequest.md | 8 +- docs/ObtainTokenResponse.md | 4 +- docs/Order.md | 5 +- docs/OrderEntry.md | 2 +- docs/OrderFulfillment.md | 1 + docs/OrderLineItem.md | 5 +- docs/OrderLineItemDiscount.md | 7 +- docs/OrderLineItemModifier.md | 4 +- docs/OrderLineItemTax.md | 3 +- docs/OrderQuantityUnit.md | 2 +- docs/OrderReturnDiscount.md | 8 +- docs/OrderReturnLineItem.md | 4 +- docs/OrderReturnLineItemModifier.md | 4 +- docs/OrderReturnServiceCharge.md | 2 +- docs/OrderReturnTax.md | 2 +- docs/OrderServiceCharge.md | 3 +- docs/PayOrderRequest.md | 2 +- docs/PayOrderResponse.md | 2 +- docs/Payment.md | 9 +- docs/PaymentRefund.md | 2 +- docs/PaymentsApi.md | 10 +- docs/RefundPaymentRequest.md | 6 +- docs/RefundsApi.md | 8 +- docs/ReportingApi.md | 8 +- docs/RetrieveCatalogObjectRequest.md | 2 +- docs/RetrieveCatalogObjectResponse.md | 6 +- docs/RetrieveInventoryAdjustmentResponse.md | 2 +- docs/RetrieveInventoryChangesRequest.md | 4 +- docs/RetrieveInventoryChangesResponse.md | 2 +- docs/RetrieveInventoryCountRequest.md | 4 +- docs/RetrieveInventoryCountResponse.md | 2 +- .../RetrieveInventoryPhysicalCountResponse.md | 2 +- docs/RetrieveLocationRequest.md | 2 +- docs/RetrieveLocationResponse.md | 4 +- docs/RetrieveMerchantRequest.md | 13 ++ docs/RetrieveMerchantResponse.md | 15 ++ docs/SearchCatalogObjectsRequest.md | 6 +- docs/SearchCatalogObjectsResponse.md | 9 +- docs/SearchCustomersRequest.md | 2 +- docs/SearchCustomersResponse.md | 2 +- docs/SearchOrdersFilter.md | 4 +- docs/SearchOrdersFulfillmentFilter.md | 4 +- docs/SearchOrdersRequest.md | 4 +- docs/SearchOrdersResponse.md | 8 +- docs/SearchOrdersSort.md | 2 +- docs/SearchOrdersSourceFilter.md | 2 +- docs/SourceApplication.md | 4 +- docs/Tender.md | 4 +- docs/Transaction.md | 2 +- docs/TransactionsApi.md | 8 +- docs/UpdateItemModifierListsRequest.md | 6 +- docs/UpdateItemModifierListsResponse.md | 2 +- docs/UpdateItemTaxesRequest.md | 6 +- docs/UpdateItemTaxesResponse.md | 2 +- docs/UpdateLocationRequest.md | 14 ++ docs/UpdateLocationResponse.md | 15 ++ docs/UpdateOrderRequest.md | 6 +- docs/UpsertCatalogObjectRequest.md | 4 +- docs/UpsertCatalogObjectResponse.md | 4 +- pom.xml | 2 +- .../java/com/squareup/connect/ApiClient.java | 2 +- .../com/squareup/connect/api/ApplePayApi.java | 2 +- .../com/squareup/connect/api/CatalogApi.java | 42 ++-- .../com/squareup/connect/api/CheckoutApi.java | 2 +- .../squareup/connect/api/CustomersApi.java | 20 +- .../squareup/connect/api/EmployeesApi.java | 4 +- .../squareup/connect/api/InventoryApi.java | 46 ++-- .../com/squareup/connect/api/LaborApi.java | 28 +-- .../squareup/connect/api/LocationsApi.java | 187 +++++++++++++++- .../squareup/connect/api/MerchantsApi.java | 123 +++++++++++ .../connect/api/MobileAuthorizationApi.java | 6 +- .../com/squareup/connect/api/OAuthApi.java | 6 +- .../com/squareup/connect/api/OrdersApi.java | 10 +- .../com/squareup/connect/api/PaymentsApi.java | 28 +-- .../com/squareup/connect/api/RefundsApi.java | 14 +- .../squareup/connect/api/ReportingApi.java | 12 +- .../squareup/connect/api/TransactionsApi.java | 22 +- .../squareup/connect/api/V1EmployeesApi.java | 32 +-- .../com/squareup/connect/api/V1ItemsApi.java | 80 +++---- .../squareup/connect/api/V1LocationsApi.java | 4 +- .../connect/api/V1TransactionsApi.java | 22 +- .../connect/models/AdditionalRecipient.java | 4 +- .../models/BatchChangeInventoryRequest.java | 4 +- .../BatchDeleteCatalogObjectsRequest.java | 4 +- .../BatchDeleteCatalogObjectsResponse.java | 8 +- .../BatchRetrieveCatalogObjectsRequest.java | 8 +- .../BatchRetrieveCatalogObjectsResponse.java | 12 +- .../BatchRetrieveInventoryChangesRequest.java | 20 +- ...BatchRetrieveInventoryChangesResponse.java | 4 +- .../BatchRetrieveInventoryCountsRequest.java | 12 +- .../BatchRetrieveInventoryCountsResponse.java | 4 +- .../BatchUpsertCatalogObjectsRequest.java | 8 +- .../BatchUpsertCatalogObjectsResponse.java | 8 +- .../connect/models/CancelPaymentRequest.java | 4 +- .../com/squareup/connect/models/Card.java | 27 ++- .../connect/models/CardPaymentDetails.java | 83 ++++++- .../connect/models/CatalogIdMapping.java | 8 +- .../connect/models/CatalogInfoResponse.java | 4 +- .../squareup/connect/models/CatalogItem.java | 16 +- .../models/CatalogItemModifierListInfo.java | 20 +- .../connect/models/CatalogItemOption.java | 8 +- .../connect/models/CatalogItemVariation.java | 16 +- .../connect/models/CatalogModifierList.java | 12 +- .../models/CatalogModifierOverride.java | 8 +- .../connect/models/CatalogObject.java | 60 ++--- .../connect/models/CatalogObjectBatch.java | 4 +- .../connect/models/CatalogPricingRule.java | 20 +- .../connect/models/CatalogProductSet.java | 8 +- .../squareup/connect/models/CatalogQuery.java | 20 +- ...ueryItemVariationsForItemOptionValues.java | 4 +- .../CatalogQueryItemsForItemOptions.java | 4 +- .../CatalogQueryItemsForModifierList.java | 4 +- .../models/CatalogQueryItemsForTax.java | 4 +- .../models/CatalogQuerySortedAttribute.java | 4 +- .../squareup/connect/models/CatalogTax.java | 4 +- .../squareup/connect/models/CatalogV1Id.java | 4 +- .../connect/models/ChargeRequest.java | 8 +- .../models/CompletePaymentRequest.java | 4 +- .../connect/models/CreateCheckoutRequest.java | 4 +- .../models/CreateCustomerCardRequest.java | 4 +- .../connect/models/CreateCustomerRequest.java | 4 +- .../connect/models/CreateOrderRequest.java | 20 +- .../models/CreateOrderRequestDiscount.java | 4 +- .../models/CreateOrderRequestLineItem.java | 8 +- .../models/CreateOrderRequestModifier.java | 8 +- .../connect/models/CreateOrderRequestTax.java | 8 +- .../connect/models/CreatePaymentRequest.java | 28 +-- .../connect/models/CreateRefundRequest.java | 8 +- .../models/DeleteCatalogObjectResponse.java | 8 +- .../com/squareup/connect/models/Error.java | 8 +- .../connect/models/InventoryAdjustment.java | 36 +-- .../connect/models/InventoryCount.java | 20 +- .../models/InventoryPhysicalCount.java | 32 +-- .../connect/models/InventoryTransfer.java | 36 +-- .../ItemVariationLocationOverrides.java | 20 +- ...onalRecipientReceivableRefundsRequest.java | 4 +- ...nalRecipientReceivableRefundsResponse.java | 4 +- ...AdditionalRecipientReceivablesRequest.java | 4 +- ...dditionalRecipientReceivablesResponse.java | 4 +- .../connect/models/ListCatalogRequest.java | 8 +- .../connect/models/ListCatalogResponse.java | 12 +- .../connect/models/ListCustomersRequest.java | 4 +- .../connect/models/ListCustomersResponse.java | 4 +- .../models/ListPaymentRefundsRequest.java | 8 +- .../models/ListPaymentRefundsResponse.java | 4 +- .../connect/models/ListPaymentsRequest.java | 4 +- .../connect/models/ListPaymentsResponse.java | 4 +- .../connect/models/ListRefundsRequest.java | 4 +- .../connect/models/ListRefundsResponse.java | 4 +- .../models/ListTransactionsRequest.java | 4 +- .../models/ListTransactionsResponse.java | 4 +- .../com/squareup/connect/models/Location.java | 35 ++- .../connect/models/MeasurementUnit.java | 29 ++- .../com/squareup/connect/models/Merchant.java | 206 ++++++++++++++++++ .../com/squareup/connect/models/Money.java | 4 +- .../connect/models/ObtainTokenRequest.java | 10 +- .../connect/models/ObtainTokenResponse.java | 8 +- .../com/squareup/connect/models/Order.java | 40 +++- .../squareup/connect/models/OrderEntry.java | 4 +- .../connect/models/OrderFulfillment.java | 33 ++- .../connect/models/OrderLineItem.java | 40 +++- .../connect/models/OrderLineItemDiscount.java | 45 +++- .../connect/models/OrderLineItemModifier.java | 8 +- .../connect/models/OrderLineItemTax.java | 37 +++- .../connect/models/OrderQuantityUnit.java | 4 +- .../connect/models/OrderReturnDiscount.java | 16 +- .../connect/models/OrderReturnLineItem.java | 8 +- .../models/OrderReturnLineItemModifier.java | 8 +- .../models/OrderReturnServiceCharge.java | 4 +- .../connect/models/OrderReturnTax.java | 4 +- .../connect/models/OrderServiceCharge.java | 38 +++- .../connect/models/PayOrderRequest.java | 4 +- .../connect/models/PayOrderResponse.java | 4 +- .../com/squareup/connect/models/Payment.java | 39 +++- .../connect/models/PaymentRefund.java | 4 +- .../connect/models/RefundPaymentRequest.java | 12 +- .../models/RetrieveCatalogObjectRequest.java | 4 +- .../models/RetrieveCatalogObjectResponse.java | 12 +- .../RetrieveInventoryAdjustmentResponse.java | 4 +- .../RetrieveInventoryChangesRequest.java | 8 +- .../RetrieveInventoryChangesResponse.java | 4 +- .../models/RetrieveInventoryCountRequest.java | 8 +- .../RetrieveInventoryCountResponse.java | 4 +- ...etrieveInventoryPhysicalCountResponse.java | 4 +- .../models/RetrieveLocationRequest.java | 4 +- .../models/RetrieveLocationResponse.java | 8 +- .../models/RetrieveMerchantRequest.java | 64 ++++++ .../models/RetrieveMerchantResponse.java | 123 +++++++++++ .../models/SearchCatalogObjectsRequest.java | 12 +- .../models/SearchCatalogObjectsResponse.java | 43 +++- .../models/SearchCustomersRequest.java | 4 +- .../models/SearchCustomersResponse.java | 4 +- .../connect/models/SearchOrdersFilter.java | 8 +- .../models/SearchOrdersFulfillmentFilter.java | 8 +- .../connect/models/SearchOrdersRequest.java | 8 +- .../connect/models/SearchOrdersResponse.java | 16 +- .../connect/models/SearchOrdersSort.java | 4 +- .../models/SearchOrdersSourceFilter.java | 4 +- .../connect/models/SourceApplication.java | 8 +- .../com/squareup/connect/models/Tender.java | 8 +- .../squareup/connect/models/Transaction.java | 4 +- .../UpdateItemModifierListsRequest.java | 12 +- .../UpdateItemModifierListsResponse.java | 4 +- .../models/UpdateItemTaxesRequest.java | 12 +- .../models/UpdateItemTaxesResponse.java | 4 +- .../connect/models/UpdateLocationRequest.java | 92 ++++++++ .../models/UpdateLocationResponse.java | 123 +++++++++++ .../connect/models/UpdateOrderRequest.java | 12 +- .../models/UpsertCatalogObjectRequest.java | 8 +- .../models/UpsertCatalogObjectResponse.java | 8 +- .../connect/api/MerchantsApiTest.java | 51 +++++ 296 files changed, 2718 insertions(+), 1071 deletions(-) create mode 100644 docs/MeasurementUnitTime.md create mode 100644 docs/Merchant.md create mode 100644 docs/MerchantStatus.md create mode 100644 docs/MerchantsApi.md create mode 100644 docs/RetrieveMerchantRequest.md create mode 100644 docs/RetrieveMerchantResponse.md create mode 100644 docs/UpdateLocationRequest.md create mode 100644 docs/UpdateLocationResponse.md create mode 100644 src/main/java/com/squareup/connect/api/MerchantsApi.java create mode 100644 src/main/java/com/squareup/connect/models/Merchant.java create mode 100644 src/main/java/com/squareup/connect/models/RetrieveMerchantRequest.java create mode 100644 src/main/java/com/squareup/connect/models/RetrieveMerchantResponse.java create mode 100644 src/main/java/com/squareup/connect/models/UpdateLocationRequest.java create mode 100644 src/main/java/com/squareup/connect/models/UpdateLocationResponse.java create mode 100644 src/test/java/com/squareup/connect/api/MerchantsApiTest.java diff --git a/CHANGES.md b/CHANGES.md index 735596d..14c5e8a 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,20 @@ # Change Log +## Version 2.20190925.0 (2019-09-25) + +* **GA release**: All SDKs have been updated to support the new Merchants API. + +* **Beta release**: All SDKs have been updated to support the new endpoints (RetrieveLocation, UpdateLocation) added to the Locations API. + +* **Beta release**: All SDKs have been updated to support the new field (`mcc`) added to the `Location` type. + +* **GA release**: All SDKs have been updated to support the new field (`bin`) added to the `Card` type. + +* **GA release**: All SDKs have been updated to support the new `CardPaymentDetails` fields (`verification_results`, `statement_description`, and `verification_method`). + +* **GA release**: All SDKs have been updated to support the new `Payment` field, (`employee_id`). + + ## Version 2.20190814.2 (2019-08-23) * **Bug fix**: Fixed path parameters for `UpdateOrder` diff --git a/README.md b/README.md index 7110c92..04706cd 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Add this dependency to your project's POM: com.squareup connect - 2.20190814.2 + 2.20190925.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.20190814.2" +compile "com.squareup:connect:2.20190925.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.20190814.2.jar +* target/connect-2.20190925.0.jar * target/lib/*.jar ## Getting Started @@ -201,6 +201,9 @@ Class | Method | HTTP request | Description *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* | [**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 +*MerchantsApi* | [**retrieveMerchant**](docs/MerchantsApi.md#retrieveMerchant) | **GET** /v2/merchants/{merchant_id} | RetrieveMerchant *MobileAuthorizationApi* | [**createMobileAuthorizationCode**](docs/MobileAuthorizationApi.md#createMobileAuthorizationCode) | **POST** /mobile/authorization-code | CreateMobileAuthorizationCode *OAuthApi* | [**obtainToken**](docs/OAuthApi.md#obtainToken) | **POST** /oauth2/token | ObtainToken *OAuthApi* | [**renewToken**](docs/OAuthApi.md#renewToken) | **POST** /oauth2/clients/{client_id}/access-token/renew | RenewToken @@ -486,9 +489,12 @@ Class | Method | HTTP request | Description - [MeasurementUnitCustom](docs/MeasurementUnitCustom.md) - [MeasurementUnitGeneric](docs/MeasurementUnitGeneric.md) - [MeasurementUnitLength](docs/MeasurementUnitLength.md) + - [MeasurementUnitTime](docs/MeasurementUnitTime.md) - [MeasurementUnitUnitType](docs/MeasurementUnitUnitType.md) - [MeasurementUnitVolume](docs/MeasurementUnitVolume.md) - [MeasurementUnitWeight](docs/MeasurementUnitWeight.md) + - [Merchant](docs/Merchant.md) + - [MerchantStatus](docs/MerchantStatus.md) - [ModelBreak](docs/ModelBreak.md) - [Money](docs/Money.md) - [ObtainTokenRequest](docs/ObtainTokenRequest.md) @@ -556,6 +562,8 @@ Class | Method | HTTP request | Description - [RetrieveInventoryPhysicalCountResponse](docs/RetrieveInventoryPhysicalCountResponse.md) - [RetrieveLocationRequest](docs/RetrieveLocationRequest.md) - [RetrieveLocationResponse](docs/RetrieveLocationResponse.md) + - [RetrieveMerchantRequest](docs/RetrieveMerchantRequest.md) + - [RetrieveMerchantResponse](docs/RetrieveMerchantResponse.md) - [RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md) - [RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md) - [RevokeTokenRequest](docs/RevokeTokenRequest.md) @@ -610,6 +618,8 @@ Class | Method | HTTP request | Description - [UpdateItemModifierListsResponse](docs/UpdateItemModifierListsResponse.md) - [UpdateItemTaxesRequest](docs/UpdateItemTaxesRequest.md) - [UpdateItemTaxesResponse](docs/UpdateItemTaxesResponse.md) + - [UpdateLocationRequest](docs/UpdateLocationRequest.md) + - [UpdateLocationResponse](docs/UpdateLocationResponse.md) - [UpdateOrderRequest](docs/UpdateOrderRequest.md) - [UpdateOrderResponse](docs/UpdateOrderResponse.md) - [UpdateShiftRequest](docs/UpdateShiftRequest.md) diff --git a/build.gradle b/build.gradle index fee91fe..717d261 100644 --- a/build.gradle +++ b/build.gradle @@ -2,7 +2,7 @@ apply plugin: 'idea' apply plugin: 'eclipse' group = 'com.squareup' -version = '2.20190814.2' +version = '2.20190925.0' buildscript { repositories { diff --git a/docs/AdditionalRecipient.md b/docs/AdditionalRecipient.md index a41f889..c5c7605 100644 --- a/docs/AdditionalRecipient.md +++ b/docs/AdditionalRecipient.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **locationId** | **String** | The location ID for a recipient (other than the merchant) receiving a portion of this tender. | **description** | **String** | The description of the additional recipient. | **amountMoney** | [**Money**](Money.md) | The amount of money distributed to the recipient. | -**receivableId** | **String** | The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. | [optional] +**receivableId** | **String** | The unique ID for this `AdditionalRecipientReceivable`, assigned by the server. | [optional] diff --git a/docs/BatchChangeInventoryRequest.md b/docs/BatchChangeInventoryRequest.md index 159a6ed..40c9d12 100644 --- a/docs/BatchChangeInventoryRequest.md +++ b/docs/BatchChangeInventoryRequest.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotencyKey** | **String** | A client-supplied, universally unique identifier (UUID) for the request. See [Idempotency](/basics/api101/idempotency) in the [API Development 101](/basics/api101/overview) section for more information. | [optional] +**idempotencyKey** | **String** | A client-supplied, universally unique identifier (UUID) for the request. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more information. | [optional] **changes** | [**List<InventoryChange>**](InventoryChange.md) | The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order. Max size is 100 changes. | [optional] **ignoreUnchangedCounts** | **Boolean** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`. | [optional] diff --git a/docs/BatchDeleteCatalogObjectsRequest.md b/docs/BatchDeleteCatalogObjectsRequest.md index 4dcffb1..f06d319 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](#type-catalogobject)s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). | [optional] +**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] diff --git a/docs/BatchDeleteCatalogObjectsResponse.md b/docs/BatchDeleteCatalogObjectsResponse.md index f5a2d71..54865a2 100644 --- a/docs/BatchDeleteCatalogObjectsResponse.md +++ b/docs/BatchDeleteCatalogObjectsResponse.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] -**deletedObjectIds** | **List<String>** | The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. | [optional] +**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] diff --git a/docs/BatchRetrieveCatalogObjectsRequest.md b/docs/BatchRetrieveCatalogObjectsRequest.md index 70da82e..634f3b4 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](#type-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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. | [optional] +**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] diff --git a/docs/BatchRetrieveCatalogObjectsResponse.md b/docs/BatchRetrieveCatalogObjectsResponse.md index efa14a0..ca96c6c 100644 --- a/docs/BatchRetrieveCatalogObjectsResponse.md +++ b/docs/BatchRetrieveCatalogObjectsResponse.md @@ -8,9 +8,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] -**objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s returned. | [optional] -**relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `objects` field. | [optional] +**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] +**objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s returned. | [optional] +**relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s referenced by the object in the `objects` field. | [optional] diff --git a/docs/BatchRetrieveInventoryChangesRequest.md b/docs/BatchRetrieveInventoryChangesRequest.md index f60b546..d01df27 100644 --- a/docs/BatchRetrieveInventoryChangesRequest.md +++ b/docs/BatchRetrieveInventoryChangesRequest.md @@ -8,13 +8,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**catalogObjectIds** | **List<String>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] -**locationIds** | **List<String>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] -**types** | **List<String>** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] -**states** | **List<String>** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values | [optional] +**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] +**types** | **List<String>** | Filters results by `InventoryChangeType`. Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] +**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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryChangesResponse.md b/docs/BatchRetrieveInventoryChangesResponse.md index bc113e7..1501f8d 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryCountsRequest.md b/docs/BatchRetrieveInventoryCountsRequest.md index ef12d0d..fdbb20a 100644 --- a/docs/BatchRetrieveInventoryCountsRequest.md +++ b/docs/BatchRetrieveInventoryCountsRequest.md @@ -8,10 +8,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**catalogObjectIds** | **List<String>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] -**locationIds** | **List<String>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] +**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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryCountsResponse.md b/docs/BatchRetrieveInventoryCountsResponse.md index c3659c1..7e20c05 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/BatchUpsertCatalogObjectsRequest.md b/docs/BatchUpsertCatalogObjectsRequest.md index cc023ab..aa42d68 100644 --- a/docs/BatchUpsertCatalogObjectsRequest.md +++ b/docs/BatchUpsertCatalogObjectsRequest.md @@ -8,8 +8,8 @@ ## Properties 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](/basics/api101/idempotency) for more information. | -**batches** | [**List<CatalogObjectBatch>**](CatalogObjectBatch.md) | A batch of [CatalogObject](#type-catalogobject)s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a [CatalogItem](#type-catalogitem) with ID `#ABC` and a [CatalogItemVariation](#type-catalogitemvariation) with its `item_id` attribute set to `#ABC` in order to associate the [CatalogItemVariation](#type-catalogitemvariation) with its parent [CatalogItem](#type-catalogitem). Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. | [optional] +**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] diff --git a/docs/BatchUpsertCatalogObjectsResponse.md b/docs/BatchUpsertCatalogObjectsResponse.md index 3c68894..17397f7 100644 --- a/docs/BatchUpsertCatalogObjectsResponse.md +++ b/docs/BatchUpsertCatalogObjectsResponse.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] -**objects** | [**List<CatalogObject>**](CatalogObject.md) | The created [CatalogObject](#type-catalogobject)s | [optional] +**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] diff --git a/docs/CancelPaymentRequest.md b/docs/CancelPaymentRequest.md index d382b00..85570f3 100644 --- a/docs/CancelPaymentRequest.md +++ b/docs/CancelPaymentRequest.md @@ -3,7 +3,7 @@ ### Description -Cancels a payment before it has been completed. Note: only payments created with `autocomplete` set to false can be canceled. +Cancels (voids) a payment before it has been completed. Note: only payments created with `autocomplete` set to false can be canceled. ## Properties Name | Type | Description | Notes diff --git a/docs/Card.md b/docs/Card.md index 7c78d9d..dc07ec1 100644 --- a/docs/Card.md +++ b/docs/Card.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **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] +**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/CardPaymentDetails.md b/docs/CardPaymentDetails.md index dd1a5c8..d68a459 100644 --- a/docs/CardPaymentDetails.md +++ b/docs/CardPaymentDetails.md @@ -11,12 +11,15 @@ Name | Type | Description | Notes **status** | **String** | The card payment's current state. It can be one of: `AUTHORIZED`, `CAPTURED`, `VOIDED`, `FAILED`. | [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 payment. Can be `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. | [optional] -**cvvStatus** | **String** | Status code returned from the Card Verification Value (CVV) check. | [optional] -**avsStatus** | **String** | Status code returned from the Address Verification System (AVS) check. | [optional] +**cvvStatus** | **String** | Status code returned from the Card Verification Value (CVV) check. Can be `CVV_ACCEPTED`, `CVV_REJECTED`, `CVV_NOT_CHECKED`. | [optional] +**avsStatus** | **String** | Status code returned from the Address Verification System (AVS) check. Can be `AVS_ACCEPTED`, `AVS_REJECTED`, `AVS_NOT_CHECKED`. | [optional] **authResultCode** | **String** | Status code returned by the card issuer that describes the payment's authorization status. | [optional] -**applicationIdentifier** | **String** | For EMV payments, identifies the EMV application used for the payment | [optional] +**applicationIdentifier** | **String** | For EMV payments, identifies the EMV application used for the payment. | [optional] **applicationName** | **String** | For EMV payments, the human-readable name of the EMV application used for the payment. | [optional] **applicationCryptogram** | **String** | For EMV payments, the cryptogram generated for the payment. | [optional] +**verificationMethod** | **String** | For EMV payments, method used to verify the cardholder's identity. Can be one of `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`. | [optional] +**verificationResults** | **String** | For EMV payments, the results of the cardholder verification. Can be one of `SUCCESS`, `FAILURE`, or `UNKNOWN`. | [optional] +**statementDescription** | **String** | The statement description sent to the card networks. Note: The actual statement description will vary and is likely to be truncated and appended with additional information on a per issuer basis. | [optional] **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] diff --git a/docs/CatalogApi.md b/docs/CatalogApi.md index d1136c0..151e786 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](#type-catalogobject) to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). +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`. 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](#type-catalogobject) to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). | + **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`. | ### Return type @@ -302,8 +302,8 @@ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); 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](/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](#type-catalogobjecttype) enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. +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`. try { ListCatalogResponse result = apiInstance.listCatalog(cursor, types); System.out.println(result); @@ -317,8 +317,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **cursor** | **String**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/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](#type-catalogobjecttype) enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] + **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] ### 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](#type-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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. Default value: `false` +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` 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](#type-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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. Default value: `false` | [optional] + **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] ### Return type diff --git a/docs/CatalogIdMapping.md b/docs/CatalogIdMapping.md index 72b9a68..842d92b 100644 --- a/docs/CatalogIdMapping.md +++ b/docs/CatalogIdMapping.md @@ -8,8 +8,8 @@ A mapping between a client-supplied temporary ID and a permanent server ID. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientObjectId** | **String** | The client-supplied, temporary `#`-prefixed ID for a new [CatalogObject](#type-catalogobject). | [optional] -**objectId** | **String** | The permanent ID for the [CatalogObject](#type-catalogobject) created by the server. | [optional] +**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] diff --git a/docs/CatalogInfoResponse.md b/docs/CatalogInfoResponse.md index bcf4d15..5262dfa 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](#type-error)s encountered. | [optional] +**errors** | [**List<Error>**](Error.md) | The set of `Error`s 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 6b159c4..599e346 100644 --- a/docs/CatalogItem.md +++ b/docs/CatalogItem.md @@ -16,11 +16,11 @@ 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](#type-catalogtax)es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. [CatalogTax](#type-catalogtax)es may also be added to or deleted from an item using `UpdateItemTaxes`. | [optional] -**modifierListInfo** | [**List<CatalogItemModifierListInfo>**](CatalogItemModifierListInfo.md) | A set of [CatalogItemModifierListInfo](#type-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](#type-catalogmodifierlist)s may also be added to or deleted from an item using `UpdateItemModifierLists`. | [optional] -**variations** | [**List<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item. Maximum: 250 item variations | [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] **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](#type-catalogitem)'s details screen immediately, allowing the merchant to choose [CatalogModifier](#type-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] +**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] diff --git a/docs/CatalogItemModifierListInfo.md b/docs/CatalogItemModifierListInfo.md index 86999cb..f93fbe4 100644 --- a/docs/CatalogItemModifierListInfo.md +++ b/docs/CatalogItemModifierListInfo.md @@ -8,11 +8,11 @@ Controls the properties of a [CatalogModifierList](#type-catalogmodifierlist) as ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**modifierListId** | **String** | The ID of the [CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo](#type-catalogmodifierlistinfo). | -**modifierOverrides** | [**List<CatalogModifierOverride>**](CatalogModifierOverride.md) | A set of [CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier](#type-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](#type-catalogmodifierlist). | [optional] -**maxSelectedModifiers** | **Integer** | If zero or larger, the largest number of [CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList](#type-catalogmodifierlist). | [optional] -**enabled** | **Boolean** | If `true`, enable this [CatalogModifierList](#type-catalogmodifierlist). | [optional] +**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] +**enabled** | **Boolean** | If `true`, enable this `CatalogModifierList`. | [optional] diff --git a/docs/CatalogItemOption.md b/docs/CatalogItemOption.md index 7c1c9f9..78da90c 100644 --- a/docs/CatalogItemOption.md +++ b/docs/CatalogItemOption.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **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] **showColors** | **Boolean** | If true, display colors for entries in `values` when present. | [optional] -**values** | [**List<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemOptionValue](#type-catalogitemoptionvalue)s for this item. | [optional] -**itemCount** | **Long** | The number of [CatalogItem](#type-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] +**values** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s 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/CatalogItemVariation.md b/docs/CatalogItemVariation.md index 32cc5af..cf9e448 100644 --- a/docs/CatalogItemVariation.md +++ b/docs/CatalogItemVariation.md @@ -8,19 +8,19 @@ An item variation (i.e., product) in the Catalog object model. Each item may hav ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**itemId** | **String** | The ID of the [CatalogItem](#type-catalogitem) associated with this item variation. Searchable. | [optional] +**itemId** | **String** | The ID of the `CatalogItem` associated with this item variation. Searchable. | [optional] **name** | **String** | The item variation's name. Searchable. This field has max length of 255 Unicode code points. | [optional] **sku** | **String** | The item variation's SKU, if any. Searchable. | [optional] **upc** | **String** | The item variation's UPC, if any. Searchable in the Connect API. This field is only exposed in the Connect API. It is not exposed in Square's Dashboard, Square Point of Sale app or Retail Point of Sale app. | [optional] -**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](#type-catalogitem) is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique. | [optional] +**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](#type-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] -**serviceDuration** | **Long** | If the [CatalogItem](#type-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] +**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] **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] diff --git a/docs/CatalogModifierList.md b/docs/CatalogModifierList.md index 20c45c8..144d557 100644 --- a/docs/CatalogModifierList.md +++ b/docs/CatalogModifierList.md @@ -8,9 +8,9 @@ A modifier list in the Catalog object model. A [CatalogModifierList](#type-catal ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. This field has max length of 255 Unicode code points. | [optional] -**selectionType** | **String** | Indicates whether multiple options from the [CatalogModifierList](#type-catalogmodifierlist) can be applied to a single [CatalogItem](#type-catalogitem). See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values | [optional] -**modifiers** | [**List<CatalogObject>**](CatalogObject.md) | The options included in the [CatalogModifierList](#type-catalogmodifierlist). You must include at least one [CatalogModifier](#type-catalogmodifier). Each [CatalogObject](#type-catalogobject) must have type `MODIFIER` and contain [CatalogModifier](#type-catalogmodifier) data. | [optional] +**name** | **String** | The `CatalogModifierList`'s name. Searchable. 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] diff --git a/docs/CatalogModifierOverride.md b/docs/CatalogModifierOverride.md index 728cbd3..ad40b50 100644 --- a/docs/CatalogModifierOverride.md +++ b/docs/CatalogModifierOverride.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**modifierId** | **String** | The ID of the [CatalogModifier](#type-catalogmodifier) whose default behavior is being overridden. | -**onByDefault** | **Boolean** | If `true`, this [CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem](#type-catalogitem). | [optional] +**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] diff --git a/docs/CatalogObject.md b/docs/CatalogObject.md index fe47a3b..57d39da 100644 --- a/docs/CatalogObject.md +++ b/docs/CatalogObject.md @@ -13,25 +13,25 @@ Name | Type | Description | Notes **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] **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](#type-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] **imageId** | **String** | Identifies the `CatalogImage` attached to this `CatalogObject`. | [optional] -**itemData** | [**CatalogItem**](CatalogItem.md) | Structured data for a [CatalogItem](#type-catalogitem), set for CatalogObjects of type `ITEM`. | [optional] -**categoryData** | [**CatalogCategory**](CatalogCategory.md) | Structured data for a [CatalogCategory](#type-catalogcategory), set for CatalogObjects of type `CATEGORY`. | [optional] -**itemVariationData** | [**CatalogItemVariation**](CatalogItemVariation.md) | Structured data for a [CatalogItemVariation](#type-catalogitemvariation), set for CatalogObjects of type `ITEM_VARIATION`. | [optional] -**taxData** | [**CatalogTax**](CatalogTax.md) | Structured data for a [CatalogTax](#type-catalogtax), set for CatalogObjects of type `TAX`. | [optional] -**discountData** | [**CatalogDiscount**](CatalogDiscount.md) | Structured data for a [CatalogDiscount](#type-catalogdiscount), set for CatalogObjects of type `DISCOUNT`. | [optional] -**modifierListData** | [**CatalogModifierList**](CatalogModifierList.md) | Structured data for a [CatalogModifierList](#type-catalogmodifierlist), set for CatalogObjects of type `MODIFIER_LIST`. | [optional] -**modifierData** | [**CatalogModifier**](CatalogModifier.md) | Structured data for a [CatalogModifier](#type-catalogmodifier), set for CatalogObjects of type `MODIFIER`. | [optional] -**timePeriodData** | [**CatalogTimePeriod**](CatalogTimePeriod.md) | Structured data for a [CatalogTimePeriod](#type-catalogtimeperiod), set for CatalogObjects of type `TIME_PERIOD`. | [optional] -**productSetData** | [**CatalogProductSet**](CatalogProductSet.md) | Structured data for a [CatalogProductSet](#type-catalogproductset), set for CatalogObjects of type `PRODUCT_SET`. | [optional] -**pricingRuleData** | [**CatalogPricingRule**](CatalogPricingRule.md) | Structured data for a [CatalogPricingRule](#type-catalogpricingrule), set for CatalogObjects of type `PRICING_RULE`. | [optional] -**imageData** | [**CatalogImage**](CatalogImage.md) | Structured data for a [CatalogImage](#type-catalogimage), set for CatalogObjects of type `IMAGE`. | [optional] -**measurementUnitData** | [**CatalogMeasurementUnit**](CatalogMeasurementUnit.md) | Structured data for a [CatalogMeasurementUnit](#type-catalogmeasurementunit), set for CatalogObjects of type `MEASUREMENT_UNIT`. | [optional] -**itemOptionData** | [**CatalogItemOption**](CatalogItemOption.md) | Structured data for a [CatalogItemOption](#type-catalogitemoption), set for CatalogObjects of type `ITEM_OPTION`. | [optional] -**itemOptionValueData** | [**CatalogItemOptionValue**](CatalogItemOptionValue.md) | Structured data for a [CatalogItemOptionValue](#type-catalogitemoptionvalue), set for CatalogObjects of type `ITEM_OPTION_VAL`. | [optional] +**itemData** | [**CatalogItem**](CatalogItem.md) | Structured data for a `CatalogItem`, set for CatalogObjects of type `ITEM`. | [optional] +**categoryData** | [**CatalogCategory**](CatalogCategory.md) | Structured data for a `CatalogCategory`, set for CatalogObjects of type `CATEGORY`. | [optional] +**itemVariationData** | [**CatalogItemVariation**](CatalogItemVariation.md) | Structured data for a `CatalogItemVariation`, set for CatalogObjects of type `ITEM_VARIATION`. | [optional] +**taxData** | [**CatalogTax**](CatalogTax.md) | Structured data for a `CatalogTax`, set for CatalogObjects of type `TAX`. | [optional] +**discountData** | [**CatalogDiscount**](CatalogDiscount.md) | Structured data for a `CatalogDiscount`, set for CatalogObjects of type `DISCOUNT`. | [optional] +**modifierListData** | [**CatalogModifierList**](CatalogModifierList.md) | Structured data for a `CatalogModifierList`, set for CatalogObjects of type `MODIFIER_LIST`. | [optional] +**modifierData** | [**CatalogModifier**](CatalogModifier.md) | Structured data for a `CatalogModifier`, set for CatalogObjects of type `MODIFIER`. | [optional] +**timePeriodData** | [**CatalogTimePeriod**](CatalogTimePeriod.md) | Structured data for a `CatalogTimePeriod`, set for CatalogObjects of type `TIME_PERIOD`. | [optional] +**productSetData** | [**CatalogProductSet**](CatalogProductSet.md) | Structured data for a `CatalogProductSet`, set for CatalogObjects of type `PRODUCT_SET`. | [optional] +**pricingRuleData** | [**CatalogPricingRule**](CatalogPricingRule.md) | Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. | [optional] +**imageData** | [**CatalogImage**](CatalogImage.md) | Structured data for a `CatalogImage`, set for CatalogObjects of type `IMAGE`. | [optional] +**measurementUnitData** | [**CatalogMeasurementUnit**](CatalogMeasurementUnit.md) | Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`. | [optional] +**itemOptionData** | [**CatalogItemOption**](CatalogItemOption.md) | Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`. | [optional] +**itemOptionValueData** | [**CatalogItemOptionValue**](CatalogItemOptionValue.md) | Structured data for a `CatalogItemOptionValue`, set for CatalogObjects of type `ITEM_OPTION_VAL`. | [optional] diff --git a/docs/CatalogObjectBatch.md b/docs/CatalogObjectBatch.md index 8359f3b..ecf2569 100644 --- a/docs/CatalogObjectBatch.md +++ b/docs/CatalogObjectBatch.md @@ -8,7 +8,7 @@ A batch of [CatalogObject](#type-catalogobject)s. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s belonging to this batch. | [optional] +**objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s belonging to this batch. | [optional] diff --git a/docs/CatalogPricingRule.md b/docs/CatalogPricingRule.md index ac4cb67..18454f9 100644 --- a/docs/CatalogPricingRule.md +++ b/docs/CatalogPricingRule.md @@ -9,11 +9,11 @@ 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](#type-catalogtimeperiod)s 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](#type-catalogdiscount) to take off the price of all matched items. Only one of `total_price_money`, `item_price`, or `discount` can be supplied. | [optional] -**matchProductsId** | **String** | Unique ID for the [CatalogProductSet](#type-catalogproductset) that will be matched by this rule. A match rule matches within the entire cart. | [optional] -**applyProductsId** | **String** | The [CatalogProductSet](#type-catalogproductset) to apply the pricing rule to within the set of matched products specified by `match_products_id`. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products. | [optional] -**excludeProductsId** | **String** | Identifies the [CatalogProductSet](#type-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] +**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] +**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** | The `CatalogProductSet` to apply the pricing rule to within the set of matched products specified by `match_products_id`. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products. | [optional] +**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] **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] diff --git a/docs/CatalogProductSet.md b/docs/CatalogProductSet.md index 8a4546a..e9828fc 100644 --- a/docs/CatalogProductSet.md +++ b/docs/CatalogProductSet.md @@ -9,8 +9,8 @@ Represents a collection of catalog objects for the purpose of applying a [Pricin 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](#type-catalogobject)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](#type-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](#type-catalogobject) 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] +**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] **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 de17ee5..c9a59b2 100644 --- a/docs/CatalogQuery.md +++ b/docs/CatalogQuery.md @@ -12,11 +12,11 @@ Name | Type | Description | Notes **exactQuery** | [**CatalogQueryExact**](CatalogQueryExact.md) | A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value. | [optional] **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](#type-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](#type-catalogtax)es enabled. | [optional] -**itemsForModifierListQuery** | [**CatalogQueryItemsForModifierList**](CatalogQueryItemsForModifierList.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList](#type-catalogmodifierlist)s enabled. | [optional] -**itemsForItemOptionsQuery** | [**CatalogQueryItemsForItemOptions**](CatalogQueryItemsForItemOptions.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption](#type-catalogitemoption)s. | [optional] -**itemVariationsForItemOptionValuesQuery** | [**CatalogQueryItemVariationsForItemOptionValues**](CatalogQueryItemVariationsForItemOptionValues.md) | A query that returns all [CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption](#type-catalogitemoption) values. | [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] diff --git a/docs/CatalogQueryItemVariationsForItemOptionValues.md b/docs/CatalogQueryItemVariationsForItemOptionValues.md index 63c77fe..7b72ec7 100644 --- a/docs/CatalogQueryItemVariationsForItemOptionValues.md +++ b/docs/CatalogQueryItemVariationsForItemOptionValues.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**itemOptionValueIds** | **List<String>** | A set of [CatalogItemOptionValue](#type-catalogitemoptionvalue) IDs to be used to find associated [CatalogItemVariation](#type-catalogitemvariation)s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned. | [optional] +**itemOptionValueIds** | **List<String>** | A set of `CatalogItemOptionValue` IDs to be used to find associated `CatalogItemVariation`s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned. | [optional] diff --git a/docs/CatalogQueryItemsForItemOptions.md b/docs/CatalogQueryItemsForItemOptions.md index 408675e..4055f07 100644 --- a/docs/CatalogQueryItemsForItemOptions.md +++ b/docs/CatalogQueryItemsForItemOptions.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**itemOptionIds** | **List<String>** | A set of [CatalogItemOption](#type-catalogitemoption) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. All Items that contain all of the given Item Options (in any order) will be returned. | [optional] +**itemOptionIds** | **List<String>** | A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` will be returned. | [optional] diff --git a/docs/CatalogQueryItemsForModifierList.md b/docs/CatalogQueryItemsForModifierList.md index 861a937..9b3cd2e 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](#type-catalogitem)s. | +**modifierListIds** | **List<String>** | A set of `CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem`s. | diff --git a/docs/CatalogQueryItemsForTax.md b/docs/CatalogQueryItemsForTax.md index a8c66e5..46761c7 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](#type-catalogitem)s. | +**taxIds** | **List<String>** | A set of `CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem`s. | diff --git a/docs/CatalogQuerySortedAttribute.md b/docs/CatalogQuerySortedAttribute.md index dd392bf..e9a489d 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](#type-sortorder), `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values | [optional] +**sortOrder** | **String** | The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values | [optional] diff --git a/docs/CatalogTax.md b/docs/CatalogTax.md index 031d84b..212838c 100644 --- a/docs/CatalogTax.md +++ b/docs/CatalogTax.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **calculationPhase** | **String** | Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for possible values | [optional] **inclusionType** | **String** | Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for possible values | [optional] **percentage** | **String** | The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%. | [optional] -**appliesToCustomAmounts** | **Boolean** | If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular [CatalogItem](#type-catalogitem). | [optional] +**appliesToCustomAmounts** | **Boolean** | If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular `CatalogItem`. | [optional] **enabled** | **Boolean** | If `true`, the tax will be shown as enabled in the Square Point of Sale app. | [optional] diff --git a/docs/CatalogV1Id.md b/docs/CatalogV1Id.md index 9599bfd..1df735b 100644 --- a/docs/CatalogV1Id.md +++ b/docs/CatalogV1Id.md @@ -9,7 +9,7 @@ An Items Connect V1 object ID along with its associated [location](#type-locatio 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](#type-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 5bd6431..e1e03e1 100644 --- a/docs/ChargeRequest.md +++ b/docs/ChargeRequest.md @@ -8,11 +8,11 @@ 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](/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](https://developer.squareup.com/docs/basics/api101/idempotency) 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](#workingwithmonetaryamounts) 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] -**delayCapture** | **Boolean** | If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction](#endpoint-capturetransaction) endpoint) or a Void (with the [VoidTransaction](#endpoint-voidtransaction) endpoint). Default value: `false` | [optional] +**delayCapture** | **Boolean** | If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the `CaptureTransaction` or a Void (with the `VoidTransaction`. Default value: `false` | [optional] **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] diff --git a/docs/CompletePaymentRequest.md b/docs/CompletePaymentRequest.md index 9f994c7..2d64ac4 100644 --- a/docs/CompletePaymentRequest.md +++ b/docs/CompletePaymentRequest.md @@ -3,7 +3,7 @@ ### Description -Completes a payment. By default, payments are set to autocomplete immediately after they are created. To complete payments manually, set `autocomplete` to false. +Completes (captures) a payment. By default, payments are set to autocomplete immediately after they are created. To complete payments manually, set `autocomplete` to false. ## Properties Name | Type | Description | Notes diff --git a/docs/CreateCheckoutRequest.md b/docs/CreateCheckoutRequest.md index 9e4059f..ea6a2a5 100644 --- a/docs/CreateCheckoutRequest.md +++ b/docs/CreateCheckoutRequest.md @@ -8,7 +8,7 @@ Defines the parameters that can be included in the body of a request to the Crea ## 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](/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](https://developer.squareup.com/docs/basics/api101/idempotency) 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/CreateCustomerCardRequest.md b/docs/CreateCustomerCardRequest.md index 4ffa8b2..6541669 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](/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 `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. | **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 fd057af..c442d0d 100644 --- a/docs/CreateCustomerRequest.md +++ b/docs/CreateCustomerRequest.md @@ -8,7 +8,7 @@ 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](/basics/api101/idempotency) guide for more information. | [optional] +**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] diff --git a/docs/CreateOrderRequest.md b/docs/CreateOrderRequest.md index 2f0d782..e1a0e38 100644 --- a/docs/CreateOrderRequest.md +++ b/docs/CreateOrderRequest.md @@ -9,11 +9,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **order** | [**Order**](Order.md) | The order to create. If this field is set, then the only other top-level field that can be set is the idempotency_key. | [optional] -**idempotencyKey** | **String** | A value you specify that uniquely identifies this order among orders you've created. If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency](/basics/api101/idempotency) for more information. | [optional] -**referenceId** | **String** | __Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead. An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters. | [optional] -**lineItems** | [**List<CreateOrderRequestLineItem>**](CreateOrderRequestLineItem.md) | __Deprecated__: Please set the line_items on the nested [order](#type-order) field instead. The line items to associate with this order. Each line item represents a different product to include in a purchase. | [optional] -**taxes** | [**List<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | __Deprecated__: Please set the taxes on the nested [order](#type-order) field instead. The taxes to include on the order. | [optional] -**discounts** | [**List<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | __Deprecated__: Please set the discounts on the nested [order](#type-order) field instead. The discounts to include on the order. | [optional] +**idempotencyKey** | **String** | A value you specify that uniquely identifies this order among orders you've created. If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | [optional] +**referenceId** | **String** | __Deprecated__: Please set the reference_id on the nested `order` field instead. An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters. | [optional] +**lineItems** | [**List<CreateOrderRequestLineItem>**](CreateOrderRequestLineItem.md) | __Deprecated__: Please set the line_items on the nested `order` field instead. The line items to associate with this order. Each line item represents a different product to include in a purchase. | [optional] +**taxes** | [**List<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | __Deprecated__: Please set the taxes on the nested `order` field instead. The taxes to include on the order. | [optional] +**discounts** | [**List<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | __Deprecated__: Please set the discounts on the nested `order` field instead. The discounts to include on the order. | [optional] diff --git a/docs/CreateOrderRequestDiscount.md b/docs/CreateOrderRequestDiscount.md index cf4bd93..2fc055b 100644 --- a/docs/CreateOrderRequestDiscount.md +++ b/docs/CreateOrderRequestDiscount.md @@ -8,7 +8,7 @@ __Deprecated__: Please use the [OrderLineItemDiscount](#type-orderlineitemdiscou ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**catalogObjectId** | **String** | Only used for catalog discounts. The catalog object ID for an existing [CatalogDiscount](#type-catalogdiscount). Do not provide a value for this field if you provide values in other fields for an ad hoc discount. | [optional] +**catalogObjectId** | **String** | Only used for catalog discounts. The catalog object ID for an existing `CatalogDiscount`. Do not provide a value for this field if you provide values in other fields for an ad hoc discount. | [optional] **name** | **String** | Only used for ad hoc discounts. The discount's name. | [optional] **percentage** | **String** | Only used for ad hoc discounts. The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0 | [optional] **amountMoney** | [**Money**](Money.md) | Only used for ad hoc discounts. The monetary amount of the discount. | [optional] diff --git a/docs/CreateOrderRequestLineItem.md b/docs/CreateOrderRequestLineItem.md index 64fbd23..c4e5f3a 100644 --- a/docs/CreateOrderRequestLineItem.md +++ b/docs/CreateOrderRequestLineItem.md @@ -10,10 +10,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Only used for ad hoc line items. The name of the line item. This value cannot exceed 500 characters. Do not provide a value for this field if you provide a value for `catalog_object_id`. | [optional] **quantity** | **String** | The quantity to purchase, as a string representation of a number. This string must have a positive integer value. | -**basePriceMoney** | [**Money**](Money.md) | The base price for a single unit of the line item. `base_price_money` is required for ad hoc line items and variable priced [CatalogItemVariation](#type-catalogitemvariation)s. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the CatalogItemVariation's price. | [optional] +**basePriceMoney** | [**Money**](Money.md) | The base price for a single unit of the line item. `base_price_money` is required for ad hoc line items and variable priced `CatalogItemVariation`s. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the CatalogItemVariation's price. | [optional] **variationName** | **String** | Only used for ad hoc line items. The variation name of the line item. This value cannot exceed 255 characters. If this value is not set for an ad hoc line item, the default value of `Regular` is used. Do not provide a value for this field if you provide a value for the `catalog_object_id`. | [optional] **note** | **String** | The note of the line item. This value cannot exceed 500 characters. | [optional] -**catalogObjectId** | **String** | Only used for Catalog line items. The catalog object ID for an existing [CatalogItemVariation](#type-catalogitemvariation). Do not provide a value for this field if you provide a value for `name` and `base_price_money`. | [optional] +**catalogObjectId** | **String** | Only used for Catalog line items. The catalog object ID for an existing `CatalogItemVariation`. Do not provide a value for this field if you provide a value for `name` and `base_price_money`. | [optional] **modifiers** | [**List<CreateOrderRequestModifier>**](CreateOrderRequestModifier.md) | Only used for Catalog line items. The modifiers to include on the line item. | [optional] **taxes** | [**List<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | The taxes to include on the line item. | [optional] **discounts** | [**List<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | The discounts to include on the line item. | [optional] diff --git a/docs/CreateOrderRequestModifier.md b/docs/CreateOrderRequestModifier.md index 9997b72..b0716fd 100644 --- a/docs/CreateOrderRequestModifier.md +++ b/docs/CreateOrderRequestModifier.md @@ -8,9 +8,9 @@ __Deprecated__: Please use the [OrderLineItemModifier](#type-orderlineitemmodifi ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**catalogObjectId** | **String** | The catalog object ID of a [CatalogModifier](#type-catalogmodifier). | [optional] +**catalogObjectId** | **String** | The catalog object ID of a `CatalogModifier`. | [optional] **name** | **String** | Only used for ad hoc modifiers. The name of the modifier. `name` cannot exceed 255 characters. Do not provide a value for `name` if you provide a value for `catalog_object_id`. | [optional] -**basePriceMoney** | [**Money**](Money.md) | The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price. | [optional] +**basePriceMoney** | [**Money**](Money.md) | The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price. | [optional] diff --git a/docs/CreateOrderRequestTax.md b/docs/CreateOrderRequestTax.md index 7598d7f..8008b62 100644 --- a/docs/CreateOrderRequestTax.md +++ b/docs/CreateOrderRequestTax.md @@ -8,9 +8,9 @@ __Deprecated__: Please use the [OrderLineItemTax](#type-orderlineitemtax) type i ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**catalogObjectId** | **String** | Only used for catalog taxes. The catalog object ID of an existing [CatalogTax](#type-catalogtax). Do not provide a value for this field if you provide values in other fields for an ad hoc tax. | [optional] +**catalogObjectId** | **String** | Only used for catalog taxes. The catalog object ID of an existing `CatalogTax`. Do not provide a value for this field if you provide values in other fields for an ad hoc tax. | [optional] **name** | **String** | Only used for ad hoc taxes. The tax's name. Do not provide a value for this field if you set `catalog_object_id`. | [optional] -**type** | **String** | Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values | [optional] +**type** | **String** | Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See `OrderLineItemTaxType` for possible values. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values | [optional] **percentage** | **String** | Only used for ad hoc taxes. The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0 | [optional] diff --git a/docs/CreatePaymentRequest.md b/docs/CreatePaymentRequest.md index 5a198c0..68f3816 100644 --- a/docs/CreatePaymentRequest.md +++ b/docs/CreatePaymentRequest.md @@ -9,17 +9,17 @@ Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRI 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](/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](/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](/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](/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](/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 or canceled. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). Default: true | [optional] +**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] +**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](/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](/payments-api/take-payments#partial-payment-gift-card). Default: false | [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] **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] diff --git a/docs/CreateRefundRequest.md b/docs/CreateRefundRequest.md index 1217ecf..9d937ac 100644 --- a/docs/CreateRefundRequest.md +++ b/docs/CreateRefundRequest.md @@ -8,8 +8,8 @@ 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](/basics/api101/idempotency) for more information. | -**tenderId** | **String** | The ID of the tender to refund. A [`Transaction`](#type-transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. | +**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. | +**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](#workingwithmonetaryamounts) for details. This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`. | diff --git a/docs/CustomersApi.md b/docs/CustomersApi.md index 83007f6..c0c64ed 100644 --- a/docs/CustomersApi.md +++ b/docs/CustomersApi.md @@ -254,7 +254,7 @@ 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](/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 [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`. try { @@ -270,7 +270,7 @@ 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](/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 [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] diff --git a/docs/DeleteCatalogObjectResponse.md b/docs/DeleteCatalogObjectResponse.md index 441f7ed..11a50d1 100644 --- a/docs/DeleteCatalogObjectResponse.md +++ b/docs/DeleteCatalogObjectResponse.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] -**deletedObjectIds** | **List<String>** | The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a [CatalogItemVariation](#type-catalogitemvariation) will be deleted (and its ID included in this field) when its parent [CatalogItem](#type-catalogitem) is deleted. | [optional] +**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] diff --git a/docs/Error.md b/docs/Error.md index dd94f5e..bae2f51 100644 --- a/docs/Error.md +++ b/docs/Error.md @@ -8,8 +8,8 @@ Represents an error encountered during a request to the Connect API. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | **String** | The high-level category for the error. See [ErrorCategory](#type-errorcategory) See [ErrorCategory](#type-errorcategory) for possible values | -**code** | **String** | The specific code of the error. See [ErrorCode](#type-errorcode) for possible See [ErrorCode](#type-errorcode) for possible values | +**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 | **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/InventoryAdjustment.md b/docs/InventoryAdjustment.md index 21e3442..ba3d393 100644 --- a/docs/InventoryAdjustment.md +++ b/docs/InventoryAdjustment.md @@ -8,19 +8,19 @@ Represents a change in state or quantity of product inventory at a particular ti ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | A unique ID generated by Square for the [InventoryAdjustment](#type-inventoryadjustment). | [optional] -**referenceId** | **String** | An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system. | [optional] -**fromState** | **String** | The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values | [optional] -**toState** | **String** | The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values | [optional] -**locationId** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional] -**catalogObjectId** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] -**catalogObjectType** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-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)](/orders-api/what-it-does#decimal-quantities) for more information. | [optional] +**id** | **String** | A unique ID generated by Square for the `InventoryAdjustment`. | [optional] +**referenceId** | **String** | An optional ID provided by the application to tie the `InventoryAdjustment` to an external system. | [optional] +**fromState** | **String** | The `InventoryState` of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values | [optional] +**toState** | **String** | The `InventoryState` of the related quantity of items after the adjustment. 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] +**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] **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] **source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that caused the inventory adjustment. | [optional] -**employeeId** | **String** | The Square ID of the [Employee](#type-employee) responsible for the inventory adjustment. | [optional] +**employeeId** | **String** | The Square ID of the `Employee` responsible for the inventory adjustment. | [optional] **transactionId** | **String** | The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions. | [optional] **refundId** | **String** | The read-only Square ID of the [Refund][#type-refund] that caused the adjustment. Only relevant for refund-related state transitions. | [optional] **purchaseOrderId** | **String** | The read-only Square ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app. | [optional] diff --git a/docs/InventoryApi.md b/docs/InventoryApi.md index ed20a01..5404152 100644 --- a/docs/InventoryApi.md +++ b/docs/InventoryApi.md @@ -196,7 +196,7 @@ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); oauth2.setAccessToken("YOUR ACCESS TOKEN"); InventoryApi apiInstance = new InventoryApi(); -String adjustmentId = "adjustmentId_example"; // String | ID of the [InventoryAdjustment](#type-inventoryadjustment) to retrieve. +String adjustmentId = "adjustmentId_example"; // String | ID of the `InventoryAdjustment` to retrieve. try { RetrieveInventoryAdjustmentResponse result = apiInstance.retrieveInventoryAdjustment(adjustmentId); System.out.println(result); @@ -210,7 +210,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **adjustmentId** | **String**| ID of the [InventoryAdjustment](#type-inventoryadjustment) to retrieve. | + **adjustmentId** | **String**| ID of the `InventoryAdjustment` to retrieve. | ### Return type @@ -249,9 +249,9 @@ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); oauth2.setAccessToken("YOUR ACCESS TOKEN"); InventoryApi apiInstance = new InventoryApi(); -String catalogObjectId = "catalogObjectId_example"; // String | ID of the [CatalogObject](#type-catalogobject) to retrieve. -String locationIds = "locationIds_example"; // String | The [Location](#type-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](/basics/api101/pagination) for more information. +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. try { RetrieveInventoryChangesResponse result = apiInstance.retrieveInventoryChanges(catalogObjectId, locationIds, cursor); System.out.println(result); @@ -265,9 +265,9 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **catalogObjectId** | **String**| ID of the [CatalogObject](#type-catalogobject) to retrieve. | - **locationIds** | **String**| The [Location](#type-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](/basics/api101/pagination) for more information. | [optional] + **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] ### Return type @@ -306,9 +306,9 @@ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); oauth2.setAccessToken("YOUR ACCESS TOKEN"); InventoryApi apiInstance = new InventoryApi(); -String catalogObjectId = "catalogObjectId_example"; // String | ID of the [CatalogObject](#type-catalogobject) to retrieve. -String locationIds = "locationIds_example"; // String | The [Location](#type-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](/basics/api101/pagination) for more information. +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. try { RetrieveInventoryCountResponse result = apiInstance.retrieveInventoryCount(catalogObjectId, locationIds, cursor); System.out.println(result); @@ -322,9 +322,9 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **catalogObjectId** | **String**| ID of the [CatalogObject](#type-catalogobject) to retrieve. | - **locationIds** | **String**| The [Location](#type-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](/basics/api101/pagination) for more information. | [optional] + **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] ### Return type @@ -363,7 +363,7 @@ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); oauth2.setAccessToken("YOUR ACCESS TOKEN"); InventoryApi apiInstance = new InventoryApi(); -String physicalCountId = "physicalCountId_example"; // String | ID of the [InventoryPhysicalCount](#type-inventoryphysicalcount) to retrieve. +String physicalCountId = "physicalCountId_example"; // String | ID of the `InventoryPhysicalCount` to retrieve. try { RetrieveInventoryPhysicalCountResponse result = apiInstance.retrieveInventoryPhysicalCount(physicalCountId); System.out.println(result); @@ -377,7 +377,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **physicalCountId** | **String**| ID of the [InventoryPhysicalCount](#type-inventoryphysicalcount) to retrieve. | + **physicalCountId** | **String**| ID of the `InventoryPhysicalCount` to retrieve. | ### Return type diff --git a/docs/InventoryCount.md b/docs/InventoryCount.md index 340d326..c476696 100644 --- a/docs/InventoryCount.md +++ b/docs/InventoryCount.md @@ -8,11 +8,11 @@ Represents Square's estimated quantity of items in a particular state at a parti ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**catalogObjectId** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] -**catalogObjectType** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] -**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional] -**locationId** | **String** | The Square ID of the [Location](#type-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)](/orders-api/what-it-does#decimal-quantities) for more information. | [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] +**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] **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 559e0cf..0e83667 100644 --- a/docs/InventoryPhysicalCount.md +++ b/docs/InventoryPhysicalCount.md @@ -8,15 +8,15 @@ Represents the quantity of an item variation that is physically present at a spe ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | A unique ID generated by Square for the [InventoryPhysicalCount](#type-inventoryphysicalcount). | [optional] -**referenceId** | **String** | An optional ID provided by the application to tie the [InventoryPhysicalCount](#type-inventoryphysicalcount) to an external system. | [optional] -**catalogObjectId** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] -**catalogObjectType** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] -**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional] -**locationId** | **String** | The Square ID of the [Location](#type-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)](/orders-api/what-it-does#decimal-quantities) for more information. | [optional] +**id** | **String** | A unique ID generated by Square for the `InventoryPhysicalCount`. | [optional] +**referenceId** | **String** | An optional ID provided by the application to tie the `InventoryPhysicalCount` to an external system. | [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] +**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] **source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that submitted the physical count. | [optional] -**employeeId** | **String** | The Square ID of the [Employee](#type-employee) responsible for 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] **createdAt** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the physical count. | [optional] diff --git a/docs/InventoryTransfer.md b/docs/InventoryTransfer.md index ffe79a7..05979bc 100644 --- a/docs/InventoryTransfer.md +++ b/docs/InventoryTransfer.md @@ -8,18 +8,18 @@ Represents the transfer of a quantity of product inventory at a particular time ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | A unique ID generated by Square for the [InventoryTransfer](#type-inventorytransfer). | [optional] -**referenceId** | **String** | An optional ID provided by the application to tie the [InventoryTransfer](#type-inventorytransfer) to an external system. | [optional] -**state** | **String** | The [InventoryState](#type-inventorystate) for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values | [optional] -**fromLocationId** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items were tracked before the transfer. | [optional] -**toLocationId** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items were tracked after the transfer. | [optional] -**catalogObjectId** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] -**catalogObjectType** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-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)](/orders-api/what-it-does#decimal-quantities) for more information. | [optional] +**id** | **String** | A unique ID generated by Square for the `InventoryTransfer`. | [optional] +**referenceId** | **String** | An optional ID provided by the application to tie the `InventoryTransfer` to an external system. | [optional] +**state** | **String** | The `InventoryState` for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values | [optional] +**fromLocationId** | **String** | The Square ID of the `Location` where the related quantity of items were tracked before the transfer. | [optional] +**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] **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] -**employeeId** | **String** | The Square ID of the [Employee](#type-employee) responsible for the inventory transfer. | [optional] +**employeeId** | **String** | The Square ID of the `Employee` responsible for the inventory transfer. | [optional] diff --git a/docs/ItemVariationLocationOverrides.md b/docs/ItemVariationLocationOverrides.md index cce8371..ff2c46e 100644 --- a/docs/ItemVariationLocationOverrides.md +++ b/docs/ItemVariationLocationOverrides.md @@ -8,11 +8,11 @@ Price and inventory alerting overrides for a [CatalogItemVariation](#type-catalo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**locationId** | **String** | The ID of the [location](#type-location). | [optional] -**priceMoney** | [**Money**](Money.md) | The price of the [CatalogItemVariation](#type-catalogitemvariation) at the given [location](#type-location), or blank for variable pricing. | [optional] -**pricingType** | **String** | The pricing type (fixed or variable) for the [CatalogItemVariation](#type-catalogitemvariation) at the given [location](#type-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](#type-location). | [optional] -**inventoryAlertType** | **String** | Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values | [optional] +**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] +**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 afd3025..b012c7c 100644 --- a/docs/ListAdditionalRecipientReceivableRefundsRequest.md +++ b/docs/ListAdditionalRecipientReceivableRefundsRequest.md @@ -11,7 +11,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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivableRefundsResponse.md b/docs/ListAdditionalRecipientReceivableRefundsResponse.md index db7faa5..4f2296e 100644 --- a/docs/ListAdditionalRecipientReceivableRefundsResponse.md +++ b/docs/ListAdditionalRecipientReceivableRefundsResponse.md @@ -10,7 +10,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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivablesRequest.md b/docs/ListAdditionalRecipientReceivablesRequest.md index d6d8a50..9d3cba9 100644 --- a/docs/ListAdditionalRecipientReceivablesRequest.md +++ b/docs/ListAdditionalRecipientReceivablesRequest.md @@ -11,7 +11,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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivablesResponse.md b/docs/ListAdditionalRecipientReceivablesResponse.md index 51731e8..a9fe396 100644 --- a/docs/ListAdditionalRecipientReceivablesResponse.md +++ b/docs/ListAdditionalRecipientReceivablesResponse.md @@ -10,7 +10,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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListCatalogRequest.md b/docs/ListCatalogRequest.md index 928cc88..bdb52ee 100644 --- a/docs/ListCatalogRequest.md +++ b/docs/ListCatalogRequest.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/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](#type-catalogobjecttype) enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] +**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] diff --git a/docs/ListCatalogResponse.md b/docs/ListCatalogResponse.md index 4ad0bed..5ea6269 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](#type-error)s encountered. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] -**objects** | [**List<CatalogObject>**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional] +**errors** | [**List<Error>**](Error.md) | The set of `Error`s 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] diff --git a/docs/ListCustomersRequest.md b/docs/ListCustomersRequest.md index b539e0d..5b7d293 100644 --- a/docs/ListCustomersRequest.md +++ b/docs/ListCustomersRequest.md @@ -8,7 +8,7 @@ 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](/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 [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] diff --git a/docs/ListCustomersResponse.md b/docs/ListCustomersResponse.md index 726727f..cf3ace2 100644 --- a/docs/ListCustomersResponse.md +++ b/docs/ListCustomersResponse.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 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](/basics/api101/pagination) for more information. | [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] diff --git a/docs/ListPaymentRefundsRequest.md b/docs/ListPaymentRefundsRequest.md index dd17296..ddfe027 100644 --- a/docs/ListPaymentRefundsRequest.md +++ b/docs/ListPaymentRefundsRequest.md @@ -11,9 +11,9 @@ Name | Type | Description | Notes **beginTime** | **String** | Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. | [optional] **endTime** | **String** | Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] **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](/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 [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](#type-paymentrefund). Default: If omitted refunds are returned regardless of status. | [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/ListPaymentRefundsResponse.md b/docs/ListPaymentRefundsResponse.md index dd10739..4764418 100644 --- a/docs/ListPaymentRefundsResponse.md +++ b/docs/ListPaymentRefundsResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] **refunds** | [**List<PaymentRefund>**](PaymentRefund.md) | The list of requested refunds. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListPaymentsRequest.md b/docs/ListPaymentsRequest.md index a850a45..76515e4 100644 --- a/docs/ListPaymentsRequest.md +++ b/docs/ListPaymentsRequest.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **beginTime** | **String** | Timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year. | [optional] **endTime** | **String** | Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] **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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] **locationId** | **String** | ID of location associated with payment | [optional] **total** | **Long** | The exact amount in the total_money for a `Payment`. | [optional] **last4** | **String** | The last 4 digits of `Payment` card. | [optional] diff --git a/docs/ListPaymentsResponse.md b/docs/ListPaymentsResponse.md index 8266b41..9a3990d 100644 --- a/docs/ListPaymentsResponse.md +++ b/docs/ListPaymentsResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] **payments** | [**List<Payment>**](Payment.md) | The requested list of `Payment`s. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListRefundsRequest.md b/docs/ListRefundsRequest.md index 7f6e35e..ff715b4 100644 --- a/docs/ListRefundsRequest.md +++ b/docs/ListRefundsRequest.md @@ -11,7 +11,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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListRefundsResponse.md b/docs/ListRefundsResponse.md index 4fe0b0d..378605d 100644 --- a/docs/ListRefundsResponse.md +++ b/docs/ListRefundsResponse.md @@ -10,7 +10,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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListTransactionsRequest.md b/docs/ListTransactionsRequest.md index d9ba2f3..02d3c56 100644 --- a/docs/ListTransactionsRequest.md +++ b/docs/ListTransactionsRequest.md @@ -11,7 +11,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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListTransactionsResponse.md b/docs/ListTransactionsResponse.md index 1ceca9e..3850994 100644 --- a/docs/ListTransactionsResponse.md +++ b/docs/ListTransactionsResponse.md @@ -10,7 +10,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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/Location.md b/docs/Location.md index 1323c75..f9de617 100644 --- a/docs/Location.md +++ b/docs/Location.md @@ -26,12 +26,13 @@ Name | Type | Description | Notes **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] -**twitterUsername** | **String** | The Twitter username of the location without the ' | [optional] -**instagramUsername** | **String** | The Instagram username of the location without the ' | [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] +**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] diff --git a/docs/LocationsApi.md b/docs/LocationsApi.md index 2d33be8..5a18896 100644 --- a/docs/LocationsApi.md +++ b/docs/LocationsApi.md @@ -5,6 +5,8 @@ All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**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 @@ -56,3 +58,111 @@ This endpoint does not need any parameter. - **Content-Type**: application/json - **Accept**: application/json + +# **retrieveLocation** +> RetrieveLocationResponse retrieveLocation(locationId) + +RetrieveLocation + +Retrieves details of a location. + +### 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(); +String locationId = "locationId_example"; // String | The ID of the location to retrieve. +try { + RetrieveLocationResponse result = apiInstance.retrieveLocation(locationId); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling LocationsApi#retrieveLocation"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **locationId** | **String**| The ID of the location to retrieve. | + +### Return type + +[**RetrieveLocationResponse**](RetrieveLocationResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **updateLocation** +> UpdateLocationResponse updateLocation(locationId, body) + +UpdateLocation + +Updates the `Location` specified by the given ID. + +### 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(); +String locationId = "locationId_example"; // String | The ID of the location to update. +UpdateLocationRequest body = new UpdateLocationRequest(); // UpdateLocationRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. +try { + UpdateLocationResponse result = apiInstance.updateLocation(locationId, body); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling LocationsApi#updateLocation"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **locationId** | **String**| The ID of the location to update. | + **body** | [**UpdateLocationRequest**](UpdateLocationRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**UpdateLocationResponse**](UpdateLocationResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + diff --git a/docs/MeasurementUnit.md b/docs/MeasurementUnit.md index ee0e99e..04a8670 100644 --- a/docs/MeasurementUnit.md +++ b/docs/MeasurementUnit.md @@ -3,7 +3,7 @@ ### Description -Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. The `family` field describes the type of measurement. For example, ounces are in the weight family. +Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. ## Properties Name | Type | Description | Notes @@ -14,6 +14,7 @@ Name | Type | Description | Notes **volumeUnit** | **String** | Represents a standard volume unit. See [MeasurementUnitVolume](#type-measurementunitvolume) for possible values | [optional] **weightUnit** | **String** | Represents a standard unit of weight or mass. See [MeasurementUnitWeight](#type-measurementunitweight) for possible values | [optional] **genericUnit** | **String** | Reserved for API integrations that lack the ability to specify a real measurement unit See [MeasurementUnitGeneric](#type-measurementunitgeneric) for possible values | [optional] +**timeUnit** | **String** | Represents a standard unit of time. See [MeasurementUnitTime](#type-measurementunittime) for possible values | [optional] **type** | **String** | Represents the type of the measurement unit. See [MeasurementUnitUnitType](#type-measurementunitunittype) for possible values | [optional] diff --git a/docs/MeasurementUnitTime.md b/docs/MeasurementUnitTime.md new file mode 100644 index 0000000..add42b6 --- /dev/null +++ b/docs/MeasurementUnitTime.md @@ -0,0 +1,16 @@ + +# MeasurementUnitTime + + +* `"GENERIC_MILLISECOND"` + +* `"GENERIC_SECOND"` + +* `"GENERIC_MINUTE"` + +* `"GENERIC_HOUR"` + +* `"GENERIC_DAY"` + + + diff --git a/docs/Merchant.md b/docs/Merchant.md new file mode 100644 index 0000000..7851e40 --- /dev/null +++ b/docs/Merchant.md @@ -0,0 +1,19 @@ + +# Merchant + +### Description + +Represents a Square seller. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | The Square-issued ID of the merchant. | [optional] +**businessName** | **String** | The business name of the merchant. | [optional] +**country** | **String** | The country code associated with the merchant account, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values | +**languageCode** | **String** | The language code associated with the merchant account, in BCP 47 format. | [optional] +**currency** | **String** | The currency associated with the merchant account, in ISO 4217 format. See [Currency](#type-currency) for possible values | [optional] +**status** | **String** | The merchant status, active or inactive. See [MerchantStatus](#type-merchantstatus) for possible values | [optional] + + + diff --git a/docs/MerchantStatus.md b/docs/MerchantStatus.md new file mode 100644 index 0000000..b934a12 --- /dev/null +++ b/docs/MerchantStatus.md @@ -0,0 +1,10 @@ + +# MerchantStatus + + +* `"ACTIVE"` + +* `"INACTIVE"` + + + diff --git a/docs/MerchantsApi.md b/docs/MerchantsApi.md new file mode 100644 index 0000000..d2c92c8 --- /dev/null +++ b/docs/MerchantsApi.md @@ -0,0 +1,62 @@ +# MerchantsApi + +All URIs are relative to *https://connect.squareup.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**retrieveMerchant**](MerchantsApi.md#retrieveMerchant) | **GET** /v2/merchants/{merchant_id} | RetrieveMerchant + + + +# **retrieveMerchant** +> RetrieveMerchantResponse retrieveMerchant(merchantId) + +RetrieveMerchant + +Retrieve a `Merchant` object for the given `merchant_id`. + +### 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.MerchantsApi; + +ApiClient defaultClient = Configuration.getDefaultApiClient(); + +// Configure OAuth2 access token for authorization: oauth2 +OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2"); +oauth2.setAccessToken("YOUR ACCESS TOKEN"); + +MerchantsApi apiInstance = new MerchantsApi(); +String merchantId = "merchantId_example"; // String | The ID of the merchant to retrieve +try { + RetrieveMerchantResponse result = apiInstance.retrieveMerchant(merchantId); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MerchantsApi#retrieveMerchant"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **merchantId** | **String**| The ID of the merchant to retrieve | + +### Return type + +[**RetrieveMerchantResponse**](RetrieveMerchantResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + diff --git a/docs/MobileAuthorizationApi.md b/docs/MobileAuthorizationApi.md index faa3bcd..8e8bc46 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](https://docs.connect.squareup.com/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](/get-started#step-4-understand-the-different-application-credentials). ### Example ```java diff --git a/docs/Money.md b/docs/Money.md index 30ac589..11884ed 100644 --- a/docs/Money.md +++ b/docs/Money.md @@ -9,7 +9,7 @@ Represents an amount of money. `Money` fields can be signed or unsigned. 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] -**currency** | **String** | The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](#type-currency) for possible values. See [Currency](#type-currency) for possible values | [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/ObtainTokenRequest.md b/docs/ObtainTokenRequest.md index d7878e0..d5ce804 100644 --- a/docs/ObtainTokenRequest.md +++ b/docs/ObtainTokenRequest.md @@ -8,13 +8,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientId** | **String** | The Square-issued ID of your application, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] -**clientSecret** | **String** | The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] +**clientId** | **String** | The Square-issued ID of your application, available from the [application dashboard](https://connect.squareup.com/apps). | +**clientSecret** | **String** | The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps). | **code** | **String** | The authorization code to exchange. This is required if `grant_type` is set to `authorization_code`, to indicate that the application wants to exchange an authorization code for an OAuth access token. | [optional] **redirectUri** | **String** | The redirect URL assigned in the [application dashboard](https://connect.squareup.com/apps). | [optional] -**grantType** | **String** | Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token` | [optional] +**grantType** | **String** | Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token` | **refreshToken** | **String** | A valid refresh token for generating a new OAuth access token. A valid refresh token is required if `grant_type` is set to `refresh_token` , to indicate the application wants a replacement for an expired OAuth access token. | [optional] -**migrationToken** | **String** | Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](/authz/oauth/migration). | [optional] +**migrationToken** | **String** | Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/authz/oauth/migration). | [optional] diff --git a/docs/ObtainTokenResponse.md b/docs/ObtainTokenResponse.md index 7e589dd..5399315 100644 --- a/docs/ObtainTokenResponse.md +++ b/docs/ObtainTokenResponse.md @@ -8,14 +8,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**accessToken** | **String** | A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](/authz/oauth/build-with-the-api) guide for more information. | [optional] +**accessToken** | **String** | A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](https://developer.squareup.com/docs/authz/oauth/build-with-the-api) guide for more information. | [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 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] **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](/authz/oauth/how-it-works#oauth-access-token-management). | [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/Order.md b/docs/Order.md index 3e4860d..d266b2b 100644 --- a/docs/Order.md +++ b/docs/Order.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **locationId** | **String** | The ID of the merchant location this order is associated with. | **referenceId** | **String** | A client specified identifier to associate an entity in another system with this order. | [optional] **source** | [**OrderSource**](OrderSource.md) | The origination details of the order. | [optional] -**customerId** | **String** | The [Customer](#type-customer) ID of the customer associated with the order. | [optional] +**customerId** | **String** | The `Customer` ID of the customer associated with the order. | [optional] **lineItems** | [**List<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. | [optional] **taxes** | [**List<OrderLineItemTax>**](OrderLineItemTax.md) | The list of all taxes associated with the order. Taxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an `OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes with `ORDER` scope, the server will generate an `OrderLineItemAppliedTax` for every line item. On reads, each tax in the list will include the total amount of that tax applied to the order. __IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, usage of the deprecated `line_items.taxes` field will result in an error. Please use `line_items.applied_taxes` instead. | [optional] **discounts** | [**List<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | The list of all discounts associated with the order. Discounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`, an `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to. For discounts with `ORDER` scope, the server will generate an `OrderLineItemAppliedDiscount` for every line item. __IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, usage of the deprecated `line_items.discounts` field will result in an error. Please use `line_items.applied_discounts` instead. | [optional] @@ -24,11 +24,12 @@ Name | Type | Description | Notes **roundingAdjustment** | [**OrderRoundingAdjustment**](OrderRoundingAdjustment.md) | A positive or negative rounding adjustment to the total of the order, commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency. | [optional] **tenders** | [**List<Tender>**](Tender.md) | The Tenders which were used to pay for the Order. | [optional] **refunds** | [**List<Refund>**](Refund.md) | The Refunds that are part of this Order. | [optional] +**metadata** | **Map<String, String>** | Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. | [optional] **createdAt** | **String** | Timestamp for when the order was created. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] **updatedAt** | **String** | Timestamp for when the order was last updated. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] **closedAt** | **String** | Timestamp for when the order was closed. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] **state** | **String** | The current state of the order. `OPEN`,`COMPLETED`,`CANCELED` See [OrderState](#type-orderstate) for possible values | [optional] -**version** | **Integer** | Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](/orders-api/manage-orders#update-orders). | [optional] +**version** | **Integer** | Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders). | [optional] **totalMoney** | [**Money**](Money.md) | The total amount of money to collect for the order. | [optional] **totalTaxMoney** | [**Money**](Money.md) | The total tax amount of money to collect for the order. | [optional] **totalDiscountMoney** | [**Money**](Money.md) | The total discount amount of money to collect for the order. | [optional] diff --git a/docs/OrderEntry.md b/docs/OrderEntry.md index 5cd0700..8d60cf5 100644 --- a/docs/OrderEntry.md +++ b/docs/OrderEntry.md @@ -9,7 +9,7 @@ A lightweight description of an [Order](#type-order) that is returned when `retu Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **String** | The id of the Order | [optional] -**version** | **Integer** | Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](/orders-api/manage-orders#update-orders). | [optional] +**version** | **Integer** | Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders). | [optional] **locationId** | **String** | The location id the Order belongs to. | [optional] diff --git a/docs/OrderFulfillment.md b/docs/OrderFulfillment.md index 919c4ca..951b883 100644 --- a/docs/OrderFulfillment.md +++ b/docs/OrderFulfillment.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **uid** | **String** | Unique ID that identifies the fulfillment only within this order. | [optional] **type** | **String** | The type of the fulfillment. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values | [optional] **state** | **String** | The state of the fulfillment. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values | [optional] +**metadata** | **Map<String, String>** | Application-defined data attached to this fulfillment. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. | [optional] **pickupDetails** | [**OrderFulfillmentPickupDetails**](OrderFulfillmentPickupDetails.md) | Contains details for a pickup fulfillment. Required when fulfillment type is `PICKUP`. | [optional] **shipmentDetails** | [**OrderFulfillmentShipmentDetails**](OrderFulfillmentShipmentDetails.md) | Contains details for a shipment fulfillment. Required when fulfillment type is `SHIPMENT`. A shipment fulfillment's relationship to fulfillment `state`: `PROPOSED`: A shipment is requested. `RESERVED`: Fulfillment accepted. Shipment processing. `PREPARED`: Shipment packaged. Shipping label created. `COMPLETED`: Package has been shipped. `CANCELED`: Shipment has been canceled. `FAILED`: Shipment has failed. | [optional] diff --git a/docs/OrderLineItem.md b/docs/OrderLineItem.md index 278493c..593285b 100644 --- a/docs/OrderLineItem.md +++ b/docs/OrderLineItem.md @@ -13,9 +13,10 @@ Name | Type | Description | Notes **quantity** | **String** | The quantity purchased, formatted as a decimal number. For example: `\"3\"`. Line items with a `quantity_unit` can have non-integer quantities. For example: `\"1.70000\"`. | **quantityUnit** | [**OrderQuantityUnit**](OrderQuantityUnit.md) | The unit and precision that this line item's quantity is measured in. | [optional] **note** | **String** | The note of the line item. | [optional] -**catalogObjectId** | **String** | The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item. | [optional] +**catalogObjectId** | **String** | The `CatalogItemVariation` id applied to this line item. | [optional] **variationName** | **String** | The name of the variation applied to this line item. | [optional] -**modifiers** | [**List<OrderLineItemModifier>**](OrderLineItemModifier.md) | The [CatalogModifier](#type-catalogmodifier)s applied to this line item. | [optional] +**metadata** | **Map<String, String>** | Application-defined data attached to this line item. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. | [optional] +**modifiers** | [**List<OrderLineItemModifier>**](OrderLineItemModifier.md) | The `CatalogModifier`s applied to this line item. | [optional] **taxes** | [**List<OrderLineItemTax>**](OrderLineItemTax.md) | A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any order-level taxes apportioned to this item. When creating an Order, set your item-level taxes in this list. This field has been deprecated in favour of `applied_taxes`. Usage of both this field and `applied_taxes` when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error. | [optional] **discounts** | [**List<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any order-level discounts apportioned to this item. When creating an Order, set your item-level discounts in this list. This field has been deprecated in favour of `applied_discounts`. Usage of both this field and `applied_discounts` when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error. | [optional] **appliedTaxes** | [**List<OrderLineItemAppliedTax>**](OrderLineItemAppliedTax.md) | The list of references to taxes applied to this line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderLineItemTax` applied to the line item. On reads, the amount applied is populated. An `OrderLineItemAppliedTax` will be automatically created on every line item for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax` records for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any line items. To change the amount of a tax, modify the referenced top-level tax. | [optional] diff --git a/docs/OrderLineItemDiscount.md b/docs/OrderLineItemDiscount.md index 5aa9cba..6fadc6a 100644 --- a/docs/OrderLineItemDiscount.md +++ b/docs/OrderLineItemDiscount.md @@ -9,12 +9,13 @@ Represents a discount that applies to one or more line items in an order. Fixed Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uid** | **String** | Unique ID that identifies the discount only within this order. | [optional] -**catalogObjectId** | **String** | The catalog object id referencing [CatalogDiscount](#type-catalogdiscount). | [optional] +**catalogObjectId** | **String** | The catalog object id referencing `CatalogDiscount`. | [optional] **name** | **String** | The discount's name. | [optional] -**type** | **String** | The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values | [optional] -**percentage** | **String** | The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount. | [optional] +**type** | **String** | The type of the discount. Discounts that don't reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values | [optional] +**percentage** | **String** | The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. `percentage` is not set for amount-based discounts. | [optional] **amountMoney** | [**Money**](Money.md) | The total declared monetary amount of the discount. `amount_money` is not set for percentage-based discounts. | [optional] **appliedMoney** | [**Money**](Money.md) | The amount of discount actually applied to the line item. Represents the amount of money applied as a line item-scoped discount. When an amount-based discount is scoped to the entire order, the value of `applied_money` is different from `amount_money` because the total amount of the discount is distributed across all line items. | [optional] +**metadata** | **Map<String, String>** | Application-defined data attached to this discount. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. | [optional] **scope** | **String** | Indicates the level at which the discount applies. For `ORDER` scoped discounts, Square generates references in `applied_discounts` on all order line items that do not have them. For `LINE_ITEM` scoped discounts, the discount only applies to line items with a discount reference in their `applied_discounts` field. This field is immutable. To change the scope of a discount you must delete the discount and re-add it as a new discount. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values | [optional] diff --git a/docs/OrderLineItemModifier.md b/docs/OrderLineItemModifier.md index 9267647..055827c 100644 --- a/docs/OrderLineItemModifier.md +++ b/docs/OrderLineItemModifier.md @@ -9,9 +9,9 @@ A [CatalogModifier](#type-catalogmodifier). Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uid** | **String** | Unique ID that identifies the modifier only within this order. | [optional] -**catalogObjectId** | **String** | The catalog object id referencing [CatalogModifier](#type-catalogmodifier). | [optional] +**catalogObjectId** | **String** | The catalog object id referencing `CatalogModifier`. | [optional] **name** | **String** | The name of the item modifier. | [optional] -**basePriceMoney** | [**Money**](Money.md) | The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price. | [optional] +**basePriceMoney** | [**Money**](Money.md) | The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price. | [optional] **totalPriceMoney** | [**Money**](Money.md) | The total price of the item modifier for its line item. This is the modifier's `base_price_money` multiplied by the line item's quantity. | [optional] diff --git a/docs/OrderLineItemTax.md b/docs/OrderLineItemTax.md index 0621890..eaa7a51 100644 --- a/docs/OrderLineItemTax.md +++ b/docs/OrderLineItemTax.md @@ -9,10 +9,11 @@ Represents a tax that applies to one or more line item in the order. Fixed-amou Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uid** | **String** | Unique ID that identifies the tax only within this order. | [optional] -**catalogObjectId** | **String** | The catalog object id referencing [CatalogTax](#type-catalogtax). | [optional] +**catalogObjectId** | **String** | The catalog object id referencing `CatalogTax`. | [optional] **name** | **String** | The tax's name. | [optional] **type** | **String** | Indicates the calculation method used to apply the tax. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values | [optional] **percentage** | **String** | The percentage of the tax, as a string representation of a decimal number. For example, a value of `\"7.25\"` corresponds to a percentage of 7.25%. | [optional] +**metadata** | **Map<String, String>** | Application-defined data attached to this tax. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. | [optional] **appliedMoney** | [**Money**](Money.md) | The amount of the money applied by the tax in the order. | [optional] **scope** | **String** | Indicates the level at which the tax applies. For `ORDER` scoped taxes, Square generates references in `applied_taxes` on all order line items that do not have them. For `LINE_ITEM` scoped taxes, the tax will only apply to line items with references in their `applied_taxes` field. This field is immutable. To change the scope, you must delete the tax and re-add it as a new tax. See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values | [optional] diff --git a/docs/OrderQuantityUnit.md b/docs/OrderQuantityUnit.md index 7128982..8584978 100644 --- a/docs/OrderQuantityUnit.md +++ b/docs/OrderQuantityUnit.md @@ -8,7 +8,7 @@ Contains the measurement unit for a quantity and a precision which specifies the ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**measurementUnit** | [**MeasurementUnit**](MeasurementUnit.md) | A [MeasurementUnit](#type-measurementunit) that represents the unit of measure for the quantity. | [optional] +**measurementUnit** | [**MeasurementUnit**](MeasurementUnit.md) | A `MeasurementUnit` that represents the unit of measure for the quantity. | [optional] **precision** | **Integer** | For non-integer quantities, represents the number of digits after the decimal point that are recorded for this quantity. For example, a precision of 1 allows quantities like `\"1.0\"` and `\"1.1\"`, but not `\"1.01\"`. Min: 0. Max: 5. | [optional] diff --git a/docs/OrderReturnDiscount.md b/docs/OrderReturnDiscount.md index 87c1549..0140145 100644 --- a/docs/OrderReturnDiscount.md +++ b/docs/OrderReturnDiscount.md @@ -10,11 +10,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uid** | **String** | Unique ID that identifies the return discount only within this order. | [optional] **sourceDiscountUid** | **String** | `uid` of the Discount from the Order which contains the original application of this discount. | [optional] -**catalogObjectId** | **String** | The catalog object id referencing [CatalogDiscount](#type-catalogdiscount). | [optional] +**catalogObjectId** | **String** | The catalog object id referencing `CatalogDiscount`. | [optional] **name** | **String** | The discount's name. | [optional] -**type** | **String** | The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values | [optional] -**percentage** | **String** | The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount. | [optional] -**amountMoney** | [**Money**](Money.md) | The total declared monetary amount of the discount. The amount_money won't be set for a percentage-based discount. | [optional] +**type** | **String** | The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. Discounts that don't reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values | [optional] +**percentage** | **String** | The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. `percentage` is not set for amount-based discounts. | [optional] +**amountMoney** | [**Money**](Money.md) | The total declared monetary amount of the discount. `amount_money` is not set for percentage-based discounts. | [optional] **appliedMoney** | [**Money**](Money.md) | The amount of discount actually applied to this line item. When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items. | [optional] **scope** | **String** | Indicates the level at which the `OrderReturnDiscount` applies. For `ORDER` scoped discounts, the server will generate references in `applied_discounts` on all `OrderReturnLineItem`s. For `LINE_ITEM` scoped discounts, the discount will only apply to `OrderReturnLineItem`s with references in their `applied_discounts` field. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values | [optional] diff --git a/docs/OrderReturnLineItem.md b/docs/OrderReturnLineItem.md index d5eeae0..00fd021 100644 --- a/docs/OrderReturnLineItem.md +++ b/docs/OrderReturnLineItem.md @@ -14,9 +14,9 @@ Name | Type | Description | Notes **quantity** | **String** | The quantity returned, formatted as a decimal number. For example: `\"3\"`. Line items with a `quantity_unit` can have non-integer quantities. For example: `\"1.70000\"`. | **quantityUnit** | [**OrderQuantityUnit**](OrderQuantityUnit.md) | The unit and precision that this return line item's quantity is measured in. | [optional] **note** | **String** | The note of the returned line item. | [optional] -**catalogObjectId** | **String** | The [CatalogItemVariation](#type-catalogitemvariation) id applied to this returned line item. | [optional] +**catalogObjectId** | **String** | The `CatalogItemVariation` id applied to this returned line item. | [optional] **variationName** | **String** | The name of the variation applied to this returned line item. | [optional] -**returnModifiers** | [**List<OrderReturnLineItemModifier>**](OrderReturnLineItemModifier.md) | The [CatalogModifier](#type-catalogmodifier)s applied to this line item. | [optional] +**returnModifiers** | [**List<OrderReturnLineItemModifier>**](OrderReturnLineItemModifier.md) | The `CatalogModifier`s applied to this line item. | [optional] **returnTaxes** | [**List<OrderReturnTax>**](OrderReturnTax.md) | A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any return-level taxes apportioned to this item. This field has been deprecated in favour of `applied_taxes`. | [optional] **returnDiscounts** | [**List<OrderReturnDiscount>**](OrderReturnDiscount.md) | A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any return-level discounts apportioned to this item. This field has been deprecated in favour of `applied_discounts`. | [optional] **appliedTaxes** | [**List<OrderLineItemAppliedTax>**](OrderLineItemAppliedTax.md) | The list of references to `OrderReturnTax` entities applied to the returned line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderReturnTax` applied to the returned line item. On reads, the amount applied is populated. | [optional] diff --git a/docs/OrderReturnLineItemModifier.md b/docs/OrderReturnLineItemModifier.md index 280f1d1..4615d40 100644 --- a/docs/OrderReturnLineItemModifier.md +++ b/docs/OrderReturnLineItemModifier.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uid** | **String** | Unique ID that identifies the return modifier only within this order. | [optional] **sourceModifierUid** | **String** | `uid` of the Modifier from the LineItem from the Order which contains the original sale of this line item modifier. | [optional] -**catalogObjectId** | **String** | The catalog object id referencing [CatalogModifier](#type-catalogmodifier). | [optional] +**catalogObjectId** | **String** | The catalog object id referencing `CatalogModifier`. | [optional] **name** | **String** | The name of the item modifier. | [optional] -**basePriceMoney** | [**Money**](Money.md) | The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price. | [optional] +**basePriceMoney** | [**Money**](Money.md) | The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price. | [optional] **totalPriceMoney** | [**Money**](Money.md) | The total price of the item modifier for its line item. This is the modifier's `base_price_money` multiplied by the line item's quantity. | [optional] diff --git a/docs/OrderReturnServiceCharge.md b/docs/OrderReturnServiceCharge.md index 1bc26ac..a3f023e 100644 --- a/docs/OrderReturnServiceCharge.md +++ b/docs/OrderReturnServiceCharge.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **uid** | **String** | Unique ID that identifies the return service charge only within this order. | [optional] **sourceServiceChargeUid** | **String** | `uid` of the Service Charge from the Order containing the original charge of the service charge. `source_service_charge_uid` is `null` for unlinked returns. | [optional] **name** | **String** | The name of the service charge. | [optional] -**catalogObjectId** | **String** | The catalog object ID of the associated [CatalogServiceCharge](#type-catalogservicecharge). | [optional] +**catalogObjectId** | **String** | The catalog object ID of the associated `CatalogServiceCharge`. | [optional] **percentage** | **String** | The percentage of the service charge, as a string representation of a decimal number. For example, a value of `\"7.25\"` corresponds to a percentage of 7.25%. Exactly one of `percentage` or `amount_money` should be set. | [optional] **amountMoney** | [**Money**](Money.md) | The amount of a non-percentage based service charge. Exactly one of `percentage` or `amount_money` should be set. | [optional] **appliedMoney** | [**Money**](Money.md) | The amount of money applied to the order by the service charge, including any inclusive tax amounts, as calculated by Square. - For fixed-amount service charges, `applied_money` is equal to `amount_money`. - For percentage-based service charges, `applied_money` is the money calculated using the percentage. | [optional] diff --git a/docs/OrderReturnTax.md b/docs/OrderReturnTax.md index cf4d0bf..98351cd 100644 --- a/docs/OrderReturnTax.md +++ b/docs/OrderReturnTax.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uid** | **String** | Unique ID that identifies the return tax only within this order. | [optional] **sourceTaxUid** | **String** | `uid` of the Tax from the Order which contains the original charge of this tax. | [optional] -**catalogObjectId** | **String** | The catalog object id referencing [CatalogTax](#type-catalogtax). | [optional] +**catalogObjectId** | **String** | The catalog object id referencing `CatalogTax`. | [optional] **name** | **String** | The tax's name. | [optional] **type** | **String** | Indicates the calculation method used to apply the tax. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values | [optional] **percentage** | **String** | The percentage of the tax, as a string representation of a decimal number. For example, a value of `\"7.25\"` corresponds to a percentage of 7.25%. | [optional] diff --git a/docs/OrderServiceCharge.md b/docs/OrderServiceCharge.md index faaa45c..3acd105 100644 --- a/docs/OrderServiceCharge.md +++ b/docs/OrderServiceCharge.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uid** | **String** | Unique ID that identifies the service charge only within this order. | [optional] **name** | **String** | The name of the service charge. | [optional] -**catalogObjectId** | **String** | The catalog object ID referencing the service charge [CatalogObject](#type-catalogobject). | [optional] +**catalogObjectId** | **String** | The catalog object ID referencing the service charge `CatalogObject`. | [optional] **percentage** | **String** | The service charge percentage as a string representation of a decimal number. For example, `\"7.25\"` indicates a service charge of 7.25%. Exactly 1 of `percentage` or `amount_money` should be set. | [optional] **amountMoney** | [**Money**](Money.md) | The amount of a non-percentage based service charge. Exactly one of `percentage` or `amount_money` should be set. | [optional] **appliedMoney** | [**Money**](Money.md) | The amount of money applied to the order by the service charge, including any inclusive tax amounts, as calculated by Square. - For fixed-amount service charges, `applied_money` is equal to `amount_money`. - For percentage-based service charges, `applied_money` is the money calculated using the percentage. | [optional] @@ -20,6 +20,7 @@ Name | Type | Description | Notes **taxable** | **Boolean** | Indicates whether the service charge can be taxed. If set to `true`, order-level taxes automatically apply to the service charge. Note that service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable. | [optional] **taxes** | [**List<OrderLineItemTax>**](OrderLineItemTax.md) | A list of taxes applied to this service charge. On read or retrieve, this list includes both item-level taxes and any order-level taxes apportioned to this service charge. When creating an Order, set your service charge-level taxes in this list. By default, order-level taxes apply to service charges calculated in the `SUBTOTAL_PHASE` if `taxable` is set to `true`. This field has been deprecated in favour of `applied_taxes`. Usage of both this field and `applied_taxes` when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error. | [optional] **appliedTaxes** | [**List<OrderLineItemAppliedTax>**](OrderLineItemAppliedTax.md) | The list of references to taxes applied to this service charge. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied is populated. An `OrderLineItemAppliedTax` will be automatically created on every taxable service charge for all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable service charge. Taxable service charges have the `taxable` field set to true and calculated in the `SUBTOTAL_PHASE`. To change the amount of a tax, modify the referenced top-level tax. | [optional] +**metadata** | **Map<String, String>** | Application-defined data attached to this service charge. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. | [optional] diff --git a/docs/PayOrderRequest.md b/docs/PayOrderRequest.md index dafde84..d45280c 100644 --- a/docs/PayOrderRequest.md +++ b/docs/PayOrderRequest.md @@ -8,7 +8,7 @@ Defines the fields that are included in requests to the [PayOrder](#endpoint-pay ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotencyKey** | **String** | A value you specify that uniquely identifies this request among requests you've sent. If you're unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments. See [Idempotency](/working-with-apis/idempotency) for more information. | +**idempotencyKey** | **String** | A value you specify that uniquely identifies this request among requests you've sent. If you're unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments. See [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information. | **orderVersion** | **Integer** | The version of the order being paid. If not supplied, the latest version will be paid. | [optional] **paymentIds** | **List<String>** | | [optional] diff --git a/docs/PayOrderResponse.md b/docs/PayOrderResponse.md index 0a08e98..e32c724 100644 --- a/docs/PayOrderResponse.md +++ b/docs/PayOrderResponse.md @@ -9,7 +9,7 @@ Defines the fields that are included in the response body of a request to the [P Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] -**order** | [**Order**](Order.md) | The paid, updated [order](#type-order). | [optional] +**order** | [**Order**](Order.md) | The paid, updated `order`. | [optional] diff --git a/docs/Payment.md b/docs/Payment.md index 3394622..09808fd 100644 --- a/docs/Payment.md +++ b/docs/Payment.md @@ -8,22 +8,23 @@ Represents a payment processed by the Square API. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Unique ID for the payment. | +**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](/build-basics/working-with-monetary-amounts). | +**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](/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. | [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] -**sourceType** | **String** | The source type for this payment | [optional] +**sourceType** | **String** | The source type for this payment Current values include: `CARD` | [optional] **cardDetails** | [**CardPaymentDetails**](CardPaymentDetails.md) | Non-confidential details about the source. Only populated if the `source_type` is `CARD`. | [optional] **locationId** | **String** | ID of the location associated with the payment. | [optional] **orderId** | **String** | ID of the order associated with this payment. | [optional] **referenceId** | **String** | An optional ID that associates this payment with an entity in another system. | [optional] **customerId** | **String** | An optional customer_id to be entered by the developer when creating a payment. | [optional] +**employeeId** | **String** | An optional ID of the employee associated with taking this payment. | [optional] **refundIds** | **List<String>** | List of `refund_id`s identifying refunds for this payment. | [optional] **buyerEmailAddress** | **String** | The buyer's e-mail address | [optional] **billingAddress** | [**Address**](Address.md) | The buyer's billing address | [optional] diff --git a/docs/PaymentRefund.md b/docs/PaymentRefund.md index cf6a012..fb13020 100644 --- a/docs/PaymentRefund.md +++ b/docs/PaymentRefund.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **status** | **String** | The refund's status: - `PENDING` - awaiting approval - `COMPLETED` - successfully completed - `REJECTED` - the refund was rejected - `FAILED` - an error occurred | [optional] **locationId** | **String** | Location ID associated with the payment this refund is attached to. | [optional] **amountMoney** | [**Money**](Money.md) | The amount of money refunded, specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | -**appFeeMoney** | [**Money**](Money.md) | Amount of money the app developer contributed to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. | [optional] +**appFeeMoney** | [**Money**](Money.md) | Amount of money the app developer contributed to help cover the refunded amount. 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. | [optional] **processingFee** | [**List<ProcessingFee>**](ProcessingFee.md) | Processing fees and fee adjustments assessed by Square on this refund. | [optional] **paymentId** | **String** | The ID of the payment assocated with this refund. | [optional] **orderId** | **String** | The ID of the order associated with the refund. | [optional] diff --git a/docs/PaymentsApi.md b/docs/PaymentsApi.md index ed79d5c..97965d2 100644 --- a/docs/PaymentsApi.md +++ b/docs/PaymentsApi.md @@ -18,7 +18,7 @@ Method | HTTP request | Description CancelPayment -Cancels 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 a payment identified by the idenpotency key that is specified 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 @@ -124,7 +124,7 @@ Name | Type | Description | Notes CompletePayment -Completes a payment. By default, payments are set to complete immediately after they are created. If you set autocomplete to false when creating a payment, you can complete the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). +Completes (captures) a payment. By default, payments are set to complete immediately after they are created. If you set autocomplete to false when creating a payment, you can complete (capture) the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). ### Example ```java @@ -304,7 +304,7 @@ PaymentsApi apiInstance = new PaymentsApi(); String beginTime = "beginTime_example"; // String | Timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year. String endTime = "endTime_example"; // String | Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. String locationId = "locationId_example"; // String | ID of location associated with payment Long total = 789L; // Long | The exact amount in the total_money for a `Payment`. String last4 = "last4_example"; // String | The last 4 digits of `Payment` card. @@ -325,7 +325,7 @@ Name | Type | Description | Notes **beginTime** | **String**| Timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year. | [optional] **endTime** | **String**| Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] **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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] **locationId** | **String**| ID of location associated with payment | [optional] **total** | **Long**| The exact amount in the total_money for a `Payment`. | [optional] **last4** | **String**| The last 4 digits of `Payment` card. | [optional] diff --git a/docs/RefundPaymentRequest.md b/docs/RefundPaymentRequest.md index 0169a59..75a3b33 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](/basics/api101/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](/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](/payments-api/take-payments-and-collect-fees) | [optional] +**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). | +**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] **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 045e667..22139f2 100644 --- a/docs/RefundsApi.md +++ b/docs/RefundsApi.md @@ -89,9 +89,9 @@ RefundsApi apiInstance = new RefundsApi(); String beginTime = "beginTime_example"; // String | Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. String endTime = "endTime_example"; // String | Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. 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](/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 [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](#type-paymentrefund). Default: If omitted refunds are returned regardless of status. +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); @@ -109,9 +109,9 @@ Name | Type | Description | Notes **beginTime** | **String**| Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. | [optional] **endTime** | **String**| Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] **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](/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 [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](#type-paymentrefund). Default: If omitted refunds are returned regardless of status. | [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/ReportingApi.md b/docs/ReportingApi.md index 75a8a41..4dcbbfa 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] ### Return type diff --git a/docs/RetrieveCatalogObjectRequest.md b/docs/RetrieveCatalogObjectRequest.md index 4d53608..68e9603 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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. 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](#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] diff --git a/docs/RetrieveCatalogObjectResponse.md b/docs/RetrieveCatalogObjectResponse.md index 870f029..97cea05 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](#type-error)s encountered. | [optional] -**object** | [**CatalogObject**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional] -**relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `object` field. | [optional] +**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] diff --git a/docs/RetrieveInventoryAdjustmentResponse.md b/docs/RetrieveInventoryAdjustmentResponse.md index 733f561..401a309 100644 --- a/docs/RetrieveInventoryAdjustmentResponse.md +++ b/docs/RetrieveInventoryAdjustmentResponse.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] -**adjustment** | [**InventoryAdjustment**](InventoryAdjustment.md) | The requested [InventoryAdjustment](#type-inventoryadjustment). | [optional] +**adjustment** | [**InventoryAdjustment**](InventoryAdjustment.md) | The requested `InventoryAdjustment`. | [optional] diff --git a/docs/RetrieveInventoryChangesRequest.md b/docs/RetrieveInventoryChangesRequest.md index d41f3ea..93405a2 100644 --- a/docs/RetrieveInventoryChangesRequest.md +++ b/docs/RetrieveInventoryChangesRequest.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**locationIds** | **String** | The [Location](#type-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](/basics/api101/pagination) for more information. | [optional] +**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] diff --git a/docs/RetrieveInventoryChangesResponse.md b/docs/RetrieveInventoryChangesResponse.md index e0782af..17cdc08 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/RetrieveInventoryCountRequest.md b/docs/RetrieveInventoryCountRequest.md index fa35984..aff23cd 100644 --- a/docs/RetrieveInventoryCountRequest.md +++ b/docs/RetrieveInventoryCountRequest.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**locationIds** | **String** | The [Location](#type-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](/basics/api101/pagination) for more information. | [optional] +**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] diff --git a/docs/RetrieveInventoryCountResponse.md b/docs/RetrieveInventoryCountResponse.md index 6ea04d8..3e54b55 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/RetrieveInventoryPhysicalCountResponse.md b/docs/RetrieveInventoryPhysicalCountResponse.md index b44f6d6..eac37c4 100644 --- a/docs/RetrieveInventoryPhysicalCountResponse.md +++ b/docs/RetrieveInventoryPhysicalCountResponse.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] -**count** | [**InventoryPhysicalCount**](InventoryPhysicalCount.md) | The requested [InventoryPhysicalCount](#type-inventoryphysicalcount). | [optional] +**count** | [**InventoryPhysicalCount**](InventoryPhysicalCount.md) | The requested `InventoryPhysicalCount`. | [optional] diff --git a/docs/RetrieveLocationRequest.md b/docs/RetrieveLocationRequest.md index 15d6a34..6e180fd 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. ## Properties Name | Type | Description | Notes diff --git a/docs/RetrieveLocationResponse.md b/docs/RetrieveLocationResponse.md index 1839966..fe5c583 100644 --- a/docs/RetrieveLocationResponse.md +++ b/docs/RetrieveLocationResponse.md @@ -3,12 +3,12 @@ ### Description -Defines the fields that are included in the response body of a request to the [RetrieveLocation](#endpoint-retrievelocation) endpoint. One of `errors` or `location` is present in a given response (never both). +Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] +**errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] **location** | [**Location**](Location.md) | The requested location. | [optional] diff --git a/docs/RetrieveMerchantRequest.md b/docs/RetrieveMerchantRequest.md new file mode 100644 index 0000000..97c8823 --- /dev/null +++ b/docs/RetrieveMerchantRequest.md @@ -0,0 +1,13 @@ + +# RetrieveMerchantRequest + +### Description + +Request object for the [RetrieveMerchant](#endpoint-retrievemerchant) endpoint. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + + diff --git a/docs/RetrieveMerchantResponse.md b/docs/RetrieveMerchantResponse.md new file mode 100644 index 0000000..dfc8f08 --- /dev/null +++ b/docs/RetrieveMerchantResponse.md @@ -0,0 +1,15 @@ + +# RetrieveMerchantResponse + +### Description + +The response obeject returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] +**merchant** | [**Merchant**](Merchant.md) | The requested `Merchant` object. | [optional] + + + diff --git a/docs/SearchCatalogObjectsRequest.md b/docs/SearchCatalogObjectsRequest.md index 7f13e00..364f85e 100644 --- a/docs/SearchCatalogObjectsRequest.md +++ b/docs/SearchCatalogObjectsRequest.md @@ -8,10 +8,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/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](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values | [optional] +**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] **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](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response. If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response. | [optional] +**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] **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 22e4983..c4ee519 100644 --- a/docs/SearchCatalogObjectsResponse.md +++ b/docs/SearchCatalogObjectsResponse.md @@ -8,10 +8,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] -**objects** | [**List<CatalogObject>**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional] -**relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the objects in the `objects` field. | [optional] +**errors** | [**List<Error>**](Error.md) | The set of `Error`s 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 this merchant's catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. | [optional] diff --git a/docs/SearchCustomersRequest.md b/docs/SearchCustomersRequest.md index 50162d0..5e4dc12 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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 2227315..d6657a6 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] diff --git a/docs/SearchOrdersFilter.md b/docs/SearchOrdersFilter.md index 7610fe6..763b21e 100644 --- a/docs/SearchOrdersFilter.md +++ b/docs/SearchOrdersFilter.md @@ -8,8 +8,8 @@ Filtering criteria to use for a SearchOrders request. Multiple filters will be A ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**stateFilter** | [**SearchOrdersStateFilter**](SearchOrdersStateFilter.md) | Filter by [`OrderState`](#type-orderstate). | [optional] -**dateTimeFilter** | [**SearchOrdersDateTimeFilter**](SearchOrdersDateTimeFilter.md) | Filter for results within a time range. __Important:__ If you filter for orders by time range, you must set SearchOrdersSort to sort by the same field. [Learn more about filtering orders by time range](/orders-api/manage-orders#important-note-on-filtering-orders-by-time-range) | [optional] +**stateFilter** | [**SearchOrdersStateFilter**](SearchOrdersStateFilter.md) | Filter by ``OrderState``. | [optional] +**dateTimeFilter** | [**SearchOrdersDateTimeFilter**](SearchOrdersDateTimeFilter.md) | Filter for results within a time range. __Important:__ If you filter for orders by time range, you must set SearchOrdersSort to sort by the same field. [Learn more about filtering orders by time range](https://developer.squareup.com/docs/orders-api/manage-orders#important-note-on-filtering-orders-by-time-range) | [optional] **fulfillmentFilter** | [**SearchOrdersFulfillmentFilter**](SearchOrdersFulfillmentFilter.md) | Filter by fulfillment type or state. | [optional] **sourceFilter** | [**SearchOrdersSourceFilter**](SearchOrdersSourceFilter.md) | Filter by source of order. | [optional] **customerFilter** | [**SearchOrdersCustomerFilter**](SearchOrdersCustomerFilter.md) | Filter by customers associated with the order. | [optional] diff --git a/docs/SearchOrdersFulfillmentFilter.md b/docs/SearchOrdersFulfillmentFilter.md index e179d97..cbee072 100644 --- a/docs/SearchOrdersFulfillmentFilter.md +++ b/docs/SearchOrdersFulfillmentFilter.md @@ -8,8 +8,8 @@ Filter based on [Order Fulfillment](#type-orderfulfillment) information. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**fulfillmentTypes** | **List<String>** | List of [fulfillment types](#type-orderfulfillmenttype) to filter for. Will return orders if any of its fulfillments match any of the fulfillment types listed in this field. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values | -**fulfillmentStates** | **List<String>** | List of [fulfillment states](#type-orderfulfillmentstate) to filter for. Will return orders if any of its fulfillments match any of the fulfillment states listed in this field. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values | [optional] +**fulfillmentTypes** | **List<String>** | List of `fulfillment types` to filter for. Will return orders if any of its fulfillments match any of the fulfillment types listed in this field. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values | +**fulfillmentStates** | **List<String>** | List of `fulfillment states` to filter for. Will return orders if any of its fulfillments match any of the fulfillment states listed in this field. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values | [optional] diff --git a/docs/SearchOrdersRequest.md b/docs/SearchOrdersRequest.md index 21fa3a5..0f8f956 100644 --- a/docs/SearchOrdersRequest.md +++ b/docs/SearchOrdersRequest.md @@ -9,10 +9,10 @@ The request does not have any required fields. When given no query criteria, Sea Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **locationIds** | **List<String>** | The location IDs for the orders to query. All locations must belong to the same merchant. Min: 1 location IDs. Max: 10 location IDs. | [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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] **query** | [**SearchOrdersQuery**](SearchOrdersQuery.md) | Query conditions used to filter or sort the results. Note that when fetching additional pages using a cursor, the query must be equal to the query used to fetch the first page of results. | [optional] **limit** | **Integer** | Maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. Default: `500` | [optional] -**returnEntries** | **Boolean** | Boolean that controls the format of the search results. If `true`, SearchOrders will return [`OrderEntry`](#type-orderentry) objects. If `false`, SearchOrders will return complete Order objects. Default: `false`. | [optional] +**returnEntries** | **Boolean** | Boolean that controls the format of the search results. If `true`, SearchOrders will return ``OrderEntry`` objects. If `false`, SearchOrders will return complete Order objects. Default: `false`. | [optional] diff --git a/docs/SearchOrdersResponse.md b/docs/SearchOrdersResponse.md index daed4b6..e3c6a33 100644 --- a/docs/SearchOrdersResponse.md +++ b/docs/SearchOrdersResponse.md @@ -8,10 +8,10 @@ Only one of `order_entries` or `orders` fields will be set, depending on whether ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderEntries** | [**List<OrderEntry>**](OrderEntry.md) | List of [OrderEntries](#type-orderentry) that fit the query conditions. Populated only if `return_entries` was set to `true` in the request. | [optional] -**orders** | [**List<Order>**](Order.md) | List of [Order](#type-order) objects that match query conditions. Populated only if `return_entries` in the request is set to `false`. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] -**errors** | [**List<Error>**](Error.md) | [Errors](#type-error) encountered during the search. | [optional] +**orderEntries** | [**List<OrderEntry>**](OrderEntry.md) | List of `OrderEntries` that fit the query conditions. Populated only if `return_entries` was set to `true` in the request. | [optional] +**orders** | [**List<Order>**](Order.md) | List of `Order` objects that match query conditions. Populated only if `return_entries` in the request is set to `false`. | [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] +**errors** | [**List<Error>**](Error.md) | `Errors` encountered during the search. | [optional] diff --git a/docs/SearchOrdersSort.md b/docs/SearchOrdersSort.md index 7cc7912..d9f20a0 100644 --- a/docs/SearchOrdersSort.md +++ b/docs/SearchOrdersSort.md @@ -8,7 +8,7 @@ Sorting criteria for a SearchOrders request. Results can only be sorted by a tim ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sortField** | **String** | The field to sort by. __Important:__ When using a [DateTimeFilter](#type-searchordersfilter), `sort_field` must match the timestamp field that the DateTimeFilter uses to filter. For example, If you set your `sort_field` to `CLOSED_AT` and you use a DateTimeFilter, your DateTimeFilter must filter for orders by their `CLOSED_AT` date. If this field does not match the timestamp field in `DateTimeFilter`, SearchOrders will return an error. Default: `CREATED_AT`. See [SearchOrdersSortField](#type-searchorderssortfield) for possible values | +**sortField** | **String** | The field to sort by. __Important:__ When using a `DateTimeFilter`, `sort_field` must match the timestamp field that the DateTimeFilter uses to filter. For example, If you set your `sort_field` to `CLOSED_AT` and you use a DateTimeFilter, your DateTimeFilter must filter for orders by their `CLOSED_AT` date. If this field does not match the timestamp field in `DateTimeFilter`, SearchOrders will return an error. Default: `CREATED_AT`. See [SearchOrdersSortField](#type-searchorderssortfield) for possible values | **sortOrder** | **String** | The chronological order in which results are returned. Defaults to `DESC`. See [SortOrder](#type-sortorder) for possible values | [optional] diff --git a/docs/SearchOrdersSourceFilter.md b/docs/SearchOrdersSourceFilter.md index c36898c..9d3f54d 100644 --- a/docs/SearchOrdersSourceFilter.md +++ b/docs/SearchOrdersSourceFilter.md @@ -8,7 +8,7 @@ Filter based on order `source` information. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sourceNames** | **List<String>** | Filters by [Source](#type-ordersource) `name`. Will return any orders with with a `source.name` that matches any of the listed source names. Max: 10 source names. | [optional] +**sourceNames** | **List<String>** | Filters by `Source` `name`. Will return any orders with with a `source.name` that matches any of the listed source names. Max: 10 source names. | [optional] diff --git a/docs/SourceApplication.md b/docs/SourceApplication.md index 27e5d57..af794f8 100644 --- a/docs/SourceApplication.md +++ b/docs/SourceApplication.md @@ -8,8 +8,8 @@ Provides information about the application used to generate an inventory change. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**product** | **String** | Read-only [Product](#type-product) type for the application. See [Product](#type-product) for possible values | [optional] -**applicationId** | **String** | Read-only Square ID assigned to the application. Only used for [Product](#type-product) type `EXTERNAL_API`. | [optional] +**product** | **String** | Read-only `Product` type for the application. See [Product](#type-product) for possible values | [optional] +**applicationId** | **String** | Read-only Square ID assigned to the application. Only used for `Product` type `EXTERNAL_API`. | [optional] **name** | **String** | Read-only display name assigned to the application (e.g. `\"Custom Application\"`, `\"Square POS 4.74 for Android\"`). | [optional] diff --git a/docs/Tender.md b/docs/Tender.md index b4b0c6f..d14c4ed 100644 --- a/docs/Tender.md +++ b/docs/Tender.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **transactionId** | **String** | The ID of the tender's associated transaction. | [optional] **createdAt** | **String** | The time when the tender was created, in RFC 3339 format. | [optional] **note** | **String** | An optional note associated with the tender at the time of payment. | [optional] -**amountMoney** | [**Money**](Money.md) | The total amount of the tender, including `tip_money`. If the tender has a `payment_id`, the `total_money` of the corresponding [Payment](#type-payment) will be equal to the `amount_money` of the tender. | [optional] +**amountMoney** | [**Money**](Money.md) | The total amount of the tender, including `tip_money`. If the tender has a `payment_id`, the `total_money` of the corresponding `Payment` will be equal to the `amount_money` of the tender. | [optional] **tipMoney** | [**Money**](Money.md) | The tip's amount of the tender. | [optional] **processingFeeMoney** | [**Money**](Money.md) | The amount of any Square processing fees applied to the tender. This field is not immediately populated when a new transaction is created. It is usually available after about ten seconds. | [optional] **customerId** | **String** | If the tender is associated with a customer or represents a customer's card on file, this is the ID of the associated customer. | [optional] @@ -21,7 +21,7 @@ Name | Type | Description | Notes **cardDetails** | [**TenderCardDetails**](TenderCardDetails.md) | The details of the card tender. This value is present only if the value of `type` is `CARD`. | [optional] **cashDetails** | [**TenderCashDetails**](TenderCashDetails.md) | The details of the cash tender. This value is present only if the value of `type` is `CASH`. | [optional] **additionalRecipients** | [**List<AdditionalRecipient>**](AdditionalRecipient.md) | Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration. | [optional] -**paymentId** | **String** | The ID of the [Payment](#type-payment) that corresponds to this tender. This value is only present for payments created with the v2 Payments API. | [optional] +**paymentId** | **String** | The ID of the `Payment` that corresponds to this tender. This value is only present for payments created with the v2 Payments API. | [optional] diff --git a/docs/Transaction.md b/docs/Transaction.md index 66a3149..35634ea 100644 --- a/docs/Transaction.md +++ b/docs/Transaction.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **createdAt** | **String** | The time when the transaction was created, in RFC 3339 format. | [optional] **tenders** | [**List<Tender>**](Tender.md) | The tenders used to pay in the transaction. | [optional] **refunds** | [**List<Refund>**](Refund.md) | Refunds that have been applied to any tender in the transaction. | [optional] -**referenceId** | **String** | If the transaction was created with the [Charge](#endpoint-transactions-charge) endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set. | [optional] +**referenceId** | **String** | If the transaction was created with the `Charge` endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set. | [optional] **product** | **String** | The Square product that processed the transaction. See [TransactionProduct](#type-transactionproduct) for possible values | [optional] **clientId** | **String** | If the transaction was created in the Square Point of Sale app, this value is the ID generated for the transaction by Square Point of Sale. This ID has no relationship to the transaction's canonical `id`, which is generated by Square's backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode). It is not currently possible with the Connect API to perform a transaction lookup by this value. | [optional] **shippingAddress** | [**Address**](Address.md) | The shipping address provided in the request, if any. | [optional] diff --git a/docs/TransactionsApi.md b/docs/TransactionsApi.md index 0f4f467..d89d1b2 100644 --- a/docs/TransactionsApi.md +++ b/docs/TransactionsApi.md @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] ### Return type diff --git a/docs/UpdateItemModifierListsRequest.md b/docs/UpdateItemModifierListsRequest.md index e315ce4..fd0a2c7 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](#type-catalogmodifierlist)s are being updated. | -**modifierListsToEnable** | **List<String>** | The set of [CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem](#type-catalogitem). | [optional] -**modifierListsToDisable** | **List<String>** | The set of [CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem](#type-catalogitem). | [optional] +**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] diff --git a/docs/UpdateItemModifierListsResponse.md b/docs/UpdateItemModifierListsResponse.md index b82c97b..34cfdf1 100644 --- a/docs/UpdateItemModifierListsResponse.md +++ b/docs/UpdateItemModifierListsResponse.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] +**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] diff --git a/docs/UpdateItemTaxesRequest.md b/docs/UpdateItemTaxesRequest.md index dccdcf1..f92a7e9 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](#type-catalogtax)es are being updated. | -**taxesToEnable** | **List<String>** | The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem](#type-catalogitem). | [optional] -**taxesToDisable** | **List<String>** | The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem](#type-catalogitem). | [optional] +**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] diff --git a/docs/UpdateItemTaxesResponse.md b/docs/UpdateItemTaxesResponse.md index a83ea34..418e649 100644 --- a/docs/UpdateItemTaxesResponse.md +++ b/docs/UpdateItemTaxesResponse.md @@ -8,7 +8,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] +**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] diff --git a/docs/UpdateLocationRequest.md b/docs/UpdateLocationRequest.md new file mode 100644 index 0000000..3f834dd --- /dev/null +++ b/docs/UpdateLocationRequest.md @@ -0,0 +1,14 @@ + +# UpdateLocationRequest + +### Description + +Request object for the [UpdateLocation](#endpoint-updatelocation) endpoint. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location** | [**Location**](Location.md) | The `Location` object with only the fields to update. | [optional] + + + diff --git a/docs/UpdateLocationResponse.md b/docs/UpdateLocationResponse.md new file mode 100644 index 0000000..336d889 --- /dev/null +++ b/docs/UpdateLocationResponse.md @@ -0,0 +1,15 @@ + +# UpdateLocationResponse + +### Description + +Response object returned by the [UpdateLocation](#endpoint-updatelocation) endpoint. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] +**location** | [**Location**](Location.md) | The updated `Location`. | [optional] + + + diff --git a/docs/UpdateOrderRequest.md b/docs/UpdateOrderRequest.md index d29d86e..cfba26e 100644 --- a/docs/UpdateOrderRequest.md +++ b/docs/UpdateOrderRequest.md @@ -8,9 +8,9 @@ Defines the fields that are included in requests to the [UpdateOrder](#endpoint- ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order** | [**Order**](Order.md) | The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. | [optional] -**fieldsToClear** | **List<String>** | The [dot notation paths](/orders-api/manage-orders#on-dot-notation) fields to clear. For example, `line_items[uid].note` [Read more about Deleting fields](/orders-api/manage-orders#delete-fields). | [optional] -**idempotencyKey** | **String** | A value you specify that uniquely identifies this update request If you're unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version will be returned. See [Idempotency](/basics/api101/idempotency) for more information. | [optional] +**order** | [**Order**](Order.md) | The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. | [optional] +**fieldsToClear** | **List<String>** | The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation) fields to clear. For example, `line_items[uid].note` [Read more about Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders#delete-fields). | [optional] +**idempotencyKey** | **String** | A value you specify that uniquely identifies this update request If you're unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version will be returned. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | [optional] diff --git a/docs/UpsertCatalogObjectRequest.md b/docs/UpsertCatalogObjectRequest.md index 3bcd665..08d4571 100644 --- a/docs/UpsertCatalogObjectRequest.md +++ b/docs/UpsertCatalogObjectRequest.md @@ -8,8 +8,8 @@ ## Properties 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](/basics/api101/idempotency) for more information. | -**object** | [**CatalogObject**](CatalogObject.md) | A [CatalogObject](#type-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. | +**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. | diff --git a/docs/UpsertCatalogObjectResponse.md b/docs/UpsertCatalogObjectResponse.md index c3004bb..6726a3e 100644 --- a/docs/UpsertCatalogObjectResponse.md +++ b/docs/UpsertCatalogObjectResponse.md @@ -8,8 +8,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**List<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] -**catalogObject** | [**CatalogObject**](CatalogObject.md) | The created [CatalogObject](#type-catalogobject). | [optional] +**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] diff --git a/pom.xml b/pom.xml index 6de600c..a7ad0e8 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ connect jar connect - 2.20190814.2 + 2.20190925.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 fa5f9f3..cd75f0b 100644 --- a/src/main/java/com/squareup/connect/ApiClient.java +++ b/src/main/java/com/squareup/connect/ApiClient.java @@ -73,7 +73,7 @@ public ApiClient() { this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("Square-Connect-Java/2.20190814.2"); + setUserAgent("Square-Connect-Java/2.20190925.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 9404f59..a46585b 100644 --- a/src/main/java/com/squareup/connect/api/ApplePayApi.java +++ b/src/main/java/com/squareup/connect/api/ApplePayApi.java @@ -57,7 +57,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/CatalogApi.java b/src/main/java/com/squareup/connect/api/CatalogApi.java index 3741ee3..83eda20 100644 --- a/src/main/java/com/squareup/connect/api/CatalogApi.java +++ b/src/main/java/com/squareup/connect/api/CatalogApi.java @@ -73,7 +73,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -156,7 +156,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -239,7 +239,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -316,7 +316,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -375,7 +375,7 @@ public void setApiClient(ApiClient apiClient) { /** * 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](#type-catalogobject) to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). (required) + * @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) * @return DeleteCatalogObjectResponse * @throws ApiException if fails to make API call */ public DeleteCatalogObjectResponse deleteCatalogObject(String objectId) throws ApiException { @@ -394,7 +394,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -418,7 +418,7 @@ public void setApiClient(ApiClient apiClient) { /** * 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](#type-catalogobject) to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). (required) + * @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) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -460,8 +460,8 @@ public void setApiClient(ApiClient apiClient) { /** * 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`. __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](/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](#type-catalogobjecttype) enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) + * @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) * @return ListCatalogResponse * @throws ApiException if fails to make API call */ public ListCatalogResponse listCatalog(String cursor, String types) throws ApiException { @@ -474,7 +474,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "types", types)); @@ -500,8 +500,8 @@ public void setApiClient(ApiClient apiClient) { /** * 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`. __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](/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](#type-catalogobjecttype) enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) + * @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) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -539,8 +539,8 @@ public void setApiClient(ApiClient apiClient) { /** * 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](#type-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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. Default value: `false` (optional) + * @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) * @return RetrieveCatalogObjectResponse * @throws ApiException if fails to make API call */ public RetrieveCatalogObjectResponse retrieveCatalogObject(String objectId, Boolean includeRelatedObjects) throws ApiException { @@ -559,7 +559,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "include_related_objects", includeRelatedObjects)); @@ -584,8 +584,8 @@ public void setApiClient(ApiClient apiClient) { /** * 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](#type-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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. Default value: `false` (optional) + * @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) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -646,7 +646,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -729,7 +729,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -812,7 +812,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -895,7 +895,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/CheckoutApi.java b/src/main/java/com/squareup/connect/api/CheckoutApi.java index 5d9dcba..e2c6e16 100644 --- a/src/main/java/com/squareup/connect/api/CheckoutApi.java +++ b/src/main/java/com/squareup/connect/api/CheckoutApi.java @@ -64,7 +64,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/CustomersApi.java b/src/main/java/com/squareup/connect/api/CustomersApi.java index 0bfb86f..80a2f0a 100644 --- a/src/main/java/com/squareup/connect/api/CustomersApi.java +++ b/src/main/java/com/squareup/connect/api/CustomersApi.java @@ -67,7 +67,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -157,7 +157,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -248,7 +248,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -340,7 +340,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -413,7 +413,7 @@ public void setApiClient(ApiClient apiClient) { /** * 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](/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 [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) * @return ListCustomersResponse @@ -428,7 +428,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_field", sortField)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -455,7 +455,7 @@ public void setApiClient(ApiClient apiClient) { /** * 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](/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 [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) * @return CompleteResponse @@ -515,7 +515,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -599,7 +599,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -689,7 +689,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/EmployeesApi.java b/src/main/java/com/squareup/connect/api/EmployeesApi.java index 026cb92..e18d2d4 100644 --- a/src/main/java/com/squareup/connect/api/EmployeesApi.java +++ b/src/main/java/com/squareup/connect/api/EmployeesApi.java @@ -55,7 +55,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_id", locationId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "status", status)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); @@ -145,7 +145,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/InventoryApi.java b/src/main/java/com/squareup/connect/api/InventoryApi.java index 5d9eb5b..76dd434 100644 --- a/src/main/java/com/squareup/connect/api/InventoryApi.java +++ b/src/main/java/com/squareup/connect/api/InventoryApi.java @@ -65,7 +65,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -148,7 +148,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -231,7 +231,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -296,7 +296,7 @@ public void setApiClient(ApiClient apiClient) { /** * RetrieveInventoryAdjustment * Returns the [InventoryAdjustment](#type-inventoryadjustment) object with the provided `adjustment_id`. - * @param adjustmentId ID of the [InventoryAdjustment](#type-inventoryadjustment) to retrieve. (required) + * @param adjustmentId ID of the `InventoryAdjustment` to retrieve. (required) * @return RetrieveInventoryAdjustmentResponse * @throws ApiException if fails to make API call */ public RetrieveInventoryAdjustmentResponse retrieveInventoryAdjustment(String adjustmentId) throws ApiException { @@ -315,7 +315,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -339,7 +339,7 @@ public void setApiClient(ApiClient apiClient) { /** * RetrieveInventoryAdjustment * Returns the [InventoryAdjustment](#type-inventoryadjustment) object with the provided `adjustment_id`. - * @param adjustmentId ID of the [InventoryAdjustment](#type-inventoryadjustment) to retrieve. (required) + * @param adjustmentId ID of the `InventoryAdjustment` to retrieve. (required) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -381,9 +381,9 @@ public void setApiClient(ApiClient apiClient) { /** * RetrieveInventoryChanges * 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](#type-catalogobject) to retrieve. (required) - * @param locationIds The [Location](#type-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](/basics/api101/pagination) for more information. (optional) + * @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) * @return RetrieveInventoryChangesResponse * @throws ApiException if fails to make API call */ public RetrieveInventoryChangesResponse retrieveInventoryChanges(String catalogObjectId, String locationIds, String cursor) throws ApiException { @@ -402,7 +402,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_ids", locationIds)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -428,9 +428,9 @@ public void setApiClient(ApiClient apiClient) { /** * RetrieveInventoryChanges * 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](#type-catalogobject) to retrieve. (required) - * @param locationIds The [Location](#type-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](/basics/api101/pagination) for more information. (optional) + * @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) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -474,9 +474,9 @@ public void setApiClient(ApiClient apiClient) { /** * RetrieveInventoryCount * 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](#type-catalogobject) to retrieve. (required) - * @param locationIds The [Location](#type-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](/basics/api101/pagination) for more information. (optional) + * @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) * @return RetrieveInventoryCountResponse * @throws ApiException if fails to make API call */ public RetrieveInventoryCountResponse retrieveInventoryCount(String catalogObjectId, String locationIds, String cursor) throws ApiException { @@ -495,7 +495,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_ids", locationIds)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -521,9 +521,9 @@ public void setApiClient(ApiClient apiClient) { /** * RetrieveInventoryCount * 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](#type-catalogobject) to retrieve. (required) - * @param locationIds The [Location](#type-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](/basics/api101/pagination) for more information. (optional) + * @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) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -567,7 +567,7 @@ public void setApiClient(ApiClient apiClient) { /** * RetrieveInventoryPhysicalCount * Returns the [InventoryPhysicalCount](#type-inventoryphysicalcount) object with the provided `physical_count_id`. - * @param physicalCountId ID of the [InventoryPhysicalCount](#type-inventoryphysicalcount) to retrieve. (required) + * @param physicalCountId ID of the `InventoryPhysicalCount` to retrieve. (required) * @return RetrieveInventoryPhysicalCountResponse * @throws ApiException if fails to make API call */ public RetrieveInventoryPhysicalCountResponse retrieveInventoryPhysicalCount(String physicalCountId) throws ApiException { @@ -586,7 +586,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -610,7 +610,7 @@ public void setApiClient(ApiClient apiClient) { /** * RetrieveInventoryPhysicalCount * Returns the [InventoryPhysicalCount](#type-inventoryphysicalcount) object with the provided `physical_count_id`. - * @param physicalCountId ID of the [InventoryPhysicalCount](#type-inventoryphysicalcount) to retrieve. (required) + * @param physicalCountId ID of the `InventoryPhysicalCount` to retrieve. (required) * @return CompleteResponse * @throws ApiException if fails to make API call */ diff --git a/src/main/java/com/squareup/connect/api/LaborApi.java b/src/main/java/com/squareup/connect/api/LaborApi.java index df7a4bf..ce41421 100644 --- a/src/main/java/com/squareup/connect/api/LaborApi.java +++ b/src/main/java/com/squareup/connect/api/LaborApi.java @@ -75,7 +75,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -158,7 +158,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -242,7 +242,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -327,7 +327,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -412,7 +412,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -497,7 +497,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -582,7 +582,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -663,7 +663,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "location_id", locationId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -746,7 +746,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "employee_id", employeeId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -828,7 +828,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "cursor", cursor)); @@ -911,7 +911,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1001,7 +1001,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1098,7 +1098,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1195,7 +1195,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/LocationsApi.java b/src/main/java/com/squareup/connect/api/LocationsApi.java index 9881ce9..238f4f3 100644 --- a/src/main/java/com/squareup/connect/api/LocationsApi.java +++ b/src/main/java/com/squareup/connect/api/LocationsApi.java @@ -9,6 +9,9 @@ import javax.ws.rs.core.GenericType; import com.squareup.connect.models.ListLocationsResponse; +import com.squareup.connect.models.RetrieveLocationResponse; +import com.squareup.connect.models.UpdateLocationRequest; +import com.squareup.connect.models.UpdateLocationResponse; import java.util.ArrayList; import java.util.HashMap; @@ -50,7 +53,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -106,4 +109,186 @@ public void setApiClient(ApiClient apiClient) { GenericType localVarReturnType = new GenericType() {}; return (CompleteResponse)apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); } + /** + * RetrieveLocation + * Retrieves details of a location. + * @param locationId The ID of the location to retrieve. (required) + * @return RetrieveLocationResponse + * @throws ApiException if fails to make API call + */ public RetrieveLocationResponse retrieveLocation(String locationId) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'locationId' is set + if (locationId == null) { + throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrieveLocation"); + } + + // create path and map variables + String localVarPath = "/v2/locations/{location_id}" + .replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString())); + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarFormParams = new HashMap(); + localVarHeaderParams.put("Square-Version", "2019-09-25"); + + + + 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, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + return completeResponse.getData(); + } + + /** + * RetrieveLocation + * Retrieves details of a location. + * @param locationId The ID of the location to retrieve. (required) + * @return CompleteResponse + * @throws ApiException if fails to make API call + */ + public CompleteResponseretrieveLocationWithHttpInfo(String locationId) throws ApiException { + Object localVarPostBody = null; + + // verify the required parameter 'locationId' is set + if (locationId == null) { + throw new ApiException(400, "Missing the required parameter 'locationId' when calling retrieveLocation"); + } + + // create path and map variables + String localVarPath = "/v2/locations/{location_id}" + .replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString())); + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + + + + 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, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + } + /** + * UpdateLocation + * Updates the `Location` specified by the given ID. + * @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 UpdateLocationResponse + * @throws ApiException if fails to make API call + */ public UpdateLocationResponse updateLocation(String locationId, UpdateLocationRequest body) throws ApiException { + Object localVarPostBody = body; + + // verify the required parameter 'locationId' is set + if (locationId == null) { + throw new ApiException(400, "Missing the required parameter 'locationId' when calling updateLocation"); + } + + // verify the required parameter 'body' is set + if (body == null) { + throw new ApiException(400, "Missing the required parameter 'body' when calling updateLocation"); + } + + // create path and map variables + String localVarPath = "/v2/locations/{location_id}" + .replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString())); + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarFormParams = new HashMap(); + localVarHeaderParams.put("Square-Version", "2019-09-25"); + + + + 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, "PUT", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + return completeResponse.getData(); + } + + /** + * UpdateLocation + * Updates the `Location` specified by the given ID. + * @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 + * @throws ApiException if fails to make API call + */ + public CompleteResponseupdateLocationWithHttpInfo(String locationId, UpdateLocationRequest body) throws ApiException { + Object localVarPostBody = body; + + // verify the required parameter 'locationId' is set + if (locationId == null) { + throw new ApiException(400, "Missing the required parameter 'locationId' when calling updateLocation"); + } + + // verify the required parameter 'body' is set + if (body == null) { + throw new ApiException(400, "Missing the required parameter 'body' when calling updateLocation"); + } + + // create path and map variables + String localVarPath = "/v2/locations/{location_id}" + .replaceAll("\\{" + "location_id" + "\\}", apiClient.escapeString(locationId.toString())); + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + + + + 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, "PUT", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + } } diff --git a/src/main/java/com/squareup/connect/api/MerchantsApi.java b/src/main/java/com/squareup/connect/api/MerchantsApi.java new file mode 100644 index 0000000..3e4db7f --- /dev/null +++ b/src/main/java/com/squareup/connect/api/MerchantsApi.java @@ -0,0 +1,123 @@ +package com.squareup.connect.api; + +import com.squareup.connect.ApiException; +import com.squareup.connect.ApiClient; +import com.squareup.connect.Configuration; +import com.squareup.connect.Pair; +import com.squareup.connect.CompleteResponse; + +import javax.ws.rs.core.GenericType; + +import com.squareup.connect.models.RetrieveMerchantResponse; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + + +public class MerchantsApi { + private ApiClient apiClient; + + public MerchantsApi() { + this(Configuration.getDefaultApiClient()); + } + + public MerchantsApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + public ApiClient getApiClient() { + return apiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * RetrieveMerchant + * Retrieve a `Merchant` object for the given `merchant_id`. + * @param merchantId The ID of the merchant to retrieve (required) + * @return RetrieveMerchantResponse + * @throws ApiException if fails to make API call + */ 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())); + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarFormParams = new HashMap(); + localVarHeaderParams.put("Square-Version", "2019-09-25"); + + + + 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, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + return completeResponse.getData(); + } + + /** + * RetrieveMerchant + * Retrieve a `Merchant` object for the given `merchant_id`. + * @param merchantId The ID of the merchant to retrieve (required) + * @return CompleteResponse + * @throws ApiException if fails to make API call + */ + 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())); + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + + + + 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, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + } +} diff --git a/src/main/java/com/squareup/connect/api/MobileAuthorizationApi.java b/src/main/java/com/squareup/connect/api/MobileAuthorizationApi.java index e467ac6..dc7b8be 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](https://docs.connect.squareup.com/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](/get-started#step-4-understand-the-different-application-credentials). * @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 @@ -57,7 +57,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -80,7 +80,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](https://docs.connect.squareup.com/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](/get-started#step-4-understand-the-different-application-credentials). * @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 diff --git a/src/main/java/com/squareup/connect/api/OAuthApi.java b/src/main/java/com/squareup/connect/api/OAuthApi.java index 683fc49..0abe24b 100644 --- a/src/main/java/com/squareup/connect/api/OAuthApi.java +++ b/src/main/java/com/squareup/connect/api/OAuthApi.java @@ -61,7 +61,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -153,7 +153,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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -243,7 +243,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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/OrdersApi.java b/src/main/java/com/squareup/connect/api/OrdersApi.java index af0b1f8..5264384 100644 --- a/src/main/java/com/squareup/connect/api/OrdersApi.java +++ b/src/main/java/com/squareup/connect/api/OrdersApi.java @@ -72,7 +72,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -169,7 +169,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -266,7 +266,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -356,7 +356,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -453,7 +453,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/PaymentsApi.java b/src/main/java/com/squareup/connect/api/PaymentsApi.java index 078d46e..4f9b77b 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 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 @@ -64,7 +64,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -87,7 +87,7 @@ public void setApiClient(ApiClient apiClient) { /** * CancelPayment - * Cancels 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 @@ -129,7 +129,7 @@ public void setApiClient(ApiClient apiClient) { } /** * CancelPaymentByIdempotencyKey - * Cancels a payment identified by the idenpotency key that is specified 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 @@ -148,7 +148,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -171,7 +171,7 @@ public void setApiClient(ApiClient apiClient) { /** * CancelPaymentByIdempotencyKey - * Cancels a payment identified by the idenpotency key that is specified 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 @@ -212,7 +212,7 @@ public void setApiClient(ApiClient apiClient) { } /** * CompletePayment - * Completes a payment. By default, payments are set to complete immediately after they are created. If you set autocomplete to false when creating a payment, you can complete the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + * Completes (captures) a payment. By default, payments are set to complete immediately after they are created. If you set autocomplete to false when creating a payment, you can complete (capture) the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). * @param paymentId Unique ID identifying the payment to be completed. (required) * @return CompletePaymentResponse * @throws ApiException if fails to make API call @@ -232,7 +232,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -255,7 +255,7 @@ public void setApiClient(ApiClient apiClient) { /** * CompletePayment - * Completes a payment. By default, payments are set to complete immediately after they are created. If you set autocomplete to false when creating a payment, you can complete the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + * Completes (captures) a payment. By default, payments are set to complete immediately after they are created. If you set autocomplete to false when creating a payment, you can complete (capture) the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). * @param paymentId Unique ID identifying the payment to be completed. (required) * @return CompleteResponse * @throws ApiException if fails to make API call @@ -316,7 +316,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -400,7 +400,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -469,7 +469,7 @@ public void setApiClient(ApiClient apiClient) { * @param beginTime Timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year. (optional) * @param endTime Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. (optional) * @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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) * @param locationId ID of location associated with payment (optional) * @param total The exact amount in the total_money for a `Payment`. (optional) * @param last4 The last 4 digits of `Payment` card. (optional) @@ -486,7 +486,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -521,7 +521,7 @@ public void setApiClient(ApiClient apiClient) { * @param beginTime Timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year. (optional) * @param endTime Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. (optional) * @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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) * @param locationId ID of location associated with payment (optional) * @param total The exact amount in the total_money for a `Payment`. (optional) * @param last4 The last 4 digits of `Payment` card. (optional) diff --git a/src/main/java/com/squareup/connect/api/RefundsApi.java b/src/main/java/com/squareup/connect/api/RefundsApi.java index d676a56..78e6135 100644 --- a/src/main/java/com/squareup/connect/api/RefundsApi.java +++ b/src/main/java/com/squareup/connect/api/RefundsApi.java @@ -60,7 +60,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -129,9 +129,9 @@ public void setApiClient(ApiClient apiClient) { * @param beginTime Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. (optional) * @param endTime Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. (optional) * @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](/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 [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](#type-paymentrefund). Default: If omitted refunds are returned regardless of status. (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 @@ -145,7 +145,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_order", sortOrder)); @@ -179,9 +179,9 @@ public void setApiClient(ApiClient apiClient) { * @param beginTime Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. (optional) * @param endTime Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. (optional) * @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](/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 [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](#type-paymentrefund). Default: If omitted refunds are returned regardless of status. (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 @@ -243,7 +243,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/ReportingApi.java b/src/main/java/com/squareup/connect/api/ReportingApi.java index dd98133..4a9022f 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ diff --git a/src/main/java/com/squareup/connect/api/TransactionsApi.java b/src/main/java/com/squareup/connect/api/TransactionsApi.java index be5e853..29230b0 100644 --- a/src/main/java/com/squareup/connect/api/TransactionsApi.java +++ b/src/main/java/com/squareup/connect/api/TransactionsApi.java @@ -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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. (optional) * @return CompleteResponse * @throws ApiException if fails to make API call */ @@ -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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -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-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/V1EmployeesApi.java b/src/main/java/com/squareup/connect/api/V1EmployeesApi.java index e5fe0d0..94d093d 100644 --- a/src/main/java/com/squareup/connect/api/V1EmployeesApi.java +++ b/src/main/java/com/squareup/connect/api/V1EmployeesApi.java @@ -60,7 +60,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -143,7 +143,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -226,7 +226,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -310,7 +310,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -398,7 +398,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -488,7 +488,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -577,7 +577,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_updated_at", beginUpdatedAt)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_updated_at", endUpdatedAt)); @@ -682,7 +682,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -771,7 +771,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "employee_id", employeeId)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_clockin_time", beginClockinTime)); @@ -889,7 +889,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -981,7 +981,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1066,7 +1066,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1151,7 +1151,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1242,7 +1242,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1339,7 +1339,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1436,7 +1436,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/V1ItemsApi.java b/src/main/java/com/squareup/connect/api/V1ItemsApi.java index f98fb35..6a633d5 100644 --- a/src/main/java/com/squareup/connect/api/V1ItemsApi.java +++ b/src/main/java/com/squareup/connect/api/V1ItemsApi.java @@ -81,7 +81,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -193,7 +193,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -306,7 +306,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -411,7 +411,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -508,7 +508,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -605,7 +605,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -702,7 +702,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -799,7 +799,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -903,7 +903,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1007,7 +1007,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1111,7 +1111,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1216,7 +1216,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1315,7 +1315,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1414,7 +1414,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1513,7 +1513,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1612,7 +1612,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1718,7 +1718,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1824,7 +1824,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1925,7 +1925,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "row", row)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "column", column)); @@ -2037,7 +2037,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -2136,7 +2136,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -2221,7 +2221,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -2306,7 +2306,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -2393,7 +2393,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -2485,7 +2485,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -2573,7 +2573,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -2658,7 +2658,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -2757,7 +2757,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -2870,7 +2870,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -2976,7 +2976,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -3075,7 +3075,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -3180,7 +3180,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -3291,7 +3291,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -3402,7 +3402,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -3513,7 +3513,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -3624,7 +3624,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -3742,7 +3742,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -3860,7 +3860,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -3971,7 +3971,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -4089,7 +4089,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/V1LocationsApi.java b/src/main/java/com/squareup/connect/api/V1LocationsApi.java index 7174912..e7c4bc4 100644 --- a/src/main/java/com/squareup/connect/api/V1LocationsApi.java +++ b/src/main/java/com/squareup/connect/api/V1LocationsApi.java @@ -50,7 +50,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -121,7 +121,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/api/V1TransactionsApi.java b/src/main/java/com/squareup/connect/api/V1TransactionsApi.java index a96cb29..1d2e06b 100644 --- a/src/main/java/com/squareup/connect/api/V1TransactionsApi.java +++ b/src/main/java/com/squareup/connect/api/V1TransactionsApi.java @@ -69,7 +69,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -160,7 +160,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -248,7 +248,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "batch_token", batchToken)); @@ -348,7 +348,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -456,7 +456,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -562,7 +562,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); localVarQueryParams.addAll(apiClient.parameterToPairs("", "order", order)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "begin_time", beginTime)); localVarQueryParams.addAll(apiClient.parameterToPairs("", "end_time", endTime)); @@ -672,7 +672,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -771,7 +771,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -870,7 +870,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -969,7 +969,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); @@ -1074,7 +1074,7 @@ public void setApiClient(ApiClient apiClient) { List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarFormParams = new HashMap(); - localVarHeaderParams.put("Square-Version", "2019-08-14"); + localVarHeaderParams.put("Square-Version", "2019-09-25"); diff --git a/src/main/java/com/squareup/connect/models/AdditionalRecipient.java b/src/main/java/com/squareup/connect/models/AdditionalRecipient.java index 65b9a8d..bf1e49a 100644 --- a/src/main/java/com/squareup/connect/models/AdditionalRecipient.java +++ b/src/main/java/com/squareup/connect/models/AdditionalRecipient.java @@ -99,10 +99,10 @@ public AdditionalRecipient receivableId(String receivableId) { } /** - * The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. + * The unique ID for this `AdditionalRecipientReceivable`, assigned by the server. * @return receivableId **/ - @ApiModelProperty(value = "The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server.") + @ApiModelProperty(value = "The unique ID for this `AdditionalRecipientReceivable`, assigned by the server.") public String getReceivableId() { return receivableId; } diff --git a/src/main/java/com/squareup/connect/models/BatchChangeInventoryRequest.java b/src/main/java/com/squareup/connect/models/BatchChangeInventoryRequest.java index 44f510d..687dac2 100644 --- a/src/main/java/com/squareup/connect/models/BatchChangeInventoryRequest.java +++ b/src/main/java/com/squareup/connect/models/BatchChangeInventoryRequest.java @@ -44,10 +44,10 @@ public BatchChangeInventoryRequest idempotencyKey(String idempotencyKey) { } /** - * A client-supplied, universally unique identifier (UUID) for the request. See [Idempotency](/basics/api101/idempotency) in the [API Development 101](/basics/api101/overview) section for more information. + * A client-supplied, universally unique identifier (UUID) for the request. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more information. * @return idempotencyKey **/ - @ApiModelProperty(value = "A client-supplied, universally unique identifier (UUID) for the request. See [Idempotency](/basics/api101/idempotency) in the [API Development 101](/basics/api101/overview) section for more information.") + @ApiModelProperty(value = "A client-supplied, universally unique identifier (UUID) for the request. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more information.") public String getIdempotencyKey() { return idempotencyKey; } diff --git a/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsRequest.java b/src/main/java/com/squareup/connect/models/BatchDeleteCatalogObjectsRequest.java index d705282..a127dc5 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](#type-catalogobject)s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). + * 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`. * @return objectIds **/ - @ApiModelProperty(value = "The IDs of the [CatalogObject](#type-catalogobject)s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s).") + @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`.") 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 bcbe773..8657ac7 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](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } @@ -72,10 +72,10 @@ public BatchDeleteCatalogObjectsResponse addDeletedObjectIdsItem(String deletedO } /** - * The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. + * The IDs of all `CatalogObject`s deleted by this request. * @return deletedObjectIds **/ - @ApiModelProperty(value = "The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request.") + @ApiModelProperty(value = "The IDs of all `CatalogObject`s deleted by this request.") public List getDeletedObjectIds() { return deletedObjectIds; } diff --git a/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsRequest.java b/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsRequest.java index 4dfbd76..b35ff75 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](#type-catalogobject)s to be retrieved. + * The IDs of the `CatalogObject`s to be retrieved. * @return objectIds **/ - @ApiModelProperty(required = true, value = "The IDs of the [CatalogObject](#type-catalogobject)s to be retrieved.") + @ApiModelProperty(required = true, value = "The IDs of the `CatalogObject`s 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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. + * 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. * @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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response.") + @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.") public Boolean getIncludeRelatedObjects() { return includeRelatedObjects; } diff --git a/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsResponse.java b/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsResponse.java index ce91f5c..72487fb 100644 --- a/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsResponse.java +++ b/src/main/java/com/squareup/connect/models/BatchRetrieveCatalogObjectsResponse.java @@ -50,10 +50,10 @@ public BatchRetrieveCatalogObjectsResponse addErrorsItem(Error errorsItem) { } /** - * The set of [Error](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } @@ -73,10 +73,10 @@ public BatchRetrieveCatalogObjectsResponse addObjectsItem(CatalogObject objectsI } /** - * A list of [CatalogObject](#type-catalogobject)s returned. + * A list of `CatalogObject`s returned. * @return objects **/ - @ApiModelProperty(value = "A list of [CatalogObject](#type-catalogobject)s returned.") + @ApiModelProperty(value = "A list of `CatalogObject`s returned.") public List getObjects() { return objects; } @@ -96,10 +96,10 @@ public BatchRetrieveCatalogObjectsResponse addRelatedObjectsItem(CatalogObject r } /** - * A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `objects` field. + * A list of `CatalogObject`s referenced by the object in the `objects` field. * @return relatedObjects **/ - @ApiModelProperty(value = "A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `objects` field.") + @ApiModelProperty(value = "A list of `CatalogObject`s referenced by the object in the `objects` field.") public List getRelatedObjects() { return relatedObjects; } diff --git a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesRequest.java b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesRequest.java index 63a6140..92b8519 100644 --- a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesRequest.java +++ b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryChangesRequest.java @@ -60,10 +60,10 @@ public BatchRetrieveInventoryChangesRequest addCatalogObjectIdsItem(String catal } /** - * Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. + * Filters results by `CatalogObject` ID. Only applied when set. Default: unset. * @return catalogObjectIds **/ - @ApiModelProperty(value = "Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset.") + @ApiModelProperty(value = "Filters results by `CatalogObject` ID. Only applied when set. Default: unset.") public List getCatalogObjectIds() { return catalogObjectIds; } @@ -83,10 +83,10 @@ public BatchRetrieveInventoryChangesRequest addLocationIdsItem(String locationId } /** - * Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. + * Filters results by `Location` ID. Only applied when set. Default: unset. * @return locationIds **/ - @ApiModelProperty(value = "Filters results by [Location](#type-location) ID. Only applied when set. Default: unset.") + @ApiModelProperty(value = "Filters results by `Location` ID. Only applied when set. Default: unset.") public List getLocationIds() { return locationIds; } @@ -106,10 +106,10 @@ public BatchRetrieveInventoryChangesRequest addTypesItem(String typesItem) { } /** - * Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values + * Filters results by `InventoryChangeType`. Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values * @return types **/ - @ApiModelProperty(value = "Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values") + @ApiModelProperty(value = "Filters results by `InventoryChangeType`. Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values") public List getTypes() { return types; } @@ -129,10 +129,10 @@ public BatchRetrieveInventoryChangesRequest addStatesItem(String statesItem) { } /** - * Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values + * Filters `ADJUSTMENT` query results by `InventoryState`. Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values * @return states **/ - @ApiModelProperty(value = "Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values") + @ApiModelProperty(value = "Filters `ADJUSTMENT` query results by `InventoryState`. Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values") public List getStates() { return states; } @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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 the original query. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 1ab15e3..68eedc6 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](/basics/api101/pagination) for more information. + * 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. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 6919193..283a729 100644 --- a/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsRequest.java +++ b/src/main/java/com/squareup/connect/models/BatchRetrieveInventoryCountsRequest.java @@ -51,10 +51,10 @@ public BatchRetrieveInventoryCountsRequest addCatalogObjectIdsItem(String catalo } /** - * Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. + * Filters results by `CatalogObject` ID. Only applied when set. Default: unset. * @return catalogObjectIds **/ - @ApiModelProperty(value = "Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset.") + @ApiModelProperty(value = "Filters results by `CatalogObject` ID. Only applied when set. Default: unset.") public List getCatalogObjectIds() { return catalogObjectIds; } @@ -74,10 +74,10 @@ public BatchRetrieveInventoryCountsRequest addLocationIdsItem(String locationIds } /** - * Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. + * Filters results by `Location` ID. Only applied when set. Default: unset. * @return locationIds **/ - @ApiModelProperty(value = "Filters results by [Location](#type-location) ID. Only applied when set. Default: unset.") + @ApiModelProperty(value = "Filters results by `Location` ID. Only applied when set. Default: unset.") public List getLocationIds() { return locationIds; } @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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 the original query. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 3a48a11..c8f5afa 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](/basics/api101/pagination) for more information. + * 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. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 526ff3b..bf0204c 100644 --- a/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsRequest.java +++ b/src/main/java/com/squareup/connect/models/BatchUpsertCatalogObjectsRequest.java @@ -41,10 +41,10 @@ public BatchUpsertCatalogObjectsRequest idempotencyKey(String idempotencyKey) { } /** - * 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](/basics/api101/idempotency) for more information. + * 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. * @return idempotencyKey **/ - @ApiModelProperty(required = true, value = "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](/basics/api101/idempotency) for more information.") + @ApiModelProperty(required = true, value = "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.") public String getIdempotencyKey() { return idempotencyKey; } @@ -64,10 +64,10 @@ public BatchUpsertCatalogObjectsRequest addBatchesItem(CatalogObjectBatch batche } /** - * A batch of [CatalogObject](#type-catalogobject)s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a [CatalogItem](#type-catalogitem) with ID `#ABC` and a [CatalogItemVariation](#type-catalogitemvariation) with its `item_id` attribute set to `#ABC` in order to associate the [CatalogItemVariation](#type-catalogitemvariation) with its parent [CatalogItem](#type-catalogitem). Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. + * 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. * @return batches **/ - @ApiModelProperty(value = "A batch of [CatalogObject](#type-catalogobject)s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a [CatalogItem](#type-catalogitem) with ID `#ABC` and a [CatalogItemVariation](#type-catalogitemvariation) with its `item_id` attribute set to `#ABC` in order to associate the [CatalogItemVariation](#type-catalogitemvariation) with its parent [CatalogItem](#type-catalogitem). Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated.") + @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.") 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 b8d00bd..b3befbb 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](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } @@ -77,10 +77,10 @@ public BatchUpsertCatalogObjectsResponse addObjectsItem(CatalogObject objectsIte } /** - * The created [CatalogObject](#type-catalogobject)s + * The created `CatalogObject`s * @return objects **/ - @ApiModelProperty(value = "The created [CatalogObject](#type-catalogobject)s") + @ApiModelProperty(value = "The created `CatalogObject`s") public List getObjects() { return objects; } diff --git a/src/main/java/com/squareup/connect/models/CancelPaymentRequest.java b/src/main/java/com/squareup/connect/models/CancelPaymentRequest.java index fe87278..6667be9 100644 --- a/src/main/java/com/squareup/connect/models/CancelPaymentRequest.java +++ b/src/main/java/com/squareup/connect/models/CancelPaymentRequest.java @@ -17,9 +17,9 @@ import io.swagger.annotations.ApiModel; /** - * Cancels a payment before it has been completed. Note: only payments created with `autocomplete` set to false can be canceled. + * Cancels (voids) a payment before it has been completed. Note: only payments created with `autocomplete` set to false can be canceled. */ -@ApiModel(description = "Cancels a payment before it has been completed. Note: only payments created with `autocomplete` set to false can be canceled.") +@ApiModel(description = "Cancels (voids) a payment before it has been completed. Note: only payments created with `autocomplete` set to false can be canceled.") public class CancelPaymentRequest { diff --git a/src/main/java/com/squareup/connect/models/Card.java b/src/main/java/com/squareup/connect/models/Card.java index 4cbc22f..7bcd706 100644 --- a/src/main/java/com/squareup/connect/models/Card.java +++ b/src/main/java/com/squareup/connect/models/Card.java @@ -51,6 +51,9 @@ public class Card { @JsonProperty("fingerprint") private String fingerprint = null; + @JsonProperty("bin") + private String bin = null; + public Card id(String id) { this.id = id; return this; @@ -195,6 +198,24 @@ public void setFingerprint(String fingerprint) { this.fingerprint = fingerprint; } + public Card bin(String bin) { + this.bin = bin; + return this; + } + + /** + * The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field. + * @return bin + **/ + @ApiModelProperty(value = "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.") + public String getBin() { + return bin; + } + + public void setBin(String bin) { + this.bin = bin; + } + @Override public boolean equals(java.lang.Object o) { @@ -212,12 +233,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.expYear, card.expYear) && Objects.equals(this.cardholderName, card.cardholderName) && Objects.equals(this.billingAddress, card.billingAddress) && - Objects.equals(this.fingerprint, card.fingerprint); + Objects.equals(this.fingerprint, card.fingerprint) && + Objects.equals(this.bin, card.bin); } @Override public int hashCode() { - return Objects.hash(id, cardBrand, last4, expMonth, expYear, cardholderName, billingAddress, fingerprint); + return Objects.hash(id, cardBrand, last4, expMonth, expYear, cardholderName, billingAddress, fingerprint, bin); } @@ -234,6 +256,7 @@ public String toString() { sb.append(" cardholderName: ").append(toIndentedString(cardholderName)).append("\n"); sb.append(" billingAddress: ").append(toIndentedString(billingAddress)).append("\n"); sb.append(" fingerprint: ").append(toIndentedString(fingerprint)).append("\n"); + sb.append(" bin: ").append(toIndentedString(bin)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/squareup/connect/models/CardPaymentDetails.java b/src/main/java/com/squareup/connect/models/CardPaymentDetails.java index 4876109..723e85f 100644 --- a/src/main/java/com/squareup/connect/models/CardPaymentDetails.java +++ b/src/main/java/com/squareup/connect/models/CardPaymentDetails.java @@ -57,6 +57,15 @@ public class CardPaymentDetails { @JsonProperty("application_cryptogram") private String applicationCryptogram = null; + @JsonProperty("verification_method") + private String verificationMethod = null; + + @JsonProperty("verification_results") + private String verificationResults = null; + + @JsonProperty("statement_description") + private String statementDescription = null; + @JsonProperty("errors") private List errors = new ArrayList(); @@ -120,10 +129,10 @@ public CardPaymentDetails cvvStatus(String cvvStatus) { } /** - * Status code returned from the Card Verification Value (CVV) check. + * Status code returned from the Card Verification Value (CVV) check. Can be `CVV_ACCEPTED`, `CVV_REJECTED`, `CVV_NOT_CHECKED`. * @return cvvStatus **/ - @ApiModelProperty(value = "Status code returned from the Card Verification Value (CVV) check.") + @ApiModelProperty(value = "Status code returned from the Card Verification Value (CVV) check. Can be `CVV_ACCEPTED`, `CVV_REJECTED`, `CVV_NOT_CHECKED`.") public String getCvvStatus() { return cvvStatus; } @@ -138,10 +147,10 @@ public CardPaymentDetails avsStatus(String avsStatus) { } /** - * Status code returned from the Address Verification System (AVS) check. + * Status code returned from the Address Verification System (AVS) check. Can be `AVS_ACCEPTED`, `AVS_REJECTED`, `AVS_NOT_CHECKED`. * @return avsStatus **/ - @ApiModelProperty(value = "Status code returned from the Address Verification System (AVS) check.") + @ApiModelProperty(value = "Status code returned from the Address Verification System (AVS) check. Can be `AVS_ACCEPTED`, `AVS_REJECTED`, `AVS_NOT_CHECKED`.") public String getAvsStatus() { return avsStatus; } @@ -174,10 +183,10 @@ public CardPaymentDetails applicationIdentifier(String applicationIdentifier) { } /** - * For EMV payments, identifies the EMV application used for the payment + * For EMV payments, identifies the EMV application used for the payment. * @return applicationIdentifier **/ - @ApiModelProperty(value = "For EMV payments, identifies the EMV application used for the payment") + @ApiModelProperty(value = "For EMV payments, identifies the EMV application used for the payment.") public String getApplicationIdentifier() { return applicationIdentifier; } @@ -222,6 +231,60 @@ public void setApplicationCryptogram(String applicationCryptogram) { this.applicationCryptogram = applicationCryptogram; } + public CardPaymentDetails verificationMethod(String verificationMethod) { + this.verificationMethod = verificationMethod; + return this; + } + + /** + * For EMV payments, method used to verify the cardholder's identity. Can be one of `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`. + * @return verificationMethod + **/ + @ApiModelProperty(value = "For EMV payments, method used to verify the cardholder's identity. Can be one of `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`.") + public String getVerificationMethod() { + return verificationMethod; + } + + public void setVerificationMethod(String verificationMethod) { + this.verificationMethod = verificationMethod; + } + + public CardPaymentDetails verificationResults(String verificationResults) { + this.verificationResults = verificationResults; + return this; + } + + /** + * For EMV payments, the results of the cardholder verification. Can be one of `SUCCESS`, `FAILURE`, or `UNKNOWN`. + * @return verificationResults + **/ + @ApiModelProperty(value = "For EMV payments, the results of the cardholder verification. Can be one of `SUCCESS`, `FAILURE`, or `UNKNOWN`.") + public String getVerificationResults() { + return verificationResults; + } + + public void setVerificationResults(String verificationResults) { + this.verificationResults = verificationResults; + } + + public CardPaymentDetails statementDescription(String statementDescription) { + this.statementDescription = statementDescription; + return this; + } + + /** + * The statement description sent to the card networks. Note: The actual statement description will vary and is likely to be truncated and appended with additional information on a per issuer basis. + * @return statementDescription + **/ + @ApiModelProperty(value = "The statement description sent to the card networks. Note: The actual statement description will vary and is likely to be truncated and appended with additional information on a per issuer basis.") + public String getStatementDescription() { + return statementDescription; + } + + public void setStatementDescription(String statementDescription) { + this.statementDescription = statementDescription; + } + public CardPaymentDetails errors(List errors) { this.errors = errors; return this; @@ -264,12 +327,15 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.applicationIdentifier, cardPaymentDetails.applicationIdentifier) && Objects.equals(this.applicationName, cardPaymentDetails.applicationName) && Objects.equals(this.applicationCryptogram, cardPaymentDetails.applicationCryptogram) && + Objects.equals(this.verificationMethod, cardPaymentDetails.verificationMethod) && + Objects.equals(this.verificationResults, cardPaymentDetails.verificationResults) && + Objects.equals(this.statementDescription, cardPaymentDetails.statementDescription) && Objects.equals(this.errors, cardPaymentDetails.errors); } @Override public int hashCode() { - return Objects.hash(status, card, entryMethod, cvvStatus, avsStatus, authResultCode, applicationIdentifier, applicationName, applicationCryptogram, errors); + return Objects.hash(status, card, entryMethod, cvvStatus, avsStatus, authResultCode, applicationIdentifier, applicationName, applicationCryptogram, verificationMethod, verificationResults, statementDescription, errors); } @@ -287,6 +353,9 @@ public String toString() { sb.append(" applicationIdentifier: ").append(toIndentedString(applicationIdentifier)).append("\n"); sb.append(" applicationName: ").append(toIndentedString(applicationName)).append("\n"); sb.append(" applicationCryptogram: ").append(toIndentedString(applicationCryptogram)).append("\n"); + sb.append(" verificationMethod: ").append(toIndentedString(verificationMethod)).append("\n"); + sb.append(" verificationResults: ").append(toIndentedString(verificationResults)).append("\n"); + sb.append(" statementDescription: ").append(toIndentedString(statementDescription)).append("\n"); sb.append(" errors: ").append(toIndentedString(errors)).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 078894b..adf421c 100644 --- a/src/main/java/com/squareup/connect/models/CatalogIdMapping.java +++ b/src/main/java/com/squareup/connect/models/CatalogIdMapping.java @@ -38,10 +38,10 @@ public CatalogIdMapping clientObjectId(String clientObjectId) { } /** - * The client-supplied, temporary `#`-prefixed ID for a new [CatalogObject](#type-catalogobject). + * The client-supplied, temporary `#`-prefixed ID for a new `CatalogObject`. * @return clientObjectId **/ - @ApiModelProperty(value = "The client-supplied, temporary `#`-prefixed ID for a new [CatalogObject](#type-catalogobject).") + @ApiModelProperty(value = "The client-supplied, temporary `#`-prefixed ID for a new `CatalogObject`.") public String getClientObjectId() { return clientObjectId; } @@ -56,10 +56,10 @@ public CatalogIdMapping objectId(String objectId) { } /** - * The permanent ID for the [CatalogObject](#type-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](#type-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 a706dd2..b1f716e 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](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s 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 c86428c..561581b 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](#type-catalogtax)es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. [CatalogTax](#type-catalogtax)es may also be added to or deleted from an item using `UpdateItemTaxes`. + * 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`. * @return taxIds **/ - @ApiModelProperty(value = "A set of IDs indicating the [CatalogTax](#type-catalogtax)es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. [CatalogTax](#type-catalogtax)es may also be added to or deleted from an item using `UpdateItemTaxes`.") + @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`.") public List getTaxIds() { return taxIds; } @@ -251,10 +251,10 @@ public CatalogItem addModifierListInfoItem(CatalogItemModifierListInfo modifierL } /** - * A set of [CatalogItemModifierListInfo](#type-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](#type-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. `CatalogModifierList`s may also be added to or deleted from an item using `UpdateItemModifierLists`. * @return modifierListInfo **/ - @ApiModelProperty(value = "A set of [CatalogItemModifierListInfo](#type-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](#type-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. `CatalogModifierList`s 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](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item. Maximum: 250 item variations + * A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations * @return variations **/ - @ApiModelProperty(value = "A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemVariation](#type-catalogitemvariation)s for this item. Maximum: 250 item variations") + @ApiModelProperty(value = "A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations") public List getVariations() { return variations; } @@ -310,10 +310,10 @@ public CatalogItem skipModifierScreen(Boolean skipModifierScreen) { } /** - * If `false`, the Square Point of Sale app will present the [CatalogItem](#type-catalogitem)'s details screen immediately, allowing the merchant to choose [CatalogModifier](#type-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. + * 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. * @return skipModifierScreen **/ - @ApiModelProperty(value = "If `false`, the Square Point of Sale app will present the [CatalogItem](#type-catalogitem)'s details screen immediately, allowing the merchant to choose [CatalogModifier](#type-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.") + @ApiModelProperty(value = "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.") public Boolean getSkipModifierScreen() { return skipModifierScreen; } diff --git a/src/main/java/com/squareup/connect/models/CatalogItemModifierListInfo.java b/src/main/java/com/squareup/connect/models/CatalogItemModifierListInfo.java index fca57a0..687c067 100644 --- a/src/main/java/com/squareup/connect/models/CatalogItemModifierListInfo.java +++ b/src/main/java/com/squareup/connect/models/CatalogItemModifierListInfo.java @@ -50,10 +50,10 @@ public CatalogItemModifierListInfo modifierListId(String modifierListId) { } /** - * The ID of the [CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo](#type-catalogmodifierlistinfo). + * The ID of the `CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo`. * @return modifierListId **/ - @ApiModelProperty(required = true, value = "The ID of the [CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo](#type-catalogmodifierlistinfo).") + @ApiModelProperty(required = true, value = "The ID of the `CatalogModifierList](#type-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](#type-catalogmodifier) is enabled by default. + * A set of `CatalogModifierOverride](#type-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](#type-catalogmodifier) is enabled by default.") + @ApiModelProperty(value = "A set of `CatalogModifierOverride](#type-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](#type-catalogmodifierlist). + * If zero or larger, the smallest number of `CatalogModifier](#type-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](#type-catalogmodifierlist).") + @ApiModelProperty(value = "If zero or larger, the smallest number of `CatalogModifier](#type-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](#type-catalogmodifierlist). + * If zero or larger, the largest number of `CatalogModifier](#type-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](#type-catalogmodifierlist).") + @ApiModelProperty(value = "If zero or larger, the largest number of `CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList`.") public Integer getMaxSelectedModifiers() { return maxSelectedModifiers; } @@ -127,10 +127,10 @@ public CatalogItemModifierListInfo enabled(Boolean enabled) { } /** - * If `true`, enable this [CatalogModifierList](#type-catalogmodifierlist). + * If `true`, enable this `CatalogModifierList`. * @return enabled **/ - @ApiModelProperty(value = "If `true`, enable this [CatalogModifierList](#type-catalogmodifierlist).") + @ApiModelProperty(value = "If `true`, enable this `CatalogModifierList`.") public Boolean getEnabled() { return enabled; } diff --git a/src/main/java/com/squareup/connect/models/CatalogItemOption.java b/src/main/java/com/squareup/connect/models/CatalogItemOption.java index 566e151..f0dc4e1 100644 --- a/src/main/java/com/squareup/connect/models/CatalogItemOption.java +++ b/src/main/java/com/squareup/connect/models/CatalogItemOption.java @@ -130,10 +130,10 @@ public CatalogItemOption addValuesItem(CatalogObject valuesItem) { } /** - * A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemOptionValue](#type-catalogitemoptionvalue)s for this item. + * A list of `CatalogObject`s containing the `CatalogItemOptionValue`s for this item. * @return values **/ - @ApiModelProperty(value = "A list of [CatalogObject](#type-catalogobject)s containing the [CatalogItemOptionValue](#type-catalogitemoptionvalue)s for this item.") + @ApiModelProperty(value = "A list of `CatalogObject`s containing the `CatalogItemOptionValue`s for this item.") public List getValues() { return values; } @@ -148,10 +148,10 @@ public CatalogItemOption itemCount(Long itemCount) { } /** - * The number of [CatalogItem](#type-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`. + * 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`. * @return itemCount **/ - @ApiModelProperty(value = "The number of [CatalogItem](#type-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`.") + @ApiModelProperty(value = "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`.") public Long getItemCount() { return itemCount; } diff --git a/src/main/java/com/squareup/connect/models/CatalogItemVariation.java b/src/main/java/com/squareup/connect/models/CatalogItemVariation.java index 2974437..2bc8ccb 100644 --- a/src/main/java/com/squareup/connect/models/CatalogItemVariation.java +++ b/src/main/java/com/squareup/connect/models/CatalogItemVariation.java @@ -82,10 +82,10 @@ public CatalogItemVariation itemId(String itemId) { } /** - * The ID of the [CatalogItem](#type-catalogitem) associated with this item variation. Searchable. + * The ID of the `CatalogItem` associated with this item variation. Searchable. * @return itemId **/ - @ApiModelProperty(value = "The ID of the [CatalogItem](#type-catalogitem) associated with this item variation. Searchable.") + @ApiModelProperty(value = "The ID of the `CatalogItem` associated with this item variation. Searchable.") public String getItemId() { return itemId; } @@ -154,10 +154,10 @@ public CatalogItemVariation ordinal(Integer ordinal) { } /** - * 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](#type-catalogitem) is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique. + * 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. * @return ordinal **/ - @ApiModelProperty(value = "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](#type-catalogitem) is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique.") + @ApiModelProperty(value = "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.") public Integer getOrdinal() { return ordinal; } @@ -213,10 +213,10 @@ public CatalogItemVariation addLocationOverridesItem(ItemVariationLocationOverri } /** - * Per-[location](#type-location) price and inventory overrides. + * Per-`location` price and inventory overrides. * @return locationOverrides **/ - @ApiModelProperty(value = "Per-[location](#type-location) price and inventory overrides.") + @ApiModelProperty(value = "Per-`location` price and inventory overrides.") public List getLocationOverrides() { return locationOverrides; } @@ -303,10 +303,10 @@ public CatalogItemVariation serviceDuration(Long serviceDuration) { } /** - * If the [CatalogItem](#type-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). + * 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). * @return serviceDuration **/ - @ApiModelProperty(value = "If the [CatalogItem](#type-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).") + @ApiModelProperty(value = "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).") public Long getServiceDuration() { return serviceDuration; } diff --git a/src/main/java/com/squareup/connect/models/CatalogModifierList.java b/src/main/java/com/squareup/connect/models/CatalogModifierList.java index 3112724..6e3ac56 100644 --- a/src/main/java/com/squareup/connect/models/CatalogModifierList.java +++ b/src/main/java/com/squareup/connect/models/CatalogModifierList.java @@ -44,10 +44,10 @@ public CatalogModifierList name(String name) { } /** - * The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. This field has max length of 255 Unicode code points. + * The `CatalogModifierList`'s name. Searchable. This field has max length of 255 Unicode code points. * @return name **/ - @ApiModelProperty(value = "The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. This field has max length of 255 Unicode code points.") + @ApiModelProperty(value = "The `CatalogModifierList`'s name. Searchable. This field has max length of 255 Unicode code points.") public String getName() { return name; } @@ -62,10 +62,10 @@ public CatalogModifierList selectionType(String selectionType) { } /** - * Indicates whether multiple options from the [CatalogModifierList](#type-catalogmodifierlist) can be applied to a single [CatalogItem](#type-catalogitem). See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values + * Indicates whether multiple options from the `CatalogModifierList` can be applied to a single `CatalogItem`. See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values * @return selectionType **/ - @ApiModelProperty(value = "Indicates whether multiple options from the [CatalogModifierList](#type-catalogmodifierlist) can be applied to a single [CatalogItem](#type-catalogitem). See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values") + @ApiModelProperty(value = "Indicates whether multiple options from the `CatalogModifierList` can be applied to a single `CatalogItem`. See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values") public String getSelectionType() { return selectionType; } @@ -85,10 +85,10 @@ public CatalogModifierList addModifiersItem(CatalogObject modifiersItem) { } /** - * The options included in the [CatalogModifierList](#type-catalogmodifierlist). You must include at least one [CatalogModifier](#type-catalogmodifier). Each [CatalogObject](#type-catalogobject) must have type `MODIFIER` and contain [CatalogModifier](#type-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](#type-catalogmodifierlist). You must include at least one [CatalogModifier](#type-catalogmodifier). Each [CatalogObject](#type-catalogobject) must have type `MODIFIER` and contain [CatalogModifier](#type-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 0615d16..4f3a9bd 100644 --- a/src/main/java/com/squareup/connect/models/CatalogModifierOverride.java +++ b/src/main/java/com/squareup/connect/models/CatalogModifierOverride.java @@ -38,10 +38,10 @@ public CatalogModifierOverride modifierId(String modifierId) { } /** - * The ID of the [CatalogModifier](#type-catalogmodifier) whose default behavior is being overridden. + * The ID of the `CatalogModifier` whose default behavior is being overridden. * @return modifierId **/ - @ApiModelProperty(required = true, value = "The ID of the [CatalogModifier](#type-catalogmodifier) whose default behavior is being overridden.") + @ApiModelProperty(required = true, value = "The ID of the `CatalogModifier` whose default behavior is being overridden.") public String getModifierId() { return modifierId; } @@ -56,10 +56,10 @@ public CatalogModifierOverride onByDefault(Boolean onByDefault) { } /** - * If `true`, this [CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem](#type-catalogitem). + * If `true`, this `CatalogModifier](#type-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](#type-catalogitem).") + @ApiModelProperty(value = "If `true`, this `CatalogModifier](#type-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 b544930..aaf8df0 100644 --- a/src/main/java/com/squareup/connect/models/CatalogObject.java +++ b/src/main/java/com/squareup/connect/models/CatalogObject.java @@ -216,10 +216,10 @@ public CatalogObject addCatalogV1IdsItem(CatalogV1Id catalogV1IdsItem) { } /** - * The Connect V1 IDs for this object at each [location](#type-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](#type-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; } @@ -316,10 +316,10 @@ public CatalogObject itemData(CatalogItem itemData) { } /** - * Structured data for a [CatalogItem](#type-catalogitem), set for CatalogObjects of type `ITEM`. + * Structured data for a `CatalogItem`, set for CatalogObjects of type `ITEM`. * @return itemData **/ - @ApiModelProperty(value = "Structured data for a [CatalogItem](#type-catalogitem), set for CatalogObjects of type `ITEM`.") + @ApiModelProperty(value = "Structured data for a `CatalogItem`, set for CatalogObjects of type `ITEM`.") public CatalogItem getItemData() { return itemData; } @@ -334,10 +334,10 @@ public CatalogObject categoryData(CatalogCategory categoryData) { } /** - * Structured data for a [CatalogCategory](#type-catalogcategory), set for CatalogObjects of type `CATEGORY`. + * Structured data for a `CatalogCategory`, set for CatalogObjects of type `CATEGORY`. * @return categoryData **/ - @ApiModelProperty(value = "Structured data for a [CatalogCategory](#type-catalogcategory), set for CatalogObjects of type `CATEGORY`.") + @ApiModelProperty(value = "Structured data for a `CatalogCategory`, set for CatalogObjects of type `CATEGORY`.") public CatalogCategory getCategoryData() { return categoryData; } @@ -352,10 +352,10 @@ public CatalogObject itemVariationData(CatalogItemVariation itemVariationData) { } /** - * Structured data for a [CatalogItemVariation](#type-catalogitemvariation), set for CatalogObjects of type `ITEM_VARIATION`. + * Structured data for a `CatalogItemVariation`, set for CatalogObjects of type `ITEM_VARIATION`. * @return itemVariationData **/ - @ApiModelProperty(value = "Structured data for a [CatalogItemVariation](#type-catalogitemvariation), set for CatalogObjects of type `ITEM_VARIATION`.") + @ApiModelProperty(value = "Structured data for a `CatalogItemVariation`, set for CatalogObjects of type `ITEM_VARIATION`.") public CatalogItemVariation getItemVariationData() { return itemVariationData; } @@ -370,10 +370,10 @@ public CatalogObject taxData(CatalogTax taxData) { } /** - * Structured data for a [CatalogTax](#type-catalogtax), set for CatalogObjects of type `TAX`. + * Structured data for a `CatalogTax`, set for CatalogObjects of type `TAX`. * @return taxData **/ - @ApiModelProperty(value = "Structured data for a [CatalogTax](#type-catalogtax), set for CatalogObjects of type `TAX`.") + @ApiModelProperty(value = "Structured data for a `CatalogTax`, set for CatalogObjects of type `TAX`.") public CatalogTax getTaxData() { return taxData; } @@ -388,10 +388,10 @@ public CatalogObject discountData(CatalogDiscount discountData) { } /** - * Structured data for a [CatalogDiscount](#type-catalogdiscount), set for CatalogObjects of type `DISCOUNT`. + * Structured data for a `CatalogDiscount`, set for CatalogObjects of type `DISCOUNT`. * @return discountData **/ - @ApiModelProperty(value = "Structured data for a [CatalogDiscount](#type-catalogdiscount), set for CatalogObjects of type `DISCOUNT`.") + @ApiModelProperty(value = "Structured data for a `CatalogDiscount`, set for CatalogObjects of type `DISCOUNT`.") public CatalogDiscount getDiscountData() { return discountData; } @@ -406,10 +406,10 @@ public CatalogObject modifierListData(CatalogModifierList modifierListData) { } /** - * Structured data for a [CatalogModifierList](#type-catalogmodifierlist), set for CatalogObjects of type `MODIFIER_LIST`. + * Structured data for a `CatalogModifierList`, set for CatalogObjects of type `MODIFIER_LIST`. * @return modifierListData **/ - @ApiModelProperty(value = "Structured data for a [CatalogModifierList](#type-catalogmodifierlist), set for CatalogObjects of type `MODIFIER_LIST`.") + @ApiModelProperty(value = "Structured data for a `CatalogModifierList`, set for CatalogObjects of type `MODIFIER_LIST`.") public CatalogModifierList getModifierListData() { return modifierListData; } @@ -424,10 +424,10 @@ public CatalogObject modifierData(CatalogModifier modifierData) { } /** - * Structured data for a [CatalogModifier](#type-catalogmodifier), set for CatalogObjects of type `MODIFIER`. + * Structured data for a `CatalogModifier`, set for CatalogObjects of type `MODIFIER`. * @return modifierData **/ - @ApiModelProperty(value = "Structured data for a [CatalogModifier](#type-catalogmodifier), set for CatalogObjects of type `MODIFIER`.") + @ApiModelProperty(value = "Structured data for a `CatalogModifier`, set for CatalogObjects of type `MODIFIER`.") public CatalogModifier getModifierData() { return modifierData; } @@ -442,10 +442,10 @@ public CatalogObject timePeriodData(CatalogTimePeriod timePeriodData) { } /** - * Structured data for a [CatalogTimePeriod](#type-catalogtimeperiod), set for CatalogObjects of type `TIME_PERIOD`. + * Structured data for a `CatalogTimePeriod`, set for CatalogObjects of type `TIME_PERIOD`. * @return timePeriodData **/ - @ApiModelProperty(value = "Structured data for a [CatalogTimePeriod](#type-catalogtimeperiod), set for CatalogObjects of type `TIME_PERIOD`.") + @ApiModelProperty(value = "Structured data for a `CatalogTimePeriod`, set for CatalogObjects of type `TIME_PERIOD`.") public CatalogTimePeriod getTimePeriodData() { return timePeriodData; } @@ -460,10 +460,10 @@ public CatalogObject productSetData(CatalogProductSet productSetData) { } /** - * Structured data for a [CatalogProductSet](#type-catalogproductset), set for CatalogObjects of type `PRODUCT_SET`. + * Structured data for a `CatalogProductSet`, set for CatalogObjects of type `PRODUCT_SET`. * @return productSetData **/ - @ApiModelProperty(value = "Structured data for a [CatalogProductSet](#type-catalogproductset), set for CatalogObjects of type `PRODUCT_SET`.") + @ApiModelProperty(value = "Structured data for a `CatalogProductSet`, set for CatalogObjects of type `PRODUCT_SET`.") public CatalogProductSet getProductSetData() { return productSetData; } @@ -478,10 +478,10 @@ public CatalogObject pricingRuleData(CatalogPricingRule pricingRuleData) { } /** - * Structured data for a [CatalogPricingRule](#type-catalogpricingrule), set for CatalogObjects of type `PRICING_RULE`. + * Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. * @return pricingRuleData **/ - @ApiModelProperty(value = "Structured data for a [CatalogPricingRule](#type-catalogpricingrule), set for CatalogObjects of type `PRICING_RULE`.") + @ApiModelProperty(value = "Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`.") public CatalogPricingRule getPricingRuleData() { return pricingRuleData; } @@ -496,10 +496,10 @@ public CatalogObject imageData(CatalogImage imageData) { } /** - * Structured data for a [CatalogImage](#type-catalogimage), set for CatalogObjects of type `IMAGE`. + * Structured data for a `CatalogImage`, set for CatalogObjects of type `IMAGE`. * @return imageData **/ - @ApiModelProperty(value = "Structured data for a [CatalogImage](#type-catalogimage), set for CatalogObjects of type `IMAGE`.") + @ApiModelProperty(value = "Structured data for a `CatalogImage`, set for CatalogObjects of type `IMAGE`.") public CatalogImage getImageData() { return imageData; } @@ -514,10 +514,10 @@ public CatalogObject measurementUnitData(CatalogMeasurementUnit measurementUnitD } /** - * Structured data for a [CatalogMeasurementUnit](#type-catalogmeasurementunit), set for CatalogObjects of type `MEASUREMENT_UNIT`. + * Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`. * @return measurementUnitData **/ - @ApiModelProperty(value = "Structured data for a [CatalogMeasurementUnit](#type-catalogmeasurementunit), set for CatalogObjects of type `MEASUREMENT_UNIT`.") + @ApiModelProperty(value = "Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`.") public CatalogMeasurementUnit getMeasurementUnitData() { return measurementUnitData; } @@ -532,10 +532,10 @@ public CatalogObject itemOptionData(CatalogItemOption itemOptionData) { } /** - * Structured data for a [CatalogItemOption](#type-catalogitemoption), set for CatalogObjects of type `ITEM_OPTION`. + * Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`. * @return itemOptionData **/ - @ApiModelProperty(value = "Structured data for a [CatalogItemOption](#type-catalogitemoption), set for CatalogObjects of type `ITEM_OPTION`.") + @ApiModelProperty(value = "Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`.") public CatalogItemOption getItemOptionData() { return itemOptionData; } @@ -550,10 +550,10 @@ public CatalogObject itemOptionValueData(CatalogItemOptionValue itemOptionValueD } /** - * Structured data for a [CatalogItemOptionValue](#type-catalogitemoptionvalue), set for CatalogObjects of type `ITEM_OPTION_VAL`. + * Structured data for a `CatalogItemOptionValue`, set for CatalogObjects of type `ITEM_OPTION_VAL`. * @return itemOptionValueData **/ - @ApiModelProperty(value = "Structured data for a [CatalogItemOptionValue](#type-catalogitemoptionvalue), set for CatalogObjects of type `ITEM_OPTION_VAL`.") + @ApiModelProperty(value = "Structured data for a `CatalogItemOptionValue`, set for CatalogObjects of type `ITEM_OPTION_VAL`.") public CatalogItemOptionValue getItemOptionValueData() { return itemOptionValueData; } diff --git a/src/main/java/com/squareup/connect/models/CatalogObjectBatch.java b/src/main/java/com/squareup/connect/models/CatalogObjectBatch.java index 2b0071e..32025f9 100644 --- a/src/main/java/com/squareup/connect/models/CatalogObjectBatch.java +++ b/src/main/java/com/squareup/connect/models/CatalogObjectBatch.java @@ -43,10 +43,10 @@ public CatalogObjectBatch addObjectsItem(CatalogObject objectsItem) { } /** - * A list of [CatalogObject](#type-catalogobject)s belonging to this batch. + * A list of `CatalogObject`s belonging to this batch. * @return objects **/ - @ApiModelProperty(value = "A list of [CatalogObject](#type-catalogobject)s belonging to this batch.") + @ApiModelProperty(value = "A list of `CatalogObject`s 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 63ae1a3..d4e25c5 100644 --- a/src/main/java/com/squareup/connect/models/CatalogPricingRule.java +++ b/src/main/java/com/squareup/connect/models/CatalogPricingRule.java @@ -87,10 +87,10 @@ public CatalogPricingRule addTimePeriodIdsItem(String timePeriodIdsItem) { } /** - * Unique ID for the [CatalogTimePeriod](#type-catalogtimeperiod)s when this pricing rule is in effect. If left unset, the pricing rule is always in effect. + * Unique ID for the `CatalogTimePeriod`s 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](#type-catalogtimeperiod)s when this pricing rule is in effect. If left unset, the pricing rule is always in effect.") + @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.") public List getTimePeriodIds() { return timePeriodIds; } @@ -105,10 +105,10 @@ public CatalogPricingRule discountId(String discountId) { } /** - * Unique ID for the [CatalogDiscount](#type-catalogdiscount) to take off the price of all matched items. Only one of `total_price_money`, `item_price`, or `discount` can be supplied. + * Unique ID for the `CatalogDiscount` to take off the price of all matched items. * @return discountId **/ - @ApiModelProperty(value = "Unique ID for the [CatalogDiscount](#type-catalogdiscount) to take off the price of all matched items. Only one of `total_price_money`, `item_price`, or `discount` can be supplied.") + @ApiModelProperty(value = "Unique ID for the `CatalogDiscount` to take off the price of all matched items.") public String getDiscountId() { return discountId; } @@ -123,10 +123,10 @@ public CatalogPricingRule matchProductsId(String matchProductsId) { } /** - * Unique ID for the [CatalogProductSet](#type-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. * @return matchProductsId **/ - @ApiModelProperty(value = "Unique ID for the [CatalogProductSet](#type-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.") public String getMatchProductsId() { return matchProductsId; } @@ -141,10 +141,10 @@ public CatalogPricingRule applyProductsId(String applyProductsId) { } /** - * The [CatalogProductSet](#type-catalogproductset) to apply the pricing rule to within the set of matched products specified by `match_products_id`. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products. + * The `CatalogProductSet` to apply the pricing rule to within the set of matched products specified by `match_products_id`. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products. * @return applyProductsId **/ - @ApiModelProperty(value = "The [CatalogProductSet](#type-catalogproductset) to apply the pricing rule to within the set of matched products specified by `match_products_id`. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products.") + @ApiModelProperty(value = "The `CatalogProductSet` to apply the pricing rule to within the set of matched products specified by `match_products_id`. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products.") public String getApplyProductsId() { return applyProductsId; } @@ -159,10 +159,10 @@ public CatalogPricingRule excludeProductsId(String excludeProductsId) { } /** - * Identifies the [CatalogProductSet](#type-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. + * 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. * @return excludeProductsId **/ - @ApiModelProperty(value = "Identifies the [CatalogProductSet](#type-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 = "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.") public String getExcludeProductsId() { return excludeProductsId; } diff --git a/src/main/java/com/squareup/connect/models/CatalogProductSet.java b/src/main/java/com/squareup/connect/models/CatalogProductSet.java index 43bfd17..f5fe5d9 100644 --- a/src/main/java/com/squareup/connect/models/CatalogProductSet.java +++ b/src/main/java/com/squareup/connect/models/CatalogProductSet.java @@ -78,10 +78,10 @@ public CatalogProductSet addProductIdsAnyItem(String productIdsAnyItem) { } /** - * Unique IDs for any [CatalogObjects](#type-catalogobject)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](#type-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 `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. * @return productIdsAny **/ - @ApiModelProperty(value = "Unique IDs for any [CatalogObjects](#type-catalogobject)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](#type-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 `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.") public List getProductIdsAny() { return productIdsAny; } @@ -101,10 +101,10 @@ public CatalogProductSet addProductIdsAllItem(String productIdsAllItem) { } /** - * Unique IDs for [CatalogObjects](#type-catalogobject) 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 `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. * @return productIdsAll **/ - @ApiModelProperty(value = "Unique IDs for [CatalogObjects](#type-catalogobject) 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 `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.") 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 2d5f1d0..c478b42 100644 --- a/src/main/java/com/squareup/connect/models/CatalogQuery.java +++ b/src/main/java/com/squareup/connect/models/CatalogQuery.java @@ -140,10 +140,10 @@ public CatalogQuery textQuery(CatalogQueryText textQuery) { } /** - * A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`. + * 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\"]}`. * @return textQuery **/ - @ApiModelProperty(value = "A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`.") + @ApiModelProperty(value = "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\"]}`.") public CatalogQueryText getTextQuery() { return textQuery; } @@ -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](#type-catalogtax)es enabled. + * A query that returns all `CatalogItem](#type-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](#type-catalogtax)es enabled.") + @ApiModelProperty(value = "A query that returns all `CatalogItem](#type-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](#type-catalogmodifierlist)s enabled. + * A query that returns all `CatalogItem](#type-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](#type-catalogmodifierlist)s enabled.") + @ApiModelProperty(value = "A query that returns all `CatalogItem](#type-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](#type-catalogitemoption)s. + * A query that returns all `CatalogItem](#type-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](#type-catalogitemoption)s.") + @ApiModelProperty(value = "A query that returns all `CatalogItem](#type-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](#type-catalogitemoption) values. + * A query that returns all `CatalogItemVariation](#type-catalogitemvariations)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](#type-catalogitemoption) values.") + @ApiModelProperty(value = "A query that returns all `CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption` values.") public CatalogQueryItemVariationsForItemOptionValues getItemVariationsForItemOptionValuesQuery() { return itemVariationsForItemOptionValuesQuery; } diff --git a/src/main/java/com/squareup/connect/models/CatalogQueryItemVariationsForItemOptionValues.java b/src/main/java/com/squareup/connect/models/CatalogQueryItemVariationsForItemOptionValues.java index 01d119a..f09b8f8 100644 --- a/src/main/java/com/squareup/connect/models/CatalogQueryItemVariationsForItemOptionValues.java +++ b/src/main/java/com/squareup/connect/models/CatalogQueryItemVariationsForItemOptionValues.java @@ -42,10 +42,10 @@ public CatalogQueryItemVariationsForItemOptionValues addItemOptionValueIdsItem(S } /** - * A set of [CatalogItemOptionValue](#type-catalogitemoptionvalue) IDs to be used to find associated [CatalogItemVariation](#type-catalogitemvariation)s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned. + * A set of `CatalogItemOptionValue` IDs to be used to find associated `CatalogItemVariation`s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned. * @return itemOptionValueIds **/ - @ApiModelProperty(value = "A set of [CatalogItemOptionValue](#type-catalogitemoptionvalue) IDs to be used to find associated [CatalogItemVariation](#type-catalogitemvariation)s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned.") + @ApiModelProperty(value = "A set of `CatalogItemOptionValue` IDs to be used to find associated `CatalogItemVariation`s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned.") public List getItemOptionValueIds() { return itemOptionValueIds; } diff --git a/src/main/java/com/squareup/connect/models/CatalogQueryItemsForItemOptions.java b/src/main/java/com/squareup/connect/models/CatalogQueryItemsForItemOptions.java index 3412f84..d011fff 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](#type-catalogitemoption) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. All Items that contain all of the given Item Options (in any order) will be returned. + * A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` will be returned. * @return itemOptionIds **/ - @ApiModelProperty(value = "A set of [CatalogItemOption](#type-catalogitemoption) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. All Items that contain all of the given Item Options (in any order) will be returned.") + @ApiModelProperty(value = "A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` 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 4284eba..b7c05ef 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](#type-catalogitem)s. + * A set of `CatalogModifierList](#type-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](#type-catalogitem)s.") + @ApiModelProperty(required = true, value = "A set of `CatalogModifierList](#type-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 676d745..2099dc5 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](#type-catalogitem)s. + * A set of `CatalogTax](#type-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](#type-catalogitem)s.") + @ApiModelProperty(required = true, value = "A set of `CatalogTax](#type-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 3278ea1..edda6d9 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](#type-sortorder), `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values + * The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values * @return sortOrder **/ - @ApiModelProperty(value = "The desired [SortOrder](#type-sortorder), `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values") + @ApiModelProperty(value = "The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values") public String getSortOrder() { return sortOrder; } diff --git a/src/main/java/com/squareup/connect/models/CatalogTax.java b/src/main/java/com/squareup/connect/models/CatalogTax.java index 956cb1e..e60e367 100644 --- a/src/main/java/com/squareup/connect/models/CatalogTax.java +++ b/src/main/java/com/squareup/connect/models/CatalogTax.java @@ -122,10 +122,10 @@ public CatalogTax appliesToCustomAmounts(Boolean appliesToCustomAmounts) { } /** - * If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular [CatalogItem](#type-catalogitem). + * If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular `CatalogItem`. * @return appliesToCustomAmounts **/ - @ApiModelProperty(value = "If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular [CatalogItem](#type-catalogitem).") + @ApiModelProperty(value = "If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular `CatalogItem`.") public Boolean getAppliesToCustomAmounts() { return appliesToCustomAmounts; } diff --git a/src/main/java/com/squareup/connect/models/CatalogV1Id.java b/src/main/java/com/squareup/connect/models/CatalogV1Id.java index 30c37f5..ef0efce 100644 --- a/src/main/java/com/squareup/connect/models/CatalogV1Id.java +++ b/src/main/java/com/squareup/connect/models/CatalogV1Id.java @@ -56,10 +56,10 @@ public CatalogV1Id locationId(String locationId) { } /** - * The ID of the [location](#type-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](#type-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 26ffe18..d5e2538 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](/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](https://developer.squareup.com/docs/basics/api101/idempotency) 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](/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](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") public String getIdempotencyKey() { return idempotencyKey; } @@ -151,10 +151,10 @@ public ChargeRequest delayCapture(Boolean delayCapture) { } /** - * If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction](#endpoint-capturetransaction) endpoint) or a Void (with the [VoidTransaction](#endpoint-voidtransaction) endpoint). Default value: `false` + * If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the `CaptureTransaction` or a Void (with the `VoidTransaction`. Default value: `false` * @return delayCapture **/ - @ApiModelProperty(value = "If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction](#endpoint-capturetransaction) endpoint) or a Void (with the [VoidTransaction](#endpoint-voidtransaction) endpoint). Default value: `false`") + @ApiModelProperty(value = "If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the `CaptureTransaction` or a Void (with the `VoidTransaction`. Default value: `false`") public Boolean getDelayCapture() { return delayCapture; } diff --git a/src/main/java/com/squareup/connect/models/CompletePaymentRequest.java b/src/main/java/com/squareup/connect/models/CompletePaymentRequest.java index 7c4db34..4a9579d 100644 --- a/src/main/java/com/squareup/connect/models/CompletePaymentRequest.java +++ b/src/main/java/com/squareup/connect/models/CompletePaymentRequest.java @@ -17,9 +17,9 @@ import io.swagger.annotations.ApiModel; /** - * Completes a payment. By default, payments are set to autocomplete immediately after they are created. To complete payments manually, set `autocomplete` to false. + * Completes (captures) a payment. By default, payments are set to autocomplete immediately after they are created. To complete payments manually, set `autocomplete` to false. */ -@ApiModel(description = "Completes a payment. By default, payments are set to autocomplete immediately after they are created. To complete payments manually, set `autocomplete` to false.") +@ApiModel(description = "Completes (captures) a payment. By default, payments are set to autocomplete immediately after they are created. To complete payments manually, set `autocomplete` to false.") public class CompletePaymentRequest { diff --git a/src/main/java/com/squareup/connect/models/CreateCheckoutRequest.java b/src/main/java/com/squareup/connect/models/CreateCheckoutRequest.java index 8dfb146..4ceb6b3 100644 --- a/src/main/java/com/squareup/connect/models/CreateCheckoutRequest.java +++ b/src/main/java/com/squareup/connect/models/CreateCheckoutRequest.java @@ -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](/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](https://developer.squareup.com/docs/basics/api101/idempotency) 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](/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](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") public String getIdempotencyKey() { return idempotencyKey; } diff --git a/src/main/java/com/squareup/connect/models/CreateCustomerCardRequest.java b/src/main/java/com/squareup/connect/models/CreateCustomerCardRequest.java index 87828d4..708ab2c 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](/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 `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. * @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](/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 `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.") 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 69698a0..463f6f1 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](/basics/api101/idempotency) guide for more information. + * The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information. * @return idempotencyKey **/ - @ApiModelProperty(value = "The idempotency key for the request. See the [Idempotency](/basics/api101/idempotency) guide for more information.") + @ApiModelProperty(value = "The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information.") public String getIdempotencyKey() { return idempotencyKey; } diff --git a/src/main/java/com/squareup/connect/models/CreateOrderRequest.java b/src/main/java/com/squareup/connect/models/CreateOrderRequest.java index 4cb8673..082c884 100644 --- a/src/main/java/com/squareup/connect/models/CreateOrderRequest.java +++ b/src/main/java/com/squareup/connect/models/CreateOrderRequest.java @@ -74,10 +74,10 @@ public CreateOrderRequest idempotencyKey(String idempotencyKey) { } /** - * A value you specify that uniquely identifies this order among orders you've created. If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency](/basics/api101/idempotency) for more information. + * A value you specify that uniquely identifies this order among orders you've created. If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. * @return idempotencyKey **/ - @ApiModelProperty(value = "A value you specify that uniquely identifies this order among orders you've created. If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency](/basics/api101/idempotency) for more information.") + @ApiModelProperty(value = "A value you specify that uniquely identifies this order among orders you've created. If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") public String getIdempotencyKey() { return idempotencyKey; } @@ -92,10 +92,10 @@ public CreateOrderRequest referenceId(String referenceId) { } /** - * __Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead. An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters. + * __Deprecated__: Please set the reference_id on the nested `order` field instead. An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters. * @return referenceId **/ - @ApiModelProperty(value = "__Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead. An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters.") + @ApiModelProperty(value = "__Deprecated__: Please set the reference_id on the nested `order` field instead. An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters.") public String getReferenceId() { return referenceId; } @@ -115,10 +115,10 @@ public CreateOrderRequest addLineItemsItem(CreateOrderRequestLineItem lineItemsI } /** - * __Deprecated__: Please set the line_items on the nested [order](#type-order) field instead. The line items to associate with this order. Each line item represents a different product to include in a purchase. + * __Deprecated__: Please set the line_items on the nested `order` field instead. The line items to associate with this order. Each line item represents a different product to include in a purchase. * @return lineItems **/ - @ApiModelProperty(value = "__Deprecated__: Please set the line_items on the nested [order](#type-order) field instead. The line items to associate with this order. Each line item represents a different product to include in a purchase.") + @ApiModelProperty(value = "__Deprecated__: Please set the line_items on the nested `order` field instead. The line items to associate with this order. Each line item represents a different product to include in a purchase.") public List getLineItems() { return lineItems; } @@ -138,10 +138,10 @@ public CreateOrderRequest addTaxesItem(CreateOrderRequestTax taxesItem) { } /** - * __Deprecated__: Please set the taxes on the nested [order](#type-order) field instead. The taxes to include on the order. + * __Deprecated__: Please set the taxes on the nested `order` field instead. The taxes to include on the order. * @return taxes **/ - @ApiModelProperty(value = "__Deprecated__: Please set the taxes on the nested [order](#type-order) field instead. The taxes to include on the order.") + @ApiModelProperty(value = "__Deprecated__: Please set the taxes on the nested `order` field instead. The taxes to include on the order.") public List getTaxes() { return taxes; } @@ -161,10 +161,10 @@ public CreateOrderRequest addDiscountsItem(CreateOrderRequestDiscount discountsI } /** - * __Deprecated__: Please set the discounts on the nested [order](#type-order) field instead. The discounts to include on the order. + * __Deprecated__: Please set the discounts on the nested `order` field instead. The discounts to include on the order. * @return discounts **/ - @ApiModelProperty(value = "__Deprecated__: Please set the discounts on the nested [order](#type-order) field instead. The discounts to include on the order.") + @ApiModelProperty(value = "__Deprecated__: Please set the discounts on the nested `order` field instead. The discounts to include on the order.") public List getDiscounts() { return discounts; } diff --git a/src/main/java/com/squareup/connect/models/CreateOrderRequestDiscount.java b/src/main/java/com/squareup/connect/models/CreateOrderRequestDiscount.java index dab08bb..d325cb2 100644 --- a/src/main/java/com/squareup/connect/models/CreateOrderRequestDiscount.java +++ b/src/main/java/com/squareup/connect/models/CreateOrderRequestDiscount.java @@ -45,10 +45,10 @@ public CreateOrderRequestDiscount catalogObjectId(String catalogObjectId) { } /** - * Only used for catalog discounts. The catalog object ID for an existing [CatalogDiscount](#type-catalogdiscount). Do not provide a value for this field if you provide values in other fields for an ad hoc discount. + * Only used for catalog discounts. The catalog object ID for an existing `CatalogDiscount`. Do not provide a value for this field if you provide values in other fields for an ad hoc discount. * @return catalogObjectId **/ - @ApiModelProperty(value = "Only used for catalog discounts. The catalog object ID for an existing [CatalogDiscount](#type-catalogdiscount). Do not provide a value for this field if you provide values in other fields for an ad hoc discount.") + @ApiModelProperty(value = "Only used for catalog discounts. The catalog object ID for an existing `CatalogDiscount`. Do not provide a value for this field if you provide values in other fields for an ad hoc discount.") public String getCatalogObjectId() { return catalogObjectId; } diff --git a/src/main/java/com/squareup/connect/models/CreateOrderRequestLineItem.java b/src/main/java/com/squareup/connect/models/CreateOrderRequestLineItem.java index deee65e..c14364a 100644 --- a/src/main/java/com/squareup/connect/models/CreateOrderRequestLineItem.java +++ b/src/main/java/com/squareup/connect/models/CreateOrderRequestLineItem.java @@ -101,10 +101,10 @@ public CreateOrderRequestLineItem basePriceMoney(Money basePriceMoney) { } /** - * The base price for a single unit of the line item. `base_price_money` is required for ad hoc line items and variable priced [CatalogItemVariation](#type-catalogitemvariation)s. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the CatalogItemVariation's price. + * The base price for a single unit of the line item. `base_price_money` is required for ad hoc line items and variable priced `CatalogItemVariation`s. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the CatalogItemVariation's price. * @return basePriceMoney **/ - @ApiModelProperty(value = "The base price for a single unit of the line item. `base_price_money` is required for ad hoc line items and variable priced [CatalogItemVariation](#type-catalogitemvariation)s. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the CatalogItemVariation's price.") + @ApiModelProperty(value = "The base price for a single unit of the line item. `base_price_money` is required for ad hoc line items and variable priced `CatalogItemVariation`s. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the CatalogItemVariation's price.") public Money getBasePriceMoney() { return basePriceMoney; } @@ -155,10 +155,10 @@ public CreateOrderRequestLineItem catalogObjectId(String catalogObjectId) { } /** - * Only used for Catalog line items. The catalog object ID for an existing [CatalogItemVariation](#type-catalogitemvariation). Do not provide a value for this field if you provide a value for `name` and `base_price_money`. + * Only used for Catalog line items. The catalog object ID for an existing `CatalogItemVariation`. Do not provide a value for this field if you provide a value for `name` and `base_price_money`. * @return catalogObjectId **/ - @ApiModelProperty(value = "Only used for Catalog line items. The catalog object ID for an existing [CatalogItemVariation](#type-catalogitemvariation). Do not provide a value for this field if you provide a value for `name` and `base_price_money`.") + @ApiModelProperty(value = "Only used for Catalog line items. The catalog object ID for an existing `CatalogItemVariation`. Do not provide a value for this field if you provide a value for `name` and `base_price_money`.") public String getCatalogObjectId() { return catalogObjectId; } diff --git a/src/main/java/com/squareup/connect/models/CreateOrderRequestModifier.java b/src/main/java/com/squareup/connect/models/CreateOrderRequestModifier.java index eb5bfbb..ed6e077 100644 --- a/src/main/java/com/squareup/connect/models/CreateOrderRequestModifier.java +++ b/src/main/java/com/squareup/connect/models/CreateOrderRequestModifier.java @@ -42,10 +42,10 @@ public CreateOrderRequestModifier catalogObjectId(String catalogObjectId) { } /** - * The catalog object ID of a [CatalogModifier](#type-catalogmodifier). + * The catalog object ID of a `CatalogModifier`. * @return catalogObjectId **/ - @ApiModelProperty(value = "The catalog object ID of a [CatalogModifier](#type-catalogmodifier).") + @ApiModelProperty(value = "The catalog object ID of a `CatalogModifier`.") public String getCatalogObjectId() { return catalogObjectId; } @@ -78,10 +78,10 @@ public CreateOrderRequestModifier basePriceMoney(Money basePriceMoney) { } /** - * The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price. + * The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price. * @return basePriceMoney **/ - @ApiModelProperty(value = "The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price.") + @ApiModelProperty(value = "The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price.") public Money getBasePriceMoney() { return basePriceMoney; } diff --git a/src/main/java/com/squareup/connect/models/CreateOrderRequestTax.java b/src/main/java/com/squareup/connect/models/CreateOrderRequestTax.java index 047a4ae..9153a88 100644 --- a/src/main/java/com/squareup/connect/models/CreateOrderRequestTax.java +++ b/src/main/java/com/squareup/connect/models/CreateOrderRequestTax.java @@ -44,10 +44,10 @@ public CreateOrderRequestTax catalogObjectId(String catalogObjectId) { } /** - * Only used for catalog taxes. The catalog object ID of an existing [CatalogTax](#type-catalogtax). Do not provide a value for this field if you provide values in other fields for an ad hoc tax. + * Only used for catalog taxes. The catalog object ID of an existing `CatalogTax`. Do not provide a value for this field if you provide values in other fields for an ad hoc tax. * @return catalogObjectId **/ - @ApiModelProperty(value = "Only used for catalog taxes. The catalog object ID of an existing [CatalogTax](#type-catalogtax). Do not provide a value for this field if you provide values in other fields for an ad hoc tax.") + @ApiModelProperty(value = "Only used for catalog taxes. The catalog object ID of an existing `CatalogTax`. Do not provide a value for this field if you provide values in other fields for an ad hoc tax.") public String getCatalogObjectId() { return catalogObjectId; } @@ -80,10 +80,10 @@ public CreateOrderRequestTax type(String type) { } /** - * Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values + * Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See `OrderLineItemTaxType` for possible values. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values * @return type **/ - @ApiModelProperty(value = "Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values") + @ApiModelProperty(value = "Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See `OrderLineItemTaxType` for possible values. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values") public String getType() { return type; } diff --git a/src/main/java/com/squareup/connect/models/CreatePaymentRequest.java b/src/main/java/com/squareup/connect/models/CreatePaymentRequest.java index 2402e9f..da3ed78 100644 --- a/src/main/java/com/squareup/connect/models/CreatePaymentRequest.java +++ b/src/main/java/com/squareup/connect/models/CreatePaymentRequest.java @@ -100,10 +100,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](/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](/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; } @@ -118,10 +118,10 @@ public CreatePaymentRequest amountMoney(Money amountMoney) { } /** - * 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](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. + * 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. * @return amountMoney **/ - @ApiModelProperty(required = true, value = "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](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment.") + @ApiModelProperty(required = true, value = "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.") public Money getAmountMoney() { return amountMoney; } @@ -136,10 +136,10 @@ public CreatePaymentRequest tipMoney(Money tipMoney) { } /** - * 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](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. + * 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. * @return tipMoney **/ - @ApiModelProperty(value = "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](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment.") + @ApiModelProperty(value = "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.") public Money getTipMoney() { return tipMoney; } @@ -154,10 +154,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](/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](/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](/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](/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; } @@ -172,10 +172,10 @@ public CreatePaymentRequest autocomplete(Boolean autocomplete) { } /** - * 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 or canceled. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). Default: true + * 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 * @return autocomplete **/ - @ApiModelProperty(value = "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 or canceled. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). Default: true") + @ApiModelProperty(value = "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") public Boolean getAutocomplete() { return autocomplete; } @@ -262,10 +262,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](/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/docs/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](/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/docs/sca-overview) for more.") public String getVerificationToken() { return verificationToken; } @@ -280,10 +280,10 @@ 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](/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 * @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](/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; } diff --git a/src/main/java/com/squareup/connect/models/CreateRefundRequest.java b/src/main/java/com/squareup/connect/models/CreateRefundRequest.java index 5869bcb..beb158c 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](/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](https://developer.squareup.com/docs/basics/api101/idempotency) 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](/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](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") public String getIdempotencyKey() { return idempotencyKey; } @@ -63,10 +63,10 @@ public CreateRefundRequest tenderId(String tenderId) { } /** - * The ID of the tender to refund. A [`Transaction`](#type-transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. + * 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. * @return tenderId **/ - @ApiModelProperty(required = true, value = "The ID of the tender to refund. A [`Transaction`](#type-transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API.") + @ApiModelProperty(required = true, value = "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.") public String getTenderId() { return tenderId; } diff --git a/src/main/java/com/squareup/connect/models/DeleteCatalogObjectResponse.java b/src/main/java/com/squareup/connect/models/DeleteCatalogObjectResponse.java index e818a39..9e9adf7 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](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } @@ -72,10 +72,10 @@ public DeleteCatalogObjectResponse addDeletedObjectIdsItem(String deletedObjectI } /** - * The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a [CatalogItemVariation](#type-catalogitemvariation) will be deleted (and its ID included in this field) when its parent [CatalogItem](#type-catalogitem) is deleted. + * 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. * @return deletedObjectIds **/ - @ApiModelProperty(value = "The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a [CatalogItemVariation](#type-catalogitemvariation) will be deleted (and its ID included in this field) when its parent [CatalogItem](#type-catalogitem) is deleted.") + @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.") public List getDeletedObjectIds() { return deletedObjectIds; } diff --git a/src/main/java/com/squareup/connect/models/Error.java b/src/main/java/com/squareup/connect/models/Error.java index 21aa165..b1aeb38 100644 --- a/src/main/java/com/squareup/connect/models/Error.java +++ b/src/main/java/com/squareup/connect/models/Error.java @@ -44,10 +44,10 @@ public Error category(String category) { } /** - * The high-level category for the error. See [ErrorCategory](#type-errorcategory) See [ErrorCategory](#type-errorcategory) for possible values + * The high-level category for the error. See [ErrorCategory](#type-errorcategory) for possible values * @return category **/ - @ApiModelProperty(required = true, value = "The high-level category for the error. See [ErrorCategory](#type-errorcategory) See [ErrorCategory](#type-errorcategory) for possible values") + @ApiModelProperty(required = true, value = "The high-level category for the error. 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 See [ErrorCode](#type-errorcode) for possible values + * The specific code of the error. 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 See [ErrorCode](#type-errorcode) for possible values") + @ApiModelProperty(required = true, value = "The specific code of the error. See [ErrorCode](#type-errorcode) for possible values") public String getCode() { return code; } diff --git a/src/main/java/com/squareup/connect/models/InventoryAdjustment.java b/src/main/java/com/squareup/connect/models/InventoryAdjustment.java index 76be73f..d911fd8 100644 --- a/src/main/java/com/squareup/connect/models/InventoryAdjustment.java +++ b/src/main/java/com/squareup/connect/models/InventoryAdjustment.java @@ -85,10 +85,10 @@ public InventoryAdjustment id(String id) { } /** - * A unique ID generated by Square for the [InventoryAdjustment](#type-inventoryadjustment). + * A unique ID generated by Square for the `InventoryAdjustment`. * @return id **/ - @ApiModelProperty(value = "A unique ID generated by Square for the [InventoryAdjustment](#type-inventoryadjustment).") + @ApiModelProperty(value = "A unique ID generated by Square for the `InventoryAdjustment`.") public String getId() { return id; } @@ -103,10 +103,10 @@ public InventoryAdjustment referenceId(String referenceId) { } /** - * An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system. + * An optional ID provided by the application to tie the `InventoryAdjustment` to an external system. * @return referenceId **/ - @ApiModelProperty(value = "An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system.") + @ApiModelProperty(value = "An optional ID provided by the application to tie the `InventoryAdjustment` to an external system.") public String getReferenceId() { return referenceId; } @@ -121,10 +121,10 @@ public InventoryAdjustment fromState(String fromState) { } /** - * The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values + * The `InventoryState` of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values * @return fromState **/ - @ApiModelProperty(value = "The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values") + @ApiModelProperty(value = "The `InventoryState` of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values") public String getFromState() { return fromState; } @@ -139,10 +139,10 @@ public InventoryAdjustment toState(String toState) { } /** - * The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values + * The `InventoryState` of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values * @return toState **/ - @ApiModelProperty(value = "The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values") + @ApiModelProperty(value = "The `InventoryState` of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values") public String getToState() { return toState; } @@ -157,10 +157,10 @@ public InventoryAdjustment locationId(String locationId) { } /** - * The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. + * The Square ID of the `Location` where the related quantity of items are being tracked. * @return locationId **/ - @ApiModelProperty(value = "The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.") + @ApiModelProperty(value = "The Square ID of the `Location` where the related quantity of items are being tracked.") public String getLocationId() { return locationId; } @@ -175,10 +175,10 @@ public InventoryAdjustment catalogObjectId(String catalogObjectId) { } /** - * The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. + * The Square generated ID of the `CatalogObject` being tracked. * @return catalogObjectId **/ - @ApiModelProperty(value = "The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.") + @ApiModelProperty(value = "The Square generated ID of the `CatalogObject` being tracked.") public String getCatalogObjectId() { return catalogObjectId; } @@ -193,10 +193,10 @@ public InventoryAdjustment catalogObjectType(String catalogObjectType) { } /** - * The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. + * The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. * @return catalogObjectType **/ - @ApiModelProperty(value = "The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type.") + @ApiModelProperty(value = "The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type.") public String getCatalogObjectType() { return catalogObjectType; } @@ -211,10 +211,10 @@ 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)](/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/orders-api/what-it-does#decimal-quantities) for more information. * @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)](/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/orders-api/what-it-does#decimal-quantities) for more information.") public String getQuantity() { return quantity; } @@ -301,10 +301,10 @@ public InventoryAdjustment employeeId(String employeeId) { } /** - * The Square ID of the [Employee](#type-employee) responsible for the inventory adjustment. + * The Square ID of the `Employee` responsible for the inventory adjustment. * @return employeeId **/ - @ApiModelProperty(value = "The Square ID of the [Employee](#type-employee) responsible for the inventory adjustment.") + @ApiModelProperty(value = "The Square ID of the `Employee` responsible for the inventory adjustment.") public String getEmployeeId() { return employeeId; } diff --git a/src/main/java/com/squareup/connect/models/InventoryCount.java b/src/main/java/com/squareup/connect/models/InventoryCount.java index d56e6c8..7c784cc 100644 --- a/src/main/java/com/squareup/connect/models/InventoryCount.java +++ b/src/main/java/com/squareup/connect/models/InventoryCount.java @@ -50,10 +50,10 @@ public InventoryCount catalogObjectId(String catalogObjectId) { } /** - * The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. + * The Square generated ID of the `CatalogObject` being tracked. * @return catalogObjectId **/ - @ApiModelProperty(value = "The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.") + @ApiModelProperty(value = "The Square generated ID of the `CatalogObject` being tracked.") public String getCatalogObjectId() { return catalogObjectId; } @@ -68,10 +68,10 @@ public InventoryCount catalogObjectType(String catalogObjectType) { } /** - * The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. + * The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. * @return catalogObjectType **/ - @ApiModelProperty(value = "The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type.") + @ApiModelProperty(value = "The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type.") public String getCatalogObjectType() { return catalogObjectType; } @@ -86,10 +86,10 @@ public InventoryCount state(String state) { } /** - * The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values + * The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values * @return state **/ - @ApiModelProperty(value = "The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values") + @ApiModelProperty(value = "The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values") public String getState() { return state; } @@ -104,10 +104,10 @@ public InventoryCount locationId(String locationId) { } /** - * The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. + * The Square ID of the `Location` where the related quantity of items are being tracked. * @return locationId **/ - @ApiModelProperty(value = "The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.") + @ApiModelProperty(value = "The Square ID of the `Location` where the related quantity of items are being tracked.") public String getLocationId() { return locationId; } @@ -122,10 +122,10 @@ 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)](/orders-api/what-it-does#decimal-quantities) for more information. + * 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. * @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)](/orders-api/what-it-does#decimal-quantities) for more information.") + @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.") 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 77ba868..ad2e54d 100644 --- a/src/main/java/com/squareup/connect/models/InventoryPhysicalCount.java +++ b/src/main/java/com/squareup/connect/models/InventoryPhysicalCount.java @@ -66,10 +66,10 @@ public InventoryPhysicalCount id(String id) { } /** - * A unique ID generated by Square for the [InventoryPhysicalCount](#type-inventoryphysicalcount). + * A unique ID generated by Square for the `InventoryPhysicalCount`. * @return id **/ - @ApiModelProperty(value = "A unique ID generated by Square for the [InventoryPhysicalCount](#type-inventoryphysicalcount).") + @ApiModelProperty(value = "A unique ID generated by Square for the `InventoryPhysicalCount`.") public String getId() { return id; } @@ -84,10 +84,10 @@ public InventoryPhysicalCount referenceId(String referenceId) { } /** - * An optional ID provided by the application to tie the [InventoryPhysicalCount](#type-inventoryphysicalcount) to an external system. + * An optional ID provided by the application to tie the `InventoryPhysicalCount` to an external system. * @return referenceId **/ - @ApiModelProperty(value = "An optional ID provided by the application to tie the [InventoryPhysicalCount](#type-inventoryphysicalcount) to an external system.") + @ApiModelProperty(value = "An optional ID provided by the application to tie the `InventoryPhysicalCount` to an external system.") public String getReferenceId() { return referenceId; } @@ -102,10 +102,10 @@ public InventoryPhysicalCount catalogObjectId(String catalogObjectId) { } /** - * The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. + * The Square generated ID of the `CatalogObject` being tracked. * @return catalogObjectId **/ - @ApiModelProperty(value = "The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.") + @ApiModelProperty(value = "The Square generated ID of the `CatalogObject` being tracked.") public String getCatalogObjectId() { return catalogObjectId; } @@ -120,10 +120,10 @@ public InventoryPhysicalCount catalogObjectType(String catalogObjectType) { } /** - * The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. + * The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. * @return catalogObjectType **/ - @ApiModelProperty(value = "The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type.") + @ApiModelProperty(value = "The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type.") public String getCatalogObjectType() { return catalogObjectType; } @@ -138,10 +138,10 @@ public InventoryPhysicalCount state(String state) { } /** - * The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values + * The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values * @return state **/ - @ApiModelProperty(value = "The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values") + @ApiModelProperty(value = "The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values") public String getState() { return state; } @@ -156,10 +156,10 @@ public InventoryPhysicalCount locationId(String locationId) { } /** - * The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. + * The Square ID of the `Location` where the related quantity of items are being tracked. * @return locationId **/ - @ApiModelProperty(value = "The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.") + @ApiModelProperty(value = "The Square ID of the `Location` where the related quantity of items are being tracked.") public String getLocationId() { return locationId; } @@ -174,10 +174,10 @@ 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)](/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/orders-api/what-it-does#decimal-quantities) for more information. * @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)](/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/orders-api/what-it-does#decimal-quantities) for more information.") public String getQuantity() { return quantity; } @@ -210,10 +210,10 @@ public InventoryPhysicalCount employeeId(String employeeId) { } /** - * The Square ID of the [Employee](#type-employee) responsible for the physical count. + * The Square ID of the `Employee` responsible for the physical count. * @return employeeId **/ - @ApiModelProperty(value = "The Square ID of the [Employee](#type-employee) responsible for the physical count.") + @ApiModelProperty(value = "The Square ID of the `Employee` responsible for the physical count.") public String getEmployeeId() { return employeeId; } diff --git a/src/main/java/com/squareup/connect/models/InventoryTransfer.java b/src/main/java/com/squareup/connect/models/InventoryTransfer.java index 7a26695..8b47fcb 100644 --- a/src/main/java/com/squareup/connect/models/InventoryTransfer.java +++ b/src/main/java/com/squareup/connect/models/InventoryTransfer.java @@ -69,10 +69,10 @@ public InventoryTransfer id(String id) { } /** - * A unique ID generated by Square for the [InventoryTransfer](#type-inventorytransfer). + * A unique ID generated by Square for the `InventoryTransfer`. * @return id **/ - @ApiModelProperty(value = "A unique ID generated by Square for the [InventoryTransfer](#type-inventorytransfer).") + @ApiModelProperty(value = "A unique ID generated by Square for the `InventoryTransfer`.") public String getId() { return id; } @@ -87,10 +87,10 @@ public InventoryTransfer referenceId(String referenceId) { } /** - * An optional ID provided by the application to tie the [InventoryTransfer](#type-inventorytransfer) to an external system. + * An optional ID provided by the application to tie the `InventoryTransfer` to an external system. * @return referenceId **/ - @ApiModelProperty(value = "An optional ID provided by the application to tie the [InventoryTransfer](#type-inventorytransfer) to an external system.") + @ApiModelProperty(value = "An optional ID provided by the application to tie the `InventoryTransfer` to an external system.") public String getReferenceId() { return referenceId; } @@ -105,10 +105,10 @@ public InventoryTransfer state(String state) { } /** - * The [InventoryState](#type-inventorystate) for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values + * The `InventoryState` for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values * @return state **/ - @ApiModelProperty(value = "The [InventoryState](#type-inventorystate) for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values") + @ApiModelProperty(value = "The `InventoryState` for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values") public String getState() { return state; } @@ -123,10 +123,10 @@ public InventoryTransfer fromLocationId(String fromLocationId) { } /** - * The Square ID of the [Location](#type-location) where the related quantity of items were tracked before the transfer. + * The Square ID of the `Location` where the related quantity of items were tracked before the transfer. * @return fromLocationId **/ - @ApiModelProperty(value = "The Square ID of the [Location](#type-location) where the related quantity of items were tracked before the transfer.") + @ApiModelProperty(value = "The Square ID of the `Location` where the related quantity of items were tracked before the transfer.") public String getFromLocationId() { return fromLocationId; } @@ -141,10 +141,10 @@ public InventoryTransfer toLocationId(String toLocationId) { } /** - * The Square ID of the [Location](#type-location) where the related quantity of items were tracked after the transfer. + * The Square ID of the `Location` where the related quantity of items were tracked after the transfer. * @return toLocationId **/ - @ApiModelProperty(value = "The Square ID of the [Location](#type-location) where the related quantity of items were tracked after the transfer.") + @ApiModelProperty(value = "The Square ID of the `Location` where the related quantity of items were tracked after the transfer.") public String getToLocationId() { return toLocationId; } @@ -159,10 +159,10 @@ public InventoryTransfer catalogObjectId(String catalogObjectId) { } /** - * The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. + * The Square generated ID of the `CatalogObject` being tracked. * @return catalogObjectId **/ - @ApiModelProperty(value = "The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked.") + @ApiModelProperty(value = "The Square generated ID of the `CatalogObject` being tracked.") public String getCatalogObjectId() { return catalogObjectId; } @@ -177,10 +177,10 @@ public InventoryTransfer catalogObjectType(String catalogObjectType) { } /** - * The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked.Tracking is only supported for the `ITEM_VARIATION` type. + * The `CatalogObjectType` of the `CatalogObject` being tracked.Tracking is only supported for the `ITEM_VARIATION` type. * @return catalogObjectType **/ - @ApiModelProperty(value = "The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked.Tracking is only supported for the `ITEM_VARIATION` type.") + @ApiModelProperty(value = "The `CatalogObjectType` of the `CatalogObject` being tracked.Tracking is only supported for the `ITEM_VARIATION` type.") public String getCatalogObjectType() { return catalogObjectType; } @@ -195,10 +195,10 @@ 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)](/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/orders-api/what-it-does#decimal-quantities) for more information. * @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)](/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/orders-api/what-it-does#decimal-quantities) for more information.") public String getQuantity() { return quantity; } @@ -267,10 +267,10 @@ public InventoryTransfer employeeId(String employeeId) { } /** - * The Square ID of the [Employee](#type-employee) responsible for the inventory transfer. + * The Square ID of the `Employee` responsible for the inventory transfer. * @return employeeId **/ - @ApiModelProperty(value = "The Square ID of the [Employee](#type-employee) responsible for the inventory transfer.") + @ApiModelProperty(value = "The Square ID of the `Employee` responsible for the inventory transfer.") public String getEmployeeId() { return employeeId; } diff --git a/src/main/java/com/squareup/connect/models/ItemVariationLocationOverrides.java b/src/main/java/com/squareup/connect/models/ItemVariationLocationOverrides.java index 114e7a3..2b17c53 100644 --- a/src/main/java/com/squareup/connect/models/ItemVariationLocationOverrides.java +++ b/src/main/java/com/squareup/connect/models/ItemVariationLocationOverrides.java @@ -51,10 +51,10 @@ public ItemVariationLocationOverrides locationId(String locationId) { } /** - * The ID of the [location](#type-location). + * The ID of the `location`. * @return locationId **/ - @ApiModelProperty(value = "The ID of the [location](#type-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](#type-location), or blank for variable pricing. + * The price of the `CatalogItemVariation](#type-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](#type-location), or blank for variable pricing.") + @ApiModelProperty(value = "The price of the `CatalogItemVariation](#type-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](#type-location). See [CatalogPricingType](#type-catalogpricingtype) for possible values + * The pricing type (fixed or variable) for the `CatalogItemVariation](#type-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](#type-location). See [CatalogPricingType](#type-catalogpricingtype) for possible values") + @ApiModelProperty(value = "The pricing type (fixed or variable) for the `CatalogItemVariation](#type-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](#type-location). + * If `true`, inventory tracking is active for the `CatalogItemVariation](#type-catalogitemvariation) at this [location`. * @return trackInventory **/ - @ApiModelProperty(value = "If `true`, inventory tracking is active for the [CatalogItemVariation](#type-catalogitemvariation) at this [location](#type-location).") + @ApiModelProperty(value = "If `true`, inventory tracking is active for the `CatalogItemVariation](#type-catalogitemvariation) at this [location`.") public Boolean getTrackInventory() { return trackInventory; } @@ -123,10 +123,10 @@ public ItemVariationLocationOverrides inventoryAlertType(String inventoryAlertTy } /** - * Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values + * 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 * @return inventoryAlertType **/ - @ApiModelProperty(value = "Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values") + @ApiModelProperty(value = "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") public String getInventoryAlertType() { return inventoryAlertType; } diff --git a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsRequest.java b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsRequest.java index bdb65b9..1378e68 100644 --- a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsRequest.java +++ b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsRequest.java @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 cf9b184..5889c51 100644 --- a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsResponse.java +++ b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivableRefundsResponse.java @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 2e1f302..38f1d96 100644 --- a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesRequest.java +++ b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesRequest.java @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 ddc3550..9883793 100644 --- a/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesResponse.java +++ b/src/main/java/com/squareup/connect/models/ListAdditionalRecipientReceivablesResponse.java @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 875cb68..2f01053 100644 --- a/src/main/java/com/squareup/connect/models/ListCatalogRequest.java +++ b/src/main/java/com/squareup/connect/models/ListCatalogRequest.java @@ -38,10 +38,10 @@ public ListCatalogRequest cursor(String cursor) { } /** - * The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. + * 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. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "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.") public String getCursor() { return cursor; } @@ -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](#type-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` enumeration, namely `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](#type-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` enumeration, namely `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 fcadd03..92d6fba 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](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } @@ -68,10 +68,10 @@ public ListCatalogResponse cursor(String cursor) { } /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. + * 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. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } @@ -91,10 +91,10 @@ public ListCatalogResponse addObjectsItem(CatalogObject objectsItem) { } /** - * The [CatalogObject](#type-catalogobject)s returned. + * The `CatalogObject`s returned. * @return objects **/ - @ApiModelProperty(value = "The [CatalogObject](#type-catalogobject)s returned.") + @ApiModelProperty(value = "The `CatalogObject`s 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 fac6087..476977e 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListCustomersResponse.java b/src/main/java/com/squareup/connect/models/ListCustomersResponse.java index 65c926c..cde4aca 100644 --- a/src/main/java/com/squareup/connect/models/ListCustomersResponse.java +++ b/src/main/java/com/squareup/connect/models/ListCustomersResponse.java @@ -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](/basics/api101/pagination) for more information. + * 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. * @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](/basics/api101/pagination) for more information.") + @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.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListPaymentRefundsRequest.java b/src/main/java/com/squareup/connect/models/ListPaymentRefundsRequest.java index 73e7272..0e7adb7 100644 --- a/src/main/java/com/squareup/connect/models/ListPaymentRefundsRequest.java +++ b/src/main/java/com/squareup/connect/models/ListPaymentRefundsRequest.java @@ -107,10 +107,10 @@ public ListPaymentRefundsRequest 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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 the original query. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } @@ -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](#type-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](#type-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; } diff --git a/src/main/java/com/squareup/connect/models/ListPaymentRefundsResponse.java b/src/main/java/com/squareup/connect/models/ListPaymentRefundsResponse.java index 87026f5..27a353d 100644 --- a/src/main/java/com/squareup/connect/models/ListPaymentRefundsResponse.java +++ b/src/main/java/com/squareup/connect/models/ListPaymentRefundsResponse.java @@ -91,10 +91,10 @@ public ListPaymentRefundsResponse cursor(String cursor) { } /** - * The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](/basics/api101/pagination) for more information. + * The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListPaymentsRequest.java b/src/main/java/com/squareup/connect/models/ListPaymentsRequest.java index 443aa3f..3243cc7 100644 --- a/src/main/java/com/squareup/connect/models/ListPaymentsRequest.java +++ b/src/main/java/com/squareup/connect/models/ListPaymentsRequest.java @@ -110,10 +110,10 @@ public ListPaymentsRequest 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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 the original query. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListPaymentsResponse.java b/src/main/java/com/squareup/connect/models/ListPaymentsResponse.java index 887ca3a..38f1c77 100644 --- a/src/main/java/com/squareup/connect/models/ListPaymentsResponse.java +++ b/src/main/java/com/squareup/connect/models/ListPaymentsResponse.java @@ -91,10 +91,10 @@ public ListPaymentsResponse cursor(String cursor) { } /** - * The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](/basics/api101/pagination) for more information. + * The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/ListRefundsRequest.java b/src/main/java/com/squareup/connect/models/ListRefundsRequest.java index 7721c20..03c2cfa 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 d98cd73..c0ac593 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 fb46360..38ce5c2 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 5eac898..773f95f 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 506abe9..7503da8 100644 --- a/src/main/java/com/squareup/connect/models/Location.java +++ b/src/main/java/com/squareup/connect/models/Location.java @@ -103,6 +103,9 @@ public class Location { @JsonProperty("pos_background_url") private String posBackgroundUrl = null; + @JsonProperty("mcc") + private String mcc = null; + public Location id(String id) { this.id = id; return this; @@ -438,10 +441,10 @@ public Location twitterUsername(String twitterUsername) { } /** - * The Twitter username of the location without the ' + * The Twitter username of the location without the '@' symbol. * @return twitterUsername **/ - @ApiModelProperty(value = "The Twitter username of the location without the '") + @ApiModelProperty(value = "The Twitter username of the location without the '@' symbol.") public String getTwitterUsername() { return twitterUsername; } @@ -456,10 +459,10 @@ public Location instagramUsername(String instagramUsername) { } /** - * The Instagram username of the location without the ' + * The Instagram username of the location without the '@' symbol. * @return instagramUsername **/ - @ApiModelProperty(value = "The Instagram username of the location without the '") + @ApiModelProperty(value = "The Instagram username of the location without the '@' symbol.") public String getInstagramUsername() { return instagramUsername; } @@ -540,6 +543,24 @@ public void setPosBackgroundUrl(String posBackgroundUrl) { this.posBackgroundUrl = posBackgroundUrl; } + public Location mcc(String mcc) { + this.mcc = mcc; + return this; + } + + /** + * 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. + * @return mcc + **/ + @ApiModelProperty(value = "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.") + public String getMcc() { + return mcc; + } + + public void setMcc(String mcc) { + this.mcc = mcc; + } + @Override public boolean equals(java.lang.Object o) { @@ -573,12 +594,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.facebookUrl, location.facebookUrl) && Objects.equals(this.coordinates, location.coordinates) && Objects.equals(this.logoUrl, location.logoUrl) && - Objects.equals(this.posBackgroundUrl, location.posBackgroundUrl); + Objects.equals(this.posBackgroundUrl, location.posBackgroundUrl) && + Objects.equals(this.mcc, location.mcc); } @Override public int hashCode() { - return Objects.hash(id, name, address, timezone, capabilities, status, createdAt, merchantId, country, languageCode, currency, phoneNumber, businessName, type, websiteUrl, businessHours, businessEmail, description, twitterUsername, instagramUsername, facebookUrl, coordinates, logoUrl, posBackgroundUrl); + return Objects.hash(id, name, address, timezone, capabilities, status, createdAt, merchantId, country, languageCode, currency, phoneNumber, businessName, type, websiteUrl, businessHours, businessEmail, description, twitterUsername, instagramUsername, facebookUrl, coordinates, logoUrl, posBackgroundUrl, mcc); } @@ -611,6 +633,7 @@ public String toString() { sb.append(" coordinates: ").append(toIndentedString(coordinates)).append("\n"); sb.append(" logoUrl: ").append(toIndentedString(logoUrl)).append("\n"); sb.append(" posBackgroundUrl: ").append(toIndentedString(posBackgroundUrl)).append("\n"); + sb.append(" mcc: ").append(toIndentedString(mcc)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/squareup/connect/models/MeasurementUnit.java b/src/main/java/com/squareup/connect/models/MeasurementUnit.java index 5c645b5..a72725e 100644 --- a/src/main/java/com/squareup/connect/models/MeasurementUnit.java +++ b/src/main/java/com/squareup/connect/models/MeasurementUnit.java @@ -22,9 +22,9 @@ import io.swagger.annotations.ApiModelProperty; /** - * Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. The `family` field describes the type of measurement. For example, ounces are in the weight family. + * Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. */ -@ApiModel(description = "Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. The `family` field describes the type of measurement. For example, ounces are in the weight family.") +@ApiModel(description = "Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.") public class MeasurementUnit { @JsonProperty("custom_unit") @@ -45,6 +45,9 @@ public class MeasurementUnit { @JsonProperty("generic_unit") private String genericUnit = null; + @JsonProperty("time_unit") + private String timeUnit = null; + @JsonProperty("type") private String type = null; @@ -156,6 +159,24 @@ public void setGenericUnit(String genericUnit) { this.genericUnit = genericUnit; } + public MeasurementUnit timeUnit(String timeUnit) { + this.timeUnit = timeUnit; + return this; + } + + /** + * Represents a standard unit of time. See [MeasurementUnitTime](#type-measurementunittime) for possible values + * @return timeUnit + **/ + @ApiModelProperty(value = "Represents a standard unit of time. See [MeasurementUnitTime](#type-measurementunittime) for possible values") + public String getTimeUnit() { + return timeUnit; + } + + public void setTimeUnit(String timeUnit) { + this.timeUnit = timeUnit; + } + public MeasurementUnit type(String type) { this.type = type; return this; @@ -190,12 +211,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.volumeUnit, measurementUnit.volumeUnit) && Objects.equals(this.weightUnit, measurementUnit.weightUnit) && Objects.equals(this.genericUnit, measurementUnit.genericUnit) && + Objects.equals(this.timeUnit, measurementUnit.timeUnit) && Objects.equals(this.type, measurementUnit.type); } @Override public int hashCode() { - return Objects.hash(customUnit, areaUnit, lengthUnit, volumeUnit, weightUnit, genericUnit, type); + return Objects.hash(customUnit, areaUnit, lengthUnit, volumeUnit, weightUnit, genericUnit, timeUnit, type); } @@ -210,6 +232,7 @@ public String toString() { sb.append(" volumeUnit: ").append(toIndentedString(volumeUnit)).append("\n"); sb.append(" weightUnit: ").append(toIndentedString(weightUnit)).append("\n"); sb.append(" genericUnit: ").append(toIndentedString(genericUnit)).append("\n"); + sb.append(" timeUnit: ").append(toIndentedString(timeUnit)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/com/squareup/connect/models/Merchant.java b/src/main/java/com/squareup/connect/models/Merchant.java new file mode 100644 index 0000000..4d1eb25 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/Merchant.java @@ -0,0 +1,206 @@ +/* + * 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; + +/** + * Represents a Square seller. + */ +@ApiModel(description = "Represents a Square seller.") + +public class Merchant { + @JsonProperty("id") + private String id = null; + + @JsonProperty("business_name") + private String businessName = null; + + @JsonProperty("country") + private String country = null; + + @JsonProperty("language_code") + private String languageCode = null; + + @JsonProperty("currency") + private String currency = null; + + @JsonProperty("status") + private String status = null; + + public Merchant id(String id) { + this.id = id; + return this; + } + + /** + * The Square-issued ID of the merchant. + * @return id + **/ + @ApiModelProperty(value = "The Square-issued ID of the merchant.") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public Merchant businessName(String businessName) { + this.businessName = businessName; + return this; + } + + /** + * The business name of the merchant. + * @return businessName + **/ + @ApiModelProperty(value = "The business name of the merchant.") + public String getBusinessName() { + return businessName; + } + + public void setBusinessName(String businessName) { + this.businessName = businessName; + } + + public Merchant country(String country) { + this.country = country; + return this; + } + + /** + * The country code associated with the merchant account, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values + * @return country + **/ + @ApiModelProperty(required = true, value = "The country code associated with the merchant account, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values") + public String getCountry() { + return country; + } + + public void setCountry(String country) { + this.country = country; + } + + public Merchant languageCode(String languageCode) { + this.languageCode = languageCode; + return this; + } + + /** + * The language code associated with the merchant account, in BCP 47 format. + * @return languageCode + **/ + @ApiModelProperty(value = "The language code associated with the merchant account, in BCP 47 format.") + public String getLanguageCode() { + return languageCode; + } + + public void setLanguageCode(String languageCode) { + this.languageCode = languageCode; + } + + public Merchant currency(String currency) { + this.currency = currency; + return this; + } + + /** + * The currency associated with the merchant account, in ISO 4217 format. See [Currency](#type-currency) for possible values + * @return currency + **/ + @ApiModelProperty(value = "The currency associated with the merchant account, in ISO 4217 format. See [Currency](#type-currency) for possible values") + public String getCurrency() { + return currency; + } + + public void setCurrency(String currency) { + this.currency = currency; + } + + public Merchant status(String status) { + this.status = status; + return this; + } + + /** + * The merchant status, active or inactive. See [MerchantStatus](#type-merchantstatus) for possible values + * @return status + **/ + @ApiModelProperty(value = "The merchant status, active or inactive. See [MerchantStatus](#type-merchantstatus) for possible values") + public String getStatus() { + return status; + } + + public void setStatus(String status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Merchant merchant = (Merchant) o; + return Objects.equals(this.id, merchant.id) && + Objects.equals(this.businessName, merchant.businessName) && + Objects.equals(this.country, merchant.country) && + Objects.equals(this.languageCode, merchant.languageCode) && + Objects.equals(this.currency, merchant.currency) && + Objects.equals(this.status, merchant.status); + } + + @Override + public int hashCode() { + return Objects.hash(id, businessName, country, languageCode, currency, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Merchant {\n"); + + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" businessName: ").append(toIndentedString(businessName)).append("\n"); + sb.append(" country: ").append(toIndentedString(country)).append("\n"); + sb.append(" languageCode: ").append(toIndentedString(languageCode)).append("\n"); + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).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/Money.java b/src/main/java/com/squareup/connect/models/Money.java index b0575e8..7a95131 100644 --- a/src/main/java/com/squareup/connect/models/Money.java +++ b/src/main/java/com/squareup/connect/models/Money.java @@ -56,10 +56,10 @@ public Money currency(String currency) { } /** - * The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](#type-currency) for possible values. See [Currency](#type-currency) for possible values + * 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 * @return currency **/ - @ApiModelProperty(value = "The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](#type-currency) for possible values. See [Currency](#type-currency) for possible values") + @ApiModelProperty(value = "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") public String getCurrency() { return currency; } diff --git a/src/main/java/com/squareup/connect/models/ObtainTokenRequest.java b/src/main/java/com/squareup/connect/models/ObtainTokenRequest.java index 1304ce6..5daab21 100644 --- a/src/main/java/com/squareup/connect/models/ObtainTokenRequest.java +++ b/src/main/java/com/squareup/connect/models/ObtainTokenRequest.java @@ -56,7 +56,7 @@ public ObtainTokenRequest clientId(String clientId) { * The Square-issued ID of your application, available from the [application dashboard](https://connect.squareup.com/apps). * @return clientId **/ - @ApiModelProperty(value = "The Square-issued ID of your application, available from the [application dashboard](https://connect.squareup.com/apps).") + @ApiModelProperty(required = true, value = "The Square-issued ID of your application, available from the [application dashboard](https://connect.squareup.com/apps).") public String getClientId() { return clientId; } @@ -74,7 +74,7 @@ public ObtainTokenRequest clientSecret(String clientSecret) { * The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps). * @return clientSecret **/ - @ApiModelProperty(value = "The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps).") + @ApiModelProperty(required = true, value = "The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps).") public String getClientSecret() { return clientSecret; } @@ -128,7 +128,7 @@ public ObtainTokenRequest grantType(String grantType) { * Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token` * @return grantType **/ - @ApiModelProperty(value = "Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token`") + @ApiModelProperty(required = true, value = "Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token`") public String getGrantType() { return grantType; } @@ -161,10 +161,10 @@ public ObtainTokenRequest migrationToken(String migrationToken) { } /** - * Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](/authz/oauth/migration). + * Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/authz/oauth/migration). * @return migrationToken **/ - @ApiModelProperty(value = "Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](/authz/oauth/migration).") + @ApiModelProperty(value = "Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/authz/oauth/migration).") public String getMigrationToken() { return migrationToken; } diff --git a/src/main/java/com/squareup/connect/models/ObtainTokenResponse.java b/src/main/java/com/squareup/connect/models/ObtainTokenResponse.java index cc696e4..1e66965 100644 --- a/src/main/java/com/squareup/connect/models/ObtainTokenResponse.java +++ b/src/main/java/com/squareup/connect/models/ObtainTokenResponse.java @@ -56,10 +56,10 @@ public ObtainTokenResponse accessToken(String accessToken) { } /** - * A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](/authz/oauth/build-with-the-api) guide for more information. + * A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](https://developer.squareup.com/docs/authz/oauth/build-with-the-api) guide for more information. * @return accessToken **/ - @ApiModelProperty(value = "A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](/authz/oauth/build-with-the-api) guide for more information.") + @ApiModelProperty(value = "A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](https://developer.squareup.com/docs/authz/oauth/build-with-the-api) guide for more information.") public String getAccessToken() { return accessToken; } @@ -182,10 +182,10 @@ public ObtainTokenResponse refreshToken(String refreshToken) { } /** - * A refresh token. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). + * 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). * @return refreshToken **/ - @ApiModelProperty(value = "A refresh token. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management).") + @ApiModelProperty(value = "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).") public String getRefreshToken() { return refreshToken; } diff --git a/src/main/java/com/squareup/connect/models/Order.java b/src/main/java/com/squareup/connect/models/Order.java index 5562a67..fd1f53b 100644 --- a/src/main/java/com/squareup/connect/models/Order.java +++ b/src/main/java/com/squareup/connect/models/Order.java @@ -32,7 +32,9 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; +import java.util.Map; /** * Contains all information related to a single order to process with Square, including line items that specify the products to purchase. Order objects also include information on any associated tenders, refunds, and returns. All Connect V2 Transactions have all been converted to Orders including all associated itemization data. @@ -88,6 +90,9 @@ public class Order { @JsonProperty("refunds") private List refunds = new ArrayList(); + @JsonProperty("metadata") + private Map metadata = new HashMap(); + @JsonProperty("created_at") private String createdAt = null; @@ -193,10 +198,10 @@ public Order customerId(String customerId) { } /** - * The [Customer](#type-customer) ID of the customer associated with the order. + * The `Customer` ID of the customer associated with the order. * @return customerId **/ - @ApiModelProperty(value = "The [Customer](#type-customer) ID of the customer associated with the order.") + @ApiModelProperty(value = "The `Customer` ID of the customer associated with the order.") public String getCustomerId() { return customerId; } @@ -443,6 +448,29 @@ public void setRefunds(List refunds) { this.refunds = refunds; } + public Order metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public Order putMetadataItem(String key, String metadataItem) { + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. + * @return metadata + **/ + @ApiModelProperty(value = "Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.") + public Map getMetadata() { + return metadata; + } + + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + public Order createdAt(String createdAt) { this.createdAt = createdAt; return this; @@ -521,10 +549,10 @@ public Order version(Integer version) { } /** - * Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](/orders-api/manage-orders#update-orders). + * Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders). * @return version **/ - @ApiModelProperty(value = "Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](/orders-api/manage-orders#update-orders).") + @ApiModelProperty(value = "Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders).") public Integer getVersion() { return version; } @@ -631,6 +659,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.roundingAdjustment, order.roundingAdjustment) && Objects.equals(this.tenders, order.tenders) && Objects.equals(this.refunds, order.refunds) && + Objects.equals(this.metadata, order.metadata) && Objects.equals(this.createdAt, order.createdAt) && Objects.equals(this.updatedAt, order.updatedAt) && Objects.equals(this.closedAt, order.closedAt) && @@ -644,7 +673,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(id, locationId, referenceId, source, customerId, lineItems, taxes, discounts, serviceCharges, fulfillments, returns, returnAmounts, netAmounts, roundingAdjustment, tenders, refunds, createdAt, updatedAt, closedAt, state, version, totalMoney, totalTaxMoney, totalDiscountMoney, totalServiceChargeMoney); + return Objects.hash(id, locationId, referenceId, source, customerId, lineItems, taxes, discounts, serviceCharges, fulfillments, returns, returnAmounts, netAmounts, roundingAdjustment, tenders, refunds, metadata, createdAt, updatedAt, closedAt, state, version, totalMoney, totalTaxMoney, totalDiscountMoney, totalServiceChargeMoney); } @@ -669,6 +698,7 @@ public String toString() { sb.append(" roundingAdjustment: ").append(toIndentedString(roundingAdjustment)).append("\n"); sb.append(" tenders: ").append(toIndentedString(tenders)).append("\n"); sb.append(" refunds: ").append(toIndentedString(refunds)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); sb.append(" closedAt: ").append(toIndentedString(closedAt)).append("\n"); diff --git a/src/main/java/com/squareup/connect/models/OrderEntry.java b/src/main/java/com/squareup/connect/models/OrderEntry.java index 02294c2..35c303d 100644 --- a/src/main/java/com/squareup/connect/models/OrderEntry.java +++ b/src/main/java/com/squareup/connect/models/OrderEntry.java @@ -59,10 +59,10 @@ public OrderEntry version(Integer version) { } /** - * Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](/orders-api/manage-orders#update-orders). + * Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders). * @return version **/ - @ApiModelProperty(value = "Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](/orders-api/manage-orders#update-orders).") + @ApiModelProperty(value = "Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders).") public Integer getVersion() { return version; } diff --git a/src/main/java/com/squareup/connect/models/OrderFulfillment.java b/src/main/java/com/squareup/connect/models/OrderFulfillment.java index ca4b108..4a0ff54 100644 --- a/src/main/java/com/squareup/connect/models/OrderFulfillment.java +++ b/src/main/java/com/squareup/connect/models/OrderFulfillment.java @@ -21,6 +21,9 @@ import com.squareup.connect.models.OrderFulfillmentShipmentDetails; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import java.util.HashMap; +import java.util.List; +import java.util.Map; /** * Contains details on how to fulfill this order. @@ -37,6 +40,9 @@ public class OrderFulfillment { @JsonProperty("state") private String state = null; + @JsonProperty("metadata") + private Map metadata = new HashMap(); + @JsonProperty("pickup_details") private OrderFulfillmentPickupDetails pickupDetails = null; @@ -97,6 +103,29 @@ public void setState(String state) { this.state = state; } + public OrderFulfillment metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public OrderFulfillment putMetadataItem(String key, String metadataItem) { + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Application-defined data attached to this fulfillment. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. + * @return metadata + **/ + @ApiModelProperty(value = "Application-defined data attached to this fulfillment. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.") + public Map getMetadata() { + return metadata; + } + + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + public OrderFulfillment pickupDetails(OrderFulfillmentPickupDetails pickupDetails) { this.pickupDetails = pickupDetails; return this; @@ -146,13 +175,14 @@ public boolean equals(java.lang.Object o) { return Objects.equals(this.uid, orderFulfillment.uid) && Objects.equals(this.type, orderFulfillment.type) && Objects.equals(this.state, orderFulfillment.state) && + Objects.equals(this.metadata, orderFulfillment.metadata) && Objects.equals(this.pickupDetails, orderFulfillment.pickupDetails) && Objects.equals(this.shipmentDetails, orderFulfillment.shipmentDetails); } @Override public int hashCode() { - return Objects.hash(uid, type, state, pickupDetails, shipmentDetails); + return Objects.hash(uid, type, state, metadata, pickupDetails, shipmentDetails); } @@ -164,6 +194,7 @@ public String toString() { sb.append(" uid: ").append(toIndentedString(uid)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); sb.append(" pickupDetails: ").append(toIndentedString(pickupDetails)).append("\n"); sb.append(" shipmentDetails: ").append(toIndentedString(shipmentDetails)).append("\n"); sb.append("}"); diff --git a/src/main/java/com/squareup/connect/models/OrderLineItem.java b/src/main/java/com/squareup/connect/models/OrderLineItem.java index 5833bf8..e8930bc 100644 --- a/src/main/java/com/squareup/connect/models/OrderLineItem.java +++ b/src/main/java/com/squareup/connect/models/OrderLineItem.java @@ -27,7 +27,9 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; +import java.util.Map; /** * Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details. @@ -56,6 +58,9 @@ public class OrderLineItem { @JsonProperty("variation_name") private String variationName = null; + @JsonProperty("metadata") + private Map metadata = new HashMap(); + @JsonProperty("modifiers") private List modifiers = new ArrayList(); @@ -185,10 +190,10 @@ public OrderLineItem catalogObjectId(String catalogObjectId) { } /** - * The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item. + * The `CatalogItemVariation` id applied to this line item. * @return catalogObjectId **/ - @ApiModelProperty(value = "The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item.") + @ApiModelProperty(value = "The `CatalogItemVariation` id applied to this line item.") public String getCatalogObjectId() { return catalogObjectId; } @@ -215,6 +220,29 @@ public void setVariationName(String variationName) { this.variationName = variationName; } + public OrderLineItem metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public OrderLineItem putMetadataItem(String key, String metadataItem) { + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Application-defined data attached to this line item. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. + * @return metadata + **/ + @ApiModelProperty(value = "Application-defined data attached to this line item. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.") + public Map getMetadata() { + return metadata; + } + + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + public OrderLineItem modifiers(List modifiers) { this.modifiers = modifiers; return this; @@ -226,10 +254,10 @@ public OrderLineItem addModifiersItem(OrderLineItemModifier modifiersItem) { } /** - * The [CatalogModifier](#type-catalogmodifier)s applied to this line item. + * The `CatalogModifier`s applied to this line item. * @return modifiers **/ - @ApiModelProperty(value = "The [CatalogModifier](#type-catalogmodifier)s applied to this line item.") + @ApiModelProperty(value = "The `CatalogModifier`s applied to this line item.") public List getModifiers() { return modifiers; } @@ -455,6 +483,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.note, orderLineItem.note) && Objects.equals(this.catalogObjectId, orderLineItem.catalogObjectId) && Objects.equals(this.variationName, orderLineItem.variationName) && + Objects.equals(this.metadata, orderLineItem.metadata) && Objects.equals(this.modifiers, orderLineItem.modifiers) && Objects.equals(this.taxes, orderLineItem.taxes) && Objects.equals(this.discounts, orderLineItem.discounts) && @@ -470,7 +499,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(uid, name, quantity, quantityUnit, note, catalogObjectId, variationName, modifiers, taxes, discounts, appliedTaxes, appliedDiscounts, basePriceMoney, variationTotalPriceMoney, grossSalesMoney, totalTaxMoney, totalDiscountMoney, totalMoney); + return Objects.hash(uid, name, quantity, quantityUnit, note, catalogObjectId, variationName, metadata, modifiers, taxes, discounts, appliedTaxes, appliedDiscounts, basePriceMoney, variationTotalPriceMoney, grossSalesMoney, totalTaxMoney, totalDiscountMoney, totalMoney); } @@ -486,6 +515,7 @@ public String toString() { sb.append(" note: ").append(toIndentedString(note)).append("\n"); sb.append(" catalogObjectId: ").append(toIndentedString(catalogObjectId)).append("\n"); sb.append(" variationName: ").append(toIndentedString(variationName)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); sb.append(" modifiers: ").append(toIndentedString(modifiers)).append("\n"); sb.append(" taxes: ").append(toIndentedString(taxes)).append("\n"); sb.append(" discounts: ").append(toIndentedString(discounts)).append("\n"); diff --git a/src/main/java/com/squareup/connect/models/OrderLineItemDiscount.java b/src/main/java/com/squareup/connect/models/OrderLineItemDiscount.java index 6230af4..a956c00 100644 --- a/src/main/java/com/squareup/connect/models/OrderLineItemDiscount.java +++ b/src/main/java/com/squareup/connect/models/OrderLineItemDiscount.java @@ -20,6 +20,9 @@ import com.squareup.connect.models.Money; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import java.util.HashMap; +import java.util.List; +import java.util.Map; /** * Represents a discount that applies to one or more line items in an order. Fixed-amount, order-scoped discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to the amount contributed by the item to the order subtotal. @@ -48,6 +51,9 @@ public class OrderLineItemDiscount { @JsonProperty("applied_money") private Money appliedMoney = null; + @JsonProperty("metadata") + private Map metadata = new HashMap(); + @JsonProperty("scope") private String scope = null; @@ -75,10 +81,10 @@ public OrderLineItemDiscount catalogObjectId(String catalogObjectId) { } /** - * The catalog object id referencing [CatalogDiscount](#type-catalogdiscount). + * The catalog object id referencing `CatalogDiscount`. * @return catalogObjectId **/ - @ApiModelProperty(value = "The catalog object id referencing [CatalogDiscount](#type-catalogdiscount).") + @ApiModelProperty(value = "The catalog object id referencing `CatalogDiscount`.") public String getCatalogObjectId() { return catalogObjectId; } @@ -111,10 +117,10 @@ public OrderLineItemDiscount type(String type) { } /** - * The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values + * The type of the discount. Discounts that don't reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values * @return type **/ - @ApiModelProperty(value = "The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values") + @ApiModelProperty(value = "The type of the discount. Discounts that don't reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values") public String getType() { return type; } @@ -129,10 +135,10 @@ public OrderLineItemDiscount percentage(String percentage) { } /** - * The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount. + * The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. `percentage` is not set for amount-based discounts. * @return percentage **/ - @ApiModelProperty(value = "The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount.") + @ApiModelProperty(value = "The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. `percentage` is not set for amount-based discounts.") public String getPercentage() { return percentage; } @@ -177,6 +183,29 @@ public void setAppliedMoney(Money appliedMoney) { this.appliedMoney = appliedMoney; } + public OrderLineItemDiscount metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public OrderLineItemDiscount putMetadataItem(String key, String metadataItem) { + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Application-defined data attached to this discount. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. + * @return metadata + **/ + @ApiModelProperty(value = "Application-defined data attached to this discount. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.") + public Map getMetadata() { + return metadata; + } + + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + public OrderLineItemDiscount scope(String scope) { this.scope = scope; return this; @@ -212,12 +241,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.percentage, orderLineItemDiscount.percentage) && Objects.equals(this.amountMoney, orderLineItemDiscount.amountMoney) && Objects.equals(this.appliedMoney, orderLineItemDiscount.appliedMoney) && + Objects.equals(this.metadata, orderLineItemDiscount.metadata) && Objects.equals(this.scope, orderLineItemDiscount.scope); } @Override public int hashCode() { - return Objects.hash(uid, catalogObjectId, name, type, percentage, amountMoney, appliedMoney, scope); + return Objects.hash(uid, catalogObjectId, name, type, percentage, amountMoney, appliedMoney, metadata, scope); } @@ -233,6 +263,7 @@ public String toString() { sb.append(" percentage: ").append(toIndentedString(percentage)).append("\n"); sb.append(" amountMoney: ").append(toIndentedString(amountMoney)).append("\n"); sb.append(" appliedMoney: ").append(toIndentedString(appliedMoney)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); sb.append(" scope: ").append(toIndentedString(scope)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/com/squareup/connect/models/OrderLineItemModifier.java b/src/main/java/com/squareup/connect/models/OrderLineItemModifier.java index b914182..20ecf7a 100644 --- a/src/main/java/com/squareup/connect/models/OrderLineItemModifier.java +++ b/src/main/java/com/squareup/connect/models/OrderLineItemModifier.java @@ -66,10 +66,10 @@ public OrderLineItemModifier catalogObjectId(String catalogObjectId) { } /** - * The catalog object id referencing [CatalogModifier](#type-catalogmodifier). + * The catalog object id referencing `CatalogModifier`. * @return catalogObjectId **/ - @ApiModelProperty(value = "The catalog object id referencing [CatalogModifier](#type-catalogmodifier).") + @ApiModelProperty(value = "The catalog object id referencing `CatalogModifier`.") public String getCatalogObjectId() { return catalogObjectId; } @@ -102,10 +102,10 @@ public OrderLineItemModifier basePriceMoney(Money basePriceMoney) { } /** - * The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price. + * The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price. * @return basePriceMoney **/ - @ApiModelProperty(value = "The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price.") + @ApiModelProperty(value = "The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price.") public Money getBasePriceMoney() { return basePriceMoney; } diff --git a/src/main/java/com/squareup/connect/models/OrderLineItemTax.java b/src/main/java/com/squareup/connect/models/OrderLineItemTax.java index d4c1a2a..1495c91 100644 --- a/src/main/java/com/squareup/connect/models/OrderLineItemTax.java +++ b/src/main/java/com/squareup/connect/models/OrderLineItemTax.java @@ -20,6 +20,9 @@ import com.squareup.connect.models.Money; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import java.util.HashMap; +import java.util.List; +import java.util.Map; /** * Represents a tax that applies to one or more line item in the order. Fixed-amount, order-scoped taxes are distributed across all non-zero line item totals. The amount distributed to each line item is relative to the amount the item contributes to the order subtotal. @@ -42,6 +45,9 @@ public class OrderLineItemTax { @JsonProperty("percentage") private String percentage = null; + @JsonProperty("metadata") + private Map metadata = new HashMap(); + @JsonProperty("applied_money") private Money appliedMoney = null; @@ -72,10 +78,10 @@ public OrderLineItemTax catalogObjectId(String catalogObjectId) { } /** - * The catalog object id referencing [CatalogTax](#type-catalogtax). + * The catalog object id referencing `CatalogTax`. * @return catalogObjectId **/ - @ApiModelProperty(value = "The catalog object id referencing [CatalogTax](#type-catalogtax).") + @ApiModelProperty(value = "The catalog object id referencing `CatalogTax`.") public String getCatalogObjectId() { return catalogObjectId; } @@ -138,6 +144,29 @@ public void setPercentage(String percentage) { this.percentage = percentage; } + public OrderLineItemTax metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public OrderLineItemTax putMetadataItem(String key, String metadataItem) { + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Application-defined data attached to this tax. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. + * @return metadata + **/ + @ApiModelProperty(value = "Application-defined data attached to this tax. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.") + public Map getMetadata() { + return metadata; + } + + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + public OrderLineItemTax appliedMoney(Money appliedMoney) { this.appliedMoney = appliedMoney; return this; @@ -189,13 +218,14 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.name, orderLineItemTax.name) && Objects.equals(this.type, orderLineItemTax.type) && Objects.equals(this.percentage, orderLineItemTax.percentage) && + Objects.equals(this.metadata, orderLineItemTax.metadata) && Objects.equals(this.appliedMoney, orderLineItemTax.appliedMoney) && Objects.equals(this.scope, orderLineItemTax.scope); } @Override public int hashCode() { - return Objects.hash(uid, catalogObjectId, name, type, percentage, appliedMoney, scope); + return Objects.hash(uid, catalogObjectId, name, type, percentage, metadata, appliedMoney, scope); } @@ -209,6 +239,7 @@ public String toString() { sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" percentage: ").append(toIndentedString(percentage)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); sb.append(" appliedMoney: ").append(toIndentedString(appliedMoney)).append("\n"); sb.append(" scope: ").append(toIndentedString(scope)).append("\n"); sb.append("}"); diff --git a/src/main/java/com/squareup/connect/models/OrderQuantityUnit.java b/src/main/java/com/squareup/connect/models/OrderQuantityUnit.java index dcb4b11..a356f95 100644 --- a/src/main/java/com/squareup/connect/models/OrderQuantityUnit.java +++ b/src/main/java/com/squareup/connect/models/OrderQuantityUnit.java @@ -39,10 +39,10 @@ public OrderQuantityUnit measurementUnit(MeasurementUnit measurementUnit) { } /** - * A [MeasurementUnit](#type-measurementunit) that represents the unit of measure for the quantity. + * A `MeasurementUnit` that represents the unit of measure for the quantity. * @return measurementUnit **/ - @ApiModelProperty(value = "A [MeasurementUnit](#type-measurementunit) that represents the unit of measure for the quantity.") + @ApiModelProperty(value = "A `MeasurementUnit` that represents the unit of measure for the quantity.") public MeasurementUnit getMeasurementUnit() { return measurementUnit; } diff --git a/src/main/java/com/squareup/connect/models/OrderReturnDiscount.java b/src/main/java/com/squareup/connect/models/OrderReturnDiscount.java index df1b8aa..b4adba1 100644 --- a/src/main/java/com/squareup/connect/models/OrderReturnDiscount.java +++ b/src/main/java/com/squareup/connect/models/OrderReturnDiscount.java @@ -96,10 +96,10 @@ public OrderReturnDiscount catalogObjectId(String catalogObjectId) { } /** - * The catalog object id referencing [CatalogDiscount](#type-catalogdiscount). + * The catalog object id referencing `CatalogDiscount`. * @return catalogObjectId **/ - @ApiModelProperty(value = "The catalog object id referencing [CatalogDiscount](#type-catalogdiscount).") + @ApiModelProperty(value = "The catalog object id referencing `CatalogDiscount`.") public String getCatalogObjectId() { return catalogObjectId; } @@ -132,10 +132,10 @@ public OrderReturnDiscount type(String type) { } /** - * The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values + * The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. Discounts that don't reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values * @return type **/ - @ApiModelProperty(value = "The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values") + @ApiModelProperty(value = "The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. Discounts that don't reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values") public String getType() { return type; } @@ -150,10 +150,10 @@ public OrderReturnDiscount percentage(String percentage) { } /** - * The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount. + * The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. `percentage` is not set for amount-based discounts. * @return percentage **/ - @ApiModelProperty(value = "The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount.") + @ApiModelProperty(value = "The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. `percentage` is not set for amount-based discounts.") public String getPercentage() { return percentage; } @@ -168,10 +168,10 @@ public OrderReturnDiscount amountMoney(Money amountMoney) { } /** - * The total declared monetary amount of the discount. The amount_money won't be set for a percentage-based discount. + * The total declared monetary amount of the discount. `amount_money` is not set for percentage-based discounts. * @return amountMoney **/ - @ApiModelProperty(value = "The total declared monetary amount of the discount. The amount_money won't be set for a percentage-based discount.") + @ApiModelProperty(value = "The total declared monetary amount of the discount. `amount_money` is not set for percentage-based discounts.") public Money getAmountMoney() { return amountMoney; } diff --git a/src/main/java/com/squareup/connect/models/OrderReturnLineItem.java b/src/main/java/com/squareup/connect/models/OrderReturnLineItem.java index 20b466d..f596693 100644 --- a/src/main/java/com/squareup/connect/models/OrderReturnLineItem.java +++ b/src/main/java/com/squareup/connect/models/OrderReturnLineItem.java @@ -206,10 +206,10 @@ public OrderReturnLineItem catalogObjectId(String catalogObjectId) { } /** - * The [CatalogItemVariation](#type-catalogitemvariation) id applied to this returned line item. + * The `CatalogItemVariation` id applied to this returned line item. * @return catalogObjectId **/ - @ApiModelProperty(value = "The [CatalogItemVariation](#type-catalogitemvariation) id applied to this returned line item.") + @ApiModelProperty(value = "The `CatalogItemVariation` id applied to this returned line item.") public String getCatalogObjectId() { return catalogObjectId; } @@ -247,10 +247,10 @@ public OrderReturnLineItem addReturnModifiersItem(OrderReturnLineItemModifier re } /** - * The [CatalogModifier](#type-catalogmodifier)s applied to this line item. + * The `CatalogModifier`s applied to this line item. * @return returnModifiers **/ - @ApiModelProperty(value = "The [CatalogModifier](#type-catalogmodifier)s applied to this line item.") + @ApiModelProperty(value = "The `CatalogModifier`s applied to this line item.") public List getReturnModifiers() { return returnModifiers; } diff --git a/src/main/java/com/squareup/connect/models/OrderReturnLineItemModifier.java b/src/main/java/com/squareup/connect/models/OrderReturnLineItemModifier.java index e48bdf3..cce943a 100644 --- a/src/main/java/com/squareup/connect/models/OrderReturnLineItemModifier.java +++ b/src/main/java/com/squareup/connect/models/OrderReturnLineItemModifier.java @@ -87,10 +87,10 @@ public OrderReturnLineItemModifier catalogObjectId(String catalogObjectId) { } /** - * The catalog object id referencing [CatalogModifier](#type-catalogmodifier). + * The catalog object id referencing `CatalogModifier`. * @return catalogObjectId **/ - @ApiModelProperty(value = "The catalog object id referencing [CatalogModifier](#type-catalogmodifier).") + @ApiModelProperty(value = "The catalog object id referencing `CatalogModifier`.") public String getCatalogObjectId() { return catalogObjectId; } @@ -123,10 +123,10 @@ public OrderReturnLineItemModifier basePriceMoney(Money basePriceMoney) { } /** - * The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price. + * The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price. * @return basePriceMoney **/ - @ApiModelProperty(value = "The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price.") + @ApiModelProperty(value = "The base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price.") public Money getBasePriceMoney() { return basePriceMoney; } diff --git a/src/main/java/com/squareup/connect/models/OrderReturnServiceCharge.java b/src/main/java/com/squareup/connect/models/OrderReturnServiceCharge.java index cefe6f4..d98c29e 100644 --- a/src/main/java/com/squareup/connect/models/OrderReturnServiceCharge.java +++ b/src/main/java/com/squareup/connect/models/OrderReturnServiceCharge.java @@ -130,10 +130,10 @@ public OrderReturnServiceCharge catalogObjectId(String catalogObjectId) { } /** - * The catalog object ID of the associated [CatalogServiceCharge](#type-catalogservicecharge). + * The catalog object ID of the associated `CatalogServiceCharge`. * @return catalogObjectId **/ - @ApiModelProperty(value = "The catalog object ID of the associated [CatalogServiceCharge](#type-catalogservicecharge).") + @ApiModelProperty(value = "The catalog object ID of the associated `CatalogServiceCharge`.") public String getCatalogObjectId() { return catalogObjectId; } diff --git a/src/main/java/com/squareup/connect/models/OrderReturnTax.java b/src/main/java/com/squareup/connect/models/OrderReturnTax.java index bcc6ef6..7ccd82c 100644 --- a/src/main/java/com/squareup/connect/models/OrderReturnTax.java +++ b/src/main/java/com/squareup/connect/models/OrderReturnTax.java @@ -93,10 +93,10 @@ public OrderReturnTax catalogObjectId(String catalogObjectId) { } /** - * The catalog object id referencing [CatalogTax](#type-catalogtax). + * The catalog object id referencing `CatalogTax`. * @return catalogObjectId **/ - @ApiModelProperty(value = "The catalog object id referencing [CatalogTax](#type-catalogtax).") + @ApiModelProperty(value = "The catalog object id referencing `CatalogTax`.") public String getCatalogObjectId() { return catalogObjectId; } diff --git a/src/main/java/com/squareup/connect/models/OrderServiceCharge.java b/src/main/java/com/squareup/connect/models/OrderServiceCharge.java index d79c5d5..1210e3a 100644 --- a/src/main/java/com/squareup/connect/models/OrderServiceCharge.java +++ b/src/main/java/com/squareup/connect/models/OrderServiceCharge.java @@ -23,7 +23,9 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; +import java.util.Map; /** * Represents a service charge applied to an order. @@ -67,6 +69,9 @@ public class OrderServiceCharge { @JsonProperty("applied_taxes") private List appliedTaxes = new ArrayList(); + @JsonProperty("metadata") + private Map metadata = new HashMap(); + public OrderServiceCharge uid(String uid) { this.uid = uid; return this; @@ -109,10 +114,10 @@ public OrderServiceCharge catalogObjectId(String catalogObjectId) { } /** - * The catalog object ID referencing the service charge [CatalogObject](#type-catalogobject). + * The catalog object ID referencing the service charge `CatalogObject`. * @return catalogObjectId **/ - @ApiModelProperty(value = "The catalog object ID referencing the service charge [CatalogObject](#type-catalogobject).") + @ApiModelProperty(value = "The catalog object ID referencing the service charge `CatalogObject`.") public String getCatalogObjectId() { return catalogObjectId; } @@ -293,6 +298,29 @@ public void setAppliedTaxes(List appliedTaxes) { this.appliedTaxes = appliedTaxes; } + public OrderServiceCharge metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public OrderServiceCharge putMetadataItem(String key, String metadataItem) { + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Application-defined data attached to this service charge. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information. + * @return metadata + **/ + @ApiModelProperty(value = "Application-defined data attached to this service charge. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.") + public Map getMetadata() { + return metadata; + } + + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + @Override public boolean equals(java.lang.Object o) { @@ -314,12 +342,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.calculationPhase, orderServiceCharge.calculationPhase) && Objects.equals(this.taxable, orderServiceCharge.taxable) && Objects.equals(this.taxes, orderServiceCharge.taxes) && - Objects.equals(this.appliedTaxes, orderServiceCharge.appliedTaxes); + Objects.equals(this.appliedTaxes, orderServiceCharge.appliedTaxes) && + Objects.equals(this.metadata, orderServiceCharge.metadata); } @Override public int hashCode() { - return Objects.hash(uid, name, catalogObjectId, percentage, amountMoney, appliedMoney, totalMoney, totalTaxMoney, calculationPhase, taxable, taxes, appliedTaxes); + return Objects.hash(uid, name, catalogObjectId, percentage, amountMoney, appliedMoney, totalMoney, totalTaxMoney, calculationPhase, taxable, taxes, appliedTaxes, metadata); } @@ -340,6 +369,7 @@ public String toString() { sb.append(" taxable: ").append(toIndentedString(taxable)).append("\n"); sb.append(" taxes: ").append(toIndentedString(taxes)).append("\n"); sb.append(" appliedTaxes: ").append(toIndentedString(appliedTaxes)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/squareup/connect/models/PayOrderRequest.java b/src/main/java/com/squareup/connect/models/PayOrderRequest.java index ce58da2..108eb69 100644 --- a/src/main/java/com/squareup/connect/models/PayOrderRequest.java +++ b/src/main/java/com/squareup/connect/models/PayOrderRequest.java @@ -43,10 +43,10 @@ public PayOrderRequest idempotencyKey(String idempotencyKey) { } /** - * A value you specify that uniquely identifies this request among requests you've sent. If you're unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments. See [Idempotency](/working-with-apis/idempotency) for more information. + * A value you specify that uniquely identifies this request among requests you've sent. If you're unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments. See [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information. * @return idempotencyKey **/ - @ApiModelProperty(required = true, value = "A value you specify that uniquely identifies this request among requests you've sent. If you're unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments. See [Idempotency](/working-with-apis/idempotency) for more information.") + @ApiModelProperty(required = true, value = "A value you specify that uniquely identifies this request among requests you've sent. If you're unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments. See [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.") public String getIdempotencyKey() { return idempotencyKey; } diff --git a/src/main/java/com/squareup/connect/models/PayOrderResponse.java b/src/main/java/com/squareup/connect/models/PayOrderResponse.java index ffb3dbc..8967de0 100644 --- a/src/main/java/com/squareup/connect/models/PayOrderResponse.java +++ b/src/main/java/com/squareup/connect/models/PayOrderResponse.java @@ -65,10 +65,10 @@ public PayOrderResponse order(Order order) { } /** - * The paid, updated [order](#type-order). + * The paid, updated `order`. * @return order **/ - @ApiModelProperty(value = "The paid, updated [order](#type-order).") + @ApiModelProperty(value = "The paid, updated `order`.") public Order getOrder() { return order; } diff --git a/src/main/java/com/squareup/connect/models/Payment.java b/src/main/java/com/squareup/connect/models/Payment.java index 87a233c..5777472 100644 --- a/src/main/java/com/squareup/connect/models/Payment.java +++ b/src/main/java/com/squareup/connect/models/Payment.java @@ -80,6 +80,9 @@ public class Payment { @JsonProperty("customer_id") private String customerId = null; + @JsonProperty("employee_id") + private String employeeId = null; + @JsonProperty("refund_ids") private List refundIds = new ArrayList(); @@ -104,7 +107,7 @@ public Payment id(String id) { * Unique ID for the payment. * @return id **/ - @ApiModelProperty(required = true, value = "Unique ID for the payment.") + @ApiModelProperty(value = "Unique ID for the payment.") public String getId() { return id; } @@ -155,10 +158,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](/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(required = true, 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](/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; } @@ -209,10 +212,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](/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](/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; } @@ -286,10 +289,10 @@ public Payment sourceType(String sourceType) { } /** - * The source type for this payment + * The source type for this payment Current values include: `CARD` * @return sourceType **/ - @ApiModelProperty(value = "The source type for this payment") + @ApiModelProperty(value = "The source type for this payment Current values include: `CARD`") public String getSourceType() { return sourceType; } @@ -388,6 +391,24 @@ public void setCustomerId(String customerId) { this.customerId = customerId; } + public Payment employeeId(String employeeId) { + this.employeeId = employeeId; + return this; + } + + /** + * An optional ID of the employee associated with taking this payment. + * @return employeeId + **/ + @ApiModelProperty(value = "An optional ID of the employee associated with taking this payment.") + public String getEmployeeId() { + return employeeId; + } + + public void setEmployeeId(String employeeId) { + this.employeeId = employeeId; + } + public Payment refundIds(List refundIds) { this.refundIds = refundIds; return this; @@ -509,6 +530,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.orderId, payment.orderId) && Objects.equals(this.referenceId, payment.referenceId) && Objects.equals(this.customerId, payment.customerId) && + Objects.equals(this.employeeId, payment.employeeId) && Objects.equals(this.refundIds, payment.refundIds) && Objects.equals(this.buyerEmailAddress, payment.buyerEmailAddress) && Objects.equals(this.billingAddress, payment.billingAddress) && @@ -518,7 +540,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(id, createdAt, updatedAt, amountMoney, tipMoney, totalMoney, appFeeMoney, processingFee, refundedMoney, status, sourceType, cardDetails, locationId, orderId, referenceId, customerId, 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); } @@ -543,6 +565,7 @@ public String toString() { sb.append(" orderId: ").append(toIndentedString(orderId)).append("\n"); sb.append(" referenceId: ").append(toIndentedString(referenceId)).append("\n"); sb.append(" customerId: ").append(toIndentedString(customerId)).append("\n"); + sb.append(" employeeId: ").append(toIndentedString(employeeId)).append("\n"); sb.append(" refundIds: ").append(toIndentedString(refundIds)).append("\n"); sb.append(" buyerEmailAddress: ").append(toIndentedString(buyerEmailAddress)).append("\n"); sb.append(" billingAddress: ").append(toIndentedString(billingAddress)).append("\n"); diff --git a/src/main/java/com/squareup/connect/models/PaymentRefund.java b/src/main/java/com/squareup/connect/models/PaymentRefund.java index 7c585b1..7430c1b 100644 --- a/src/main/java/com/squareup/connect/models/PaymentRefund.java +++ b/src/main/java/com/squareup/connect/models/PaymentRefund.java @@ -141,10 +141,10 @@ public PaymentRefund appFeeMoney(Money appFeeMoney) { } /** - * Amount of money the app developer contributed to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. + * Amount of money the app developer contributed to help cover the refunded amount. 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. * @return appFeeMoney **/ - @ApiModelProperty(value = "Amount of money the app developer contributed to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details.") + @ApiModelProperty(value = "Amount of money the app developer contributed to help cover the refunded amount. 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.") public Money getAppFeeMoney() { return appFeeMoney; } diff --git a/src/main/java/com/squareup/connect/models/RefundPaymentRequest.java b/src/main/java/com/squareup/connect/models/RefundPaymentRequest.java index 7d25e0b..e19ae6c 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](/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/basics/api101/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](/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/basics/api101/idempotency).") public String getIdempotencyKey() { return idempotencyKey; } @@ -66,10 +66,10 @@ public RefundPaymentRequest amountMoney(Money amountMoney) { } /** - * 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](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card. + * 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. * @return amountMoney **/ - @ApiModelProperty(required = true, value = "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](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card.") + @ApiModelProperty(required = true, value = "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.") public Money getAmountMoney() { return amountMoney; } @@ -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](/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](/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/RetrieveCatalogObjectRequest.java b/src/main/java/com/squareup/connect/models/RetrieveCatalogObjectRequest.java index 9f6c4e0..6fceb5c 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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. 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](#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` * @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](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. 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](#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`") 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 d13f7ef..23fe68c 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](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } @@ -68,10 +68,10 @@ public RetrieveCatalogObjectResponse object(CatalogObject object) { } /** - * The [CatalogObject](#type-catalogobject)s returned. + * The `CatalogObject`s returned. * @return object **/ - @ApiModelProperty(value = "The [CatalogObject](#type-catalogobject)s returned.") + @ApiModelProperty(value = "The `CatalogObject`s returned.") public CatalogObject getObject() { return object; } @@ -91,10 +91,10 @@ public RetrieveCatalogObjectResponse addRelatedObjectsItem(CatalogObject related } /** - * A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `object` field. + * A list of `CatalogObject`s referenced by the object in the `object` field. * @return relatedObjects **/ - @ApiModelProperty(value = "A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `object` field.") + @ApiModelProperty(value = "A list of `CatalogObject`s referenced by the object in the `object` field.") public List getRelatedObjects() { return relatedObjects; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveInventoryAdjustmentResponse.java b/src/main/java/com/squareup/connect/models/RetrieveInventoryAdjustmentResponse.java index cac66b3..6b79af6 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveInventoryAdjustmentResponse.java +++ b/src/main/java/com/squareup/connect/models/RetrieveInventoryAdjustmentResponse.java @@ -65,10 +65,10 @@ public RetrieveInventoryAdjustmentResponse adjustment(InventoryAdjustment adjust } /** - * The requested [InventoryAdjustment](#type-inventoryadjustment). + * The requested `InventoryAdjustment`. * @return adjustment **/ - @ApiModelProperty(value = "The requested [InventoryAdjustment](#type-inventoryadjustment).") + @ApiModelProperty(value = "The requested `InventoryAdjustment`.") public InventoryAdjustment getAdjustment() { return adjustment; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesRequest.java b/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesRequest.java index cb26f97..292b1a6 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesRequest.java +++ b/src/main/java/com/squareup/connect/models/RetrieveInventoryChangesRequest.java @@ -38,10 +38,10 @@ public RetrieveInventoryChangesRequest locationIds(String locationIds) { } /** - * The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. + * The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. * @return locationIds **/ - @ApiModelProperty(value = "The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations.") + @ApiModelProperty(value = "The `Location` IDs to look up as a comma-separated list. An empty list queries all locations.") public String getLocationIds() { return locationIds; } @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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 the original query. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 4080f77..8e5adc8 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](/basics/api101/pagination) for more information. + * 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. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 cbacc6a..6233f10 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveInventoryCountRequest.java +++ b/src/main/java/com/squareup/connect/models/RetrieveInventoryCountRequest.java @@ -38,10 +38,10 @@ public RetrieveInventoryCountRequest locationIds(String locationIds) { } /** - * The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. + * The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. * @return locationIds **/ - @ApiModelProperty(value = "The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations.") + @ApiModelProperty(value = "The `Location` IDs to look up as a comma-separated list. An empty list queries all locations.") public String getLocationIds() { return locationIds; } @@ -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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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 the original query. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) 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 2f795e0..02af618 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](/basics/api101/pagination) for more information. + * 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. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveInventoryPhysicalCountResponse.java b/src/main/java/com/squareup/connect/models/RetrieveInventoryPhysicalCountResponse.java index 6b91b42..2913776 100644 --- a/src/main/java/com/squareup/connect/models/RetrieveInventoryPhysicalCountResponse.java +++ b/src/main/java/com/squareup/connect/models/RetrieveInventoryPhysicalCountResponse.java @@ -65,10 +65,10 @@ public RetrieveInventoryPhysicalCountResponse count(InventoryPhysicalCount count } /** - * The requested [InventoryPhysicalCount](#type-inventoryphysicalcount). + * The requested `InventoryPhysicalCount`. * @return count **/ - @ApiModelProperty(value = "The requested [InventoryPhysicalCount](#type-inventoryphysicalcount).") + @ApiModelProperty(value = "The requested `InventoryPhysicalCount`.") public InventoryPhysicalCount getCount() { return count; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveLocationRequest.java b/src/main/java/com/squareup/connect/models/RetrieveLocationRequest.java index 373f9a5..8f97d64 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. */ -@ApiModel(description = "") +@ApiModel(description = "Defines the fields that are included in the request body for the [RetrieveLocation](#endpoint-locations-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 3629569..e1c6520 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 are included in the response body of a request to the [RetrieveLocation](#endpoint-retrievelocation) endpoint. One of `errors` or `location` is present in a given response (never both). + * Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. */ -@ApiModel(description = "Defines the fields that are included in the response body of a request to the [RetrieveLocation](#endpoint-retrievelocation) endpoint. One of `errors` or `location` is present in a given response (never both).") +@ApiModel(description = "Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response.") public class RetrieveLocationResponse { @JsonProperty("errors") @@ -47,10 +47,10 @@ public RetrieveLocationResponse addErrorsItem(Error errorsItem) { } /** - * Any errors that occurred during the request. + * Information on errors encountered during the request. * @return errors **/ - @ApiModelProperty(value = "Any errors that occurred during the request.") + @ApiModelProperty(value = "Information on errors encountered during the request.") public List getErrors() { return errors; } diff --git a/src/main/java/com/squareup/connect/models/RetrieveMerchantRequest.java b/src/main/java/com/squareup/connect/models/RetrieveMerchantRequest.java new file mode 100644 index 0000000..99912d7 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/RetrieveMerchantRequest.java @@ -0,0 +1,64 @@ +/* + * 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 io.swagger.annotations.ApiModel; + +/** + * Request object for the [RetrieveMerchant](#endpoint-retrievemerchant) endpoint. + */ +@ApiModel(description = "Request object for the [RetrieveMerchant](#endpoint-retrievemerchant) endpoint.") + +public class RetrieveMerchantRequest { + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + return true; + } + + @Override + public int hashCode() { + return Objects.hash(); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RetrieveMerchantRequest {\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/RetrieveMerchantResponse.java b/src/main/java/com/squareup/connect/models/RetrieveMerchantResponse.java new file mode 100644 index 0000000..1278f3a --- /dev/null +++ b/src/main/java/com/squareup/connect/models/RetrieveMerchantResponse.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.Merchant; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.util.ArrayList; +import java.util.List; + +/** + * The response obeject returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. + */ +@ApiModel(description = "The response obeject returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint.") + +public class RetrieveMerchantResponse { + @JsonProperty("errors") + private List errors = new ArrayList(); + + @JsonProperty("merchant") + private Merchant merchant = null; + + public RetrieveMerchantResponse errors(List errors) { + this.errors = errors; + return this; + } + + public RetrieveMerchantResponse 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 RetrieveMerchantResponse merchant(Merchant merchant) { + this.merchant = merchant; + return this; + } + + /** + * The requested `Merchant` object. + * @return merchant + **/ + @ApiModelProperty(value = "The requested `Merchant` object.") + public Merchant getMerchant() { + return merchant; + } + + public void setMerchant(Merchant merchant) { + this.merchant = merchant; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RetrieveMerchantResponse retrieveMerchantResponse = (RetrieveMerchantResponse) o; + return Objects.equals(this.errors, retrieveMerchantResponse.errors) && + Objects.equals(this.merchant, retrieveMerchantResponse.merchant); + } + + @Override + public int hashCode() { + return Objects.hash(errors, merchant); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RetrieveMerchantResponse {\n"); + + sb.append(" errors: ").append(toIndentedString(errors)).append("\n"); + sb.append(" merchant: ").append(toIndentedString(merchant)).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/SearchCatalogObjectsRequest.java b/src/main/java/com/squareup/connect/models/SearchCatalogObjectsRequest.java index fa47608..51e2940 100644 --- a/src/main/java/com/squareup/connect/models/SearchCatalogObjectsRequest.java +++ b/src/main/java/com/squareup/connect/models/SearchCatalogObjectsRequest.java @@ -56,10 +56,10 @@ public SearchCatalogObjectsRequest cursor(String cursor) { } /** - * The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. + * 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. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information.") + @ApiModelProperty(value = "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.") public String getCursor() { return cursor; } @@ -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](#type-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` enumeration, namely `\"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](#type-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` enumeration, namely `\"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](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response. If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response. + * 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. * @return includeRelatedObjects **/ - @ApiModelProperty(value = "If `true`, the response will include additional objects that are related to the requested object, as follows: If a [CatalogItem](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response. If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response.") + @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.") public Boolean getIncludeRelatedObjects() { return includeRelatedObjects; } diff --git a/src/main/java/com/squareup/connect/models/SearchCatalogObjectsResponse.java b/src/main/java/com/squareup/connect/models/SearchCatalogObjectsResponse.java index 3525b6e..4e4cf0f 100644 --- a/src/main/java/com/squareup/connect/models/SearchCatalogObjectsResponse.java +++ b/src/main/java/com/squareup/connect/models/SearchCatalogObjectsResponse.java @@ -42,6 +42,9 @@ public class SearchCatalogObjectsResponse { @JsonProperty("related_objects") private List relatedObjects = new ArrayList(); + @JsonProperty("latest_time") + private String latestTime = null; + public SearchCatalogObjectsResponse errors(List errors) { this.errors = errors; return this; @@ -53,10 +56,10 @@ public SearchCatalogObjectsResponse addErrorsItem(Error errorsItem) { } /** - * The set of [Error](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } @@ -71,10 +74,10 @@ public SearchCatalogObjectsResponse cursor(String cursor) { } /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. + * 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. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } @@ -94,10 +97,10 @@ public SearchCatalogObjectsResponse addObjectsItem(CatalogObject objectsItem) { } /** - * The [CatalogObject](#type-catalogobject)s returned. + * The `CatalogObject`s returned. * @return objects **/ - @ApiModelProperty(value = "The [CatalogObject](#type-catalogobject)s returned.") + @ApiModelProperty(value = "The `CatalogObject`s returned.") public List getObjects() { return objects; } @@ -117,10 +120,10 @@ public SearchCatalogObjectsResponse addRelatedObjectsItem(CatalogObject relatedO } /** - * A list of [CatalogObject](#type-catalogobject)s referenced by the objects in the `objects` field. + * A list of `CatalogObject`s referenced by the objects in the `objects` field. * @return relatedObjects **/ - @ApiModelProperty(value = "A list of [CatalogObject](#type-catalogobject)s referenced by the objects in the `objects` field.") + @ApiModelProperty(value = "A list of `CatalogObject`s referenced by the objects in the `objects` field.") public List getRelatedObjects() { return relatedObjects; } @@ -129,6 +132,24 @@ public void setRelatedObjects(List relatedObjects) { this.relatedObjects = relatedObjects; } + public SearchCatalogObjectsResponse latestTime(String latestTime) { + this.latestTime = latestTime; + return this; + } + + /** + * When this merchant's catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. + * @return latestTime + **/ + @ApiModelProperty(value = " When this merchant's 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; + } + + public void setLatestTime(String latestTime) { + this.latestTime = latestTime; + } + @Override public boolean equals(java.lang.Object o) { @@ -142,12 +163,13 @@ public boolean equals(java.lang.Object o) { return Objects.equals(this.errors, searchCatalogObjectsResponse.errors) && Objects.equals(this.cursor, searchCatalogObjectsResponse.cursor) && Objects.equals(this.objects, searchCatalogObjectsResponse.objects) && - Objects.equals(this.relatedObjects, searchCatalogObjectsResponse.relatedObjects); + Objects.equals(this.relatedObjects, searchCatalogObjectsResponse.relatedObjects) && + Objects.equals(this.latestTime, searchCatalogObjectsResponse.latestTime); } @Override public int hashCode() { - return Objects.hash(errors, cursor, objects, relatedObjects); + return Objects.hash(errors, cursor, objects, relatedObjects, latestTime); } @@ -160,6 +182,7 @@ public String toString() { sb.append(" cursor: ").append(toIndentedString(cursor)).append("\n"); sb.append(" objects: ").append(toIndentedString(objects)).append("\n"); sb.append(" relatedObjects: ").append(toIndentedString(relatedObjects)).append("\n"); + sb.append(" latestTime: ").append(toIndentedString(latestTime)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/squareup/connect/models/SearchCustomersRequest.java b/src/main/java/com/squareup/connect/models/SearchCustomersRequest.java index eb8ca41..b79257c 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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 71176ed..0911ccb 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } diff --git a/src/main/java/com/squareup/connect/models/SearchOrdersFilter.java b/src/main/java/com/squareup/connect/models/SearchOrdersFilter.java index 49f59fa..13666c3 100644 --- a/src/main/java/com/squareup/connect/models/SearchOrdersFilter.java +++ b/src/main/java/com/squareup/connect/models/SearchOrdersFilter.java @@ -52,10 +52,10 @@ public SearchOrdersFilter stateFilter(SearchOrdersStateFilter stateFilter) { } /** - * Filter by [`OrderState`](#type-orderstate). + * Filter by ``OrderState``. * @return stateFilter **/ - @ApiModelProperty(value = "Filter by [`OrderState`](#type-orderstate).") + @ApiModelProperty(value = "Filter by ``OrderState``.") public SearchOrdersStateFilter getStateFilter() { return stateFilter; } @@ -70,10 +70,10 @@ public SearchOrdersFilter dateTimeFilter(SearchOrdersDateTimeFilter dateTimeFilt } /** - * Filter for results within a time range. __Important:__ If you filter for orders by time range, you must set SearchOrdersSort to sort by the same field. [Learn more about filtering orders by time range](/orders-api/manage-orders#important-note-on-filtering-orders-by-time-range) + * Filter for results within a time range. __Important:__ If you filter for orders by time range, you must set SearchOrdersSort to sort by the same field. [Learn more about filtering orders by time range](https://developer.squareup.com/docs/orders-api/manage-orders#important-note-on-filtering-orders-by-time-range) * @return dateTimeFilter **/ - @ApiModelProperty(value = "Filter for results within a time range. __Important:__ If you filter for orders by time range, you must set SearchOrdersSort to sort by the same field. [Learn more about filtering orders by time range](/orders-api/manage-orders#important-note-on-filtering-orders-by-time-range)") + @ApiModelProperty(value = "Filter for results within a time range. __Important:__ If you filter for orders by time range, you must set SearchOrdersSort to sort by the same field. [Learn more about filtering orders by time range](https://developer.squareup.com/docs/orders-api/manage-orders#important-note-on-filtering-orders-by-time-range)") public SearchOrdersDateTimeFilter getDateTimeFilter() { return dateTimeFilter; } diff --git a/src/main/java/com/squareup/connect/models/SearchOrdersFulfillmentFilter.java b/src/main/java/com/squareup/connect/models/SearchOrdersFulfillmentFilter.java index 907b60c..a98fe3a 100644 --- a/src/main/java/com/squareup/connect/models/SearchOrdersFulfillmentFilter.java +++ b/src/main/java/com/squareup/connect/models/SearchOrdersFulfillmentFilter.java @@ -45,10 +45,10 @@ public SearchOrdersFulfillmentFilter addFulfillmentTypesItem(String fulfillmentT } /** - * List of [fulfillment types](#type-orderfulfillmenttype) to filter for. Will return orders if any of its fulfillments match any of the fulfillment types listed in this field. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values + * List of `fulfillment types` to filter for. Will return orders if any of its fulfillments match any of the fulfillment types listed in this field. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values * @return fulfillmentTypes **/ - @ApiModelProperty(required = true, value = "List of [fulfillment types](#type-orderfulfillmenttype) to filter for. Will return orders if any of its fulfillments match any of the fulfillment types listed in this field. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values") + @ApiModelProperty(required = true, value = "List of `fulfillment types` to filter for. Will return orders if any of its fulfillments match any of the fulfillment types listed in this field. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values") public List getFulfillmentTypes() { return fulfillmentTypes; } @@ -68,10 +68,10 @@ public SearchOrdersFulfillmentFilter addFulfillmentStatesItem(String fulfillment } /** - * List of [fulfillment states](#type-orderfulfillmentstate) to filter for. Will return orders if any of its fulfillments match any of the fulfillment states listed in this field. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values + * List of `fulfillment states` to filter for. Will return orders if any of its fulfillments match any of the fulfillment states listed in this field. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values * @return fulfillmentStates **/ - @ApiModelProperty(value = "List of [fulfillment states](#type-orderfulfillmentstate) to filter for. Will return orders if any of its fulfillments match any of the fulfillment states listed in this field. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values") + @ApiModelProperty(value = "List of `fulfillment states` to filter for. Will return orders if any of its fulfillments match any of the fulfillment states listed in this field. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values") public List getFulfillmentStates() { return fulfillmentStates; } diff --git a/src/main/java/com/squareup/connect/models/SearchOrdersRequest.java b/src/main/java/com/squareup/connect/models/SearchOrdersRequest.java index 8a1f72d..8844fc2 100644 --- a/src/main/java/com/squareup/connect/models/SearchOrdersRequest.java +++ b/src/main/java/com/squareup/connect/models/SearchOrdersRequest.java @@ -73,10 +73,10 @@ public SearchOrdersRequest 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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/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](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } @@ -128,10 +128,10 @@ public SearchOrdersRequest returnEntries(Boolean returnEntries) { } /** - * Boolean that controls the format of the search results. If `true`, SearchOrders will return [`OrderEntry`](#type-orderentry) objects. If `false`, SearchOrders will return complete Order objects. Default: `false`. + * Boolean that controls the format of the search results. If `true`, SearchOrders will return ``OrderEntry`` objects. If `false`, SearchOrders will return complete Order objects. Default: `false`. * @return returnEntries **/ - @ApiModelProperty(value = "Boolean that controls the format of the search results. If `true`, SearchOrders will return [`OrderEntry`](#type-orderentry) objects. If `false`, SearchOrders will return complete Order objects. Default: `false`.") + @ApiModelProperty(value = "Boolean that controls the format of the search results. If `true`, SearchOrders will return ``OrderEntry`` objects. If `false`, SearchOrders will return complete Order objects. Default: `false`.") public Boolean getReturnEntries() { return returnEntries; } diff --git a/src/main/java/com/squareup/connect/models/SearchOrdersResponse.java b/src/main/java/com/squareup/connect/models/SearchOrdersResponse.java index 6035318..a3007f9 100644 --- a/src/main/java/com/squareup/connect/models/SearchOrdersResponse.java +++ b/src/main/java/com/squareup/connect/models/SearchOrdersResponse.java @@ -54,10 +54,10 @@ public SearchOrdersResponse addOrderEntriesItem(OrderEntry orderEntriesItem) { } /** - * List of [OrderEntries](#type-orderentry) that fit the query conditions. Populated only if `return_entries` was set to `true` in the request. + * List of `OrderEntries` that fit the query conditions. Populated only if `return_entries` was set to `true` in the request. * @return orderEntries **/ - @ApiModelProperty(value = "List of [OrderEntries](#type-orderentry) that fit the query conditions. Populated only if `return_entries` was set to `true` in the request.") + @ApiModelProperty(value = "List of `OrderEntries` that fit the query conditions. Populated only if `return_entries` was set to `true` in the request.") public List getOrderEntries() { return orderEntries; } @@ -77,10 +77,10 @@ public SearchOrdersResponse addOrdersItem(Order ordersItem) { } /** - * List of [Order](#type-order) objects that match query conditions. Populated only if `return_entries` in the request is set to `false`. + * List of `Order` objects that match query conditions. Populated only if `return_entries` in the request is set to `false`. * @return orders **/ - @ApiModelProperty(value = "List of [Order](#type-order) objects that match query conditions. Populated only if `return_entries` in the request is set to `false`.") + @ApiModelProperty(value = "List of `Order` objects that match query conditions. Populated only if `return_entries` in the request is set to `false`.") public List getOrders() { return orders; } @@ -95,10 +95,10 @@ public SearchOrdersResponse cursor(String cursor) { } /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. + * 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. * @return cursor **/ - @ApiModelProperty(value = "The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/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 [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.") public String getCursor() { return cursor; } @@ -118,10 +118,10 @@ public SearchOrdersResponse addErrorsItem(Error errorsItem) { } /** - * [Errors](#type-error) encountered during the search. + * `Errors` encountered during the search. * @return errors **/ - @ApiModelProperty(value = "[Errors](#type-error) encountered during the search.") + @ApiModelProperty(value = "`Errors` encountered during the search.") public List getErrors() { return errors; } diff --git a/src/main/java/com/squareup/connect/models/SearchOrdersSort.java b/src/main/java/com/squareup/connect/models/SearchOrdersSort.java index 376028b..65a0591 100644 --- a/src/main/java/com/squareup/connect/models/SearchOrdersSort.java +++ b/src/main/java/com/squareup/connect/models/SearchOrdersSort.java @@ -38,10 +38,10 @@ public SearchOrdersSort sortField(String sortField) { } /** - * The field to sort by. __Important:__ When using a [DateTimeFilter](#type-searchordersfilter), `sort_field` must match the timestamp field that the DateTimeFilter uses to filter. For example, If you set your `sort_field` to `CLOSED_AT` and you use a DateTimeFilter, your DateTimeFilter must filter for orders by their `CLOSED_AT` date. If this field does not match the timestamp field in `DateTimeFilter`, SearchOrders will return an error. Default: `CREATED_AT`. See [SearchOrdersSortField](#type-searchorderssortfield) for possible values + * The field to sort by. __Important:__ When using a `DateTimeFilter`, `sort_field` must match the timestamp field that the DateTimeFilter uses to filter. For example, If you set your `sort_field` to `CLOSED_AT` and you use a DateTimeFilter, your DateTimeFilter must filter for orders by their `CLOSED_AT` date. If this field does not match the timestamp field in `DateTimeFilter`, SearchOrders will return an error. Default: `CREATED_AT`. See [SearchOrdersSortField](#type-searchorderssortfield) for possible values * @return sortField **/ - @ApiModelProperty(required = true, value = "The field to sort by. __Important:__ When using a [DateTimeFilter](#type-searchordersfilter), `sort_field` must match the timestamp field that the DateTimeFilter uses to filter. For example, If you set your `sort_field` to `CLOSED_AT` and you use a DateTimeFilter, your DateTimeFilter must filter for orders by their `CLOSED_AT` date. If this field does not match the timestamp field in `DateTimeFilter`, SearchOrders will return an error. Default: `CREATED_AT`. See [SearchOrdersSortField](#type-searchorderssortfield) for possible values") + @ApiModelProperty(required = true, value = "The field to sort by. __Important:__ When using a `DateTimeFilter`, `sort_field` must match the timestamp field that the DateTimeFilter uses to filter. For example, If you set your `sort_field` to `CLOSED_AT` and you use a DateTimeFilter, your DateTimeFilter must filter for orders by their `CLOSED_AT` date. If this field does not match the timestamp field in `DateTimeFilter`, SearchOrders will return an error. Default: `CREATED_AT`. See [SearchOrdersSortField](#type-searchorderssortfield) for possible values") public String getSortField() { return sortField; } diff --git a/src/main/java/com/squareup/connect/models/SearchOrdersSourceFilter.java b/src/main/java/com/squareup/connect/models/SearchOrdersSourceFilter.java index 294aa9e..0b1cfe2 100644 --- a/src/main/java/com/squareup/connect/models/SearchOrdersSourceFilter.java +++ b/src/main/java/com/squareup/connect/models/SearchOrdersSourceFilter.java @@ -42,10 +42,10 @@ public SearchOrdersSourceFilter addSourceNamesItem(String sourceNamesItem) { } /** - * Filters by [Source](#type-ordersource) `name`. Will return any orders with with a `source.name` that matches any of the listed source names. Max: 10 source names. + * Filters by `Source` `name`. Will return any orders with with a `source.name` that matches any of the listed source names. Max: 10 source names. * @return sourceNames **/ - @ApiModelProperty(value = "Filters by [Source](#type-ordersource) `name`. Will return any orders with with a `source.name` that matches any of the listed source names. Max: 10 source names.") + @ApiModelProperty(value = "Filters by `Source` `name`. Will return any orders with with a `source.name` that matches any of the listed source names. Max: 10 source names.") public List getSourceNames() { return sourceNames; } diff --git a/src/main/java/com/squareup/connect/models/SourceApplication.java b/src/main/java/com/squareup/connect/models/SourceApplication.java index 6670c9d..6e06960 100644 --- a/src/main/java/com/squareup/connect/models/SourceApplication.java +++ b/src/main/java/com/squareup/connect/models/SourceApplication.java @@ -41,10 +41,10 @@ public SourceApplication product(String product) { } /** - * Read-only [Product](#type-product) type for the application. See [Product](#type-product) for possible values + * Read-only `Product` type for the application. See [Product](#type-product) for possible values * @return product **/ - @ApiModelProperty(value = "Read-only [Product](#type-product) type for the application. See [Product](#type-product) for possible values") + @ApiModelProperty(value = "Read-only `Product` type for the application. See [Product](#type-product) for possible values") public String getProduct() { return product; } @@ -59,10 +59,10 @@ public SourceApplication applicationId(String applicationId) { } /** - * Read-only Square ID assigned to the application. Only used for [Product](#type-product) type `EXTERNAL_API`. + * Read-only Square ID assigned to the application. Only used for `Product` type `EXTERNAL_API`. * @return applicationId **/ - @ApiModelProperty(value = "Read-only Square ID assigned to the application. Only used for [Product](#type-product) type `EXTERNAL_API`.") + @ApiModelProperty(value = "Read-only Square ID assigned to the application. Only used for `Product` type `EXTERNAL_API`.") public String getApplicationId() { return applicationId; } diff --git a/src/main/java/com/squareup/connect/models/Tender.java b/src/main/java/com/squareup/connect/models/Tender.java index 6d46b99..db37087 100644 --- a/src/main/java/com/squareup/connect/models/Tender.java +++ b/src/main/java/com/squareup/connect/models/Tender.java @@ -170,10 +170,10 @@ public Tender amountMoney(Money amountMoney) { } /** - * The total amount of the tender, including `tip_money`. If the tender has a `payment_id`, the `total_money` of the corresponding [Payment](#type-payment) will be equal to the `amount_money` of the tender. + * The total amount of the tender, including `tip_money`. If the tender has a `payment_id`, the `total_money` of the corresponding `Payment` will be equal to the `amount_money` of the tender. * @return amountMoney **/ - @ApiModelProperty(value = "The total amount of the tender, including `tip_money`. If the tender has a `payment_id`, the `total_money` of the corresponding [Payment](#type-payment) will be equal to the `amount_money` of the tender.") + @ApiModelProperty(value = "The total amount of the tender, including `tip_money`. If the tender has a `payment_id`, the `total_money` of the corresponding `Payment` will be equal to the `amount_money` of the tender.") public Money getAmountMoney() { return amountMoney; } @@ -319,10 +319,10 @@ public Tender paymentId(String paymentId) { } /** - * The ID of the [Payment](#type-payment) that corresponds to this tender. This value is only present for payments created with the v2 Payments API. + * The ID of the `Payment` that corresponds to this tender. This value is only present for payments created with the v2 Payments API. * @return paymentId **/ - @ApiModelProperty(value = "The ID of the [Payment](#type-payment) that corresponds to this tender. This value is only present for payments created with the v2 Payments API.") + @ApiModelProperty(value = "The ID of the `Payment` that corresponds to this tender. This value is only present for payments created with the v2 Payments API.") public String getPaymentId() { return paymentId; } diff --git a/src/main/java/com/squareup/connect/models/Transaction.java b/src/main/java/com/squareup/connect/models/Transaction.java index e363533..b0a7ebb 100644 --- a/src/main/java/com/squareup/connect/models/Transaction.java +++ b/src/main/java/com/squareup/connect/models/Transaction.java @@ -167,10 +167,10 @@ public Transaction referenceId(String referenceId) { } /** - * If the transaction was created with the [Charge](#endpoint-transactions-charge) endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set. + * If the transaction was created with the `Charge` endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set. * @return referenceId **/ - @ApiModelProperty(value = "If the transaction was created with the [Charge](#endpoint-transactions-charge) endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set.") + @ApiModelProperty(value = "If the transaction was created with the `Charge` endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set.") public String getReferenceId() { return referenceId; } diff --git a/src/main/java/com/squareup/connect/models/UpdateItemModifierListsRequest.java b/src/main/java/com/squareup/connect/models/UpdateItemModifierListsRequest.java index e797af2..3833ccb 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](#type-catalogmodifierlist)s are being updated. + * The `CatalogItem](#type-catalogitem)s whose [CatalogModifierList`s are being updated. * @return itemIds **/ - @ApiModelProperty(required = true, value = "The [CatalogItem](#type-catalogitem)s whose [CatalogModifierList](#type-catalogmodifierlist)s are being updated.") + @ApiModelProperty(required = true, value = "The `CatalogItem](#type-catalogitem)s whose [CatalogModifierList`s are 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](#type-catalogitem). + * The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem`. * @return modifierListsToEnable **/ - @ApiModelProperty(value = "The set of [CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem](#type-catalogitem).") + @ApiModelProperty(value = "The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) 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](#type-catalogitem). + * The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem`. * @return modifierListsToDisable **/ - @ApiModelProperty(value = "The set of [CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem](#type-catalogitem).") + @ApiModelProperty(value = "The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) 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 ff69e28..a258102 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](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } diff --git a/src/main/java/com/squareup/connect/models/UpdateItemTaxesRequest.java b/src/main/java/com/squareup/connect/models/UpdateItemTaxesRequest.java index 92beaa2..b800944 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](#type-catalogtax)es are being updated. + * The `CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax`es are being updated. * @return itemIds **/ - @ApiModelProperty(required = true, value = "The [CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax](#type-catalogtax)es are being updated.") + @ApiModelProperty(required = true, value = "The `CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax`es are 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](#type-catalogitem). + * The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem`. * @return taxesToEnable **/ - @ApiModelProperty(value = "The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem](#type-catalogitem).") + @ApiModelProperty(value = "The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem`.") 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](#type-catalogitem). + * The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem`. * @return taxesToDisable **/ - @ApiModelProperty(value = "The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem](#type-catalogitem).") + @ApiModelProperty(value = "The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem`.") 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 5875ec0..bd0996b 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](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } diff --git a/src/main/java/com/squareup/connect/models/UpdateLocationRequest.java b/src/main/java/com/squareup/connect/models/UpdateLocationRequest.java new file mode 100644 index 0000000..e8dba18 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/UpdateLocationRequest.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 [UpdateLocation](#endpoint-updatelocation) endpoint. + */ +@ApiModel(description = "Request object for the [UpdateLocation](#endpoint-updatelocation) endpoint.") + +public class UpdateLocationRequest { + @JsonProperty("location") + private Location location = null; + + public UpdateLocationRequest location(Location location) { + this.location = location; + return this; + } + + /** + * The `Location` object with only the fields to update. + * @return location + **/ + @ApiModelProperty(value = "The `Location` object with only the fields to update.") + 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; + } + UpdateLocationRequest updateLocationRequest = (UpdateLocationRequest) o; + return Objects.equals(this.location, updateLocationRequest.location); + } + + @Override + public int hashCode() { + return Objects.hash(location); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UpdateLocationRequest {\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/UpdateLocationResponse.java b/src/main/java/com/squareup/connect/models/UpdateLocationResponse.java new file mode 100644 index 0000000..c3692b4 --- /dev/null +++ b/src/main/java/com/squareup/connect/models/UpdateLocationResponse.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 [UpdateLocation](#endpoint-updatelocation) endpoint. + */ +@ApiModel(description = "Response object returned by the [UpdateLocation](#endpoint-updatelocation) endpoint.") + +public class UpdateLocationResponse { + @JsonProperty("errors") + private List errors = new ArrayList(); + + @JsonProperty("location") + private Location location = null; + + public UpdateLocationResponse errors(List errors) { + this.errors = errors; + return this; + } + + public UpdateLocationResponse 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 UpdateLocationResponse location(Location location) { + this.location = location; + return this; + } + + /** + * The updated `Location`. + * @return location + **/ + @ApiModelProperty(value = "The updated `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; + } + UpdateLocationResponse updateLocationResponse = (UpdateLocationResponse) o; + return Objects.equals(this.errors, updateLocationResponse.errors) && + Objects.equals(this.location, updateLocationResponse.location); + } + + @Override + public int hashCode() { + return Objects.hash(errors, location); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UpdateLocationResponse {\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/UpdateOrderRequest.java b/src/main/java/com/squareup/connect/models/UpdateOrderRequest.java index ecad59d..d6b2c03 100644 --- a/src/main/java/com/squareup/connect/models/UpdateOrderRequest.java +++ b/src/main/java/com/squareup/connect/models/UpdateOrderRequest.java @@ -44,10 +44,10 @@ public UpdateOrderRequest order(Order order) { } /** - * The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. + * The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. * @return order **/ - @ApiModelProperty(value = "The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to.") + @ApiModelProperty(value = "The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to.") public Order getOrder() { return order; } @@ -67,10 +67,10 @@ public UpdateOrderRequest addFieldsToClearItem(String fieldsToClearItem) { } /** - * The [dot notation paths](/orders-api/manage-orders#on-dot-notation) fields to clear. For example, `line_items[uid].note` [Read more about Deleting fields](/orders-api/manage-orders#delete-fields). + * The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation) fields to clear. For example, `line_items[uid].note` [Read more about Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders#delete-fields). * @return fieldsToClear **/ - @ApiModelProperty(value = "The [dot notation paths](/orders-api/manage-orders#on-dot-notation) fields to clear. For example, `line_items[uid].note` [Read more about Deleting fields](/orders-api/manage-orders#delete-fields).") + @ApiModelProperty(value = "The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation) fields to clear. For example, `line_items[uid].note` [Read more about Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders#delete-fields).") public List getFieldsToClear() { return fieldsToClear; } @@ -85,10 +85,10 @@ public UpdateOrderRequest idempotencyKey(String idempotencyKey) { } /** - * A value you specify that uniquely identifies this update request If you're unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version will be returned. See [Idempotency](/basics/api101/idempotency) for more information. + * A value you specify that uniquely identifies this update request If you're unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version will be returned. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. * @return idempotencyKey **/ - @ApiModelProperty(value = "A value you specify that uniquely identifies this update request If you're unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version will be returned. See [Idempotency](/basics/api101/idempotency) for more information.") + @ApiModelProperty(value = "A value you specify that uniquely identifies this update request If you're unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version will be returned. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.") public String getIdempotencyKey() { return idempotencyKey; } diff --git a/src/main/java/com/squareup/connect/models/UpsertCatalogObjectRequest.java b/src/main/java/com/squareup/connect/models/UpsertCatalogObjectRequest.java index 28106b0..5f9a8c5 100644 --- a/src/main/java/com/squareup/connect/models/UpsertCatalogObjectRequest.java +++ b/src/main/java/com/squareup/connect/models/UpsertCatalogObjectRequest.java @@ -39,10 +39,10 @@ public UpsertCatalogObjectRequest idempotencyKey(String idempotencyKey) { } /** - * 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](/basics/api101/idempotency) for more information. + * 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. * @return idempotencyKey **/ - @ApiModelProperty(required = true, value = "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](/basics/api101/idempotency) for more information.") + @ApiModelProperty(required = true, value = "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.") public String getIdempotencyKey() { return idempotencyKey; } @@ -57,10 +57,10 @@ public UpsertCatalogObjectRequest object(CatalogObject object) { } /** - * A [CatalogObject](#type-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](#type-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 ea833a2..51f71b0 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](#type-error)s encountered. + * The set of `Error`s encountered. * @return errors **/ - @ApiModelProperty(value = "The set of [Error](#type-error)s encountered.") + @ApiModelProperty(value = "The set of `Error`s encountered.") public List getErrors() { return errors; } @@ -69,10 +69,10 @@ public UpsertCatalogObjectResponse catalogObject(CatalogObject catalogObject) { } /** - * The created [CatalogObject](#type-catalogobject). + * The created `CatalogObject`. * @return catalogObject **/ - @ApiModelProperty(value = "The created [CatalogObject](#type-catalogobject).") + @ApiModelProperty(value = "The created `CatalogObject`.") public CatalogObject getCatalogObject() { return catalogObject; } diff --git a/src/test/java/com/squareup/connect/api/MerchantsApiTest.java b/src/test/java/com/squareup/connect/api/MerchantsApiTest.java new file mode 100644 index 0000000..6e973cb --- /dev/null +++ b/src/test/java/com/squareup/connect/api/MerchantsApiTest.java @@ -0,0 +1,51 @@ +/* + * 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.api; + +import com.squareup.connect.ApiException; +import com.squareup.connect.models.RetrieveMerchantResponse; +import org.junit.Test; +import org.junit.Ignore; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * API tests for MerchantsApi + */ +@Ignore +public class MerchantsApiTest { + + private final MerchantsApi api = new MerchantsApi(); + + + /** + * RetrieveMerchant + * + * Retrieve a `Merchant` object for the given `merchant_id`. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void retrieveMerchantTest() throws ApiException { + String merchantId = null; + RetrieveMerchantResponse response = api.retrieveMerchant(merchantId); + + // TODO: test validations + } + +}