From cc1dea6cc50bd3fdde6a909354fbbac7d96a1ed1 Mon Sep 17 00:00:00 2001 From: Connect API Specification Generator Date: Wed, 20 Nov 2019 19:38:43 +0000 Subject: [PATCH] Release 2.25.0 --- CHANGES.md | 13 + README.md | 22 +- docs/ApplePayApi.md | 2 +- docs/BatchDeleteCatalogObjectsRequest.md | 2 +- docs/BatchDeleteCatalogObjectsResponse.md | 6 +- docs/BatchRetrieveCatalogObjectsRequest.md | 4 +- docs/BatchRetrieveInventoryChangesRequest.md | 2 +- docs/BatchRetrieveInventoryChangesResponse.md | 2 +- docs/BatchRetrieveInventoryCountsRequest.md | 2 +- docs/BatchRetrieveInventoryCountsResponse.md | 2 +- docs/BatchUpsertCatalogObjectsRequest.md | 2 +- docs/BatchUpsertCatalogObjectsResponse.md | 8 +- docs/BusinessHours.md | 2 +- docs/BusinessHoursPeriod.md | 2 +- docs/CaptureTransactionRequest.md | 2 +- docs/Card.md | 4 +- docs/CashPaymentDetails.md | 17 + docs/CatalogApi.md | 18 +- docs/CatalogCategory.md | 4 +- docs/CatalogDiscount.md | 5 +- ...ts.md => CatalogDiscountModifyTaxBasis.md} | 4 +- docs/CatalogDiscountType.md | 2 +- docs/CatalogIdMapping.md | 2 +- docs/CatalogInfoResponse.md | 2 +- docs/CatalogItem.md | 6 +- docs/CatalogItemModifierListInfo.md | 10 +- docs/CatalogItemOption.md | 6 +- docs/CatalogItemOptionValue.md | 6 +- .../CatalogItemOptionValueForItemVariation.md | 2 +- docs/CatalogItemProductType.md | 2 +- docs/CatalogItemVariation.md | 4 +- docs/CatalogMeasurementUnit.md | 4 +- docs/CatalogModifier.md | 4 +- docs/CatalogModifierList.md | 6 +- docs/CatalogModifierListSelectionType.md | 2 +- docs/CatalogModifierOverride.md | 2 +- docs/CatalogObject.md | 8 +- docs/CatalogObjectBatch.md | 4 +- docs/CatalogObjectType.md | 2 +- docs/CatalogPricingRule.md | 16 +- docs/CatalogPricingType.md | 2 +- docs/CatalogProductSet.md | 8 +- docs/CatalogQuery.md | 10 +- docs/CatalogQueryCustomAttributeUsage.md | 17 + docs/CatalogQueryFilteredItems.md | 25 + ...QueryFilteredItemsCustomAttributeFilter.md | 21 + ...redItemsCustomAttributeFilterFilterType.md | 15 + ...alogQueryFilteredItemsNullableAttribute.md | 15 + docs/CatalogQueryFilteredItemsStockLevel.md | 15 + docs/CatalogQueryItemsForItemOptions.md | 2 +- docs/CatalogQueryItemsForModifierList.md | 2 +- docs/CatalogQueryItemsForTax.md | 2 +- docs/CatalogQuerySortedAttribute.md | 2 +- docs/CatalogQueryText.md | 2 +- docs/CatalogV1Id.md | 4 +- docs/ChargeRequest.md | 10 +- docs/Coordinates.md | 4 +- docs/CreateCatalogImageRequest.md | 18 + docs/CreateCatalogImageResponse.md | 17 + docs/CreateCheckoutRequest.md | 4 +- docs/CreateCheckoutResponse.md | 2 +- docs/CreateCustomerCardRequest.md | 2 +- docs/CreateCustomerRequest.md | 22 +- docs/CreateLocationRequest.md | 17 + docs/CreateLocationResponse.md | 18 + docs/CreateMobileAuthorizationCodeRequest.md | 2 +- docs/CreateMobileAuthorizationCodeResponse.md | 2 +- docs/CreatePaymentRequest.md | 11 +- docs/CreateRefundRequest.md | 2 +- docs/Customer.md | 32 +- docs/CustomerCreationSourceFilter.md | 2 +- docs/CustomerFilter.md | 2 +- docs/CustomerPreferences.md | 2 +- docs/CustomerSort.md | 4 +- docs/CustomersApi.md | 16 +- docs/DeleteCatalogObjectResponse.md | 6 +- docs/Device.md | 1 + docs/Employee.md | 16 +- docs/EmployeesApi.md | 4 +- docs/Error.md | 6 +- docs/ExcludeStrategy.md | 2 +- docs/ExternalPaymentDetails.md | 19 + docs/InventoryAdjustment.md | 2 +- docs/InventoryAlertType.md | 2 +- docs/InventoryApi.md | 8 +- docs/InventoryChange.md | 4 +- docs/InventoryCount.md | 4 +- docs/InventoryPhysicalCount.md | 2 +- docs/InventoryTransfer.md | 2 +- docs/ItemVariationLocationOverrides.md | 10 +- ...tionalRecipientReceivableRefundsRequest.md | 4 +- ...ionalRecipientReceivableRefundsResponse.md | 4 +- ...stAdditionalRecipientReceivablesRequest.md | 4 +- ...tAdditionalRecipientReceivablesResponse.md | 4 +- docs/ListCatalogRequest.md | 2 +- docs/ListCatalogResponse.md | 4 +- docs/ListCustomersRequest.md | 6 +- docs/ListCustomersResponse.md | 4 +- docs/ListEmployeesRequest.md | 2 +- docs/ListEmployeesResponse.md | 2 +- docs/ListLocationsRequest.md | 2 +- docs/ListLocationsResponse.md | 4 +- docs/ListPaymentRefundsRequest.md | 4 +- docs/ListRefundsRequest.md | 2 +- docs/ListRefundsResponse.md | 2 +- docs/ListTransactionsRequest.md | 2 +- docs/ListTransactionsResponse.md | 2 +- docs/Location.md | 32 +- docs/LocationCapability.md | 2 +- docs/LocationStatus.md | 2 +- docs/LocationType.md | 2 +- docs/LocationsApi.md | 72 +- docs/MeasurementUnitGeneric.md | 2 +- docs/MerchantsApi.md | 2 +- docs/MobileAuthorizationApi.md | 2 +- docs/Money.md | 4 +- docs/OAuthApi.md | 8 +- docs/ObtainTokenResponse.md | 2 +- docs/Payment.md | 7 +- docs/PaymentsApi.md | 4 +- docs/RefundPaymentRequest.md | 4 +- docs/RefundsApi.md | 8 +- docs/RegisterDomainRequest.md | 2 +- docs/RegisterDomainResponse.md | 4 +- docs/RenewTokenResponse.md | 4 +- docs/ReportingApi.md | 8 +- docs/RetrieveCatalogObjectRequest.md | 2 +- docs/RetrieveCatalogObjectResponse.md | 6 +- docs/RetrieveEmployeeRequest.md | 2 +- docs/RetrieveEmployeeResponse.md | 2 +- docs/RetrieveInventoryChangesRequest.md | 2 +- docs/RetrieveInventoryChangesResponse.md | 2 +- docs/RetrieveInventoryCountRequest.md | 2 +- docs/RetrieveInventoryCountResponse.md | 2 +- docs/RetrieveLocationRequest.md | 2 +- docs/RetrieveLocationResponse.md | 2 +- docs/RetrieveMerchantResponse.md | 2 +- docs/RetrieveTransactionRequest.md | 2 +- docs/RevokeTokenRequest.md | 2 +- docs/SearchCatalogObjectsRequest.md | 6 +- docs/SearchCatalogObjectsResponse.md | 8 +- docs/SearchCustomersRequest.md | 2 +- docs/SearchCustomersResponse.md | 2 +- docs/Shift.md | 2 +- docs/ShiftFilter.md | 4 +- docs/StandardUnitDescription.md | 4 +- docs/StandardUnitDescriptionGroup.md | 2 +- docs/TaxInclusionType.md | 2 +- docs/TenderCardDetails.md | 2 +- docs/TransactionsApi.md | 14 +- docs/UpdateBreakTypeRequest.md | 2 +- docs/UpdateCustomerRequest.md | 20 +- docs/UpdateItemModifierListsRequest.md | 6 +- docs/UpdateItemModifierListsResponse.md | 4 +- docs/UpdateItemTaxesRequest.md | 6 +- docs/UpdateItemTaxesResponse.md | 4 +- docs/UpdateWorkweekConfigRequest.md | 2 +- docs/UpsertCatalogObjectRequest.md | 2 +- docs/UpsertCatalogObjectResponse.md | 6 +- docs/V1AdjustInventoryRequest.md | 1 + .../V1AdjustInventoryRequestAdjustmentType.md | 1 + docs/V1ApplyFeeRequest.md | 1 + docs/V1ApplyModifierListRequest.md | 1 + docs/V1Category.md | 1 + docs/V1CreateCategoryRequest.md | 1 + docs/V1CreateDiscountRequest.md | 1 + docs/V1CreateFeeRequest.md | 1 + docs/V1CreateItemRequest.md | 1 + docs/V1CreateModifierListRequest.md | 1 + docs/V1CreateModifierOptionRequest.md | 1 + docs/V1CreatePageRequest.md | 1 + docs/V1CreateVariationRequest.md | 1 + docs/V1DeleteCategoryRequest.md | 1 + docs/V1DeleteDiscountRequest.md | 1 + docs/V1DeleteFeeRequest.md | 1 + docs/V1DeleteItemRequest.md | 1 + docs/V1DeleteModifierListRequest.md | 1 + docs/V1DeleteModifierOptionRequest.md | 1 + docs/V1DeletePageCellRequest.md | 1 + docs/V1DeletePageRequest.md | 1 + docs/V1DeleteVariationRequest.md | 1 + docs/V1Discount.md | 3 +- docs/V1DiscountColor.md | 1 + docs/V1DiscountDiscountType.md | 1 + docs/V1Fee.md | 3 +- docs/V1FeeAdjustmentType.md | 1 + docs/V1FeeCalculationPhase.md | 1 + docs/V1FeeInclusionType.md | 1 + docs/V1FeeType.md | 1 + docs/V1InventoryEntry.md | 1 + docs/V1Item.md | 5 +- docs/V1ItemColor.md | 1 + docs/V1ItemImage.md | 1 + docs/V1ItemType.md | 1 + docs/V1ItemVisibility.md | 1 + docs/V1ItemsApi.md | 120 ++- docs/V1ListCategoriesRequest.md | 1 + docs/V1ListCategoriesResponse.md | 1 + docs/V1ListDiscountsRequest.md | 1 + docs/V1ListDiscountsResponse.md | 1 + docs/V1ListFeesRequest.md | 1 + docs/V1ListFeesResponse.md | 1 + docs/V1ListInventoryRequest.md | 1 + docs/V1ListInventoryResponse.md | 1 + docs/V1ListItemsRequest.md | 1 + docs/V1ListItemsResponse.md | 1 + docs/V1ListLocationsRequest.md | 1 + docs/V1ListLocationsResponse.md | 1 + docs/V1ListModifierListsRequest.md | 1 + docs/V1ListModifierListsResponse.md | 1 + docs/V1ListPagesRequest.md | 1 + docs/V1ListPagesResponse.md | 1 + docs/V1LocationsApi.md | 6 +- docs/V1Merchant.md | 1 + docs/V1MerchantAccountType.md | 1 + docs/V1MerchantBusinessType.md | 1 + docs/V1MerchantLocationDetails.md | 1 + docs/V1ModifierList.md | 1 + docs/V1ModifierListSelectionType.md | 1 + docs/V1ModifierOption.md | 3 +- docs/V1Money.md | 1 + docs/V1Page.md | 1 + docs/V1PageCell.md | 1 + docs/V1PageCellObjectType.md | 1 + docs/V1PageCellPlaceholderType.md | 1 + docs/V1PhoneNumber.md | 1 + docs/V1RemoveFeeRequest.md | 1 + docs/V1RemoveModifierListRequest.md | 1 + docs/V1RetrieveBusinessRequest.md | 1 + docs/V1RetrieveItemRequest.md | 1 + docs/V1RetrieveModifierListRequest.md | 1 + docs/V1Tender.md | 1 + docs/V1TenderCardBrand.md | 1 + docs/V1TenderEntryMethod.md | 1 + docs/V1TenderType.md | 1 + docs/V1UpdateCategoryRequest.md | 1 + docs/V1UpdateDiscountRequest.md | 1 + docs/V1UpdateFeeRequest.md | 1 + docs/V1UpdateItemRequest.md | 1 + docs/V1UpdateModifierListRequest.md | 1 + ...1UpdateModifierListRequestSelectionType.md | 1 + docs/V1UpdateModifierOptionRequest.md | 1 + docs/V1UpdatePageCellRequest.md | 1 + docs/V1UpdatePageRequest.md | 1 + docs/V1UpdateVariationRequest.md | 1 + docs/V1Variation.md | 3 +- docs/V1VariationInventoryAlertType.md | 1 + docs/V1VariationPricingType.md | 1 + docs/VoidTransactionRequest.md | 2 +- .../Model/CashPaymentDetailsTests.cs | 86 ++ .../CatalogDiscountModifyTaxBasisTests.cs | 70 ++ .../CatalogQueryCustomAttributeUsageTests.cs | 86 ++ ...emsCustomAttributeFilterFilterTypeTests.cs | 70 ++ ...FilteredItemsCustomAttributeFilterTests.cs | 118 +++ ...ueryFilteredItemsNullableAttributeTests.cs | 70 ++ ...atalogQueryFilteredItemsStockLevelTests.cs | 70 ++ .../Model/CatalogQueryFilteredItemsTests.cs | 150 +++ .../Model/CreateCatalogImageRequestTests.cs | 94 ++ .../Model/CreateCatalogImageResponseTests.cs | 86 ++ .../Model/CreateLocationRequestTests.cs | 78 ++ .../Model/CreateLocationResponseTests.cs | 86 ++ .../Model/ExternalPaymentDetailsTests.cs | 102 ++ src/Square.Connect/Api/ApplePayApi.cs | 20 +- src/Square.Connect/Api/CatalogApi.cs | 124 +-- src/Square.Connect/Api/CheckoutApi.cs | 4 +- src/Square.Connect/Api/CustomersApi.cs | 112 +- src/Square.Connect/Api/EmployeesApi.cs | 40 +- src/Square.Connect/Api/InventoryApi.cs | 60 +- src/Square.Connect/Api/LaborApi.cs | 56 +- src/Square.Connect/Api/LocationsApi.cs | 250 ++++- src/Square.Connect/Api/MerchantsApi.cs | 24 +- .../Api/MobileAuthorizationApi.cs | 20 +- src/Square.Connect/Api/OAuthApi.cs | 60 +- src/Square.Connect/Api/OrdersApi.cs | 20 +- src/Square.Connect/Api/PaymentsApi.cs | 56 +- src/Square.Connect/Api/RefundsApi.cs | 44 +- src/Square.Connect/Api/ReportingApi.cs | 40 +- src/Square.Connect/Api/TransactionsApi.cs | 108 +- src/Square.Connect/Api/V1EmployeesApi.cs | 64 +- src/Square.Connect/Api/V1ItemsApi.cs | 960 ++++++++++-------- src/Square.Connect/Api/V1LocationsApi.cs | 48 +- src/Square.Connect/Api/V1TransactionsApi.cs | 44 +- src/Square.Connect/Client/Configuration.cs | 6 +- .../Model/AdditionalRecipient.cs | 1 + .../Model/BatchDeleteCatalogObjectsRequest.cs | 6 +- .../BatchDeleteCatalogObjectsResponse.cs | 18 +- .../BatchRetrieveCatalogObjectsRequest.cs | 12 +- .../BatchRetrieveInventoryChangesRequest.cs | 6 +- .../BatchRetrieveInventoryChangesResponse.cs | 6 +- .../BatchRetrieveInventoryCountsRequest.cs | 6 +- .../BatchRetrieveInventoryCountsResponse.cs | 6 +- .../Model/BatchUpsertCatalogObjectsRequest.cs | 6 +- .../BatchUpsertCatalogObjectsResponse.cs | 24 +- src/Square.Connect/Model/BusinessHours.cs | 2 +- .../Model/BusinessHoursPeriod.cs | 2 +- .../Model/CaptureTransactionRequest.cs | 2 +- src/Square.Connect/Model/Card.cs | 12 +- .../Model/CashPaymentDetails.cs | 151 +++ src/Square.Connect/Model/CatalogCategory.cs | 8 +- src/Square.Connect/Model/CatalogDiscount.cs | 30 +- src/Square.Connect/Model/CatalogIdMapping.cs | 6 +- .../Model/CatalogInfoResponse.cs | 6 +- src/Square.Connect/Model/CatalogItem.cs | 18 +- .../Model/CatalogItemModifierListInfo.cs | 26 +- src/Square.Connect/Model/CatalogItemOption.cs | 14 +- .../Model/CatalogItemOptionValue.cs | 14 +- .../CatalogItemOptionValueForItemVariation.cs | 2 +- .../Model/CatalogItemVariation.cs | 12 +- .../Model/CatalogMeasurementUnit.cs | 8 +- src/Square.Connect/Model/CatalogModifier.cs | 12 +- .../Model/CatalogModifierList.cs | 14 +- .../Model/CatalogModifierOverride.cs | 6 +- src/Square.Connect/Model/CatalogObject.cs | 20 +- .../Model/CatalogObjectBatch.cs | 8 +- .../Model/CatalogPricingRule.cs | 48 +- src/Square.Connect/Model/CatalogProductSet.cs | 20 +- src/Square.Connect/Model/CatalogQuery.cs | 26 +- .../Model/CatalogQueryCustomAttributeUsage.cs | 138 +++ .../Model/CatalogQueryFilteredItems.cs | 266 +++++ ...QueryFilteredItemsCustomAttributeFilter.cs | 202 ++++ .../Model/CatalogQueryItemsForItemOptions.cs | 6 +- .../Model/CatalogQueryItemsForModifierList.cs | 6 +- .../Model/CatalogQueryItemsForTax.cs | 6 +- .../Model/CatalogQuerySortedAttribute.cs | 6 +- src/Square.Connect/Model/CatalogQueryText.cs | 6 +- src/Square.Connect/Model/CatalogV1Id.cs | 8 +- src/Square.Connect/Model/ChargeRequest.cs | 30 +- src/Square.Connect/Model/Coordinates.cs | 12 +- .../Model/CreateCatalogImageRequest.cs | 173 ++++ .../Model/CreateCatalogImageResponse.cs | 138 +++ .../Model/CreateCheckoutRequest.cs | 8 +- .../Model/CreateCheckoutResponse.cs | 2 +- .../Model/CreateCustomerCardRequest.cs | 6 +- .../Model/CreateCustomerRequest.cs | 66 +- .../Model/CreateLocationRequest.cs | 123 +++ .../Model/CreateLocationResponse.cs | 139 +++ .../CreateMobileAuthorizationCodeRequest.cs | 2 +- .../CreateMobileAuthorizationCodeResponse.cs | 2 +- .../Model/CreatePaymentRequest.cs | 50 +- .../Model/CreateRefundRequest.cs | 6 +- src/Square.Connect/Model/Customer.cs | 92 +- .../Model/CustomerCreationSourceFilter.cs | 6 +- src/Square.Connect/Model/CustomerFilter.cs | 2 +- .../Model/CustomerPreferences.cs | 2 +- src/Square.Connect/Model/CustomerSort.cs | 12 +- .../Model/DeleteCatalogObjectResponse.cs | 18 +- src/Square.Connect/Model/Device.cs | 1 + src/Square.Connect/Model/Employee.cs | 44 +- src/Square.Connect/Model/Error.cs | 14 +- .../Model/ExternalPaymentDetails.cs | 191 ++++ .../Model/InventoryAdjustment.cs | 6 +- src/Square.Connect/Model/InventoryChange.cs | 8 +- src/Square.Connect/Model/InventoryCount.cs | 8 +- .../Model/InventoryPhysicalCount.cs | 6 +- src/Square.Connect/Model/InventoryTransfer.cs | 6 +- .../Model/ItemVariationLocationOverrides.cs | 26 +- ...tionalRecipientReceivableRefundsRequest.cs | 8 +- ...ionalRecipientReceivableRefundsResponse.cs | 8 +- ...stAdditionalRecipientReceivablesRequest.cs | 8 +- ...tAdditionalRecipientReceivablesResponse.cs | 8 +- .../Model/ListCatalogRequest.cs | 6 +- .../Model/ListCatalogResponse.cs | 12 +- .../Model/ListCustomersRequest.cs | 18 +- .../Model/ListCustomersResponse.cs | 12 +- .../Model/ListEmployeesRequest.cs | 2 +- .../Model/ListEmployeesResponse.cs | 2 +- .../Model/ListLocationsRequest.cs | 2 +- .../Model/ListLocationsResponse.cs | 8 +- .../Model/ListPaymentRefundsRequest.cs | 12 +- .../Model/ListRefundsRequest.cs | 6 +- .../Model/ListRefundsResponse.cs | 6 +- .../Model/ListTransactionsRequest.cs | 6 +- .../Model/ListTransactionsResponse.cs | 6 +- src/Square.Connect/Model/Location.cs | 92 +- src/Square.Connect/Model/Money.cs | 8 +- .../Model/ObtainTokenResponse.cs | 6 +- src/Square.Connect/Model/Payment.cs | 36 +- .../Model/RefundPaymentRequest.cs | 12 +- .../Model/RegisterDomainRequest.cs | 2 +- .../Model/RegisterDomainResponse.cs | 8 +- .../Model/RenewTokenResponse.cs | 12 +- .../Model/RetrieveCatalogObjectRequest.cs | 6 +- .../Model/RetrieveCatalogObjectResponse.cs | 18 +- .../Model/RetrieveEmployeeRequest.cs | 2 +- .../Model/RetrieveEmployeeResponse.cs | 2 +- .../Model/RetrieveInventoryChangesRequest.cs | 6 +- .../Model/RetrieveInventoryChangesResponse.cs | 6 +- .../Model/RetrieveInventoryCountRequest.cs | 6 +- .../Model/RetrieveInventoryCountResponse.cs | 6 +- .../Model/RetrieveLocationRequest.cs | 2 +- .../Model/RetrieveLocationResponse.cs | 2 +- .../Model/RetrieveMerchantResponse.cs | 2 +- .../Model/RetrieveTransactionRequest.cs | 2 +- .../Model/RevokeTokenRequest.cs | 6 +- .../Model/SearchCatalogObjectsRequest.cs | 18 +- .../Model/SearchCatalogObjectsResponse.cs | 24 +- .../Model/SearchCustomersRequest.cs | 6 +- .../Model/SearchCustomersResponse.cs | 6 +- src/Square.Connect/Model/Shift.cs | 6 +- src/Square.Connect/Model/ShiftFilter.cs | 42 +- .../Model/StandardUnitDescription.cs | 12 +- .../Model/StandardUnitDescriptionGroup.cs | 6 +- src/Square.Connect/Model/TenderCardDetails.cs | 6 +- .../Model/UpdateBreakTypeRequest.cs | 17 +- .../Model/UpdateCustomerRequest.cs | 60 +- .../Model/UpdateItemModifierListsRequest.cs | 18 +- .../Model/UpdateItemModifierListsResponse.cs | 12 +- .../Model/UpdateItemTaxesRequest.cs | 18 +- .../Model/UpdateItemTaxesResponse.cs | 12 +- .../Model/UpdateWorkweekConfigRequest.cs | 17 +- .../Model/UpsertCatalogObjectRequest.cs | 6 +- .../Model/UpsertCatalogObjectResponse.cs | 18 +- .../Model/V1AdjustInventoryRequest.cs | 1 + src/Square.Connect/Model/V1ApplyFeeRequest.cs | 1 + .../Model/V1ApplyModifierListRequest.cs | 1 + src/Square.Connect/Model/V1Category.cs | 1 + .../Model/V1CreateCategoryRequest.cs | 1 + .../Model/V1CreateDiscountRequest.cs | 1 + .../Model/V1CreateFeeRequest.cs | 1 + .../Model/V1CreateItemRequest.cs | 1 + .../Model/V1CreateModifierListRequest.cs | 1 + .../Model/V1CreateModifierOptionRequest.cs | 1 + .../Model/V1CreatePageRequest.cs | 1 + .../Model/V1CreateVariationRequest.cs | 1 + .../Model/V1DeleteCategoryRequest.cs | 1 + .../Model/V1DeleteDiscountRequest.cs | 1 + .../Model/V1DeleteFeeRequest.cs | 1 + .../Model/V1DeleteItemRequest.cs | 1 + .../Model/V1DeleteModifierListRequest.cs | 1 + .../Model/V1DeleteModifierOptionRequest.cs | 1 + .../Model/V1DeletePageCellRequest.cs | 1 + .../Model/V1DeletePageRequest.cs | 1 + .../Model/V1DeleteVariationRequest.cs | 1 + src/Square.Connect/Model/V1Discount.cs | 7 +- src/Square.Connect/Model/V1Fee.cs | 7 +- src/Square.Connect/Model/V1InventoryEntry.cs | 1 + src/Square.Connect/Model/V1Item.cs | 13 +- src/Square.Connect/Model/V1ItemImage.cs | 1 + .../Model/V1ListCategoriesRequest.cs | 1 + .../Model/V1ListCategoriesResponse.cs | 1 + .../Model/V1ListDiscountsRequest.cs | 1 + .../Model/V1ListDiscountsResponse.cs | 1 + src/Square.Connect/Model/V1ListFeesRequest.cs | 1 + .../Model/V1ListFeesResponse.cs | 1 + .../Model/V1ListInventoryRequest.cs | 1 + .../Model/V1ListInventoryResponse.cs | 1 + .../Model/V1ListItemsRequest.cs | 1 + .../Model/V1ListItemsResponse.cs | 1 + .../Model/V1ListLocationsRequest.cs | 1 + .../Model/V1ListLocationsResponse.cs | 1 + .../Model/V1ListModifierListsRequest.cs | 1 + .../Model/V1ListModifierListsResponse.cs | 1 + .../Model/V1ListPagesRequest.cs | 1 + .../Model/V1ListPagesResponse.cs | 1 + src/Square.Connect/Model/V1Merchant.cs | 1 + .../Model/V1MerchantLocationDetails.cs | 1 + src/Square.Connect/Model/V1ModifierList.cs | 1 + src/Square.Connect/Model/V1ModifierOption.cs | 7 +- src/Square.Connect/Model/V1Money.cs | 1 + src/Square.Connect/Model/V1Page.cs | 1 + src/Square.Connect/Model/V1PageCell.cs | 1 + src/Square.Connect/Model/V1PhoneNumber.cs | 1 + .../Model/V1RemoveFeeRequest.cs | 1 + .../Model/V1RemoveModifierListRequest.cs | 1 + .../Model/V1RetrieveBusinessRequest.cs | 1 + .../Model/V1RetrieveItemRequest.cs | 1 + .../Model/V1RetrieveModifierListRequest.cs | 1 + src/Square.Connect/Model/V1Tender.cs | 1 + .../Model/V1UpdateCategoryRequest.cs | 1 + .../Model/V1UpdateDiscountRequest.cs | 1 + .../Model/V1UpdateFeeRequest.cs | 1 + .../Model/V1UpdateItemRequest.cs | 1 + .../Model/V1UpdateModifierListRequest.cs | 1 + .../Model/V1UpdateModifierOptionRequest.cs | 1 + .../Model/V1UpdatePageCellRequest.cs | 1 + .../Model/V1UpdatePageRequest.cs | 1 + .../Model/V1UpdateVariationRequest.cs | 1 + src/Square.Connect/Model/V1Variation.cs | 7 +- .../Model/VoidTransactionRequest.cs | 2 +- src/Square.Connect/Properties/AssemblyInfo.cs | 6 +- src/Square.Connect/Square.Connect.nuspec | 2 +- 481 files changed, 5645 insertions(+), 2086 deletions(-) create mode 100644 docs/CashPaymentDetails.md rename docs/{WebhookEvents.md => CatalogDiscountModifyTaxBasis.md} (72%) create mode 100644 docs/CatalogQueryCustomAttributeUsage.md create mode 100644 docs/CatalogQueryFilteredItems.md create mode 100644 docs/CatalogQueryFilteredItemsCustomAttributeFilter.md create mode 100644 docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md create mode 100644 docs/CatalogQueryFilteredItemsNullableAttribute.md create mode 100644 docs/CatalogQueryFilteredItemsStockLevel.md create mode 100644 docs/CreateCatalogImageRequest.md create mode 100644 docs/CreateCatalogImageResponse.md create mode 100644 docs/CreateLocationRequest.md create mode 100644 docs/CreateLocationResponse.md create mode 100644 docs/ExternalPaymentDetails.md create mode 100644 src/Square.Connect.Test/Model/CashPaymentDetailsTests.cs create mode 100644 src/Square.Connect.Test/Model/CatalogDiscountModifyTaxBasisTests.cs create mode 100644 src/Square.Connect.Test/Model/CatalogQueryCustomAttributeUsageTests.cs create mode 100644 src/Square.Connect.Test/Model/CatalogQueryFilteredItemsCustomAttributeFilterFilterTypeTests.cs create mode 100644 src/Square.Connect.Test/Model/CatalogQueryFilteredItemsCustomAttributeFilterTests.cs create mode 100644 src/Square.Connect.Test/Model/CatalogQueryFilteredItemsNullableAttributeTests.cs create mode 100644 src/Square.Connect.Test/Model/CatalogQueryFilteredItemsStockLevelTests.cs create mode 100644 src/Square.Connect.Test/Model/CatalogQueryFilteredItemsTests.cs create mode 100644 src/Square.Connect.Test/Model/CreateCatalogImageRequestTests.cs create mode 100644 src/Square.Connect.Test/Model/CreateCatalogImageResponseTests.cs create mode 100644 src/Square.Connect.Test/Model/CreateLocationRequestTests.cs create mode 100644 src/Square.Connect.Test/Model/CreateLocationResponseTests.cs create mode 100644 src/Square.Connect.Test/Model/ExternalPaymentDetailsTests.cs create mode 100644 src/Square.Connect/Model/CashPaymentDetails.cs create mode 100644 src/Square.Connect/Model/CatalogQueryCustomAttributeUsage.cs create mode 100644 src/Square.Connect/Model/CatalogQueryFilteredItems.cs create mode 100644 src/Square.Connect/Model/CatalogQueryFilteredItemsCustomAttributeFilter.cs create mode 100644 src/Square.Connect/Model/CreateCatalogImageRequest.cs create mode 100644 src/Square.Connect/Model/CreateCatalogImageResponse.cs create mode 100644 src/Square.Connect/Model/CreateLocationRequest.cs create mode 100644 src/Square.Connect/Model/CreateLocationResponse.cs create mode 100644 src/Square.Connect/Model/ExternalPaymentDetails.cs diff --git a/CHANGES.md b/CHANGES.md index f43e591..ce3d372 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,7 +1,20 @@ # Change Log +## Version 2.25.0 (2019-11-20) +!!!important +Square has begun the retirement process for Connect v1 APIs. See the [Connect v1 Retirement](/migrate-from-v1) information page for details. +!!! + +* __GA releases:__ SDKs now support the new `modify_tax_basis` field to Discounts and v2 Sandbox +* __BETA releases:__ SDKs now support the Shifts API webhooks for Labor shift created, updated, deleted, CreateLocation endpoint, and the ability to customize statement description in Payments API. +* **Deprecated**: Support for v1Items API and v1Locations API is fully deprecated. + + + + ## Version 2.24.0 (2019-10-23) * **GA release**: Merchants.ListMerchant is GA for all SDKs. +* **Beta release**: All SDKs support new Locations API endpoint, CreateLocation. * **Beta release**: All SDKs support exclusion strategies for pricing rules. diff --git a/README.md b/README.md index 11d0fff..f312d45 100644 --- a/README.md +++ b/README.md @@ -177,6 +177,7 @@ Class | Method | HTTP request *LaborApi* | [**UpdateBreakType**](docs/LaborApi.md#updatebreaktype) | **PUT** /v2/labor/break-types/{id} *LaborApi* | [**UpdateShift**](docs/LaborApi.md#updateshift) | **PUT** /v2/labor/shifts/{id} *LaborApi* | [**UpdateWorkweekConfig**](docs/LaborApi.md#updateworkweekconfig) | **PUT** /v2/labor/workweek-configs/{id} +*LocationsApi* | [**CreateLocation**](docs/LocationsApi.md#createlocation) | **POST** /v2/locations *LocationsApi* | [**ListLocations**](docs/LocationsApi.md#listlocations) | **GET** /v2/locations *LocationsApi* | [**RetrieveLocation**](docs/LocationsApi.md#retrievelocation) | **GET** /v2/locations/{location_id} *LocationsApi* | [**UpdateLocation**](docs/LocationsApi.md#updatelocation) | **PUT** /v2/locations/{location_id} @@ -312,6 +313,7 @@ Class | Method | HTTP request - [Model.CaptureTransactionResponse](docs/CaptureTransactionResponse.md) - [Model.Card](docs/Card.md) - [Model.CardPaymentDetails](docs/CardPaymentDetails.md) + - [Model.CashPaymentDetails](docs/CashPaymentDetails.md) - [Model.CatalogCategory](docs/CatalogCategory.md) - [Model.CatalogDiscount](docs/CatalogDiscount.md) - [Model.CatalogIdMapping](docs/CatalogIdMapping.md) @@ -335,7 +337,10 @@ Class | Method | HTTP request - [Model.CatalogPricingRule](docs/CatalogPricingRule.md) - [Model.CatalogProductSet](docs/CatalogProductSet.md) - [Model.CatalogQuery](docs/CatalogQuery.md) + - [Model.CatalogQueryCustomAttributeUsage](docs/CatalogQueryCustomAttributeUsage.md) - [Model.CatalogQueryExact](docs/CatalogQueryExact.md) + - [Model.CatalogQueryFilteredItems](docs/CatalogQueryFilteredItems.md) + - [Model.CatalogQueryFilteredItemsCustomAttributeFilter](docs/CatalogQueryFilteredItemsCustomAttributeFilter.md) - [Model.CatalogQueryItemVariationsForItemOptionValues](docs/CatalogQueryItemVariationsForItemOptionValues.md) - [Model.CatalogQueryItemsForItemOptions](docs/CatalogQueryItemsForItemOptions.md) - [Model.CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md) @@ -356,12 +361,16 @@ Class | Method | HTTP request - [Model.Coordinates](docs/Coordinates.md) - [Model.CreateBreakTypeRequest](docs/CreateBreakTypeRequest.md) - [Model.CreateBreakTypeResponse](docs/CreateBreakTypeResponse.md) + - [Model.CreateCatalogImageRequest](docs/CreateCatalogImageRequest.md) + - [Model.CreateCatalogImageResponse](docs/CreateCatalogImageResponse.md) - [Model.CreateCheckoutRequest](docs/CreateCheckoutRequest.md) - [Model.CreateCheckoutResponse](docs/CreateCheckoutResponse.md) - [Model.CreateCustomerCardRequest](docs/CreateCustomerCardRequest.md) - [Model.CreateCustomerCardResponse](docs/CreateCustomerCardResponse.md) - [Model.CreateCustomerRequest](docs/CreateCustomerRequest.md) - [Model.CreateCustomerResponse](docs/CreateCustomerResponse.md) + - [Model.CreateLocationRequest](docs/CreateLocationRequest.md) + - [Model.CreateLocationResponse](docs/CreateLocationResponse.md) - [Model.CreateMobileAuthorizationCodeRequest](docs/CreateMobileAuthorizationCodeRequest.md) - [Model.CreateMobileAuthorizationCodeResponse](docs/CreateMobileAuthorizationCodeResponse.md) - [Model.CreateOrderRequest](docs/CreateOrderRequest.md) @@ -398,6 +407,7 @@ Class | Method | HTTP request - [Model.Employee](docs/Employee.md) - [Model.EmployeeWage](docs/EmployeeWage.md) - [Model.Error](docs/Error.md) + - [Model.ExternalPaymentDetails](docs/ExternalPaymentDetails.md) - [Model.GetBreakTypeRequest](docs/GetBreakTypeRequest.md) - [Model.GetBreakTypeResponse](docs/GetBreakTypeResponse.md) - [Model.GetEmployeeWageRequest](docs/GetEmployeeWageRequest.md) @@ -698,18 +708,18 @@ Class | Method | HTTP request - EMPLOYEES_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee profile information. For example, to create and modify employee profiles. - INVENTORY_READ: __HTTP Method__: `GET` Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint. - INVENTORY_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint. - - ITEMS_READ: __HTTP Method__: `GET` Grants read access to product catalog information. For example, to get an item or a list of items. + - ITEMS_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. - ITEMS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to product catalog information. For example, to modify or add to a product catalog. - MERCHANT_PROFILE_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. - ORDERS_READ: __HTTP Method__: `GET` Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint. - ORDERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to order information. For example, to call the CreateCheckout endpoint. - PAYMENTS_READ: __HTTP Method__: `GET` Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint. - - PAYMENTS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process payments with the Transactions or Checkout API. - - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: __HTTP Method__: `POST`, `PUT`, `DELETE` Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Transactions API. - - PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process in-person payments. + - PAYMENTS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API. + - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: __HTTP Method__: `POST`, `PUT`, `DELETE` Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Payments API. + - PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to payments and refunds information. For example, to process in-person payments. - SETTLEMENTS_READ: __HTTP Method__: `GET` Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint. - - TIMECARDS_READ: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v1 ListTimecards endpoint. - - TIMECARDS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard information. For example, to create and modify timecards. + - TIMECARDS_READ: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint. + - TIMECARDS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee shift information. For example, to create and modify employee shifts. - TIMECARDS_SETTINGS_READ: __HTTP Method__: `GET` Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint. - TIMECARDS_SETTINGS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint. diff --git a/docs/ApplePayApi.md b/docs/ApplePayApi.md index 684f39f..a953ed6 100644 --- a/docs/ApplePayApi.md +++ b/docs/ApplePayApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description RegisterDomain -Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. +Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). ### Example ```csharp diff --git a/docs/BatchDeleteCatalogObjectsRequest.md b/docs/BatchDeleteCatalogObjectsRequest.md index 7f1c71b..3f73047 100644 --- a/docs/BatchDeleteCatalogObjectsRequest.md +++ b/docs/BatchDeleteCatalogObjectsRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ObjectIds** | **List** | The IDs of the `CatalogObject`s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a `CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation`. | [optional] +**ObjectIds** | **List** | The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a CatalogItem will delete its CatalogItemVariation. | [optional] diff --git a/docs/BatchDeleteCatalogObjectsResponse.md b/docs/BatchDeleteCatalogObjectsResponse.md index cdaa412..f041160 100644 --- a/docs/BatchDeleteCatalogObjectsResponse.md +++ b/docs/BatchDeleteCatalogObjectsResponse.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**DeletedObjectIds** | **List** | The IDs of all `CatalogObject`s deleted by this request. | [optional] -**DeletedAt** | **string** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**Errors** | [**List<Error>**](Error.md) | The set of Errors encountered. | [optional] +**DeletedObjectIds** | **List** | The IDs of all CatalogObjects deleted by this request. | [optional] +**DeletedAt** | **string** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] diff --git a/docs/BatchRetrieveCatalogObjectsRequest.md b/docs/BatchRetrieveCatalogObjectsRequest.md index 7a0c0d4..5459762 100644 --- a/docs/BatchRetrieveCatalogObjectsRequest.md +++ b/docs/BatchRetrieveCatalogObjectsRequest.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ObjectIds** | **List** | The IDs of the `CatalogObject`s to be retrieved. | -**IncludeRelatedObjects** | **bool?** | If `true`, the response will include additional objects that are related to the requested objects, as follows: If the `objects` field of the response contains a `CatalogItem`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. | [optional] +**ObjectIds** | **List** | The IDs of the CatalogObjects to be retrieved. | +**IncludeRelatedObjects** | **bool?** | If `true`, the response will include additional objects that are related to the requested objects, as follows: If the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. | [optional] diff --git a/docs/BatchRetrieveInventoryChangesRequest.md b/docs/BatchRetrieveInventoryChangesRequest.md index 6957eba..3b5ac20 100644 --- a/docs/BatchRetrieveInventoryChangesRequest.md +++ b/docs/BatchRetrieveInventoryChangesRequest.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **States** | **List** | Filters `ADJUSTMENT` query results by `InventoryState`. Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values | [optional] **UpdatedAfter** | **string** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] **UpdatedBefore** | **string** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] -**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryChangesResponse.md b/docs/BatchRetrieveInventoryChangesResponse.md index f19a0ea..77ebd41 100644 --- a/docs/BatchRetrieveInventoryChangesResponse.md +++ b/docs/BatchRetrieveInventoryChangesResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **Changes** | [**List<InventoryChange>**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional] -**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryCountsRequest.md b/docs/BatchRetrieveInventoryCountsRequest.md index 644d727..63bc112 100644 --- a/docs/BatchRetrieveInventoryCountsRequest.md +++ b/docs/BatchRetrieveInventoryCountsRequest.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **CatalogObjectIds** | **List** | Filters results by `CatalogObject` ID. Only applied when set. Default: unset. | [optional] **LocationIds** | **List** | Filters results by `Location` ID. Only applied when set. Default: unset. | [optional] **UpdatedAfter** | **string** | Provided as an RFC 3339 timestamp. Returns results whose `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] -**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryCountsResponse.md b/docs/BatchRetrieveInventoryCountsResponse.md index 0a6c19c..8b32ecc 100644 --- a/docs/BatchRetrieveInventoryCountsResponse.md +++ b/docs/BatchRetrieveInventoryCountsResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **Counts** | [**List<InventoryCount>**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional] -**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/BatchUpsertCatalogObjectsRequest.md b/docs/BatchUpsertCatalogObjectsRequest.md index eca5b4a..cfcf70d 100644 --- a/docs/BatchUpsertCatalogObjectsRequest.md +++ b/docs/BatchUpsertCatalogObjectsRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **IdempotencyKey** | **string** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | -**Batches** | [**List<CatalogObjectBatch>**](CatalogObjectBatch.md) | A batch of `CatalogObject`s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a `CatalogItem` with ID `#ABC` and a `CatalogItemVariation` with its `item_id` attribute set to `#ABC` in order to associate the `CatalogItemVariation` with its parent `CatalogItem`. Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. | [optional] +**Batches** | [**List<CatalogObjectBatch>**](CatalogObjectBatch.md) | A batch of CatalogObjects to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a CatalogItem with ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to `#ABC` in order to associate the CatalogItemVariation with its parent CatalogItem. Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. | [optional] diff --git a/docs/BatchUpsertCatalogObjectsResponse.md b/docs/BatchUpsertCatalogObjectsResponse.md index 428eed4..4c0bb36 100644 --- a/docs/BatchUpsertCatalogObjectsResponse.md +++ b/docs/BatchUpsertCatalogObjectsResponse.md @@ -8,10 +8,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**Objects** | [**List<CatalogObject>**](CatalogObject.md) | The created `CatalogObject`s | [optional] -**UpdatedAt** | **string** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] -**IdMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this Upsert. | [optional] +**Errors** | [**List<Error>**](Error.md) | Information on any errors that encountered. | [optional] +**Objects** | [**List<CatalogObject>**](CatalogObject.md) | The created successfully created CatalogObjects. | [optional] +**UpdatedAt** | **string** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**IdMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this upsert. | [optional] diff --git a/docs/BusinessHours.md b/docs/BusinessHours.md index 9d2d28a..c9a6b68 100644 --- a/docs/BusinessHours.md +++ b/docs/BusinessHours.md @@ -2,7 +2,7 @@ ### Description - Represents the hours of operation for a business location. +Represents the hours of operation for a business location. ## Properties diff --git a/docs/BusinessHoursPeriod.md b/docs/BusinessHoursPeriod.md index 0617f5a..becb6c5 100644 --- a/docs/BusinessHoursPeriod.md +++ b/docs/BusinessHoursPeriod.md @@ -2,7 +2,7 @@ ### Description - Represents a period of time during which a business location is open. +Represents a period of time during which a business location is open. ## Properties diff --git a/docs/CaptureTransactionRequest.md b/docs/CaptureTransactionRequest.md index 066d46e..8c8875e 100644 --- a/docs/CaptureTransactionRequest.md +++ b/docs/CaptureTransactionRequest.md @@ -2,7 +2,7 @@ ### Description -Defines the query parameters for calls to the CaptureTransaction endpoint. + **Note: This model is deprecated.** ## Properties diff --git a/docs/Card.md b/docs/Card.md index cb8c920..95f834f 100644 --- a/docs/Card.md +++ b/docs/Card.md @@ -9,13 +9,13 @@ Represents the payment details of a card to be used for payments. These details Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **string** | Unique ID for this card. Generated by Square. | [optional] -**CardBrand** | **string** | The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for possible values | [optional] +**CardBrand** | **string** | The card's brand (such as `VISA`). See `CardBrand` for all possible values. See [CardBrand](#type-cardbrand) for possible values | [optional] **Last4** | **string** | The last 4 digits of the card number. | [optional] **ExpMonth** | **long?** | The expiration month of the associated card as an integer between 1 and 12. | [optional] **ExpYear** | **long?** | The four-digit year of the card's expiration date. | [optional] **CardholderName** | **string** | The name of the cardholder. | [optional] **BillingAddress** | [**Address**](Address.md) | The billing address for this card. | [optional] -**Fingerprint** | **string** | A unique, Square-assigned ID that identifies the card across multiple locations and applications for a single Square account. | [optional] +**Fingerprint** | **string** | __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. | [optional] **Bin** | **string** | The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field. | [optional] diff --git a/docs/CashPaymentDetails.md b/docs/CashPaymentDetails.md new file mode 100644 index 0000000..6395230 --- /dev/null +++ b/docs/CashPaymentDetails.md @@ -0,0 +1,17 @@ +# Square.Connect.Model.CashPaymentDetails + +### Description + +Additional details about CASH type payments. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BuyerSuppliedMoney** | [**Money**](Money.md) | The amount and currency of the money supplied by the buyer. | +**ChangeBackMoney** | [**Money**](Money.md) | The amount of change due back to the buyer. Read Only field calculated from the amount_money and buyer_supplied_money fields. | [optional] + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CatalogApi.md b/docs/CatalogApi.md index b1fc23e..9b883b3 100644 --- a/docs/CatalogApi.md +++ b/docs/CatalogApi.md @@ -300,7 +300,7 @@ namespace Example Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new CatalogApi(); - var 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`. + var objectId = objectId_example; // string | The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). try { @@ -321,7 +321,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **objectId** | **string**| The ID of the `CatalogObject` to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a `CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation`. | + **objectId** | **string**| The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). | ### Return type @@ -366,7 +366,7 @@ namespace Example var apiInstance = new CatalogApi(); var 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. (optional) - var 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`. (optional) + var types = types_example; // string | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) try { @@ -388,7 +388,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **cursor** | **string**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] - **types** | **string**| An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] + **types** | **string**| An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] ### Return type @@ -432,8 +432,8 @@ namespace Example Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new CatalogApi(); - var objectId = objectId_example; // string | The object ID of any type of `CatalogObject`s to be retrieved. - var includeRelatedObjects = true; // bool? | 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) + var objectId = objectId_example; // string | The object ID of any type of catalog objects to be retrieved. + var includeRelatedObjects = true; // bool? | If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) try { @@ -454,8 +454,8 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **objectId** | **string**| The object ID of any type of `CatalogObject`s to be retrieved. | - **includeRelatedObjects** | **bool?**| If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a `CatalogItem`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` | [optional] + **objectId** | **string**| The object ID of any type of catalog objects to be retrieved. | + **includeRelatedObjects** | **bool?**| If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` | [optional] ### Return type @@ -478,7 +478,7 @@ Name | Type | Description | Notes SearchCatalogObjects -Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). +Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). - - - - Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). ### Example ```csharp diff --git a/docs/CatalogCategory.md b/docs/CatalogCategory.md index 651fe7a..ee40530 100644 --- a/docs/CatalogCategory.md +++ b/docs/CatalogCategory.md @@ -2,13 +2,13 @@ ### Description -A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model. +A category to which a `CatalogItem` belongs in the `Catalog` object model. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The category's name. Searchable. This field has max length of 255 Unicode code points. | [optional] +**Name** | **string** | The category name. Searchable. This field has max length of 255 Unicode code points. | [optional] diff --git a/docs/CatalogDiscount.md b/docs/CatalogDiscount.md index af73f32..b879be5 100644 --- a/docs/CatalogDiscount.md +++ b/docs/CatalogDiscount.md @@ -8,12 +8,13 @@ A discount in the Catalog object model. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The discount's name. Searchable. This field has max length of 255 Unicode code points. | [optional] +**Name** | **string** | The discount name. Searchable. This field has max length of 255 Unicode code points. | [optional] **DiscountType** | **string** | Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for possible values | [optional] **Percentage** | **string** | The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`. Do not include this field for amount-based or variable discounts. | [optional] **AmountMoney** | [**Money**](Money.md) | The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`. Do not include this field for percentage-based or variable discounts. | [optional] **PinRequired** | **bool?** | Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app. | [optional] -**LabelColor** | **string** | The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] +**LabelColor** | **string** | The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] +**ModifyTaxBasis** | **string** | Indicates whether this discount should reduce the price used to calculate tax. Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must be calculated based on an item's price, ignoring a particular discount. For example, in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a customer pays but does not reduce the sale price used to calculate how much sales tax is due. In this case, the discount representing that manufacturer coupon should have `DO_NOT_MODIFY_TAX_BASIS` for this field. If you are unsure whether you need to use this field, consult your tax professional. See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values | [optional] diff --git a/docs/WebhookEvents.md b/docs/CatalogDiscountModifyTaxBasis.md similarity index 72% rename from docs/WebhookEvents.md rename to docs/CatalogDiscountModifyTaxBasis.md index 9edb1d0..f648ef1 100644 --- a/docs/WebhookEvents.md +++ b/docs/CatalogDiscountModifyTaxBasis.md @@ -1,8 +1,8 @@ -# Square.Connect.Model.WebhookEvents +# Square.Connect.Model.CatalogDiscountModifyTaxBasis ### Description -The type of an event that triggers a webhook notification to an application. + ## Properties diff --git a/docs/CatalogDiscountType.md b/docs/CatalogDiscountType.md index 39b2480..04a6d20 100644 --- a/docs/CatalogDiscountType.md +++ b/docs/CatalogDiscountType.md @@ -2,7 +2,7 @@ ### Description -How to apply a `CatalogDiscount](#type-catalogdiscount) to a [CatalogItem`. +How to apply a CatalogDiscount to a CatalogItem. ## Properties diff --git a/docs/CatalogIdMapping.md b/docs/CatalogIdMapping.md index 81191a4..a2919cf 100644 --- a/docs/CatalogIdMapping.md +++ b/docs/CatalogIdMapping.md @@ -9,7 +9,7 @@ A mapping between a client-supplied temporary ID and a permanent server ID. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ClientObjectId** | **string** | The client-supplied, temporary `#`-prefixed ID for a new `CatalogObject`. | [optional] -**ObjectId** | **string** | The permanent ID for the `CatalogObject` created by the server. | [optional] +**ObjectId** | **string** | The permanent ID for the CatalogObject created by the server. | [optional] diff --git a/docs/CatalogInfoResponse.md b/docs/CatalogInfoResponse.md index cd146dc..dbc9de6 100644 --- a/docs/CatalogInfoResponse.md +++ b/docs/CatalogInfoResponse.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] +**Errors** | [**List<Error>**](Error.md) | The set of errors encountered. | [optional] **Limits** | [**CatalogInfoResponseLimits**](CatalogInfoResponseLimits.md) | | [optional] **StandardUnitDescriptionGroup** | [**StandardUnitDescriptionGroup**](StandardUnitDescriptionGroup.md) | Names and abbreviations for standard units. | [optional] diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md index cf76236..f5a5c2a 100644 --- a/docs/CatalogItem.md +++ b/docs/CatalogItem.md @@ -16,9 +16,9 @@ Name | Type | Description | Notes **AvailableForPickup** | **bool?** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional] **AvailableElectronically** | **bool?** | 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** | A set of IDs indicating the `CatalogTax`es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. `CatalogTax`es may also be added to or deleted from an item using `UpdateItemTaxes`. | [optional] -**ModifierListInfo** | [**List<CatalogItemModifierListInfo>**](CatalogItemModifierListInfo.md) | A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. `CatalogModifierList`s may also be added to or deleted from an item using `UpdateItemModifierLists`. | [optional] -**Variations** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations | [optional] +**TaxIds** | **List** | A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item. Taxes may also be added to or deleted from an item using `UpdateItemTaxes`. | [optional] +**ModifierListInfo** | [**List<CatalogItemModifierListInfo>**](CatalogItemModifierListInfo.md) | A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. Modifier lists may also be added to or deleted from an item using `UpdateItemModifierLists`. | [optional] +**Variations** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects containing the `CatalogItemVariation`s for this item. | [optional] **ProductType** | **string** | The product type of the item. May not be changed once an item has been created. Only items of product type `REGULAR` or `APPOINTMENTS_SERVICE` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values | [optional] **SkipModifierScreen** | **bool?** | If `false`, the Square Point of Sale app will present the `CatalogItem`'s details screen immediately, allowing the merchant to choose `CatalogModifier`s before adding the item to the cart. This is the default behavior. If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details. Third-party clients are encouraged to implement similar behaviors. | [optional] **ItemOptions** | [**List<CatalogItemOptionForItem>**](CatalogItemOptionForItem.md) | List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options. | [optional] [beta] diff --git a/docs/CatalogItemModifierListInfo.md b/docs/CatalogItemModifierListInfo.md index 7c0c4c0..7e09148 100644 --- a/docs/CatalogItemModifierListInfo.md +++ b/docs/CatalogItemModifierListInfo.md @@ -2,16 +2,16 @@ ### Description -Controls the properties of a [CatalogModifierList](#type-catalogmodifierlist) as it applies to this [CatalogItem](#type-catalogitem). +Controls the properties of a `CatalogModifierList` as it applies to this `CatalogItem`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ModifierListId** | **string** | The ID of the `CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo`. | -**ModifierOverrides** | [**List<CatalogModifierOverride>**](CatalogModifierOverride.md) | A set of `CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier` is enabled by default. | [optional] -**MinSelectedModifiers** | **int?** | If zero or larger, the smallest number of `CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList`. | [optional] -**MaxSelectedModifiers** | **int?** | If zero or larger, the largest number of `CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList`. | [optional] +**ModifierListId** | **string** | The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`. | +**ModifierOverrides** | [**List<CatalogModifierOverride>**](CatalogModifierOverride.md) | A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. | [optional] +**MinSelectedModifiers** | **int?** | If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. | [optional] +**MaxSelectedModifiers** | **int?** | If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. | [optional] **Enabled** | **bool?** | If `true`, enable this `CatalogModifierList`. | [optional] diff --git a/docs/CatalogItemOption.md b/docs/CatalogItemOption.md index 6a4a9b5..051a8f0 100644 --- a/docs/CatalogItemOption.md +++ b/docs/CatalogItemOption.md @@ -2,7 +2,7 @@ ### Description -A group of variations for a [CatalogItem](#type-catalogitem)'s. +A group of variations for a `CatalogItem`. **Note: This model is in beta.** ## Properties @@ -11,9 +11,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | The item option's display name for the seller. Must be unique across all item options. Searchable. | [optional] **DisplayName** | **string** | The item option's display name for the customer. Searchable. | [optional] -**Description** | **string** | The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. | [optional] +**Description** | **string** | The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. | [optional] **ShowColors** | **bool?** | If true, display colors for entries in `values` when present. | [optional] -**Values** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s containing the `CatalogItemOptionValue`s for this item. | [optional] +**Values** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item. | [optional] **ItemCount** | **long?** | The number of `CatalogItem`s currently associated with this item option. Present only if the `include_counts` was specified in the request. Any count over 100 will be returned as `100`. | [optional] diff --git a/docs/CatalogItemOptionValue.md b/docs/CatalogItemOptionValue.md index bb280c1..d0742ac 100644 --- a/docs/CatalogItemOptionValue.md +++ b/docs/CatalogItemOptionValue.md @@ -2,7 +2,7 @@ ### Description -An enumerated value that can link a [CatalogItemVariation(#type-catalogitemvariation) to an item option as one of its item option values. +An enumerated value that can link a `CatalogItemVariation` to an item option as one of its item option values. **Note: This model is in beta.** ## Properties @@ -11,10 +11,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ItemOptionId** | **string** | Unique ID of the associated item option. | [optional] **Name** | **string** | Name of this item option value. Searchable. | [optional] -**Description** | **string** | The option value's human-readable description. | [optional] +**Description** | **string** | A human-readable description for the option value. | [optional] **Color** | **string** | The HTML-supported hex color for the item option (e.g., \"#ff8d4e85\"). Only displayed if `show_colors` is enabled on the parent `ItemOption`. When left unset, `color` defaults to white (\"#ffffff\") when `show_colors` is enabled on the parent `ItemOption`. | [optional] **Ordinal** | **int?** | Determines where this option value appears in a list of option values. | [optional] -**ItemVariationCount** | **long?** | The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. | [optional] +**ItemVariationCount** | **long?** | The number of `CatalogItemVariation`s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. | [optional] diff --git a/docs/CatalogItemOptionValueForItemVariation.md b/docs/CatalogItemOptionValueForItemVariation.md index f82ff02..444b3c5 100644 --- a/docs/CatalogItemOptionValueForItemVariation.md +++ b/docs/CatalogItemOptionValueForItemVariation.md @@ -2,7 +2,7 @@ ### Description -A [CatalogItemOptionValue](#type-catalogitemoptionvalue) links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, “Color:Red, Size:Small” or “Color:Blue, Size:Medium”. +A `CatalogItemOptionValue` links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, \"Color:Red, Size:Small\" or \"Color:Blue, Size:Medium\". **Note: This model is in beta.** ## Properties diff --git a/docs/CatalogItemProductType.md b/docs/CatalogItemProductType.md index 9851596..66827a0 100644 --- a/docs/CatalogItemProductType.md +++ b/docs/CatalogItemProductType.md @@ -2,7 +2,7 @@ ### Description - The type of a `CatalogItem`. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items. +The type of a CatalogItem. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items. ## Properties diff --git a/docs/CatalogItemVariation.md b/docs/CatalogItemVariation.md index f7d9dd5..33c39f8 100644 --- a/docs/CatalogItemVariation.md +++ b/docs/CatalogItemVariation.md @@ -15,11 +15,11 @@ Name | Type | Description | Notes **Ordinal** | **int?** | The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent `CatalogItem` is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique. | [optional] **PricingType** | **string** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for possible values | [optional] **PriceMoney** | [**Money**](Money.md) | The item variation's price, if fixed pricing is used. | [optional] -**LocationOverrides** | [**List<ItemVariationLocationOverrides>**](ItemVariationLocationOverrides.md) | Per-`location` price and inventory overrides. | [optional] +**LocationOverrides** | [**List<ItemVariationLocationOverrides>**](ItemVariationLocationOverrides.md) | Per-location price and inventory overrides. | [optional] **TrackInventory** | **bool?** | If `true`, inventory tracking is active for the variation. | [optional] **InventoryAlertType** | **string** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values | [optional] **InventoryAlertThreshold** | **long?** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer. | [optional] -**UserData** | **string** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional] +**UserData** | **string** | Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. | [optional] **ServiceDuration** | **long?** | If the `CatalogItem` that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional] **ItemOptionValues** | [**List<CatalogItemOptionValueForItemVariation>**](CatalogItemOptionValueForItemVariation.md) | List of item option values associated with this item variation. Listed in the same order as the item options of the parent item. | [optional] [beta] **MeasurementUnitId** | **string** | ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities. | [optional] [beta] diff --git a/docs/CatalogMeasurementUnit.md b/docs/CatalogMeasurementUnit.md index 7b69697..3f43713 100644 --- a/docs/CatalogMeasurementUnit.md +++ b/docs/CatalogMeasurementUnit.md @@ -2,7 +2,7 @@ ### Description -Represents the unit used to measure a [CatalogItemVariation](#type-catalogitemvariation) and specifies the precision for decimal quantities. +Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities. **Note: This model is in beta.** ## Properties @@ -10,7 +10,7 @@ Represents the unit used to measure a [CatalogItemVariation](#type-catalogitemva Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **MeasurementUnit** | [**MeasurementUnit**](MeasurementUnit.md) | Indicates the unit used to measure the quantity of a catalog item variation. | [optional] -**Precision** | **int?** | Represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example, if the precision is 2, then an itemization’s quantity can be 0.01, 0.12, etc. Min: 0 Max: 5 Default: 3 | [optional] +**Precision** | **int?** | An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3 | [optional] diff --git a/docs/CatalogModifier.md b/docs/CatalogModifier.md index b5725d5..bf3fdcf 100644 --- a/docs/CatalogModifier.md +++ b/docs/CatalogModifier.md @@ -8,8 +8,8 @@ A modifier in the Catalog object model. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The modifier's name. Searchable. This field has max length of 255 Unicode code points. | [optional] -**PriceMoney** | [**Money**](Money.md) | The modifier's price. | [optional] +**Name** | **string** | The modifier name. Searchable. This field has max length of 255 Unicode code points. | [optional] +**PriceMoney** | [**Money**](Money.md) | The modifier price. | [optional] diff --git a/docs/CatalogModifierList.md b/docs/CatalogModifierList.md index 30a9308..051f83d 100644 --- a/docs/CatalogModifierList.md +++ b/docs/CatalogModifierList.md @@ -2,15 +2,15 @@ ### Description -A modifier list in the Catalog object model. A [CatalogModifierList](#type-catalogmodifierlist) contains [Modifier](#type-catalogmodifier)s that can be applied to a [CatalogItem](#type-catalogitem) at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" [CatalogItem](#type-catalogitem) might contain [CatalogModifier](#type-catalogmodifier)s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed. +A modifier list in the Catalog object model. A `CatalogModifierList` contains `CatalogModifier` objects that can be applied to a `CatalogItem` at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" `CatalogItem` might contain `CatalogModifier`s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The `CatalogModifierList`'s name. Searchable. This field has max length of 255 Unicode code points. | [optional] +**Name** | **string** | A searchable name for the `CatalogModifierList`. This field has max length of 255 Unicode code points. | [optional] **SelectionType** | **string** | Indicates whether multiple options from the `CatalogModifierList` can be applied to a single `CatalogItem`. See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values | [optional] -**Modifiers** | [**List<CatalogObject>**](CatalogObject.md) | The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each `CatalogObject` must have type `MODIFIER` and contain `CatalogModifier` data. | [optional] +**Modifiers** | [**List<CatalogObject>**](CatalogObject.md) | The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each CatalogObject must have type `MODIFIER` and contain `CatalogModifier` data. | [optional] diff --git a/docs/CatalogModifierListSelectionType.md b/docs/CatalogModifierListSelectionType.md index 68b78d3..9562a63 100644 --- a/docs/CatalogModifierListSelectionType.md +++ b/docs/CatalogModifierListSelectionType.md @@ -2,7 +2,7 @@ ### Description -Indicates whether a `CatalogModifierList` supports multiple selections. +Indicates whether a CatalogModifierList supports multiple selections. ## Properties diff --git a/docs/CatalogModifierOverride.md b/docs/CatalogModifierOverride.md index c611615..b493816 100644 --- a/docs/CatalogModifierOverride.md +++ b/docs/CatalogModifierOverride.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ModifierId** | **string** | The ID of the `CatalogModifier` whose default behavior is being overridden. | -**OnByDefault** | **bool?** | If `true`, this `CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem`. | [optional] +**OnByDefault** | **bool?** | If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`. | [optional] diff --git a/docs/CatalogObject.md b/docs/CatalogObject.md index 1ef30d3..67aa04a 100644 --- a/docs/CatalogObject.md +++ b/docs/CatalogObject.md @@ -2,18 +2,18 @@ ### Description -The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid [CatalogItem](#type-catalogitem) object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid [CatalogItemVariation](#type-catalogitemvariation) object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid [CatalogModifier](#type-catalogmodifier) object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid [CatalogModifierList](#type-catalogmodifierlist) object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid [CatalogCategory](#type-catalogcategory) object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid [CatalogDiscount](#type-catalogdiscount) object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid [CatalogTax](#type-catalogtax) object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid [CatalogImage](#type-catalogimage) object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. +The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid `CatalogItem` object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid `CatalogItemVariation` object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid `CatalogModifier` object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid `CatalogModifierList` object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid `CatalogCategory` object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid `CatalogDiscount` object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid `CatalogTax` object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid `CatalogImage` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **string** | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See [CatalogObjectType](#type-catalogobjecttype) for possible values | -**Id** | **string** | An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. | -**UpdatedAt** | **string** | Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional] +**Id** | **string** | An identifier to reference this object in the catalog. When a new `CatalogObject` is inserted, the client should set the id to a temporary identifier starting with a \"`#`\" character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. | +**UpdatedAt** | **string** | Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional] **Version** | **long?** | The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting. | [optional] **IsDeleted** | **bool?** | If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional] -**CatalogV1Ids** | [**List<CatalogV1Id>**](CatalogV1Id.md) | The Connect V1 IDs for this object at each `location` where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional] +**CatalogV1Ids** | [**List<CatalogV1Id>**](CatalogV1Id.md) | The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional] **PresentAtAllLocations** | **bool?** | 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** | A list of locations where the object is present, even if `present_at_all_locations` is `false`. | [optional] **AbsentAtLocationIds** | **List** | A list of locations where the object is not present, even if `present_at_all_locations` is `true`. | [optional] diff --git a/docs/CatalogObjectBatch.md b/docs/CatalogObjectBatch.md index 2b77a8f..11d7719 100644 --- a/docs/CatalogObjectBatch.md +++ b/docs/CatalogObjectBatch.md @@ -2,13 +2,13 @@ ### Description -A batch of [CatalogObject](#type-catalogobject)s. +A batch of catalog objects. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s belonging to this batch. | [optional] +**Objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects belonging to this batch. | [optional] diff --git a/docs/CatalogObjectType.md b/docs/CatalogObjectType.md index 596ab1b..ae43b25 100644 --- a/docs/CatalogObjectType.md +++ b/docs/CatalogObjectType.md @@ -2,7 +2,7 @@ ### Description -Possible kinds of `CatalogObject`s returned from the Catalog, each containing type-specific properties in the `*_data` field corresponding to the object type. +Possible types of CatalogObjects returned from the Catalog, each containing type-specific properties in the `*_data` field corresponding to the object type. ## Properties diff --git a/docs/CatalogPricingRule.md b/docs/CatalogPricingRule.md index aca439d..6bf3789 100644 --- a/docs/CatalogPricingRule.md +++ b/docs/CatalogPricingRule.md @@ -10,16 +10,16 @@ Defines how prices are modified or set for items that match the pricing rule dur Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | User-defined name for the pricing rule. For example, \"Buy one get one free\" or \"10% off\". | [optional] -**TimePeriodIds** | **List** | Unique ID for the `CatalogTimePeriod`s when this pricing rule is in effect. If left unset, the pricing rule is always in effect. | [optional] +**TimePeriodIds** | **List** | A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect. | [optional] **DiscountId** | **string** | Unique ID for the `CatalogDiscount` to take off the price of all matched items. | [optional] -**MatchProductsId** | **string** | Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. | [optional] -**ApplyProductsId** | **string** | `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. This field has been deprecated: new pricing rules should prefer the exclude_products_id field. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. | [optional] [deprecated] -**ExcludeProductsId** | **string** | Identifies the `CatalogProductSet` to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. | [optional] +**MatchProductsId** | **string** | Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. A match rule can match multiple times in the cart. If no `ProductSet` is present, the rule will match all products. | [optional] +**ApplyProductsId** | **string** | __Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. | [optional] [deprecated] +**ExcludeProductsId** | **string** | `CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. | [optional] **ValidFromDate** | **string** | Represents the date the Pricing Rule is valid from. Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional] -**ValidFromLocalTime** | **string** | Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] -**ValidUntilDate** | **string** | Represents the date the pricing rule will become inactive. Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional] -**ValidUntilLocalTime** | **string** | Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] -**ExcludeStrategy** | **string** | If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. See `ExcludeStrategy` for all possible values. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values | [optional] +**ValidFromLocalTime** | **string** | Represents the local time the pricing rule should be valid from. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] +**ValidUntilDate** | **string** | Represents the date the Pricing Rule is valid until. Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional] +**ValidUntilLocalTime** | **string** | Represents the local time the pricing rule should be valid until. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional] +**ExcludeStrategy** | **string** | If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values | [optional] diff --git a/docs/CatalogPricingType.md b/docs/CatalogPricingType.md index 1c6dd1b..e7484b1 100644 --- a/docs/CatalogPricingType.md +++ b/docs/CatalogPricingType.md @@ -2,7 +2,7 @@ ### Description -Indicates whether the price of a `CatalogItemVariation` should be entered manually at the time of sale. +Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale. ## Properties diff --git a/docs/CatalogProductSet.md b/docs/CatalogProductSet.md index 4bbe395..23773f9 100644 --- a/docs/CatalogProductSet.md +++ b/docs/CatalogProductSet.md @@ -2,16 +2,16 @@ ### Description -Represents a collection of catalog objects for the purpose of applying a [PricingRule](#type-pricingrule). Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations. +Represents a collection of catalog objects for the purpose of applying a `PricingRule`. Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations. **Note: This model is in beta.** ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". | [optional] -**ProductIdsAny** | **List** | 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** | Unique IDs for `CatalogObjects` to include in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. | [optional] +**Name** | **string** | User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". | [optional] +**ProductIdsAny** | **List** | Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. | [optional] +**ProductIdsAll** | **List** | Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. | [optional] **QuantityExact** | **long?** | If set, there must be exactly this many items from `products_any` or `products_all` in the cart for the discount to apply. Cannot be combined with either `quantity_min` or `quantity_max`. | [optional] **QuantityMin** | **long?** | If set, there must be at least this many items from `products_any` or `products_all` in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified. | [optional] **QuantityMax** | **long?** | If set, the pricing rule will apply to a maximum of this many items from `products_any` or `products_all`. | [optional] diff --git a/docs/CatalogQuery.md b/docs/CatalogQuery.md index 77c7a0a..a08be28 100644 --- a/docs/CatalogQuery.md +++ b/docs/CatalogQuery.md @@ -2,7 +2,7 @@ ### Description -A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest). Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. +A query to be applied to a `SearchCatalogObjectsRequest`. Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) (`CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifierList`, `CatalogModifier`). For example, a query that should return Items may specify attribute names from any of the searchable fields of the `CatalogItem` data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. ## Properties @@ -13,10 +13,10 @@ Name | Type | Description | Notes **PrefixQuery** | [**CatalogQueryPrefix**](CatalogQueryPrefix.md) | A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix. | [optional] **RangeQuery** | [**CatalogQueryRange**](CatalogQueryRange.md) | A query that returns only objects for which the given (integer-valued) attribute lies in the given range. | [optional] **TextQuery** | [**CatalogQueryText**](CatalogQueryText.md) | A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a `CatalogItem` contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`. | [optional] -**ItemsForTaxQuery** | [**CatalogQueryItemsForTax**](CatalogQueryItemsForTax.md) | A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax`es enabled. | [optional] -**ItemsForModifierListQuery** | [**CatalogQueryItemsForModifierList**](CatalogQueryItemsForModifierList.md) | A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList`s enabled. | [optional] -**ItemsForItemOptionsQuery** | [**CatalogQueryItemsForItemOptions**](CatalogQueryItemsForItemOptions.md) | A query that returns all `CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption`s. | [optional] -**ItemVariationsForItemOptionValuesQuery** | [**CatalogQueryItemVariationsForItemOptionValues**](CatalogQueryItemVariationsForItemOptionValues.md) | A query that returns all `CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption` values. | [optional] +**ItemsForTaxQuery** | [**CatalogQueryItemsForTax**](CatalogQueryItemsForTax.md) | A query that returns all `CatalogItem`s that have any of the given `CatalogTax`es enabled. | [optional] +**ItemsForModifierListQuery** | [**CatalogQueryItemsForModifierList**](CatalogQueryItemsForModifierList.md) | A query that returns all `CatalogItem`s that have any of the given `CatalogModifierList`s enabled. | [optional] +**ItemsForItemOptionsQuery** | [**CatalogQueryItemsForItemOptions**](CatalogQueryItemsForItemOptions.md) | A query that returns all `CatalogItem`s that have all of the given `CatalogItemOption`s. | [optional] +**ItemVariationsForItemOptionValuesQuery** | [**CatalogQueryItemVariationsForItemOptionValues**](CatalogQueryItemVariationsForItemOptionValues.md) | A query that returns all `CatalogItemVariation`s that have all of the given `CatalogItemOption` values. | [optional] diff --git a/docs/CatalogQueryCustomAttributeUsage.md b/docs/CatalogQueryCustomAttributeUsage.md new file mode 100644 index 0000000..f45ea70 --- /dev/null +++ b/docs/CatalogQueryCustomAttributeUsage.md @@ -0,0 +1,17 @@ +# Square.Connect.Model.CatalogQueryCustomAttributeUsage + +### Description + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomAttributeDefinitionIds** | **List** | | [optional] +**HasValue** | **bool?** | | [optional] + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CatalogQueryFilteredItems.md b/docs/CatalogQueryFilteredItems.md new file mode 100644 index 0000000..1441c75 --- /dev/null +++ b/docs/CatalogQueryFilteredItems.md @@ -0,0 +1,25 @@ +# Square.Connect.Model.CatalogQueryFilteredItems + +### Description + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TextFilter** | **string** | | [optional] +**SearchVendorCode** | **bool?** | | [optional] +**CategoryIds** | **List** | | [optional] +**StockLevels** | **List** | See [CatalogQueryFilteredItemsStockLevel](#type-catalogqueryfiltereditemsstocklevel) for possible values | [optional] +**EnabledLocationIds** | **List** | | [optional] +**VendorIds** | **List** | | [optional] +**ProductTypes** | **List** | See [CatalogItemProductType](#type-catalogitemproducttype) for possible values | [optional] +**CustomAttributeFilters** | [**List<CatalogQueryFilteredItemsCustomAttributeFilter>**](CatalogQueryFilteredItemsCustomAttributeFilter.md) | | [optional] +**DoesNotExist** | **List** | See [CatalogQueryFilteredItemsNullableAttribute](#type-catalogqueryfiltereditemsnullableattribute) for possible values | [optional] +**SortOrder** | **string** | See [SortOrder](#type-sortorder) for possible values | [optional] + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CatalogQueryFilteredItemsCustomAttributeFilter.md b/docs/CatalogQueryFilteredItemsCustomAttributeFilter.md new file mode 100644 index 0000000..7c9f5ed --- /dev/null +++ b/docs/CatalogQueryFilteredItemsCustomAttributeFilter.md @@ -0,0 +1,21 @@ +# Square.Connect.Model.CatalogQueryFilteredItemsCustomAttributeFilter + +### Description + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FilterType** | **string** | See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values | [optional] +**CustomAttributeDefinitionIds** | **List** | | [optional] +**CustomAttributeValueExact** | **string** | | [optional] +**CustomAttributeValuePrefix** | **string** | | [optional] +**CustomAttributeMinValue** | **string** | | [optional] +**CustomAttributeMaxValue** | **string** | | [optional] + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md b/docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md new file mode 100644 index 0000000..f307243 --- /dev/null +++ b/docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md @@ -0,0 +1,15 @@ +# Square.Connect.Model.CatalogQueryFilteredItemsCustomAttributeFilterFilterType + +### Description + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CatalogQueryFilteredItemsNullableAttribute.md b/docs/CatalogQueryFilteredItemsNullableAttribute.md new file mode 100644 index 0000000..a996679 --- /dev/null +++ b/docs/CatalogQueryFilteredItemsNullableAttribute.md @@ -0,0 +1,15 @@ +# Square.Connect.Model.CatalogQueryFilteredItemsNullableAttribute + +### Description + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CatalogQueryFilteredItemsStockLevel.md b/docs/CatalogQueryFilteredItemsStockLevel.md new file mode 100644 index 0000000..b8de3fc --- /dev/null +++ b/docs/CatalogQueryFilteredItemsStockLevel.md @@ -0,0 +1,15 @@ +# Square.Connect.Model.CatalogQueryFilteredItemsStockLevel + +### Description + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CatalogQueryItemsForItemOptions.md b/docs/CatalogQueryItemsForItemOptions.md index 9e5591c..ee52626 100644 --- a/docs/CatalogQueryItemsForItemOptions.md +++ b/docs/CatalogQueryItemsForItemOptions.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ItemOptionIds** | **List** | A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` will be returned. | [optional] +**ItemOptionIds** | **List** | A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem`s. All Items that contain all of the given Item Options (in any order) will be returned. | [optional] diff --git a/docs/CatalogQueryItemsForModifierList.md b/docs/CatalogQueryItemsForModifierList.md index fa0308a..013db92 100644 --- a/docs/CatalogQueryItemsForModifierList.md +++ b/docs/CatalogQueryItemsForModifierList.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ModifierListIds** | **List** | A set of `CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem`s. | +**ModifierListIds** | **List** | A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. | diff --git a/docs/CatalogQueryItemsForTax.md b/docs/CatalogQueryItemsForTax.md index 31684b2..20a62d1 100644 --- a/docs/CatalogQueryItemsForTax.md +++ b/docs/CatalogQueryItemsForTax.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaxIds** | **List** | A set of `CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem`s. | +**TaxIds** | **List** | A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. | diff --git a/docs/CatalogQuerySortedAttribute.md b/docs/CatalogQuerySortedAttribute.md index 509a9e4..ea412e1 100644 --- a/docs/CatalogQuerySortedAttribute.md +++ b/docs/CatalogQuerySortedAttribute.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **AttributeName** | **string** | The attribute whose value should be used as the sort key. | **InitialAttributeValue** | **string** | The first attribute value to be returned by the query. Ascending sorts will return only objects with this value or greater, while descending sorts will return only objects with this value or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts). | [optional] -**SortOrder** | **string** | The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values | [optional] +**SortOrder** | **string** | The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values | [optional] diff --git a/docs/CatalogQueryText.md b/docs/CatalogQueryText.md index 77291c4..d1e7f42 100644 --- a/docs/CatalogQueryText.md +++ b/docs/CatalogQueryText.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Keywords** | **List** | A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored. | +**Keywords** | **List** | A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 characters are ignored. | diff --git a/docs/CatalogV1Id.md b/docs/CatalogV1Id.md index 129be07..7244f9b 100644 --- a/docs/CatalogV1Id.md +++ b/docs/CatalogV1Id.md @@ -2,14 +2,14 @@ ### Description -An Items Connect V1 object ID along with its associated [location](#type-location) ID. +An Items Connect V1 object ID along with its associated location ID. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_CatalogV1Id** | **string** | The ID for an object in Connect V1, if different from its Connect V2 ID. | [optional] -**LocationId** | **string** | The ID of the `location` this Connect V1 ID is associated with. | [optional] +**LocationId** | **string** | The ID of the `Location` this Connect V1 ID is associated with. | [optional] diff --git a/docs/ChargeRequest.md b/docs/ChargeRequest.md index ad8e2db..295deb9 100644 --- a/docs/ChargeRequest.md +++ b/docs/ChargeRequest.md @@ -9,7 +9,7 @@ Defines the parameters that can be included in the body of a request to the [Cha Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdempotencyKey** | **string** | A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**IdempotencyKey** | **string** | A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. | **AmountMoney** | [**Money**](Money.md) | The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The value of `currency` must match the currency associated with the business that is charging the card. | **CardNonce** | **string** | A nonce generated from the `SqPaymentForm` that represents the card to charge. The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the `SqPaymentForm`. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for `customer_card_id`. | [optional] **CustomerCardId** | **string** | The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`. If you provide this value, you _must_ also provide a value for `customer_id`. | [optional] @@ -17,12 +17,12 @@ Name | Type | Description | Notes **ReferenceId** | **string** | An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters. | [optional] **Note** | **string** | An optional note to associate with the transaction. This value cannot exceed 60 characters. | [optional] **CustomerId** | **string** | The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise. | [optional] -**BillingAddress** | [**Address**](Address.md) | The buyer's billing address. | [optional] -**ShippingAddress** | [**Address**](Address.md) | The buyer's shipping address, if available. | [optional] -**BuyerEmailAddress** | **string** | The buyer's email address, if available. | [optional] +**BillingAddress** | [**Address**](Address.md) | The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided. | [optional] +**ShippingAddress** | [**Address**](Address.md) | The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. | [optional] +**BuyerEmailAddress** | **string** | The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. | [optional] **OrderId** | **string** | The ID of the order to associate with this transaction. If you provide this value, the `amount_money` value of your request must __exactly match__ the value of the order's `total_money` field. | [optional] **AdditionalRecipients** | [**List<AdditionalRecipient>**](AdditionalRecipient.md) | The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in the charge request. The `location_id` must be the valid location of the app owner merchant. This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox. | [optional] -**VerificationToken** | **string** | An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. | [optional] +**VerificationToken** | **string** | A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result. | [optional] diff --git a/docs/Coordinates.md b/docs/Coordinates.md index 2d7c3a1..80ca8fc 100644 --- a/docs/Coordinates.md +++ b/docs/Coordinates.md @@ -8,8 +8,8 @@ Latitude and longitude coordinates. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Latitude** | **decimal?** | The coordinate's latitude expressed in degrees. | [optional] -**Longitude** | **decimal?** | The coordinate's longitude expressed in degrees. | [optional] +**Latitude** | **decimal?** | The latitude of the coordinate expressed in degrees. | [optional] +**Longitude** | **decimal?** | The longitude of the coordinate expressed in degrees. | [optional] diff --git a/docs/CreateCatalogImageRequest.md b/docs/CreateCatalogImageRequest.md new file mode 100644 index 0000000..0aaf3d1 --- /dev/null +++ b/docs/CreateCatalogImageRequest.md @@ -0,0 +1,18 @@ +# Square.Connect.Model.CreateCatalogImageRequest + +### Description + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdempotencyKey** | **string** | A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**ObjectId** | **string** | Unique ID of the `CatalogObject` to attach to this `CatalogImage`. Leave this field empty to create unattached images, for example if you are building an integration where these images can be attached to catalog items at a later time. | [optional] +**Image** | [**CatalogObject**](CatalogObject.md) | The new `IMAGE`-type `CatalogObject` to be attached to this `CatalogImage`. If the `CatalogObject` already has a `CatalogImage`, this call will overwrite it. | [optional] + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateCatalogImageResponse.md b/docs/CreateCatalogImageResponse.md new file mode 100644 index 0000000..ef786ab --- /dev/null +++ b/docs/CreateCatalogImageResponse.md @@ -0,0 +1,17 @@ +# Square.Connect.Model.CreateCatalogImageResponse + +### Description + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**Image** | [**CatalogObject**](CatalogObject.md) | The newly created `CatalogImage` including a Square-generated URL for each image. | [optional] + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateCheckoutRequest.md b/docs/CreateCheckoutRequest.md index 06e07b7..d1f3772 100644 --- a/docs/CreateCheckoutRequest.md +++ b/docs/CreateCheckoutRequest.md @@ -2,13 +2,13 @@ ### Description -Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint. +Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdempotencyKey** | **string** | A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**IdempotencyKey** | **string** | A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency keys](#idempotencykeys) for more information. | **Order** | [**CreateOrderRequest**](CreateOrderRequest.md) | The order including line items to be checked out. | **AskForShippingAddress** | **bool?** | If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`. | [optional] **MerchantSupportEmail** | **string** | The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set. | [optional] diff --git a/docs/CreateCheckoutResponse.md b/docs/CreateCheckoutResponse.md index 596ebbb..15ed1b3 100644 --- a/docs/CreateCheckoutResponse.md +++ b/docs/CreateCheckoutResponse.md @@ -2,7 +2,7 @@ ### Description -Defines the fields that are included in the response body of a request to the CreateCheckout endpoint. +Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. ## Properties diff --git a/docs/CreateCustomerCardRequest.md b/docs/CreateCustomerCardRequest.md index 0d3705e..964a968 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 Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CardNonce** | **string** | A card nonce representing the credit card to link to the customer. Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __Note:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. | +**CardNonce** | **string** | A card nonce representing the credit card to link to the customer. Card nonces are generated by the Square Payment Form when customers enter their card information. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __NOTE:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. | **BillingAddress** | [**Address**](Address.md) | Address information for the card on file. Only the `postal_code` field is required for payments in the US and Canada. | [optional] **CardholderName** | **string** | The full name printed on the credit card. | [optional] **VerificationToken** | **string** | An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. | [optional] diff --git a/docs/CreateCustomerRequest.md b/docs/CreateCustomerRequest.md index 8dd5d39..7a3830d 100644 --- a/docs/CreateCustomerRequest.md +++ b/docs/CreateCustomerRequest.md @@ -8,17 +8,17 @@ Defines the body parameters that can be provided in a request to the CreateCusto Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdempotencyKey** | **string** | The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information. | [optional] -**GivenName** | **string** | The customer's given (i.e., first) name. | [optional] -**FamilyName** | **string** | The customer's family (i.e., last) name. | [optional] -**CompanyName** | **string** | The name of the customer's company. | [optional] -**Nickname** | **string** | A nickname for the customer. | [optional] -**EmailAddress** | **string** | The customer's email address. | [optional] -**Address** | [**Address**](Address.md) | The customer's physical address. | [optional] -**PhoneNumber** | **string** | The customer's phone number. | [optional] -**ReferenceId** | **string** | An optional second ID you can set to associate the customer with an entity in another system. | [optional] -**Note** | **string** | An optional note to associate with the customer. | [optional] -**Birthday** | **string** | The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. | [optional] +**IdempotencyKey** | **string** | The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) guide for more information. | [optional] +**GivenName** | **string** | The given (i.e., first) name associated with the customer profile. | [optional] +**FamilyName** | **string** | The family (i.e., last) name associated with the customer profile. | [optional] +**CompanyName** | **string** | A business name associated with the customer profile. | [optional] +**Nickname** | **string** | A nickname for the customer profile. | [optional] +**EmailAddress** | **string** | The email address associated with the customer profile. | [optional] +**Address** | [**Address**](Address.md) | The physical address associated with the customer profile. | [optional] +**PhoneNumber** | **string** | The 11-digit phone number associated with the customer profile. | [optional] +**ReferenceId** | **string** | An optional, second ID used to associate the customer profile with an entity in another system. | [optional] +**Note** | **string** | A custom note associated with the customer profile. | [optional] +**Birthday** | **string** | The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. | [optional] diff --git a/docs/CreateLocationRequest.md b/docs/CreateLocationRequest.md new file mode 100644 index 0000000..6041df9 --- /dev/null +++ b/docs/CreateLocationRequest.md @@ -0,0 +1,17 @@ +# Square.Connect.Model.CreateLocationRequest + +### Description + +Request object for the [CreateLocation](#endpoint-createlocation) endpoint. +**Note: This model is in beta.** + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Location** | [**Location**](Location.md) | The initial values of the location being created. The `name` field is required. All other fields are optional. Unspecified fields will be set to default values using existing location data. | [optional] + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateLocationResponse.md b/docs/CreateLocationResponse.md new file mode 100644 index 0000000..ce93df5 --- /dev/null +++ b/docs/CreateLocationResponse.md @@ -0,0 +1,18 @@ +# Square.Connect.Model.CreateLocationResponse + +### Description + +Response object returned by the [CreateLocation](#endpoint-createlocation) endpoint. +**Note: This model is in beta.** + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] +**Location** | [**Location**](Location.md) | The newly created `Location`. | [optional] + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateMobileAuthorizationCodeRequest.md b/docs/CreateMobileAuthorizationCodeRequest.md index 72b5367..14b2704 100644 --- a/docs/CreateMobileAuthorizationCodeRequest.md +++ b/docs/CreateMobileAuthorizationCodeRequest.md @@ -2,7 +2,7 @@ ### Description -Defines the body parameters that can be provided in a request to the CreateMobileAuthorizationCode endpoint. +Defines the body parameters that can be provided in a request to the __CreateMobileAuthorizationCode__ endpoint. ## Properties diff --git a/docs/CreateMobileAuthorizationCodeResponse.md b/docs/CreateMobileAuthorizationCodeResponse.md index 1b0be21..facdc00 100644 --- a/docs/CreateMobileAuthorizationCodeResponse.md +++ b/docs/CreateMobileAuthorizationCodeResponse.md @@ -2,7 +2,7 @@ ### Description -Defines the fields that are included in the response body of a request to the CreateMobileAuthorizationCode endpoint. +Defines the fields that are included in the response body of a request to the __CreateMobileAuthorizationCode__ endpoint. ## Properties diff --git a/docs/CreatePaymentRequest.md b/docs/CreatePaymentRequest.md index 98abccb..e1deff3 100644 --- a/docs/CreatePaymentRequest.md +++ b/docs/CreatePaymentRequest.md @@ -2,28 +2,29 @@ ### Description -Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees). +Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees). ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **SourceId** | **string** | The ID for the source of funds for this payment. This can be a nonce generated by the Payment Form or a card on file made with the Customers API. | -**IdempotencyKey** | **string** | A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**IdempotencyKey** | **string** | A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | **AmountMoney** | [**Money**](Money.md) | The amount of money to accept for this payment, not including `tip_money`. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. | **TipMoney** | [**Money**](Money.md) | The amount designated as a tip, in addition to `amount_money` Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. | [optional] -**AppFeeMoney** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). | [optional] +**AppFeeMoney** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). | [optional] **Autocomplete** | **bool?** | If set to `true`, this payment will be completed when possible. If set to `false`, this payment will be held in an approved state until either explicitly completed (captured) or canceled (voided). For more information, see [Delayed Payments](https://developer.squareup.com/docs/payments-api/take-payments#delayed-payments). Default: true | [optional] **OrderId** | **string** | Associate a previously created order with this payment | [optional] **CustomerId** | **string** | The ID of the customer associated with the payment. Required if the `source_id` refers to a card on file created using the Customers API. | [optional] **LocationId** | **string** | The location ID to associate with the payment. If not specified, the default location is used. | [optional] **ReferenceId** | **string** | A user-defined ID to associate with the payment. You can use this field to associate the payment to an entity in an external system. For example, you might specify an order ID that is generated by a third-party shopping cart. Limit 40 characters. | [optional] -**VerificationToken** | **string** | An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/docs/sca-overview) for more. | [optional] -**AcceptPartialAuthorization** | **bool?** | If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false | [optional] [beta] +**VerificationToken** | **string** | An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/sca-overview) for more. | [optional] +**AcceptPartialAuthorization** | **bool?** | If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true`. For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false | [optional] [beta] **BuyerEmailAddress** | **string** | The buyer's e-mail address | [optional] **BillingAddress** | [**Address**](Address.md) | The buyer's billing address. | [optional] **ShippingAddress** | [**Address**](Address.md) | The buyer's shipping address. | [optional] **Note** | **string** | An optional note to be entered by the developer when creating a payment Limit 500 characters. | [optional] +**StatementDescriptionIdentifier** | **string** | Optional additional payment information to include on the customer's card statement as part of statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Limit 20 characters. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. | [optional] [beta] diff --git a/docs/CreateRefundRequest.md b/docs/CreateRefundRequest.md index b1fcf57..0586a7e 100644 --- a/docs/CreateRefundRequest.md +++ b/docs/CreateRefundRequest.md @@ -9,7 +9,7 @@ Defines the body parameters that can be included in a request to the [CreateRefu Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdempotencyKey** | **string** | A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | +**IdempotencyKey** | **string** | A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information. | **TenderId** | **string** | The ID of the tender to refund. A ``Transaction`` has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. | **Reason** | **string** | A description of the reason for the refund. Default value: `Refund via API` | [optional] **AmountMoney** | [**Money**](Money.md) | The amount of money to refund. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`. | diff --git a/docs/Customer.md b/docs/Customer.md index e0e2fe7..2f01e3f 100644 --- a/docs/Customer.md +++ b/docs/Customer.md @@ -2,27 +2,27 @@ ### Description -Represents one of a business's customers, which can have one or more cards on file associated with it. +Represents a Square customer profile, which can have one or more cards on file associated with it. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | The customer's unique ID. | -**CreatedAt** | **string** | The time when the customer was created, in RFC 3339 format. | -**UpdatedAt** | **string** | The time when the customer was last updated, in RFC 3339 format. | -**Cards** | [**List<Card>**](Card.md) | The payment details of the customer's cards on file. | [optional] -**GivenName** | **string** | The customer's given (i.e., first) name. | [optional] -**FamilyName** | **string** | The customer's family (i.e., last) name. | [optional] -**Nickname** | **string** | The customer's nickname. | [optional] -**CompanyName** | **string** | The name of the customer's company. | [optional] -**EmailAddress** | **string** | The customer's email address. | [optional] -**Address** | [**Address**](Address.md) | The customer's physical address. | [optional] -**PhoneNumber** | **string** | The customer's phone number. | [optional] -**Birthday** | **string** | The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. | [optional] -**ReferenceId** | **string** | A second ID you can set to associate the customer with an entity in another system. | [optional] -**Note** | **string** | A note to associate with the customer. | [optional] -**Preferences** | [**CustomerPreferences**](CustomerPreferences.md) | The customer's preferences. | [optional] +**Id** | **string** | A unique, Square-assigned object ID. | +**CreatedAt** | **string** | The time when the customer profile was created, in RFC 3339 format. | +**UpdatedAt** | **string** | The time when the customer profile was last updated, in RFC 3339 format. | +**Cards** | [**List<Card>**](Card.md) | Payment details of cards stored on file for the customer profile. | [optional] +**GivenName** | **string** | The given (i.e., first) name associated with the customer profile. | [optional] +**FamilyName** | **string** | The family (i.e., last) name associated with the customer profile. | [optional] +**Nickname** | **string** | A nickname for the customer profile. | [optional] +**CompanyName** | **string** | A business name associated with the customer profile. | [optional] +**EmailAddress** | **string** | The email address associated with the customer profile. | [optional] +**Address** | [**Address**](Address.md) | The physical address associated with the customer profile. | [optional] +**PhoneNumber** | **string** | The 11-digit phone number associated with the customer profile. | [optional] +**Birthday** | **string** | The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. | [optional] +**ReferenceId** | **string** | An optional, second ID used to associate the customer profile with an entity in another system. | [optional] +**Note** | **string** | A custom note associated with the customer profile. | [optional] +**Preferences** | [**CustomerPreferences**](CustomerPreferences.md) | Represents general customer preferences. | [optional] **Groups** | [**List<CustomerGroupInfo>**](CustomerGroupInfo.md) | The groups the customer belongs to. | [optional] **CreationSource** | **string** | A creation source represents the method used to create the customer profile. See [CustomerCreationSource](#type-customercreationsource) for possible values | [optional] diff --git a/docs/CustomerCreationSourceFilter.md b/docs/CustomerCreationSourceFilter.md index 2ce7f3d..52db340 100644 --- a/docs/CustomerCreationSourceFilter.md +++ b/docs/CustomerCreationSourceFilter.md @@ -9,7 +9,7 @@ Creation source filter. If one or more creation sources are set, customer profi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Values** | **List** | The list of creation sources used as filtering criteria. See [CustomerCreationSource](#type-customercreationsource) for possible values | [optional] -**Rule** | **string** | Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values | [optional] +**Rule** | **string** | Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values | [optional] diff --git a/docs/CustomerFilter.md b/docs/CustomerFilter.md index b79f3d3..d5ab0b4 100644 --- a/docs/CustomerFilter.md +++ b/docs/CustomerFilter.md @@ -2,7 +2,7 @@ ### Description -Represents a set of `CustomerQuery` filters used to limit the set of Customers returned by SearchCustomers. +Represents a set of `CustomerQuery` filters used to limit the set of `Customers` returned by SearchCustomers. ## Properties diff --git a/docs/CustomerPreferences.md b/docs/CustomerPreferences.md index 926217e..bb6cb66 100644 --- a/docs/CustomerPreferences.md +++ b/docs/CustomerPreferences.md @@ -2,7 +2,7 @@ ### Description -Represents a particular customer's preferences. +Represents communication preferences for the customer profile. ## Properties diff --git a/docs/CustomerSort.md b/docs/CustomerSort.md index d498ceb..a6b7d89 100644 --- a/docs/CustomerSort.md +++ b/docs/CustomerSort.md @@ -8,8 +8,8 @@ Indicates the field to use for sorting customer profiles. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Field** | **string** | Indicates the information used to sort the results. For example, by creation date. Default value: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] -**Order** | **string** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default value: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] +**Field** | **string** | Indicates the information used to sort the results. For example, by creation date. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] +**Order** | **string** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] diff --git a/docs/CustomersApi.md b/docs/CustomersApi.md index f7a6247..0e3be3f 100644 --- a/docs/CustomersApi.md +++ b/docs/CustomersApi.md @@ -85,7 +85,7 @@ Name | Type | Description | Notes CreateCustomerCard -Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. +Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. ### Example ```csharp @@ -305,9 +305,9 @@ namespace Example Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new CustomersApi(); - var 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. (optional) - var sortField = sortField_example; // string | Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - var sortOrder = sortOrder_example; // string | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + var cursor = cursor_example; // string | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + var sortField = sortField_example; // string | Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + var sortOrder = sortOrder_example; // string | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) try { @@ -328,9 +328,9 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] - **sortField** | **string**| Indicates how Customers should be sorted. Default: `DEFAULT`. | [optional] - **sortOrder** | **string**| Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. | [optional] + **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] + **sortField** | **string**| Indicates how Customers should be sorted. Default: `DEFAULT`. | [optional] + **sortOrder** | **string**| Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. | [optional] ### Return type @@ -483,7 +483,7 @@ Name | Type | Description | Notes UpdateCustomer -Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. +Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. ### Example ```csharp diff --git a/docs/DeleteCatalogObjectResponse.md b/docs/DeleteCatalogObjectResponse.md index 0babd77..8abf828 100644 --- a/docs/DeleteCatalogObjectResponse.md +++ b/docs/DeleteCatalogObjectResponse.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**DeletedObjectIds** | **List** | The IDs of all `CatalogObject`s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a `CatalogItemVariation` when its parent `CatalogItem` is deleted. | [optional] -**DeletedAt** | **string** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**Errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**DeletedObjectIds** | **List** | The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted. | [optional] +**DeletedAt** | **string** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. | [optional] diff --git a/docs/Device.md b/docs/Device.md index 5333bef..738e7e0 100644 --- a/docs/Device.md +++ b/docs/Device.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/Employee.md b/docs/Employee.md index 90af163..5e77ed0 100644 --- a/docs/Employee.md +++ b/docs/Employee.md @@ -2,19 +2,19 @@ ### Description -An employee created in the **Square Dashboard** account of a business. Used by the Labor API. +An employee object that is used by the external API. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | UUID for this `Employee`. | [optional] -**FirstName** | **string** | Given (first) name of the employee. | [optional] -**LastName** | **string** | Family (last) name of the employee | [optional] -**Email** | **string** | Email of the employee | [optional] -**PhoneNumber** | **string** | Phone number of the employee in E.164 format, i.e. \"+12125554250\" | [optional] -**LocationIds** | **List** | A list of location IDs where this employee has access. | [optional] -**Status** | **string** | Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] +**Id** | **string** | UUID for this object. | [optional] +**FirstName** | **string** | The employee's first name. | [optional] +**LastName** | **string** | The employee's last name. | [optional] +**Email** | **string** | The employee's email address | [optional] +**PhoneNumber** | **string** | The employee's phone number in E.164 format, i.e. \"+12125554250\" | [optional] +**LocationIds** | **List** | A list of location IDs where this employee has access to. | [optional] +**Status** | **string** | Specifies the status of the employees being fetched. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] **CreatedAt** | **string** | A read-only timestamp in RFC 3339 format. | [optional] **UpdatedAt** | **string** | A read-only timestamp in RFC 3339 format. | [optional] diff --git a/docs/EmployeesApi.md b/docs/EmployeesApi.md index fdf0465..b00cad4 100644 --- a/docs/EmployeesApi.md +++ b/docs/EmployeesApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description ListEmployees -Gets a list of `Employee` objects for a business. + ### Example ```csharp @@ -85,7 +85,7 @@ Name | Type | Description | Notes RetrieveEmployee -Gets an `Employee` by Square-assigned employee `ID` (UUID) + ### Example ```csharp diff --git a/docs/Error.md b/docs/Error.md index 7357e61..4aeda84 100644 --- a/docs/Error.md +++ b/docs/Error.md @@ -2,14 +2,14 @@ ### Description -Represents an error encountered during a request to the Connect API. +Represents an error encountered during a request to the Connect API. See [Handling errors](#handlingerrors) for more information. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Category** | **string** | The high-level category for the error. See [ErrorCategory](#type-errorcategory) for possible values | -**Code** | **string** | The specific code of the error. See [ErrorCode](#type-errorcode) for possible values | +**Category** | **string** | The high-level category for the error. See `ErrorCategory` for possible values. See [ErrorCategory](#type-errorcategory) for possible values | +**Code** | **string** | The specific code of the error. See `ErrorCode` for possible values See [ErrorCode](#type-errorcode) for possible values | **Detail** | **string** | A human-readable description of the error for debugging purposes. | [optional] **Field** | **string** | The name of the field provided in the original request (if any) that the error pertains to. | [optional] diff --git a/docs/ExcludeStrategy.md b/docs/ExcludeStrategy.md index 507f09d..28aca07 100644 --- a/docs/ExcludeStrategy.md +++ b/docs/ExcludeStrategy.md @@ -2,7 +2,7 @@ ### Description -Indicates which products matched by a `CatalogPricingRule` will be excluded if the pricing rule uses an exclude set. +Indicates which products matched by a CatalogPricingRule will be excluded if the pricing rule uses an exclude set. **Note: This model is in beta.** ## Properties diff --git a/docs/ExternalPaymentDetails.md b/docs/ExternalPaymentDetails.md new file mode 100644 index 0000000..d53afeb --- /dev/null +++ b/docs/ExternalPaymentDetails.md @@ -0,0 +1,19 @@ +# Square.Connect.Model.ExternalPaymentDetails + +### Description + +Additional details about EXTERNAL type payments. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of External payment which can be one of: CHECK - Paid by a physical check BANK_TRANSFER - Paid by ACH or other bank transfer OTHER_GIFT_CARD - Paid by a non-square gift card CRYPTO - Paid via a crypto currency SQUARE_CASH - Paid via Square Cash app SOCIAL - Venmo, WeChatPay, AliPay, etc. EXTERNAL - A 3rd party application gathered this payment outside of Square EMONEY - A Japanese e-money brand Square doesn’t support CREDIT/DEBIT - A credit/debit card Square doesn’t support OTHER - A type not listed here | +**Source** | **string** | A description of the source of the external payment, e.g. “Uber Eats”, “Stripe”, “Shopify”. Limit 255 characters | +**SourceId** | **string** | An ID to associate this payment to its originating source Limit 255 characters. | [optional] +**SourceFeeMoney** | [**Money**](Money.md) | The total of fees paid to the source. (amount_money - source_fee_money) = net money to the merchant | [optional] + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InventoryAdjustment.md b/docs/InventoryAdjustment.md index e51ad99..395edc9 100644 --- a/docs/InventoryAdjustment.md +++ b/docs/InventoryAdjustment.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **LocationId** | **string** | The Square ID of the `Location` where the related quantity of items are being tracked. | [optional] **CatalogObjectId** | **string** | The Square generated ID of the `CatalogObject` being tracked. | [optional] **CatalogObjectType** | **string** | The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] -**Quantity** | **string** | The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. | [optional] [beta] +**Quantity** | **string** | The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. | [optional] [beta] **TotalPriceMoney** | [**Money**](Money.md) | The read-only total price paid for goods associated with the adjustment. Present if and only if `to_state` is `SOLD`. Always non-negative. | [optional] **OccurredAt** | **string** | A client-generated timestamp in RFC 3339 format that indicates when the adjustment took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional] **CreatedAt** | **string** | A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment. | [optional] diff --git a/docs/InventoryAlertType.md b/docs/InventoryAlertType.md index b29bec2..edaba19 100644 --- a/docs/InventoryAlertType.md +++ b/docs/InventoryAlertType.md @@ -2,7 +2,7 @@ ### Description -Indicates whether Square should alert the merchant when the inventory quantity of a `CatalogItemVariation` is low. +Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low. ## Properties diff --git a/docs/InventoryApi.md b/docs/InventoryApi.md index 9ecec9f..dd84146 100644 --- a/docs/InventoryApi.md +++ b/docs/InventoryApi.md @@ -302,7 +302,7 @@ namespace Example var apiInstance = new InventoryApi(); var catalogObjectId = catalogObjectId_example; // string | ID of the `CatalogObject` to retrieve. var locationIds = locationIds_example; // string | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - var 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. (optional) + var cursor = cursor_example; // string | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) try { @@ -325,7 +325,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **catalogObjectId** | **string**| ID of the `CatalogObject` to retrieve. | **locationIds** | **string**| The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] - **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] ### Return type @@ -371,7 +371,7 @@ namespace Example var apiInstance = new InventoryApi(); var catalogObjectId = catalogObjectId_example; // string | ID of the `CatalogObject` to retrieve. var locationIds = locationIds_example; // string | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - var 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. (optional) + var cursor = cursor_example; // string | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) try { @@ -394,7 +394,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **catalogObjectId** | **string**| ID of the `CatalogObject` to retrieve. | **locationIds** | **string**| The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] - **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] ### Return type diff --git a/docs/InventoryChange.md b/docs/InventoryChange.md index 8107901..7a69d16 100644 --- a/docs/InventoryChange.md +++ b/docs/InventoryChange.md @@ -2,13 +2,13 @@ ### Description -Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular [CatalogObject](#type-catalogobject). +Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular `CatalogObject`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] +**Type** | **string** | Indicates how the inventory change was applied. See `InventoryChangeType` for all possible values. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] **PhysicalCount** | [**InventoryPhysicalCount**](InventoryPhysicalCount.md) | Contains details about the physical count when `type` is `PHYSICAL_COUNT` and unset for all other types. | [optional] **Adjustment** | [**InventoryAdjustment**](InventoryAdjustment.md) | Contains details about the inventory adjustment when `type` is `ADJUSTMENT` and unset for all other types. | [optional] **Transfer** | [**InventoryTransfer**](InventoryTransfer.md) | Contains details about the inventory transfer when `type` is `TRANSFER` and unset for all other types. | [optional] diff --git a/docs/InventoryCount.md b/docs/InventoryCount.md index 1039082..0311bba 100644 --- a/docs/InventoryCount.md +++ b/docs/InventoryCount.md @@ -2,7 +2,7 @@ ### Description -Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments +Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments. ## Properties @@ -12,7 +12,7 @@ Name | Type | Description | Notes **CatalogObjectType** | **string** | The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] **State** | **string** | The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional] **LocationId** | **string** | The Square ID of the `Location` where the related quantity of items are being tracked. | [optional] -**Quantity** | **string** | The number of items in the count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. | [optional] [beta] +**Quantity** | **string** | The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. | [optional] [beta] **CalculatedAt** | **string** | A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count. | [optional] diff --git a/docs/InventoryPhysicalCount.md b/docs/InventoryPhysicalCount.md index 2074ffc..ac02956 100644 --- a/docs/InventoryPhysicalCount.md +++ b/docs/InventoryPhysicalCount.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **CatalogObjectType** | **string** | The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] **State** | **string** | The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional] **LocationId** | **string** | The Square ID of the `Location` where the related quantity of items are being tracked. | [optional] -**Quantity** | **string** | The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. | [optional] [beta] +**Quantity** | **string** | The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. | [optional] [beta] **Source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that submitted the physical count. | [optional] **EmployeeId** | **string** | The Square ID of the `Employee` responsible for the physical count. | [optional] **OccurredAt** | **string** | A client-generated timestamp in RFC 3339 format that indicates when the physical count took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional] diff --git a/docs/InventoryTransfer.md b/docs/InventoryTransfer.md index f91da04..712f77b 100644 --- a/docs/InventoryTransfer.md +++ b/docs/InventoryTransfer.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **ToLocationId** | **string** | The Square ID of the `Location` where the related quantity of items were tracked after the transfer. | [optional] **CatalogObjectId** | **string** | The Square generated ID of the `CatalogObject` being tracked. | [optional] **CatalogObjectType** | **string** | The `CatalogObjectType` of the `CatalogObject` being tracked.Tracking is only supported for the `ITEM_VARIATION` type. | [optional] -**Quantity** | **string** | The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. | [optional] [beta] +**Quantity** | **string** | The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. | [optional] [beta] **OccurredAt** | **string** | A client-generated timestamp in RFC 3339 format that indicates when the transfer took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional] **CreatedAt** | **string** | A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request. | [optional] **Source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that initiated the inventory transfer. | [optional] diff --git a/docs/ItemVariationLocationOverrides.md b/docs/ItemVariationLocationOverrides.md index 0355693..674d000 100644 --- a/docs/ItemVariationLocationOverrides.md +++ b/docs/ItemVariationLocationOverrides.md @@ -2,16 +2,16 @@ ### Description -Price and inventory alerting overrides for a [CatalogItemVariation](#type-catalogitemvariation) at a specific [location](#type-location). +Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**LocationId** | **string** | The ID of the `location`. | [optional] -**PriceMoney** | [**Money**](Money.md) | The price of the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`, or blank for variable pricing. | [optional] -**PricingType** | **string** | The pricing type (fixed or variable) for the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values | [optional] -**TrackInventory** | **bool?** | If `true`, inventory tracking is active for the `CatalogItemVariation](#type-catalogitemvariation) at this [location`. | [optional] +**LocationId** | **string** | The ID of the `Location`. | [optional] +**PriceMoney** | [**Money**](Money.md) | The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing. | [optional] +**PricingType** | **string** | The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values | [optional] +**TrackInventory** | **bool?** | If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`. | [optional] **InventoryAlertType** | **string** | Indicates whether the `CatalogItemVariation` displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values | [optional] **InventoryAlertThreshold** | **long?** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer. | [optional] diff --git a/docs/ListAdditionalRecipientReceivableRefundsRequest.md b/docs/ListAdditionalRecipientReceivableRefundsRequest.md index 782c21a..57058fd 100644 --- a/docs/ListAdditionalRecipientReceivableRefundsRequest.md +++ b/docs/ListAdditionalRecipientReceivableRefundsRequest.md @@ -2,7 +2,7 @@ ### Description -Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivableRefunds endpoint. +Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. **Note: This model is deprecated.** ## Properties @@ -12,7 +12,7 @@ Name | Type | Description | Notes **BeginTime** | **string** | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **EndTime** | **string** | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **SortOrder** | **string** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivableRefundsResponse.md b/docs/ListAdditionalRecipientReceivableRefundsResponse.md index 0f43c43..91ea151 100644 --- a/docs/ListAdditionalRecipientReceivableRefundsResponse.md +++ b/docs/ListAdditionalRecipientReceivableRefundsResponse.md @@ -2,7 +2,7 @@ ### Description -Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivableRefunds endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both). +Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both). **Note: This model is deprecated.** ## Properties @@ -11,7 +11,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **ReceivableRefunds** | [**List<AdditionalRecipientReceivableRefund>**](AdditionalRecipientReceivableRefund.md) | An array of AdditionalRecipientReceivableRefunds that match your query. | [optional] -**Cursor** | **string** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivablesRequest.md b/docs/ListAdditionalRecipientReceivablesRequest.md index 772fcdf..9fd8f03 100644 --- a/docs/ListAdditionalRecipientReceivablesRequest.md +++ b/docs/ListAdditionalRecipientReceivablesRequest.md @@ -2,7 +2,7 @@ ### Description -Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivables endpoint. +Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. **Note: This model is deprecated.** ## Properties @@ -12,7 +12,7 @@ Name | Type | Description | Notes **BeginTime** | **string** | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **EndTime** | **string** | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **SortOrder** | **string** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivablesResponse.md b/docs/ListAdditionalRecipientReceivablesResponse.md index 32393b8..ec1d212 100644 --- a/docs/ListAdditionalRecipientReceivablesResponse.md +++ b/docs/ListAdditionalRecipientReceivablesResponse.md @@ -2,7 +2,7 @@ ### Description -Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivables endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both). +Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both). **Note: This model is deprecated.** ## Properties @@ -11,7 +11,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **Receivables** | [**List<AdditionalRecipientReceivable>**](AdditionalRecipientReceivable.md) | An array of AdditionalRecipientReceivables that match your query. | [optional] -**Cursor** | **string** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListCatalogRequest.md b/docs/ListCatalogRequest.md index c4a3e10..716d34a 100644 --- a/docs/ListCatalogRequest.md +++ b/docs/ListCatalogRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Cursor** | **string** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**Types** | **string** | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] +**Types** | **string** | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] diff --git a/docs/ListCatalogResponse.md b/docs/ListCatalogResponse.md index 812163c..5974474 100644 --- a/docs/ListCatalogResponse.md +++ b/docs/ListCatalogResponse.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] +**Errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] **Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**Objects** | [**List<CatalogObject>**](CatalogObject.md) | The `CatalogObject`s returned. | [optional] +**Objects** | [**List<CatalogObject>**](CatalogObject.md) | The CatalogObjects returned. | [optional] diff --git a/docs/ListCustomersRequest.md b/docs/ListCustomersRequest.md index 6ae7bef..858fd09 100644 --- a/docs/ListCustomersRequest.md +++ b/docs/ListCustomersRequest.md @@ -8,9 +8,9 @@ Defines the query parameters that can be provided in a request to the ListCustom Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**SortField** | **string** | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] -**SortOrder** | **string** | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] +**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] +**SortField** | **string** | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] +**SortOrder** | **string** | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] diff --git a/docs/ListCustomersResponse.md b/docs/ListCustomersResponse.md index e5c3012..168cd9f 100644 --- a/docs/ListCustomersResponse.md +++ b/docs/ListCustomersResponse.md @@ -9,8 +9,8 @@ Defines the fields that are included in the response body of a request to the Li Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] -**Customers** | [**List<Customer>**](Customer.md) | An array of `Customer` objects that match your query. | [optional] -**Cursor** | **string** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Customers** | [**List<Customer>**](Customer.md) | An array of `Customer` objects that match the provided query. | [optional] +**Cursor** | **string** | A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] diff --git a/docs/ListEmployeesRequest.md b/docs/ListEmployeesRequest.md index 346efff..1f89f29 100644 --- a/docs/ListEmployeesRequest.md +++ b/docs/ListEmployeesRequest.md @@ -2,7 +2,7 @@ ### Description -Retrieve a paged-list of employees for a Square account + ## Properties diff --git a/docs/ListEmployeesResponse.md b/docs/ListEmployeesResponse.md index 1cb9bf9..77d97cb 100644 --- a/docs/ListEmployeesResponse.md +++ b/docs/ListEmployeesResponse.md @@ -2,7 +2,7 @@ ### Description -Defines the fields that are included in the response body of a request to the ListEmployees endpoint. One of `errors` or `employees` is present in a given response (never both). + ## Properties diff --git a/docs/ListLocationsRequest.md b/docs/ListLocationsRequest.md index d647a13..dce22c1 100644 --- a/docs/ListLocationsRequest.md +++ b/docs/ListLocationsRequest.md @@ -2,7 +2,7 @@ ### Description -Defines the fields that are included in requests to the ListLocations endpoint. +Defines the fields that are included in requests to the __ListLocations__ endpoint. ## Properties diff --git a/docs/ListLocationsResponse.md b/docs/ListLocationsResponse.md index b16295c..582f925 100644 --- a/docs/ListLocationsResponse.md +++ b/docs/ListLocationsResponse.md @@ -2,14 +2,14 @@ ### Description -Defines the fields that are included in the response body of a request to the ListLocations endpoint. One of `errors` or `locations` is present in a given response (never both). +Defines the fields that are included in the response body of a request to the __ListLocations__ endpoint. One of `errors` or `locations` is present in a given response (never both). ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] -**Locations** | [**List<Location>**](Location.md) | The business's locations. | [optional] +**Locations** | [**List<Location>**](Location.md) | The business locations. | [optional] diff --git a/docs/ListPaymentRefundsRequest.md b/docs/ListPaymentRefundsRequest.md index c6bf640..d054fd4 100644 --- a/docs/ListPaymentRefundsRequest.md +++ b/docs/ListPaymentRefundsRequest.md @@ -13,8 +13,8 @@ Name | Type | Description | Notes **SortOrder** | **string** | The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). | [optional] **Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] **LocationId** | **string** | ID of location associated with payment. | [optional] -**Status** | **string** | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] -**SourceType** | **string** | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] +**Status** | **string** | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] +**SourceType** | **string** | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] diff --git a/docs/ListRefundsRequest.md b/docs/ListRefundsRequest.md index 9be9851..eebbddf 100644 --- a/docs/ListRefundsRequest.md +++ b/docs/ListRefundsRequest.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **BeginTime** | **string** | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **EndTime** | **string** | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **SortOrder** | **string** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListRefundsResponse.md b/docs/ListRefundsResponse.md index 356fe0e..8b04348 100644 --- a/docs/ListRefundsResponse.md +++ b/docs/ListRefundsResponse.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **Refunds** | [**List<Refund>**](Refund.md) | An array of refunds that match your query. | [optional] -**Cursor** | **string** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListTransactionsRequest.md b/docs/ListTransactionsRequest.md index ddaa8ad..5a905bb 100644 --- a/docs/ListTransactionsRequest.md +++ b/docs/ListTransactionsRequest.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **BeginTime** | **string** | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **EndTime** | **string** | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **SortOrder** | **string** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/ListTransactionsResponse.md b/docs/ListTransactionsResponse.md index 27217c6..bb5c82c 100644 --- a/docs/ListTransactionsResponse.md +++ b/docs/ListTransactionsResponse.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **Transactions** | [**List<Transaction>**](Transaction.md) | An array of transactions that match your query. | [optional] -**Cursor** | **string** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] diff --git a/docs/Location.md b/docs/Location.md index b4eefc1..8ae3e48 100644 --- a/docs/Location.md +++ b/docs/Location.md @@ -2,36 +2,36 @@ ### Description -Represents one of a business's locations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **string** | The Square-issued ID of the location. | [optional] -**Name** | **string** | The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname | [optional] -**Address** | [**Address**](Address.md) | The location's physical address. | [optional] -**Timezone** | **string** | The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone. | [optional] +**Name** | **string** | The name of the location. This information appears in the dashboard as the nickname. | [optional] +**Address** | [**Address**](Address.md) | The physical address of the location. | [optional] +**Timezone** | **string** | The [IANA Timezone](https://www.iana.org/time-zones) identifier for the timezone of the location. | [optional] **Capabilities** | **List** | The Square features that are enabled for the location. See `LocationCapability` for possible values. See [LocationCapability](#type-locationcapability) for possible values | [optional] -**Status** | **string** | The location's status See [LocationStatus](#type-locationstatus) for possible values | [optional] +**Status** | **string** | The status of the location, either active or inactive. See [LocationStatus](#type-locationstatus) for possible values | [optional] **CreatedAt** | **string** | The time when the location was created, in RFC 3339 format. | [optional] **MerchantId** | **string** | The ID of the merchant that owns the location. | [optional] **Country** | **string** | The country of the location, in ISO 3166-1-alpha-2 format. See `Country` for possible values. See [Country](#type-country) for possible values | [optional] -**LanguageCode** | **string** | The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). | [optional] -**Currency** | **string** | The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values | [optional] -**PhoneNumber** | **string** | The location's phone_number. | [optional] -**BusinessName** | **string** | The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts. | [optional] -**Type** | **string** | The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values | [optional] -**WebsiteUrl** | **string** | The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set. | [optional] -**BusinessHours** | [**BusinessHours**](BusinessHours.md) | The hours of operation for a business location. Default: none; only exists if explicitly set. | [optional] -**BusinessEmail** | **string** | The email of the location. | [optional] -**Description** | **string** | The business description of the location. | [optional] +**LanguageCode** | **string** | The language associated with the location, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). | [optional] +**Currency** | **string** | The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values | [optional] +**PhoneNumber** | **string** | The phone number of the location in human readable format. | [optional] +**BusinessName** | **string** | The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts. | [optional] +**Type** | **string** | The type of the location, either physical or mobile. See [LocationType](#type-locationtype) for possible values | [optional] +**WebsiteUrl** | **string** | The website URL of the location. | [optional] +**BusinessHours** | [**BusinessHours**](BusinessHours.md) | Represents the hours of operation for the location. | [optional] +**BusinessEmail** | **string** | The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts. | [optional] +**Description** | **string** | The description of the location. | [optional] **TwitterUsername** | **string** | The Twitter username of the location without the '&#64;' symbol. | [optional] **InstagramUsername** | **string** | The Instagram username of the location without the '&#64;' symbol. | [optional] **FacebookUrl** | **string** | The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. | [optional] **Coordinates** | [**Coordinates**](Coordinates.md) | The physical coordinates (latitude and longitude) of the location. | [optional] -**LogoUrl** | **string** | The logo image URL of the location. | [optional] -**PosBackgroundUrl** | **string** | The Point of Sale background image URL of the location. | [optional] +**LogoUrl** | **string** | The URL of the logo image for the location. | [optional] +**PosBackgroundUrl** | **string** | The URL of the Point of Sale background image for the location. | [optional] **Mcc** | **string** | The merchant category code (MCC) of the location, as standardized by ISO 18245. The MCC describes the kind of goods or services sold at the location. | [optional] [beta] diff --git a/docs/LocationCapability.md b/docs/LocationCapability.md index 504a6c2..97e54d4 100644 --- a/docs/LocationCapability.md +++ b/docs/LocationCapability.md @@ -2,7 +2,7 @@ ### Description -Indicates payment capabilities that a business's location might or might not have enabled. +The capabilities a location may have. ## Properties diff --git a/docs/LocationStatus.md b/docs/LocationStatus.md index 5118aba..e98fc12 100644 --- a/docs/LocationStatus.md +++ b/docs/LocationStatus.md @@ -2,7 +2,7 @@ ### Description -Indicates the location's status. +The status of the location, whether a location is active or inactive. ## Properties diff --git a/docs/LocationType.md b/docs/LocationType.md index 977f85c..860e8d3 100644 --- a/docs/LocationType.md +++ b/docs/LocationType.md @@ -2,7 +2,7 @@ ### Description -Indicates the location's type. +A location's physical or mobile type. ## Properties diff --git a/docs/LocationsApi.md b/docs/LocationsApi.md index 9e11021..1f402c8 100644 --- a/docs/LocationsApi.md +++ b/docs/LocationsApi.md @@ -4,18 +4,85 @@ All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**CreateLocation**](LocationsApi.md#createlocation) | **POST** /v2/locations | CreateLocation [**ListLocations**](LocationsApi.md#listlocations) | **GET** /v2/locations | ListLocations [**RetrieveLocation**](LocationsApi.md#retrievelocation) | **GET** /v2/locations/{location_id} | RetrieveLocation [**UpdateLocation**](LocationsApi.md#updatelocation) | **PUT** /v2/locations/{location_id} | UpdateLocation + +# **CreateLocation** +**Note: This endpoint is in beta.** +> CreateLocationResponse CreateLocation (CreateLocationRequest body) + +CreateLocation + +Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + +### Example +```csharp +using System; +using System.Diagnostics; +using Square.Connect.Api; +using Square.Connect.Client; +using Square.Connect.Model; + +namespace Example +{ + public class CreateLocationExample + { + public void main() + { + + // Configure OAuth2 access token for authorization: oauth2 + Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN"; + + var apiInstance = new LocationsApi(); + var body = new CreateLocationRequest(); // CreateLocationRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + + try + { + // CreateLocation + CreateLocationResponse result = apiInstance.CreateLocation(body); + Debug.WriteLine(result); + } + catch (Exception e) + { + Debug.Print("Exception when calling LocationsApi.CreateLocation: " + e.Message ); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateLocationRequest**](CreateLocationRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**CreateLocationResponse**](CreateLocationResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **ListLocations** > ListLocationsResponse ListLocations () ListLocations -Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. +Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. ### Example ```csharp @@ -72,7 +139,6 @@ This endpoint does not need any parameter. # **RetrieveLocation** -**Note: This endpoint is in beta.** > RetrieveLocationResponse RetrieveLocation (string locationId) RetrieveLocation @@ -143,7 +209,7 @@ Name | Type | Description | Notes UpdateLocation -Updates the `Location` specified by the given ID. +Updates a location. ### Example ```csharp diff --git a/docs/MeasurementUnitGeneric.md b/docs/MeasurementUnitGeneric.md index 0a71918..8d90e5e 100644 --- a/docs/MeasurementUnitGeneric.md +++ b/docs/MeasurementUnitGeneric.md @@ -2,7 +2,7 @@ ### Description -A custom unit of measurement defined by the user. + **Note: This model is in beta.** ## Properties diff --git a/docs/MerchantsApi.md b/docs/MerchantsApi.md index e080ee1..1cf0aab 100644 --- a/docs/MerchantsApi.md +++ b/docs/MerchantsApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description ListMerchants -Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. +Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. ### Example ```csharp diff --git a/docs/MobileAuthorizationApi.md b/docs/MobileAuthorizationApi.md index 27c53ba..d6d94c2 100644 --- a/docs/MobileAuthorizationApi.md +++ b/docs/MobileAuthorizationApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description CreateMobileAuthorizationCode -Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). +Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/docs/build-basics/access-tokens). ### Example ```csharp diff --git a/docs/Money.md b/docs/Money.md index 52a7023..4526eab 100644 --- a/docs/Money.md +++ b/docs/Money.md @@ -2,13 +2,13 @@ ### Description -Represents an amount of money. `Money` fields can be signed or unsigned. +Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](/build-basics/working-with-monetary-amounts) for more information. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Amount** | **long?** | The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case. | [optional] +**Amount** | **long?** | The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case. | [optional] **Currency** | **string** | The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See `Currency` for possible values. See [Currency](#type-currency) for possible values | [optional] diff --git a/docs/OAuthApi.md b/docs/OAuthApi.md index 2d440ab..d303242 100644 --- a/docs/OAuthApi.md +++ b/docs/OAuthApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description ObtainToken -Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. +Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. ### Example ```csharp @@ -78,7 +78,7 @@ No authorization required RenewToken -`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). +`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). ### Example ```csharp @@ -101,7 +101,7 @@ namespace Example // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer"); var apiInstance = new OAuthApi(); - var clientId = clientId_example; // string | Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + var clientId = clientId_example; // string | Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). var body = new RenewTokenRequest(); // RenewTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. try @@ -123,7 +123,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **clientId** | **string**| Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). | + **clientId** | **string**| Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). | **body** | [**RenewTokenRequest**](RenewTokenRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | ### Return type diff --git a/docs/ObtainTokenResponse.md b/docs/ObtainTokenResponse.md index 909be54..91277f8 100644 --- a/docs/ObtainTokenResponse.md +++ b/docs/ObtainTokenResponse.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **ExpiresAt** | **string** | The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. | [optional] **MerchantId** | **string** | The ID of the authorizing merchant's business. | [optional] **SubscriptionId** | **string** | __LEGACY FIELD__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] -**PlanId** | **string** | __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] +**PlanId** | **string** | T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] **IdToken** | **string** | Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request. | [optional] **RefreshToken** | **string** | A refresh token. For more information, see [OAuth access token management](https://developer.squareup.com/docs/authz/oauth/how-it-works#oauth-access-token-management). | [optional] diff --git a/docs/Payment.md b/docs/Payment.md index d6baf0c..c20b3e9 100644 --- a/docs/Payment.md +++ b/docs/Payment.md @@ -11,10 +11,10 @@ Name | Type | Description | Notes **Id** | **string** | Unique ID for the payment. | [optional] **CreatedAt** | **string** | Timestamp of when the payment was created, in RFC 3339 format. | [optional] **UpdatedAt** | **string** | Timestamp of when the payment was last updated, in RFC 3339 format. | [optional] -**AmountMoney** | [**Money**](Money.md) | The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] +**AmountMoney** | [**Money**](Money.md) | The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] **TipMoney** | [**Money**](Money.md) | The amount designated as a tip. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] -**TotalMoney** | [**Money**](Money.md) | The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] -**AppFeeMoney** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. | [optional] +**TotalMoney** | [**Money**](Money.md) | The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] +**AppFeeMoney** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. | [optional] **ProcessingFee** | [**List<ProcessingFee>**](ProcessingFee.md) | Processing fees and fee adjustments assessed by Square on this payment. | [optional] **RefundedMoney** | [**Money**](Money.md) | Total amount of the payment refunded to-date. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] **Status** | **string** | Indicates whether the payment is `APPROVED`, `COMPLETED`, `CANCELED`, or `FAILED`. | [optional] @@ -30,6 +30,7 @@ Name | Type | Description | Notes **BillingAddress** | [**Address**](Address.md) | The buyer's billing address | [optional] **ShippingAddress** | [**Address**](Address.md) | The buyer's shipping address | [optional] **Note** | **string** | An optional note to include when creating a payment | [optional] +**StatementDescriptionIdentifier** | **string** | Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. | [optional] [beta] diff --git a/docs/PaymentsApi.md b/docs/PaymentsApi.md index 55c1ca8..ee4f84b 100644 --- a/docs/PaymentsApi.md +++ b/docs/PaymentsApi.md @@ -18,7 +18,7 @@ Method | HTTP request | Description CancelPayment -Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). +Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). ### Example ```csharp @@ -83,7 +83,7 @@ Name | Type | Description | Notes CancelPaymentByIdempotencyKey -Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. +Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. ### Example ```csharp diff --git a/docs/RefundPaymentRequest.md b/docs/RefundPaymentRequest.md index 90d785a..0649df3 100644 --- a/docs/RefundPaymentRequest.md +++ b/docs/RefundPaymentRequest.md @@ -8,9 +8,9 @@ Refunds a payment. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdempotencyKey** | **string** | A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency). | +**IdempotencyKey** | **string** | A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). | **AmountMoney** | [**Money**](Money.md) | The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card. | -**AppFeeMoney** | [**Money**](Money.md) | Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) | [optional] +**AppFeeMoney** | [**Money**](Money.md) | Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) | [optional] **PaymentId** | **string** | Unique ID of the payment being refunded. | [optional] **Reason** | **string** | A description of the reason for the refund. | [optional] diff --git a/docs/RefundsApi.md b/docs/RefundsApi.md index 20802a6..df7b56b 100644 --- a/docs/RefundsApi.md +++ b/docs/RefundsApi.md @@ -106,8 +106,8 @@ namespace Example var sortOrder = sortOrder_example; // string | The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) var 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. (optional) var locationId = locationId_example; // string | ID of location associated with payment. (optional) - var 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. (optional) - var 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. (optional) + var 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. (optional) + var 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. (optional) try { @@ -133,8 +133,8 @@ Name | Type | Description | Notes **sortOrder** | **string**| The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). | [optional] **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] **locationId** | **string**| ID of location associated with payment. | [optional] - **status** | **string**| If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] - **sourceType** | **string**| If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] + **status** | **string**| If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] + **sourceType** | **string**| If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] ### Return type diff --git a/docs/RegisterDomainRequest.md b/docs/RegisterDomainRequest.md index 87b2bf4..dbfce05 100644 --- a/docs/RegisterDomainRequest.md +++ b/docs/RegisterDomainRequest.md @@ -2,7 +2,7 @@ ### Description -Defines the parameters that can be included in the body of a request to the RegisterDomain endpoint. +Defines the parameters that can be included in the body of a request to the __RegisterDomain__ endpoint. ## Properties diff --git a/docs/RegisterDomainResponse.md b/docs/RegisterDomainResponse.md index 864a83f..9592fc3 100644 --- a/docs/RegisterDomainResponse.md +++ b/docs/RegisterDomainResponse.md @@ -2,14 +2,14 @@ ### Description -Defines the fields that are included in the response body of a request to the RegisterDomain endpoint. Either `errors` or `status` will be present in a given response (never both). +Defines the fields that are included in the response body of a request to the __RegisterDomain__ endpoint. Either `errors` or `status` will be present in a given response (never both). ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] -**Status** | **string** | Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values | [optional] +**Status** | **string** | Status of the domain registration. See `RegisterDomainResponseStatus` for possible values. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values | [optional] diff --git a/docs/RenewTokenResponse.md b/docs/RenewTokenResponse.md index 558b030..3469131 100644 --- a/docs/RenewTokenResponse.md +++ b/docs/RenewTokenResponse.md @@ -9,11 +9,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccessToken** | **string** | The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://docs.connect.squareup.com/api/connect/v2/#requestandresponseheaders) for the format of this header. | [optional] +**AccessToken** | **string** | The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://developer.squareup.com/docs/api/connect/v2/#requestandresponseheaders) for the format of this header. | [optional] **TokenType** | **string** | This value is always _bearer_. | [optional] **ExpiresAt** | **string** | The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. | [optional] **MerchantId** | **string** | The ID of the authorizing merchant's business. | [optional] -**SubscriptionId** | **string** | __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization. | [optional] +**SubscriptionId** | **string** | __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization.. | [optional] **PlanId** | **string** | __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] diff --git a/docs/ReportingApi.md b/docs/ReportingApi.md index 0f347e8..c200dc3 100644 --- a/docs/ReportingApi.md +++ b/docs/ReportingApi.md @@ -40,7 +40,7 @@ namespace Example var 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. (optional) var 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. (optional) var 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` (optional) - var 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. (optional) + var cursor = cursor_example; // string | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) try { @@ -65,7 +65,7 @@ Name | Type | Description | Notes **beginTime** | **string**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **string**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **string**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] ### Return type @@ -114,7 +114,7 @@ namespace Example var 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. (optional) var 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. (optional) var 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` (optional) - var 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. (optional) + var cursor = cursor_example; // string | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) try { @@ -139,7 +139,7 @@ Name | Type | Description | Notes **beginTime** | **string**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **string**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **string**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] ### Return type diff --git a/docs/RetrieveCatalogObjectRequest.md b/docs/RetrieveCatalogObjectRequest.md index 495d582..4cfe262 100644 --- a/docs/RetrieveCatalogObjectRequest.md +++ b/docs/RetrieveCatalogObjectRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IncludeRelatedObjects** | **bool?** | If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a `CatalogItem`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` | [optional] +**IncludeRelatedObjects** | **bool?** | If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` | [optional] diff --git a/docs/RetrieveCatalogObjectResponse.md b/docs/RetrieveCatalogObjectResponse.md index d6a6b8b..9bb44a3 100644 --- a/docs/RetrieveCatalogObjectResponse.md +++ b/docs/RetrieveCatalogObjectResponse.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**_Object** | [**CatalogObject**](CatalogObject.md) | The `CatalogObject`s returned. | [optional] -**RelatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s referenced by the object in the `object` field. | [optional] +**Errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**_Object** | [**CatalogObject**](CatalogObject.md) | The CatalogObjects returned. | [optional] +**RelatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects referenced by the object in the `object` field. | [optional] diff --git a/docs/RetrieveEmployeeRequest.md b/docs/RetrieveEmployeeRequest.md index 92563c6..a77ef15 100644 --- a/docs/RetrieveEmployeeRequest.md +++ b/docs/RetrieveEmployeeRequest.md @@ -2,7 +2,7 @@ ### Description -Retrieve an employee by `Employee.id` + ## Properties diff --git a/docs/RetrieveEmployeeResponse.md b/docs/RetrieveEmployeeResponse.md index 061f12e..0bb0081 100644 --- a/docs/RetrieveEmployeeResponse.md +++ b/docs/RetrieveEmployeeResponse.md @@ -2,7 +2,7 @@ ### Description -Defines the fields that are included in the response body of a request to the RetrieveEmployee endpoint. One of `errors` or `employee` is present in a given response (never both). + ## Properties diff --git a/docs/RetrieveInventoryChangesRequest.md b/docs/RetrieveInventoryChangesRequest.md index e55c76d..2e40c52 100644 --- a/docs/RetrieveInventoryChangesRequest.md +++ b/docs/RetrieveInventoryChangesRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **LocationIds** | **string** | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] -**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/RetrieveInventoryChangesResponse.md b/docs/RetrieveInventoryChangesResponse.md index 24e8208..fe8aa5f 100644 --- a/docs/RetrieveInventoryChangesResponse.md +++ b/docs/RetrieveInventoryChangesResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **Changes** | [**List<InventoryChange>**](InventoryChange.md) | The set of inventory changes for the requested object and locations. | [optional] -**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/RetrieveInventoryCountRequest.md b/docs/RetrieveInventoryCountRequest.md index 57a1346..56acd06 100644 --- a/docs/RetrieveInventoryCountRequest.md +++ b/docs/RetrieveInventoryCountRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **LocationIds** | **string** | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] -**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/RetrieveInventoryCountResponse.md b/docs/RetrieveInventoryCountResponse.md index a9604c5..0fdfcd1 100644 --- a/docs/RetrieveInventoryCountResponse.md +++ b/docs/RetrieveInventoryCountResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **Counts** | [**List<InventoryCount>**](InventoryCount.md) | The current calculated inventory counts for the requested object and locations. | [optional] -**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/RetrieveLocationRequest.md b/docs/RetrieveLocationRequest.md index 2b17fca..5ae1006 100644 --- a/docs/RetrieveLocationRequest.md +++ b/docs/RetrieveLocationRequest.md @@ -2,7 +2,7 @@ ### Description -Defines the fields that are included in the request body for the [RetrieveLocation](#endpoint-locations-retrievelocation) endpoint. +Defines the fields that are included in the request body for the __RetrieveLocation__ endpoint. ## Properties diff --git a/docs/RetrieveLocationResponse.md b/docs/RetrieveLocationResponse.md index 49b8363..9aac1f6 100644 --- a/docs/RetrieveLocationResponse.md +++ b/docs/RetrieveLocationResponse.md @@ -2,7 +2,7 @@ ### Description -Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. +Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. ## Properties diff --git a/docs/RetrieveMerchantResponse.md b/docs/RetrieveMerchantResponse.md index 2973023..0a1f8d8 100644 --- a/docs/RetrieveMerchantResponse.md +++ b/docs/RetrieveMerchantResponse.md @@ -2,7 +2,7 @@ ### Description -The response obeject returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. +The response object returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. ## Properties diff --git a/docs/RetrieveTransactionRequest.md b/docs/RetrieveTransactionRequest.md index 6776caa..f0329e0 100644 --- a/docs/RetrieveTransactionRequest.md +++ b/docs/RetrieveTransactionRequest.md @@ -2,7 +2,7 @@ ### Description -Defines the request body fields for calls to the RetrieveTransaction endpoint. + **Note: This model is deprecated.** ## Properties diff --git a/docs/RevokeTokenRequest.md b/docs/RevokeTokenRequest.md index d797e47..d9bfa4a 100644 --- a/docs/RevokeTokenRequest.md +++ b/docs/RevokeTokenRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] +**ClientId** | **string** | The Square issued ID for your application, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] **AccessToken** | **string** | The access token of the merchant whose token you want to revoke. Do not provide a value for merchant_id if you provide this parameter. | [optional] **MerchantId** | **string** | The ID of the merchant whose token you want to revoke. Do not provide a value for access_token if you provide this parameter. | [optional] diff --git a/docs/SearchCatalogObjectsRequest.md b/docs/SearchCatalogObjectsRequest.md index 51ce970..914bf79 100644 --- a/docs/SearchCatalogObjectsRequest.md +++ b/docs/SearchCatalogObjectsRequest.md @@ -9,10 +9,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Cursor** | **string** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**ObjectTypes** | **List** | The desired set of object types to appear in the search results. The legal values are taken from the `CatalogObjectType` enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values | [optional] +**ObjectTypes** | **List** | The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values | [optional] **IncludeDeletedObjects** | **bool?** | If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`. | [optional] -**IncludeRelatedObjects** | **bool?** | If `true`, the response will include additional objects that are related to the requested object, as follows: If a `CatalogItem` is returned in the object field of the response, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be included in the `related_objects` field of the response. If a `CatalogItemVariation` is returned in the object field of the response, its parent `CatalogItem` will be included in the `related_objects` field of the response. | [optional] -**BeginTime** | **string** | Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. | [optional] +**IncludeRelatedObjects** | **bool?** | If `true`, the response will include additional objects that are related to the requested object, as follows: If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response. If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response. | [optional] +**BeginTime** | **string** | Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. | [optional] **Query** | [**CatalogQuery**](CatalogQuery.md) | A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. | [optional] **Limit** | **int?** | 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 2b0f395..c3846c5 100644 --- a/docs/SearchCatalogObjectsResponse.md +++ b/docs/SearchCatalogObjectsResponse.md @@ -8,11 +8,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] +**Errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] **Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**Objects** | [**List<CatalogObject>**](CatalogObject.md) | The `CatalogObject`s returned. | [optional] -**RelatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s referenced by the objects in the `objects` field. | [optional] -**LatestTime** | **string** | When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. | [optional] [beta] +**Objects** | [**List<CatalogObject>**](CatalogObject.md) | The CatalogObjects returned. | [optional] +**RelatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects referenced by the objects in the `objects` field. | [optional] +**LatestTime** | **string** | When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. | [optional] [beta] diff --git a/docs/SearchCustomersRequest.md b/docs/SearchCustomersRequest.md index eadac5b..be37242 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 Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Cursor** | **string** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] **Limit** | **long?** | A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored. | [optional] **Query** | [**CustomerQuery**](CustomerQuery.md) | Query customers based on the given conditions and sort order. Calling SearchCustomers without an explicit query parameter will return all customers ordered alphabetically based on `given_name` and `family_name`. | [optional] diff --git a/docs/SearchCustomersResponse.md b/docs/SearchCustomersResponse.md index 707465e..0dcea43 100644 --- a/docs/SearchCustomersResponse.md +++ b/docs/SearchCustomersResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] **Customers** | [**List<Customer>**](Customer.md) | An array of `Customer` objects that match a query. | [optional] -**Cursor** | **string** | A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**Cursor** | **string** | A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] diff --git a/docs/Shift.md b/docs/Shift.md index e1dd4af..8dd3604 100644 --- a/docs/Shift.md +++ b/docs/Shift.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **Timezone** | **string** | Read-only convenience value that is calculated from the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone. | [optional] **StartAt** | **string** | RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated. | **EndAt** | **string** | RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the shift length is calculated. For example, a shift from `00:00` to `08:01` is considered an 8 hour shift (midnight to 8am). | [optional] -**Wage** | [**ShiftWage**](ShiftWage.md) | Job and pay related information. | [optional] +**Wage** | [**ShiftWage**](ShiftWage.md) | Job and pay related information. If wage is not set on create, will default to a wage of zero money. If title is not set on create, will default to the name of the role the employee is assigned to, if any. | [optional] **Breaks** | [**List<ModelBreak>**](ModelBreak.md) | A list of any paid or unpaid breaks that were taken during this shift. | [optional] **Status** | **string** | Describes working state of the current `Shift`. See [ShiftStatus](#type-shiftstatus) for possible values | [optional] **Version** | **int?** | Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write. | [optional] diff --git a/docs/ShiftFilter.md b/docs/ShiftFilter.md index 97594c2..4d498f4 100644 --- a/docs/ShiftFilter.md +++ b/docs/ShiftFilter.md @@ -8,8 +8,8 @@ Defines a filter used in a search for `Shift` records. `AND` logic is used by Sq Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**LocationId** | **List** | Fetch shifts for the specified location. | [optional] -**EmployeeId** | **List** | Fetch shifts for the specified employee. | [optional] +**LocationIds** | **List** | Fetch shifts for the specified location. | [optional] +**EmployeeIds** | **List** | Fetch shifts for the specified employee. | [optional] **Status** | **string** | Fetch a `Shift` instance by `Shift.status`. See [ShiftFilterStatus](#type-shiftfilterstatus) for possible values | [optional] **Start** | [**TimeRange**](TimeRange.md) | Fetch `Shift`s that start in the time range - Inclusive. | [optional] **End** | [**TimeRange**](TimeRange.md) | Fetch the `Shift`s that end in the time range - Inclusive. | [optional] diff --git a/docs/StandardUnitDescription.md b/docs/StandardUnitDescription.md index 88cde2b..f0dcac7 100644 --- a/docs/StandardUnitDescription.md +++ b/docs/StandardUnitDescription.md @@ -9,8 +9,8 @@ Contains the name and abbreviation for standard measurement unit. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Unit** | [**MeasurementUnit**](MeasurementUnit.md) | Identifies the measurement unit being described. | [optional] -**Name** | **string** | Display name of the measurement unit. For example, 'Pound'. | [optional] -**Abbreviation** | **string** | Abbreviation for the measurement unit. For example, 'lb'. | [optional] +**Name** | **string** | UI display name of the measurement unit. For example, 'Pound'. | [optional] +**Abbreviation** | **string** | UI display abbreviation for the measurement unit. For example, 'lb'. | [optional] diff --git a/docs/StandardUnitDescriptionGroup.md b/docs/StandardUnitDescriptionGroup.md index ad788f7..2240316 100644 --- a/docs/StandardUnitDescriptionGroup.md +++ b/docs/StandardUnitDescriptionGroup.md @@ -8,7 +8,7 @@ Group of standard measurement units. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**StandardUnitDescriptions** | [**List<StandardUnitDescription>**](StandardUnitDescription.md) | List of measurement units in this description group. | [optional] +**StandardUnitDescriptions** | [**List<StandardUnitDescription>**](StandardUnitDescription.md) | List of standard (non-custom) measurement units in this description group. | [optional] **LanguageCode** | **string** | IETF language tag. | [optional] diff --git a/docs/TaxInclusionType.md b/docs/TaxInclusionType.md index c94e8bb..806033c 100644 --- a/docs/TaxInclusionType.md +++ b/docs/TaxInclusionType.md @@ -2,7 +2,7 @@ ### Description -Whether to the tax amount should be additional to or included in to the `CatalogItem` price. +Whether to the tax amount should be additional to or included in the CatalogItem price. ## Properties diff --git a/docs/TenderCardDetails.md b/docs/TenderCardDetails.md index 336a3fa..199de83 100644 --- a/docs/TenderCardDetails.md +++ b/docs/TenderCardDetails.md @@ -8,7 +8,7 @@ Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CAR Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Status** | **string** | The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values | [optional] +**Status** | **string** | The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See `TenderCardDetailsStatus` for possible values. See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values | [optional] **Card** | [**Card**](Card.md) | The credit card's non-confidential details. | [optional] **EntryMethod** | **string** | The method used to enter the card's details for the transaction. See [TenderCardDetailsEntryMethod](#type-tendercarddetailsentrymethod) for possible values | [optional] diff --git a/docs/TransactionsApi.md b/docs/TransactionsApi.md index 7f1d4d6..1fb20dc 100644 --- a/docs/TransactionsApi.md +++ b/docs/TransactionsApi.md @@ -20,7 +20,7 @@ Method | HTTP request | Description CaptureTransaction -Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. +Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. ### Example ```csharp @@ -88,7 +88,7 @@ Name | Type | Description | Notes Charge -Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. +Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. ### Example ```csharp @@ -251,7 +251,7 @@ namespace Example var 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. (optional) var 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. (optional) var 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` (optional) - var 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. (optional) + var cursor = cursor_example; // string | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) try { @@ -276,7 +276,7 @@ Name | Type | Description | Notes **beginTime** | **string**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **string**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **string**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] ### Return type @@ -325,7 +325,7 @@ namespace Example var 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. (optional) var 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. (optional) var 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` (optional) - var 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. (optional) + var cursor = cursor_example; // string | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) try { @@ -350,7 +350,7 @@ Name | Type | Description | Notes **beginTime** | **string**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional] **endTime** | **string**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional] **sortOrder** | **string**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] + **cursor** | **string**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. | [optional] ### Return type @@ -442,7 +442,7 @@ Name | Type | Description | Notes VoidTransaction -Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. +Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. ### Example ```csharp diff --git a/docs/UpdateBreakTypeRequest.md b/docs/UpdateBreakTypeRequest.md index d9ba618..35882bb 100644 --- a/docs/UpdateBreakTypeRequest.md +++ b/docs/UpdateBreakTypeRequest.md @@ -8,7 +8,7 @@ A request to update a `BreakType` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BreakType** | [**BreakType**](BreakType.md) | The updated `BreakType`. | [optional] +**BreakType** | [**BreakType**](BreakType.md) | The updated `BreakType`. | diff --git a/docs/UpdateCustomerRequest.md b/docs/UpdateCustomerRequest.md index 9a322b1..df2bf54 100644 --- a/docs/UpdateCustomerRequest.md +++ b/docs/UpdateCustomerRequest.md @@ -8,16 +8,16 @@ Defines the body parameters that can be provided in a request to the UpdateCusto Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GivenName** | **string** | The customer's given (i.e., first) name. | [optional] -**FamilyName** | **string** | The customer's family (i.e., last) name. | [optional] -**CompanyName** | **string** | The name of the customer's company. | [optional] -**Nickname** | **string** | A nickname for the customer. | [optional] -**EmailAddress** | **string** | The customer's email address. | [optional] -**Address** | [**Address**](Address.md) | The customer's physical address. | [optional] -**PhoneNumber** | **string** | The customer's phone number. | [optional] -**ReferenceId** | **string** | An optional second ID you can set to associate the customer with an entity in another system. | [optional] -**Note** | **string** | An optional note to associate with the customer. | [optional] -**Birthday** | **string** | The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. | [optional] +**GivenName** | **string** | The given (i.e., first) name associated with the customer profile. | [optional] +**FamilyName** | **string** | The family (i.e., last) name associated with the customer profile. | [optional] +**CompanyName** | **string** | A business name associated with the customer profile. | [optional] +**Nickname** | **string** | A nickname for the customer profile. | [optional] +**EmailAddress** | **string** | The email address associated with the customer profile. | [optional] +**Address** | [**Address**](Address.md) | The physical address associated with the customer profile. | [optional] +**PhoneNumber** | **string** | The 11-digit phone number associated with the customer profile. | [optional] +**ReferenceId** | **string** | An optional, second ID used to associate the customer profile with an entity in another system. | [optional] +**Note** | **string** | A custom note associated with the customer profile. | [optional] +**Birthday** | **string** | The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. | [optional] diff --git a/docs/UpdateItemModifierListsRequest.md b/docs/UpdateItemModifierListsRequest.md index 5e0f335..01e801e 100644 --- a/docs/UpdateItemModifierListsRequest.md +++ b/docs/UpdateItemModifierListsRequest.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ItemIds** | **List** | The `CatalogItem](#type-catalogitem)s whose [CatalogModifierList`s are being updated. | -**ModifierListsToEnable** | **List** | The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem`. | [optional] -**ModifierListsToDisable** | **List** | The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem`. | [optional] +**ItemIds** | **List** | The IDs of the catalog items associated with the CatalogModifierList objects being updated. | +**ModifierListsToEnable** | **List** | The IDs of the CatalogModifierList objects to enable for the CatalogItem. | [optional] +**ModifierListsToDisable** | **List** | The IDs of the CatalogModifierList objects to disable for the CatalogItem. | [optional] diff --git a/docs/UpdateItemModifierListsResponse.md b/docs/UpdateItemModifierListsResponse.md index 8961d31..e29d012 100644 --- a/docs/UpdateItemModifierListsResponse.md +++ b/docs/UpdateItemModifierListsResponse.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**UpdatedAt** | **string** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**Errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**UpdatedAt** | **string** | | [optional] diff --git a/docs/UpdateItemTaxesRequest.md b/docs/UpdateItemTaxesRequest.md index c409395..15284c2 100644 --- a/docs/UpdateItemTaxesRequest.md +++ b/docs/UpdateItemTaxesRequest.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ItemIds** | **List** | The `CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax`es are being updated. | -**TaxesToEnable** | **List** | The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem`. | [optional] -**TaxesToDisable** | **List** | The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem`. | [optional] +**ItemIds** | **List** | IDs for the CatalogItems associated with the CatalogTax objects being updated. | +**TaxesToEnable** | **List** | IDs of the CatalogTax objects to enable. | [optional] +**TaxesToDisable** | **List** | IDs of the CatalogTax objects to disable. | [optional] diff --git a/docs/UpdateItemTaxesResponse.md b/docs/UpdateItemTaxesResponse.md index 0ae8877..01b8ab1 100644 --- a/docs/UpdateItemTaxesResponse.md +++ b/docs/UpdateItemTaxesResponse.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**UpdatedAt** | **string** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**Errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**UpdatedAt** | **string** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-date) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. | [optional] diff --git a/docs/UpdateWorkweekConfigRequest.md b/docs/UpdateWorkweekConfigRequest.md index f3f6d81..b8a5e30 100644 --- a/docs/UpdateWorkweekConfigRequest.md +++ b/docs/UpdateWorkweekConfigRequest.md @@ -8,7 +8,7 @@ A request to update a `WorkweekConfig` object Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**WorkweekConfig** | [**WorkweekConfig**](WorkweekConfig.md) | The updated `WorkweekConfig` object. | [optional] +**WorkweekConfig** | [**WorkweekConfig**](WorkweekConfig.md) | The updated `WorkweekConfig` object. | diff --git a/docs/UpsertCatalogObjectRequest.md b/docs/UpsertCatalogObjectRequest.md index cc36f34..0584186 100644 --- a/docs/UpsertCatalogObjectRequest.md +++ b/docs/UpsertCatalogObjectRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **IdempotencyKey** | **string** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | -**_Object** | [**CatalogObject**](CatalogObject.md) | A `CatalogObject` to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. | +**_Object** | [**CatalogObject**](CatalogObject.md) | A CatalogObject to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. | diff --git a/docs/UpsertCatalogObjectResponse.md b/docs/UpsertCatalogObjectResponse.md index 1bc270c..72a707e 100644 --- a/docs/UpsertCatalogObjectResponse.md +++ b/docs/UpsertCatalogObjectResponse.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] -**CatalogObject** | [**CatalogObject**](CatalogObject.md) | The created `CatalogObject`. | [optional] -**IdMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this Upsert. | [optional] +**Errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] +**CatalogObject** | [**CatalogObject**](CatalogObject.md) | The successfully created or updated CatalogObject. | [optional] +**IdMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this upsert. | [optional] diff --git a/docs/V1AdjustInventoryRequest.md b/docs/V1AdjustInventoryRequest.md index b089572..677dcb8 100644 --- a/docs/V1AdjustInventoryRequest.md +++ b/docs/V1AdjustInventoryRequest.md @@ -3,6 +3,7 @@ ### Description V1AdjustInventoryRequest +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1AdjustInventoryRequestAdjustmentType.md b/docs/V1AdjustInventoryRequestAdjustmentType.md index 9242cd2..01b0dd5 100644 --- a/docs/V1AdjustInventoryRequestAdjustmentType.md +++ b/docs/V1AdjustInventoryRequestAdjustmentType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ApplyFeeRequest.md b/docs/V1ApplyFeeRequest.md index 28b5e62..e9290ca 100644 --- a/docs/V1ApplyFeeRequest.md +++ b/docs/V1ApplyFeeRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ApplyModifierListRequest.md b/docs/V1ApplyModifierListRequest.md index ed2b567..18b624d 100644 --- a/docs/V1ApplyModifierListRequest.md +++ b/docs/V1ApplyModifierListRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1Category.md b/docs/V1Category.md index 8c9deee..03f0440 100644 --- a/docs/V1Category.md +++ b/docs/V1Category.md @@ -3,6 +3,7 @@ ### Description V1Category +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1CreateCategoryRequest.md b/docs/V1CreateCategoryRequest.md index 8fe7cca..412ed37 100644 --- a/docs/V1CreateCategoryRequest.md +++ b/docs/V1CreateCategoryRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1CreateDiscountRequest.md b/docs/V1CreateDiscountRequest.md index 614fb7c..ae38f37 100644 --- a/docs/V1CreateDiscountRequest.md +++ b/docs/V1CreateDiscountRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1CreateFeeRequest.md b/docs/V1CreateFeeRequest.md index bd8adee..a27f892 100644 --- a/docs/V1CreateFeeRequest.md +++ b/docs/V1CreateFeeRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1CreateItemRequest.md b/docs/V1CreateItemRequest.md index 7db8e6d..dccf393 100644 --- a/docs/V1CreateItemRequest.md +++ b/docs/V1CreateItemRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1CreateModifierListRequest.md b/docs/V1CreateModifierListRequest.md index 5fa7436..60d632d 100644 --- a/docs/V1CreateModifierListRequest.md +++ b/docs/V1CreateModifierListRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1CreateModifierOptionRequest.md b/docs/V1CreateModifierOptionRequest.md index 14eddb8..4349515 100644 --- a/docs/V1CreateModifierOptionRequest.md +++ b/docs/V1CreateModifierOptionRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1CreatePageRequest.md b/docs/V1CreatePageRequest.md index 9bda825..5e0c850 100644 --- a/docs/V1CreatePageRequest.md +++ b/docs/V1CreatePageRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1CreateVariationRequest.md b/docs/V1CreateVariationRequest.md index da7dc04..2299abe 100644 --- a/docs/V1CreateVariationRequest.md +++ b/docs/V1CreateVariationRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DeleteCategoryRequest.md b/docs/V1DeleteCategoryRequest.md index 86362a2..cae7f06 100644 --- a/docs/V1DeleteCategoryRequest.md +++ b/docs/V1DeleteCategoryRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DeleteDiscountRequest.md b/docs/V1DeleteDiscountRequest.md index 78aa413..c1532ff 100644 --- a/docs/V1DeleteDiscountRequest.md +++ b/docs/V1DeleteDiscountRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DeleteFeeRequest.md b/docs/V1DeleteFeeRequest.md index 0560dc3..eefeaac 100644 --- a/docs/V1DeleteFeeRequest.md +++ b/docs/V1DeleteFeeRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DeleteItemRequest.md b/docs/V1DeleteItemRequest.md index 8ddfd78..425447f 100644 --- a/docs/V1DeleteItemRequest.md +++ b/docs/V1DeleteItemRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DeleteModifierListRequest.md b/docs/V1DeleteModifierListRequest.md index 3acaed5..3f70ad4 100644 --- a/docs/V1DeleteModifierListRequest.md +++ b/docs/V1DeleteModifierListRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DeleteModifierOptionRequest.md b/docs/V1DeleteModifierOptionRequest.md index ce6c96a..28cb7e4 100644 --- a/docs/V1DeleteModifierOptionRequest.md +++ b/docs/V1DeleteModifierOptionRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DeletePageCellRequest.md b/docs/V1DeletePageCellRequest.md index fc6c207..d9c3817 100644 --- a/docs/V1DeletePageCellRequest.md +++ b/docs/V1DeletePageCellRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DeletePageRequest.md b/docs/V1DeletePageRequest.md index 1fce4db..99f7ca2 100644 --- a/docs/V1DeletePageRequest.md +++ b/docs/V1DeletePageRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DeleteVariationRequest.md b/docs/V1DeleteVariationRequest.md index 6b8a04a..5fac758 100644 --- a/docs/V1DeleteVariationRequest.md +++ b/docs/V1DeleteVariationRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1Discount.md b/docs/V1Discount.md index 7dc8bdb..add315c 100644 --- a/docs/V1Discount.md +++ b/docs/V1Discount.md @@ -3,6 +3,7 @@ ### Description V1Discount +**Note: This model is deprecated.** ## Properties @@ -14,7 +15,7 @@ Name | Type | Description | Notes **AmountMoney** | [**V1Money**](V1Money.md) | The amount of the discount. This amount is 0 if discount_type is VARIABLE_AMOUNT. This field is not included for rate-based discounts. | [optional] **DiscountType** | **string** | Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values | [optional] **PinRequired** | **bool?** | Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment. | [optional] -**Color** | **string** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values | [optional] +**Color** | **string** | The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values | [optional] **V2Id** | **string** | The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. | [optional] diff --git a/docs/V1DiscountColor.md b/docs/V1DiscountColor.md index 15c311d..b2e05fb 100644 --- a/docs/V1DiscountColor.md +++ b/docs/V1DiscountColor.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1DiscountDiscountType.md b/docs/V1DiscountDiscountType.md index 7b2725e..df82648 100644 --- a/docs/V1DiscountDiscountType.md +++ b/docs/V1DiscountDiscountType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1Fee.md b/docs/V1Fee.md index 8f92168..b5fd27b 100644 --- a/docs/V1Fee.md +++ b/docs/V1Fee.md @@ -3,6 +3,7 @@ ### Description V1Fee +**Note: This model is deprecated.** ## Properties @@ -13,7 +14,7 @@ Name | Type | Description | Notes **Rate** | **string** | The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. | [optional] **CalculationPhase** | **string** | Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values | [optional] **AdjustmentType** | **string** | The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values | [optional] -**AppliesToCustomAmounts** | **bool?** | If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item. | [optional] +**AppliesToCustomAmounts** | **bool?** | If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item. | [optional] **Enabled** | **bool?** | If true, the fee is applied to all appropriate items. If false, the fee is not applied at all. | [optional] **InclusionType** | **string** | Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values | [optional] **Type** | **string** | In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values | [optional] diff --git a/docs/V1FeeAdjustmentType.md b/docs/V1FeeAdjustmentType.md index 274d7ab..a7ca029 100644 --- a/docs/V1FeeAdjustmentType.md +++ b/docs/V1FeeAdjustmentType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1FeeCalculationPhase.md b/docs/V1FeeCalculationPhase.md index e4573b6..d194699 100644 --- a/docs/V1FeeCalculationPhase.md +++ b/docs/V1FeeCalculationPhase.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1FeeInclusionType.md b/docs/V1FeeInclusionType.md index 79556c8..001509f 100644 --- a/docs/V1FeeInclusionType.md +++ b/docs/V1FeeInclusionType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1FeeType.md b/docs/V1FeeType.md index 528e7c0..669fd5b 100644 --- a/docs/V1FeeType.md +++ b/docs/V1FeeType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1InventoryEntry.md b/docs/V1InventoryEntry.md index 2093182..29c26b0 100644 --- a/docs/V1InventoryEntry.md +++ b/docs/V1InventoryEntry.md @@ -3,6 +3,7 @@ ### Description V1InventoryEntry +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1Item.md b/docs/V1Item.md index ac0c19a..d40bfbe 100644 --- a/docs/V1Item.md +++ b/docs/V1Item.md @@ -3,6 +3,7 @@ ### Description V1Item +**Note: This model is deprecated.** ## Properties @@ -12,8 +13,8 @@ Name | Type | Description | Notes **Name** | **string** | The item's name. | [optional] **Description** | **string** | The item's description. | [optional] **Type** | **string** | The item's type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values | [optional] -**Color** | **string** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values | [optional] -**Abbreviation** | **string** | The text of the item's display label in Square Register. Only up to the first five characters of the string are used. | [optional] +**Color** | **string** | The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values | [optional] +**Abbreviation** | **string** | The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used. | [optional] **Visibility** | **string** | Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values | [optional] **AvailableOnline** | **bool?** | If true, the item can be added to shipping orders from the merchant's online store. | [optional] **MasterImage** | [**V1ItemImage**](V1ItemImage.md) | The item's master image, if any. | [optional] diff --git a/docs/V1ItemColor.md b/docs/V1ItemColor.md index 6738c7d..e724603 100644 --- a/docs/V1ItemColor.md +++ b/docs/V1ItemColor.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ItemImage.md b/docs/V1ItemImage.md index abbf2c1..44d8295 100644 --- a/docs/V1ItemImage.md +++ b/docs/V1ItemImage.md @@ -3,6 +3,7 @@ ### Description V1ItemImage +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ItemType.md b/docs/V1ItemType.md index 288627d..d1420fd 100644 --- a/docs/V1ItemType.md +++ b/docs/V1ItemType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ItemVisibility.md b/docs/V1ItemVisibility.md index 48c8940..b29cfa1 100644 --- a/docs/V1ItemVisibility.md +++ b/docs/V1ItemVisibility.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ItemsApi.md b/docs/V1ItemsApi.md index 4f615d3..91685fe 100644 --- a/docs/V1ItemsApi.md +++ b/docs/V1ItemsApi.md @@ -48,11 +48,12 @@ Method | HTTP request | Description # **AdjustInventory** +**Note: This endpoint is deprecated.** > V1InventoryEntry AdjustInventory (string locationId, string variationId, V1AdjustInventoryRequest body) AdjustInventory -Adjusts an item variation's current available inventory. +Adjusts the current available inventory of an item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -117,11 +118,12 @@ Name | Type | Description | Notes # **ApplyFee** +**Note: This endpoint is deprecated.** > V1Item ApplyFee (string locationId, string itemId, string feeId) ApplyFee -Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. +Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -186,11 +188,12 @@ Name | Type | Description | Notes # **ApplyModifierList** +**Note: This endpoint is deprecated.** > V1Item ApplyModifierList (string locationId, string modifierListId, string itemId) ApplyModifierList -Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. +Associates a modifier list with an item so the associated modifier options can be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -255,11 +258,12 @@ Name | Type | Description | Notes # **CreateCategory** +**Note: This endpoint is deprecated.** > V1Category CreateCategory (string locationId, V1Category body) CreateCategory -Creates an item category. +Creates an item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -322,11 +326,12 @@ Name | Type | Description | Notes # **CreateDiscount** +**Note: This endpoint is deprecated.** > V1Discount CreateDiscount (string locationId, V1Discount body) CreateDiscount -Creates a discount. +Creates a discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -389,11 +394,12 @@ Name | Type | Description | Notes # **CreateFee** +**Note: This endpoint is deprecated.** > V1Fee CreateFee (string locationId, V1Fee body) CreateFee -Creates a fee (tax). +Creates a fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -456,11 +462,12 @@ Name | Type | Description | Notes # **CreateItem** +**Note: This endpoint is deprecated.** > V1Item CreateItem (string locationId, V1Item body) CreateItem -Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. +Creates an item and at least one variation for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. ### Example ```csharp @@ -523,11 +530,12 @@ Name | Type | Description | Notes # **CreateModifierList** +**Note: This endpoint is deprecated.** > V1ModifierList CreateModifierList (string locationId, V1ModifierList body) CreateModifierList -Creates an item modifier list and at least one modifier option for it. +Creates an item modifier list and at least 1 modifier option for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -590,11 +598,12 @@ Name | Type | Description | Notes # **CreateModifierOption** +**Note: This endpoint is deprecated.** > V1ModifierOption CreateModifierOption (string locationId, string modifierListId, V1ModifierOption body) CreateModifierOption -Creates an item modifier option and adds it to a modifier list. +Creates an item modifier option and adds it to a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -659,11 +668,12 @@ Name | Type | Description | Notes # **CreatePage** +**Note: This endpoint is deprecated.** > V1Page CreatePage (string locationId, V1Page body) CreatePage -Creates a Favorites page in Square Register. +Creates a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -726,11 +736,12 @@ Name | Type | Description | Notes # **CreateVariation** +**Note: This endpoint is deprecated.** > V1Variation CreateVariation (string locationId, string itemId, V1Variation body) CreateVariation -Creates an item variation for an existing item. +Creates an item variation for an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -795,11 +806,12 @@ Name | Type | Description | Notes # **DeleteCategory** +**Note: This endpoint is deprecated.** > V1Category DeleteCategory (string locationId, string categoryId) DeleteCategory -Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. +Deletes an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. ### Example ```csharp @@ -862,11 +874,12 @@ Name | Type | Description | Notes # **DeleteDiscount** +**Note: This endpoint is deprecated.** > V1Discount DeleteDiscount (string locationId, string discountId) DeleteDiscount -Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. +Deletes an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. ### Example ```csharp @@ -929,11 +942,12 @@ Name | Type | Description | Notes # **DeleteFee** +**Note: This endpoint is deprecated.** > V1Fee DeleteFee (string locationId, string feeId) DeleteFee -Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. +Deletes an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. ### Example ```csharp @@ -996,11 +1010,12 @@ Name | Type | Description | Notes # **DeleteItem** +**Note: This endpoint is deprecated.** > V1Item DeleteItem (string locationId, string itemId) DeleteItem -Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. +Deletes an existing item and all item variations associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. ### Example ```csharp @@ -1063,11 +1078,12 @@ Name | Type | Description | Notes # **DeleteModifierList** +**Note: This endpoint is deprecated.** > V1ModifierList DeleteModifierList (string locationId, string modifierListId) DeleteModifierList -Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. +Deletes an existing item modifier list and all modifier options associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. ### Example ```csharp @@ -1130,11 +1146,12 @@ Name | Type | Description | Notes # **DeleteModifierOption** +**Note: This endpoint is deprecated.** > V1ModifierOption DeleteModifierOption (string locationId, string modifierListId, string modifierOptionId) DeleteModifierOption -Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. +Deletes an existing item modifier option from a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. ### Example ```csharp @@ -1199,11 +1216,12 @@ Name | Type | Description | Notes # **DeletePage** +**Note: This endpoint is deprecated.** > V1Page DeletePage (string locationId, string pageId) DeletePage -Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. +Deletes an existing Favorites page and all of its cells. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. ### Example ```csharp @@ -1266,11 +1284,12 @@ Name | Type | Description | Notes # **DeletePageCell** +**Note: This endpoint is deprecated.** > V1Page DeletePageCell (string locationId, string pageId, string row = null, string column = null) DeletePageCell -Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. +Deletes a cell from a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. ### Example ```csharp @@ -1337,11 +1356,12 @@ Name | Type | Description | Notes # **DeleteVariation** +**Note: This endpoint is deprecated.** > V1Variation DeleteVariation (string locationId, string itemId, string variationId) DeleteVariation -Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. +Deletes an existing item variation from an item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. ### Example ```csharp @@ -1406,11 +1426,12 @@ Name | Type | Description | Notes # **ListCategories** +**Note: This endpoint is deprecated.** > List ListCategories (string locationId) ListCategories -Lists all of a location's item categories. +Lists all the item categories for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -1471,11 +1492,12 @@ Name | Type | Description | Notes # **ListDiscounts** +**Note: This endpoint is deprecated.** > List ListDiscounts (string locationId) ListDiscounts -Lists all of a location's discounts. +Lists all the discounts for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -1536,11 +1558,12 @@ Name | Type | Description | Notes # **ListFees** +**Note: This endpoint is deprecated.** > List ListFees (string locationId) ListFees -Lists all of a location's fees (taxes). +Lists all the fees (taxes) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -1601,11 +1624,12 @@ Name | Type | Description | Notes # **ListInventory** +**Note: This endpoint is deprecated.** > List ListInventory (string locationId, int? limit = null, string batchToken = null) ListInventory -Provides inventory information for all of a merchant's inventory-enabled item variations. +Provides inventory information for all inventory-enabled item variations. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -1670,11 +1694,12 @@ Name | Type | Description | Notes # **ListItems** +**Note: This endpoint is deprecated.** > List ListItems (string locationId, string batchToken = null) ListItems -Provides summary information for all of a location's items. +Provides summary information of all items for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -1737,11 +1762,12 @@ Name | Type | Description | Notes # **ListModifierLists** +**Note: This endpoint is deprecated.** > List ListModifierLists (string locationId) ListModifierLists -Lists all of a location's modifier lists. +Lists all the modifier lists for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -1802,11 +1828,12 @@ Name | Type | Description | Notes # **ListPages** +**Note: This endpoint is deprecated.** > List ListPages (string locationId) ListPages -Lists all of a location's Favorites pages in Square Register. +Lists all Favorites pages (in Square Point of Sale) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -1867,11 +1894,12 @@ Name | Type | Description | Notes # **RemoveFee** +**Note: This endpoint is deprecated.** > V1Item RemoveFee (string locationId, string itemId, string feeId) RemoveFee -Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. +Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -1936,11 +1964,12 @@ Name | Type | Description | Notes # **RemoveModifierList** +**Note: This endpoint is deprecated.** > V1Item RemoveModifierList (string locationId, string modifierListId, string itemId) RemoveModifierList -Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. +Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2005,11 +2034,12 @@ Name | Type | Description | Notes # **RetrieveItem** +**Note: This endpoint is deprecated.** > V1Item RetrieveItem (string locationId, string itemId) RetrieveItem -Provides the details for a single item, including associated modifier lists and fees. +Provides the details for a single item, including associated modifier lists and fees. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2072,11 +2102,12 @@ Name | Type | Description | Notes # **RetrieveModifierList** +**Note: This endpoint is deprecated.** > V1ModifierList RetrieveModifierList (string locationId, string modifierListId) RetrieveModifierList -Provides the details for a single modifier list. +Provides the details for a single modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2139,11 +2170,12 @@ Name | Type | Description | Notes # **UpdateCategory** +**Note: This endpoint is deprecated.** > V1Category UpdateCategory (string locationId, string categoryId, V1Category body) UpdateCategory -Modifies the details of an existing item category. +Modifies the details of an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2208,11 +2240,12 @@ Name | Type | Description | Notes # **UpdateDiscount** +**Note: This endpoint is deprecated.** > V1Discount UpdateDiscount (string locationId, string discountId, V1Discount body) UpdateDiscount -Modifies the details of an existing discount. +Modifies the details of an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2277,11 +2310,12 @@ Name | Type | Description | Notes # **UpdateFee** +**Note: This endpoint is deprecated.** > V1Fee UpdateFee (string locationId, string feeId, V1Fee body) UpdateFee -Modifies the details of an existing fee (tax). +Modifies the details of an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2346,11 +2380,12 @@ Name | Type | Description | Notes # **UpdateItem** +**Note: This endpoint is deprecated.** > V1Item UpdateItem (string locationId, string itemId, V1Item body) UpdateItem -Modifies the core details of an existing item. +Modifies the core details of an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2415,11 +2450,12 @@ Name | Type | Description | Notes # **UpdateModifierList** +**Note: This endpoint is deprecated.** > V1ModifierList UpdateModifierList (string locationId, string modifierListId, V1UpdateModifierListRequest body) UpdateModifierList -Modifies the details of an existing item modifier list. +Modifies the details of an existing item modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2484,11 +2520,12 @@ Name | Type | Description | Notes # **UpdateModifierOption** +**Note: This endpoint is deprecated.** > V1ModifierOption UpdateModifierOption (string locationId, string modifierListId, string modifierOptionId, V1ModifierOption body) UpdateModifierOption -Modifies the details of an existing item modifier option. +Modifies the details of an existing item modifier option. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2555,11 +2592,12 @@ Name | Type | Description | Notes # **UpdatePage** +**Note: This endpoint is deprecated.** > V1Page UpdatePage (string locationId, string pageId, V1Page body) UpdatePage -Modifies the details of a Favorites page in Square Register. +Modifies the details of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2624,11 +2662,12 @@ Name | Type | Description | Notes # **UpdatePageCell** +**Note: This endpoint is deprecated.** > V1Page UpdatePageCell (string locationId, string pageId, V1PageCell body) UpdatePageCell -Modifies a cell of a Favorites page in Square Register. +Modifies a cell of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp @@ -2693,11 +2732,12 @@ Name | Type | Description | Notes # **UpdateVariation** +**Note: This endpoint is deprecated.** > V1Variation UpdateVariation (string locationId, string itemId, string variationId, V1Variation body) UpdateVariation -Modifies the details of an existing item variation. +Modifies the details of an existing item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- ### Example ```csharp diff --git a/docs/V1ListCategoriesRequest.md b/docs/V1ListCategoriesRequest.md index 533996e..9decd6a 100644 --- a/docs/V1ListCategoriesRequest.md +++ b/docs/V1ListCategoriesRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListCategoriesResponse.md b/docs/V1ListCategoriesResponse.md index 1fc3798..d880f6b 100644 --- a/docs/V1ListCategoriesResponse.md +++ b/docs/V1ListCategoriesResponse.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListDiscountsRequest.md b/docs/V1ListDiscountsRequest.md index 60a475f..0ada0e5 100644 --- a/docs/V1ListDiscountsRequest.md +++ b/docs/V1ListDiscountsRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListDiscountsResponse.md b/docs/V1ListDiscountsResponse.md index 0eb2f64..a8ebae2 100644 --- a/docs/V1ListDiscountsResponse.md +++ b/docs/V1ListDiscountsResponse.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListFeesRequest.md b/docs/V1ListFeesRequest.md index dd148f9..f7a8f95 100644 --- a/docs/V1ListFeesRequest.md +++ b/docs/V1ListFeesRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListFeesResponse.md b/docs/V1ListFeesResponse.md index cae6d3e..2eb1452 100644 --- a/docs/V1ListFeesResponse.md +++ b/docs/V1ListFeesResponse.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListInventoryRequest.md b/docs/V1ListInventoryRequest.md index 56162a0..3feff20 100644 --- a/docs/V1ListInventoryRequest.md +++ b/docs/V1ListInventoryRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListInventoryResponse.md b/docs/V1ListInventoryResponse.md index de85a31..002f735 100644 --- a/docs/V1ListInventoryResponse.md +++ b/docs/V1ListInventoryResponse.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListItemsRequest.md b/docs/V1ListItemsRequest.md index 5c19398..dac6ac3 100644 --- a/docs/V1ListItemsRequest.md +++ b/docs/V1ListItemsRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListItemsResponse.md b/docs/V1ListItemsResponse.md index 68f4506..11cea7b 100644 --- a/docs/V1ListItemsResponse.md +++ b/docs/V1ListItemsResponse.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListLocationsRequest.md b/docs/V1ListLocationsRequest.md index 11908ee..46040a7 100644 --- a/docs/V1ListLocationsRequest.md +++ b/docs/V1ListLocationsRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListLocationsResponse.md b/docs/V1ListLocationsResponse.md index 8c55c00..5ff8488 100644 --- a/docs/V1ListLocationsResponse.md +++ b/docs/V1ListLocationsResponse.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListModifierListsRequest.md b/docs/V1ListModifierListsRequest.md index 30e0756..771b71d 100644 --- a/docs/V1ListModifierListsRequest.md +++ b/docs/V1ListModifierListsRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListModifierListsResponse.md b/docs/V1ListModifierListsResponse.md index 37f8439..2715541 100644 --- a/docs/V1ListModifierListsResponse.md +++ b/docs/V1ListModifierListsResponse.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListPagesRequest.md b/docs/V1ListPagesRequest.md index a3ccd98..6d05028 100644 --- a/docs/V1ListPagesRequest.md +++ b/docs/V1ListPagesRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ListPagesResponse.md b/docs/V1ListPagesResponse.md index 7e93b24..698ac60 100644 --- a/docs/V1ListPagesResponse.md +++ b/docs/V1ListPagesResponse.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1LocationsApi.md b/docs/V1LocationsApi.md index 2474e18..785dcb7 100644 --- a/docs/V1LocationsApi.md +++ b/docs/V1LocationsApi.md @@ -10,11 +10,12 @@ Method | HTTP request | Description # **ListLocations** +**Note: This endpoint is deprecated.** > List ListLocations () ListLocations -Provides details for a business's locations, including their IDs. +Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- ### Example ```csharp @@ -71,11 +72,12 @@ This endpoint does not need any parameter. # **RetrieveBusiness** +**Note: This endpoint is deprecated.** > V1Merchant RetrieveBusiness () RetrieveBusiness -Get a business's information. +Get the general information for a business. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- ### Example ```csharp diff --git a/docs/V1Merchant.md b/docs/V1Merchant.md index 6d1f537..2077ec8 100644 --- a/docs/V1Merchant.md +++ b/docs/V1Merchant.md @@ -3,6 +3,7 @@ ### Description Defines the fields that are included in the response body of a request to the **RetrieveBusiness** endpoint. +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1MerchantAccountType.md b/docs/V1MerchantAccountType.md index 455f9b0..faee664 100644 --- a/docs/V1MerchantAccountType.md +++ b/docs/V1MerchantAccountType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1MerchantBusinessType.md b/docs/V1MerchantBusinessType.md index f98c0e1..5258eb0 100644 --- a/docs/V1MerchantBusinessType.md +++ b/docs/V1MerchantBusinessType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1MerchantLocationDetails.md b/docs/V1MerchantLocationDetails.md index 320af94..891ba6d 100644 --- a/docs/V1MerchantLocationDetails.md +++ b/docs/V1MerchantLocationDetails.md @@ -3,6 +3,7 @@ ### Description Additional information for a single-location account specified by its associated business account, if it has one. +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ModifierList.md b/docs/V1ModifierList.md index 75382c8..2660161 100644 --- a/docs/V1ModifierList.md +++ b/docs/V1ModifierList.md @@ -3,6 +3,7 @@ ### Description V1ModifierList +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ModifierListSelectionType.md b/docs/V1ModifierListSelectionType.md index b0b003b..7665e7b 100644 --- a/docs/V1ModifierListSelectionType.md +++ b/docs/V1ModifierListSelectionType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1ModifierOption.md b/docs/V1ModifierOption.md index e54459b..947422e 100644 --- a/docs/V1ModifierOption.md +++ b/docs/V1ModifierOption.md @@ -3,6 +3,7 @@ ### Description V1ModifierOption +**Note: This model is deprecated.** ## Properties @@ -12,7 +13,7 @@ Name | Type | Description | Notes **Name** | **string** | The modifier option's name. | [optional] **PriceMoney** | [**V1Money**](V1Money.md) | The modifier option's price. | [optional] **OnByDefault** | **bool?** | If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE. | [optional] -**Ordinal** | **int?** | Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. | [optional] +**Ordinal** | **int?** | Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. | [optional] **ModifierListId** | **string** | The ID of the modifier list the option belongs to. | [optional] **V2Id** | **string** | The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. | [optional] diff --git a/docs/V1Money.md b/docs/V1Money.md index a859856..14de849 100644 --- a/docs/V1Money.md +++ b/docs/V1Money.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1Page.md b/docs/V1Page.md index 7fa6edc..eab76a4 100644 --- a/docs/V1Page.md +++ b/docs/V1Page.md @@ -3,6 +3,7 @@ ### Description V1Page +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1PageCell.md b/docs/V1PageCell.md index 7595b96..bb43de4 100644 --- a/docs/V1PageCell.md +++ b/docs/V1PageCell.md @@ -3,6 +3,7 @@ ### Description V1PageCell +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1PageCellObjectType.md b/docs/V1PageCellObjectType.md index 71f5eaa..ac46f31 100644 --- a/docs/V1PageCellObjectType.md +++ b/docs/V1PageCellObjectType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1PageCellPlaceholderType.md b/docs/V1PageCellPlaceholderType.md index 99e5300..17f49ee 100644 --- a/docs/V1PageCellPlaceholderType.md +++ b/docs/V1PageCellPlaceholderType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1PhoneNumber.md b/docs/V1PhoneNumber.md index a2d1c51..af78b20 100644 --- a/docs/V1PhoneNumber.md +++ b/docs/V1PhoneNumber.md @@ -3,6 +3,7 @@ ### Description Represents a phone number. +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1RemoveFeeRequest.md b/docs/V1RemoveFeeRequest.md index 5a272e1..812b1b7 100644 --- a/docs/V1RemoveFeeRequest.md +++ b/docs/V1RemoveFeeRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1RemoveModifierListRequest.md b/docs/V1RemoveModifierListRequest.md index f71eb2c..e04ed83 100644 --- a/docs/V1RemoveModifierListRequest.md +++ b/docs/V1RemoveModifierListRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1RetrieveBusinessRequest.md b/docs/V1RetrieveBusinessRequest.md index eac73f0..7cda75d 100644 --- a/docs/V1RetrieveBusinessRequest.md +++ b/docs/V1RetrieveBusinessRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1RetrieveItemRequest.md b/docs/V1RetrieveItemRequest.md index ccaecec..0ccbd51 100644 --- a/docs/V1RetrieveItemRequest.md +++ b/docs/V1RetrieveItemRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1RetrieveModifierListRequest.md b/docs/V1RetrieveModifierListRequest.md index c37fbb9..90a979f 100644 --- a/docs/V1RetrieveModifierListRequest.md +++ b/docs/V1RetrieveModifierListRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1Tender.md b/docs/V1Tender.md index 212efa7..52d229d 100644 --- a/docs/V1Tender.md +++ b/docs/V1Tender.md @@ -3,6 +3,7 @@ ### Description A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The `tender` field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url fields of the corresponding Tender objects. *A note on gift cards**: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A `Tender` object with a type of `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the associated payment. +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1TenderCardBrand.md b/docs/V1TenderCardBrand.md index 675dc43..e8553d2 100644 --- a/docs/V1TenderCardBrand.md +++ b/docs/V1TenderCardBrand.md @@ -3,6 +3,7 @@ ### Description The brand of a credit card. +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1TenderEntryMethod.md b/docs/V1TenderEntryMethod.md index d8b8cc7..f60ba6c 100644 --- a/docs/V1TenderEntryMethod.md +++ b/docs/V1TenderEntryMethod.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1TenderType.md b/docs/V1TenderType.md index 2f3e79b..b36578e 100644 --- a/docs/V1TenderType.md +++ b/docs/V1TenderType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdateCategoryRequest.md b/docs/V1UpdateCategoryRequest.md index 1ea2543..a68eb5e 100644 --- a/docs/V1UpdateCategoryRequest.md +++ b/docs/V1UpdateCategoryRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdateDiscountRequest.md b/docs/V1UpdateDiscountRequest.md index 2ba888a..ef51b3f 100644 --- a/docs/V1UpdateDiscountRequest.md +++ b/docs/V1UpdateDiscountRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdateFeeRequest.md b/docs/V1UpdateFeeRequest.md index 9264572..6e09720 100644 --- a/docs/V1UpdateFeeRequest.md +++ b/docs/V1UpdateFeeRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdateItemRequest.md b/docs/V1UpdateItemRequest.md index 0597458..a40945f 100644 --- a/docs/V1UpdateItemRequest.md +++ b/docs/V1UpdateItemRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdateModifierListRequest.md b/docs/V1UpdateModifierListRequest.md index 168faba..49fc1b6 100644 --- a/docs/V1UpdateModifierListRequest.md +++ b/docs/V1UpdateModifierListRequest.md @@ -3,6 +3,7 @@ ### Description V1UpdateModifierListRequest +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdateModifierListRequestSelectionType.md b/docs/V1UpdateModifierListRequestSelectionType.md index 893a277..d09e9a5 100644 --- a/docs/V1UpdateModifierListRequestSelectionType.md +++ b/docs/V1UpdateModifierListRequestSelectionType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdateModifierOptionRequest.md b/docs/V1UpdateModifierOptionRequest.md index 8b3a467..d568e9f 100644 --- a/docs/V1UpdateModifierOptionRequest.md +++ b/docs/V1UpdateModifierOptionRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdatePageCellRequest.md b/docs/V1UpdatePageCellRequest.md index 3e64222..58b3c5b 100644 --- a/docs/V1UpdatePageCellRequest.md +++ b/docs/V1UpdatePageCellRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdatePageRequest.md b/docs/V1UpdatePageRequest.md index e705804..e4c787e 100644 --- a/docs/V1UpdatePageRequest.md +++ b/docs/V1UpdatePageRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1UpdateVariationRequest.md b/docs/V1UpdateVariationRequest.md index 6fb978e..7641f3a 100644 --- a/docs/V1UpdateVariationRequest.md +++ b/docs/V1UpdateVariationRequest.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1Variation.md b/docs/V1Variation.md index df65a0f..9666856 100644 --- a/docs/V1Variation.md +++ b/docs/V1Variation.md @@ -3,6 +3,7 @@ ### Description V1Variation +**Note: This model is deprecated.** ## Properties @@ -11,7 +12,7 @@ Name | Type | Description | Notes **Id** | **string** | The item variation's unique ID. | [optional] **Name** | **string** | The item variation's name. | [optional] **ItemId** | **string** | The ID of the variation's associated item. | [optional] -**Ordinal** | **int?** | Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order | [optional] +**Ordinal** | **int?** | Indicates the variation's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order | [optional] **PricingType** | **string** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values | [optional] **PriceMoney** | [**V1Money**](V1Money.md) | The item variation's price, if any. | [optional] **Sku** | **string** | The item variation's SKU, if any. | [optional] diff --git a/docs/V1VariationInventoryAlertType.md b/docs/V1VariationInventoryAlertType.md index 8c2255e..0ec690e 100644 --- a/docs/V1VariationInventoryAlertType.md +++ b/docs/V1VariationInventoryAlertType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/V1VariationPricingType.md b/docs/V1VariationPricingType.md index 50ab253..cc5dd49 100644 --- a/docs/V1VariationPricingType.md +++ b/docs/V1VariationPricingType.md @@ -3,6 +3,7 @@ ### Description +**Note: This model is deprecated.** ## Properties diff --git a/docs/VoidTransactionRequest.md b/docs/VoidTransactionRequest.md index 4ec6c66..9becf60 100644 --- a/docs/VoidTransactionRequest.md +++ b/docs/VoidTransactionRequest.md @@ -2,7 +2,7 @@ ### Description -Defines the request body for calls to the VoidTransaction endpoint. + **Note: This model is deprecated.** ## Properties diff --git a/src/Square.Connect.Test/Model/CashPaymentDetailsTests.cs b/src/Square.Connect.Test/Model/CashPaymentDetailsTests.cs new file mode 100644 index 0000000..80815c7 --- /dev/null +++ b/src/Square.Connect.Test/Model/CashPaymentDetailsTests.cs @@ -0,0 +1,86 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CashPaymentDetails + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CashPaymentDetailsTests + { + // TODO uncomment below to declare an instance variable for CashPaymentDetails + //private CashPaymentDetails instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CashPaymentDetails + //instance = new CashPaymentDetails(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CashPaymentDetails + /// + [Test] + public void CashPaymentDetailsInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CashPaymentDetails + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CashPaymentDetails"); + } + + /// + /// Test the property 'BuyerSuppliedMoney' + /// + [Test] + public void BuyerSuppliedMoneyTest() + { + // TODO unit test for the property 'BuyerSuppliedMoney' + } + /// + /// Test the property 'ChangeBackMoney' + /// + [Test] + public void ChangeBackMoneyTest() + { + // TODO unit test for the property 'ChangeBackMoney' + } + + } + +} diff --git a/src/Square.Connect.Test/Model/CatalogDiscountModifyTaxBasisTests.cs b/src/Square.Connect.Test/Model/CatalogDiscountModifyTaxBasisTests.cs new file mode 100644 index 0000000..30e9c3a --- /dev/null +++ b/src/Square.Connect.Test/Model/CatalogDiscountModifyTaxBasisTests.cs @@ -0,0 +1,70 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CatalogDiscountModifyTaxBasis + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CatalogDiscountModifyTaxBasisTests + { + // TODO uncomment below to declare an instance variable for CatalogDiscountModifyTaxBasis + //private CatalogDiscountModifyTaxBasis instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CatalogDiscountModifyTaxBasis + //instance = new CatalogDiscountModifyTaxBasis(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CatalogDiscountModifyTaxBasis + /// + [Test] + public void CatalogDiscountModifyTaxBasisInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CatalogDiscountModifyTaxBasis + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CatalogDiscountModifyTaxBasis"); + } + + + } + +} diff --git a/src/Square.Connect.Test/Model/CatalogQueryCustomAttributeUsageTests.cs b/src/Square.Connect.Test/Model/CatalogQueryCustomAttributeUsageTests.cs new file mode 100644 index 0000000..1fc45b5 --- /dev/null +++ b/src/Square.Connect.Test/Model/CatalogQueryCustomAttributeUsageTests.cs @@ -0,0 +1,86 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CatalogQueryCustomAttributeUsage + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CatalogQueryCustomAttributeUsageTests + { + // TODO uncomment below to declare an instance variable for CatalogQueryCustomAttributeUsage + //private CatalogQueryCustomAttributeUsage instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CatalogQueryCustomAttributeUsage + //instance = new CatalogQueryCustomAttributeUsage(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CatalogQueryCustomAttributeUsage + /// + [Test] + public void CatalogQueryCustomAttributeUsageInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CatalogQueryCustomAttributeUsage + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CatalogQueryCustomAttributeUsage"); + } + + /// + /// Test the property 'CustomAttributeDefinitionIds' + /// + [Test] + public void CustomAttributeDefinitionIdsTest() + { + // TODO unit test for the property 'CustomAttributeDefinitionIds' + } + /// + /// Test the property 'HasValue' + /// + [Test] + public void HasValueTest() + { + // TODO unit test for the property 'HasValue' + } + + } + +} diff --git a/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsCustomAttributeFilterFilterTypeTests.cs b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsCustomAttributeFilterFilterTypeTests.cs new file mode 100644 index 0000000..87dad62 --- /dev/null +++ b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsCustomAttributeFilterFilterTypeTests.cs @@ -0,0 +1,70 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CatalogQueryFilteredItemsCustomAttributeFilterFilterType + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CatalogQueryFilteredItemsCustomAttributeFilterFilterTypeTests + { + // TODO uncomment below to declare an instance variable for CatalogQueryFilteredItemsCustomAttributeFilterFilterType + //private CatalogQueryFilteredItemsCustomAttributeFilterFilterType instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CatalogQueryFilteredItemsCustomAttributeFilterFilterType + //instance = new CatalogQueryFilteredItemsCustomAttributeFilterFilterType(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CatalogQueryFilteredItemsCustomAttributeFilterFilterType + /// + [Test] + public void CatalogQueryFilteredItemsCustomAttributeFilterFilterTypeInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CatalogQueryFilteredItemsCustomAttributeFilterFilterType + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CatalogQueryFilteredItemsCustomAttributeFilterFilterType"); + } + + + } + +} diff --git a/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsCustomAttributeFilterTests.cs b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsCustomAttributeFilterTests.cs new file mode 100644 index 0000000..7ef23dc --- /dev/null +++ b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsCustomAttributeFilterTests.cs @@ -0,0 +1,118 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CatalogQueryFilteredItemsCustomAttributeFilter + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CatalogQueryFilteredItemsCustomAttributeFilterTests + { + // TODO uncomment below to declare an instance variable for CatalogQueryFilteredItemsCustomAttributeFilter + //private CatalogQueryFilteredItemsCustomAttributeFilter instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CatalogQueryFilteredItemsCustomAttributeFilter + //instance = new CatalogQueryFilteredItemsCustomAttributeFilter(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CatalogQueryFilteredItemsCustomAttributeFilter + /// + [Test] + public void CatalogQueryFilteredItemsCustomAttributeFilterInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CatalogQueryFilteredItemsCustomAttributeFilter + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CatalogQueryFilteredItemsCustomAttributeFilter"); + } + + /// + /// Test the property 'FilterType' + /// + [Test] + public void FilterTypeTest() + { + // TODO unit test for the property 'FilterType' + } + /// + /// Test the property 'CustomAttributeDefinitionIds' + /// + [Test] + public void CustomAttributeDefinitionIdsTest() + { + // TODO unit test for the property 'CustomAttributeDefinitionIds' + } + /// + /// Test the property 'CustomAttributeValueExact' + /// + [Test] + public void CustomAttributeValueExactTest() + { + // TODO unit test for the property 'CustomAttributeValueExact' + } + /// + /// Test the property 'CustomAttributeValuePrefix' + /// + [Test] + public void CustomAttributeValuePrefixTest() + { + // TODO unit test for the property 'CustomAttributeValuePrefix' + } + /// + /// Test the property 'CustomAttributeMinValue' + /// + [Test] + public void CustomAttributeMinValueTest() + { + // TODO unit test for the property 'CustomAttributeMinValue' + } + /// + /// Test the property 'CustomAttributeMaxValue' + /// + [Test] + public void CustomAttributeMaxValueTest() + { + // TODO unit test for the property 'CustomAttributeMaxValue' + } + + } + +} diff --git a/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsNullableAttributeTests.cs b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsNullableAttributeTests.cs new file mode 100644 index 0000000..c0c9f39 --- /dev/null +++ b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsNullableAttributeTests.cs @@ -0,0 +1,70 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CatalogQueryFilteredItemsNullableAttribute + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CatalogQueryFilteredItemsNullableAttributeTests + { + // TODO uncomment below to declare an instance variable for CatalogQueryFilteredItemsNullableAttribute + //private CatalogQueryFilteredItemsNullableAttribute instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CatalogQueryFilteredItemsNullableAttribute + //instance = new CatalogQueryFilteredItemsNullableAttribute(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CatalogQueryFilteredItemsNullableAttribute + /// + [Test] + public void CatalogQueryFilteredItemsNullableAttributeInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CatalogQueryFilteredItemsNullableAttribute + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CatalogQueryFilteredItemsNullableAttribute"); + } + + + } + +} diff --git a/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsStockLevelTests.cs b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsStockLevelTests.cs new file mode 100644 index 0000000..547202e --- /dev/null +++ b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsStockLevelTests.cs @@ -0,0 +1,70 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CatalogQueryFilteredItemsStockLevel + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CatalogQueryFilteredItemsStockLevelTests + { + // TODO uncomment below to declare an instance variable for CatalogQueryFilteredItemsStockLevel + //private CatalogQueryFilteredItemsStockLevel instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CatalogQueryFilteredItemsStockLevel + //instance = new CatalogQueryFilteredItemsStockLevel(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CatalogQueryFilteredItemsStockLevel + /// + [Test] + public void CatalogQueryFilteredItemsStockLevelInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CatalogQueryFilteredItemsStockLevel + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CatalogQueryFilteredItemsStockLevel"); + } + + + } + +} diff --git a/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsTests.cs b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsTests.cs new file mode 100644 index 0000000..10dc6a6 --- /dev/null +++ b/src/Square.Connect.Test/Model/CatalogQueryFilteredItemsTests.cs @@ -0,0 +1,150 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CatalogQueryFilteredItems + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CatalogQueryFilteredItemsTests + { + // TODO uncomment below to declare an instance variable for CatalogQueryFilteredItems + //private CatalogQueryFilteredItems instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CatalogQueryFilteredItems + //instance = new CatalogQueryFilteredItems(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CatalogQueryFilteredItems + /// + [Test] + public void CatalogQueryFilteredItemsInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CatalogQueryFilteredItems + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CatalogQueryFilteredItems"); + } + + /// + /// Test the property 'TextFilter' + /// + [Test] + public void TextFilterTest() + { + // TODO unit test for the property 'TextFilter' + } + /// + /// Test the property 'SearchVendorCode' + /// + [Test] + public void SearchVendorCodeTest() + { + // TODO unit test for the property 'SearchVendorCode' + } + /// + /// Test the property 'CategoryIds' + /// + [Test] + public void CategoryIdsTest() + { + // TODO unit test for the property 'CategoryIds' + } + /// + /// Test the property 'StockLevels' + /// + [Test] + public void StockLevelsTest() + { + // TODO unit test for the property 'StockLevels' + } + /// + /// Test the property 'EnabledLocationIds' + /// + [Test] + public void EnabledLocationIdsTest() + { + // TODO unit test for the property 'EnabledLocationIds' + } + /// + /// Test the property 'VendorIds' + /// + [Test] + public void VendorIdsTest() + { + // TODO unit test for the property 'VendorIds' + } + /// + /// Test the property 'ProductTypes' + /// + [Test] + public void ProductTypesTest() + { + // TODO unit test for the property 'ProductTypes' + } + /// + /// Test the property 'CustomAttributeFilters' + /// + [Test] + public void CustomAttributeFiltersTest() + { + // TODO unit test for the property 'CustomAttributeFilters' + } + /// + /// Test the property 'DoesNotExist' + /// + [Test] + public void DoesNotExistTest() + { + // TODO unit test for the property 'DoesNotExist' + } + /// + /// Test the property 'SortOrder' + /// + [Test] + public void SortOrderTest() + { + // TODO unit test for the property 'SortOrder' + } + + } + +} diff --git a/src/Square.Connect.Test/Model/CreateCatalogImageRequestTests.cs b/src/Square.Connect.Test/Model/CreateCatalogImageRequestTests.cs new file mode 100644 index 0000000..49afe19 --- /dev/null +++ b/src/Square.Connect.Test/Model/CreateCatalogImageRequestTests.cs @@ -0,0 +1,94 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CreateCatalogImageRequest + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CreateCatalogImageRequestTests + { + // TODO uncomment below to declare an instance variable for CreateCatalogImageRequest + //private CreateCatalogImageRequest instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CreateCatalogImageRequest + //instance = new CreateCatalogImageRequest(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CreateCatalogImageRequest + /// + [Test] + public void CreateCatalogImageRequestInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CreateCatalogImageRequest + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CreateCatalogImageRequest"); + } + + /// + /// Test the property 'IdempotencyKey' + /// + [Test] + public void IdempotencyKeyTest() + { + // TODO unit test for the property 'IdempotencyKey' + } + /// + /// Test the property 'ObjectId' + /// + [Test] + public void ObjectIdTest() + { + // TODO unit test for the property 'ObjectId' + } + /// + /// Test the property 'Image' + /// + [Test] + public void ImageTest() + { + // TODO unit test for the property 'Image' + } + + } + +} diff --git a/src/Square.Connect.Test/Model/CreateCatalogImageResponseTests.cs b/src/Square.Connect.Test/Model/CreateCatalogImageResponseTests.cs new file mode 100644 index 0000000..1c5d4b4 --- /dev/null +++ b/src/Square.Connect.Test/Model/CreateCatalogImageResponseTests.cs @@ -0,0 +1,86 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CreateCatalogImageResponse + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CreateCatalogImageResponseTests + { + // TODO uncomment below to declare an instance variable for CreateCatalogImageResponse + //private CreateCatalogImageResponse instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CreateCatalogImageResponse + //instance = new CreateCatalogImageResponse(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CreateCatalogImageResponse + /// + [Test] + public void CreateCatalogImageResponseInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CreateCatalogImageResponse + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CreateCatalogImageResponse"); + } + + /// + /// Test the property 'Errors' + /// + [Test] + public void ErrorsTest() + { + // TODO unit test for the property 'Errors' + } + /// + /// Test the property 'Image' + /// + [Test] + public void ImageTest() + { + // TODO unit test for the property 'Image' + } + + } + +} diff --git a/src/Square.Connect.Test/Model/CreateLocationRequestTests.cs b/src/Square.Connect.Test/Model/CreateLocationRequestTests.cs new file mode 100644 index 0000000..3d74a41 --- /dev/null +++ b/src/Square.Connect.Test/Model/CreateLocationRequestTests.cs @@ -0,0 +1,78 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CreateLocationRequest + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CreateLocationRequestTests + { + // TODO uncomment below to declare an instance variable for CreateLocationRequest + //private CreateLocationRequest instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CreateLocationRequest + //instance = new CreateLocationRequest(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CreateLocationRequest + /// + [Test] + public void CreateLocationRequestInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CreateLocationRequest + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CreateLocationRequest"); + } + + /// + /// Test the property 'Location' + /// + [Test] + public void LocationTest() + { + // TODO unit test for the property 'Location' + } + + } + +} diff --git a/src/Square.Connect.Test/Model/CreateLocationResponseTests.cs b/src/Square.Connect.Test/Model/CreateLocationResponseTests.cs new file mode 100644 index 0000000..1bb67b4 --- /dev/null +++ b/src/Square.Connect.Test/Model/CreateLocationResponseTests.cs @@ -0,0 +1,86 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing CreateLocationResponse + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class CreateLocationResponseTests + { + // TODO uncomment below to declare an instance variable for CreateLocationResponse + //private CreateLocationResponse instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of CreateLocationResponse + //instance = new CreateLocationResponse(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of CreateLocationResponse + /// + [Test] + public void CreateLocationResponseInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" CreateLocationResponse + //Assert.IsInstanceOfType (instance, "variable 'instance' is a CreateLocationResponse"); + } + + /// + /// Test the property 'Errors' + /// + [Test] + public void ErrorsTest() + { + // TODO unit test for the property 'Errors' + } + /// + /// Test the property 'Location' + /// + [Test] + public void LocationTest() + { + // TODO unit test for the property 'Location' + } + + } + +} diff --git a/src/Square.Connect.Test/Model/ExternalPaymentDetailsTests.cs b/src/Square.Connect.Test/Model/ExternalPaymentDetailsTests.cs new file mode 100644 index 0000000..44a9213 --- /dev/null +++ b/src/Square.Connect.Test/Model/ExternalPaymentDetailsTests.cs @@ -0,0 +1,102 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + + +using NUnit.Framework; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Square.Connect.Api; +using Square.Connect.Model; +using Square.Connect.Client; +using System.Reflection; + +namespace Square.Connect.Test +{ + /// + /// Class for testing ExternalPaymentDetails + /// + /// + /// This file is automatically generated by Swagger Codegen. + /// Please update the test case below to test the model. + /// + [TestFixture] + public class ExternalPaymentDetailsTests + { + // TODO uncomment below to declare an instance variable for ExternalPaymentDetails + //private ExternalPaymentDetails instance; + + /// + /// Setup before each test + /// + [SetUp] + public void Init() + { + // TODO uncomment below to create an instance of ExternalPaymentDetails + //instance = new ExternalPaymentDetails(); + } + + /// + /// Clean up after each test + /// + [TearDown] + public void Cleanup() + { + + } + + /// + /// Test an instance of ExternalPaymentDetails + /// + [Test] + public void ExternalPaymentDetailsInstanceTest() + { + // TODO uncomment below to test "IsInstanceOfType" ExternalPaymentDetails + //Assert.IsInstanceOfType (instance, "variable 'instance' is a ExternalPaymentDetails"); + } + + /// + /// Test the property 'Type' + /// + [Test] + public void TypeTest() + { + // TODO unit test for the property 'Type' + } + /// + /// Test the property 'Source' + /// + [Test] + public void SourceTest() + { + // TODO unit test for the property 'Source' + } + /// + /// Test the property 'SourceId' + /// + [Test] + public void SourceIdTest() + { + // TODO unit test for the property 'SourceId' + } + /// + /// Test the property 'SourceFeeMoney' + /// + [Test] + public void SourceFeeMoneyTest() + { + // TODO unit test for the property 'SourceFeeMoney' + } + + } + +} diff --git a/src/Square.Connect/Api/ApplePayApi.cs b/src/Square.Connect/Api/ApplePayApi.cs index 7ddb8d5..a858724 100644 --- a/src/Square.Connect/Api/ApplePayApi.cs +++ b/src/Square.Connect/Api/ApplePayApi.cs @@ -28,7 +28,7 @@ public interface IApplePayApi : IApiAccessor /// RegisterDomain /// /// - /// Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + /// Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -38,7 +38,7 @@ public interface IApplePayApi : IApiAccessor /// RegisterDomain /// /// - /// Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + /// Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -50,7 +50,7 @@ public interface IApplePayApi : IApiAccessor /// RegisterDomain /// /// - /// Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + /// Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -61,7 +61,7 @@ public interface IApplePayApi : IApiAccessor /// RegisterDomain /// /// - /// Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + /// Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -180,7 +180,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// RegisterDomain Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + /// RegisterDomain Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -192,7 +192,7 @@ public RegisterDomainResponse RegisterDomain (RegisterDomainRequest body) } /// - /// RegisterDomain Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + /// RegisterDomain Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -224,7 +224,7 @@ public ApiResponse< RegisterDomainResponse > RegisterDomainWithHttpInfo (Registe String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -261,7 +261,7 @@ public ApiResponse< RegisterDomainResponse > RegisterDomainWithHttpInfo (Registe } /// - /// RegisterDomain Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + /// RegisterDomain Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -274,7 +274,7 @@ public async System.Threading.Tasks.Task RegisterDomainA } /// - /// RegisterDomain Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide. + /// RegisterDomain Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -306,7 +306,7 @@ public async System.Threading.Tasks.Task> Re String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter diff --git a/src/Square.Connect/Api/CatalogApi.cs b/src/Square.Connect/Api/CatalogApi.cs index 675b218..60d0727 100644 --- a/src/Square.Connect/Api/CatalogApi.cs +++ b/src/Square.Connect/Api/CatalogApi.cs @@ -109,7 +109,7 @@ public interface ICatalogApi : IApiAccessor /// 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. /// /// Thrown when fails to make API call - /// 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`. + /// The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). /// DeleteCatalogObjectResponse DeleteCatalogObjectResponse DeleteCatalogObject (string objectId); /// @@ -119,7 +119,7 @@ public interface ICatalogApi : IApiAccessor /// 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. /// /// Thrown when fails to make API call - /// 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`. + /// The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). /// ApiResponse of DeleteCatalogObjectResponse ApiResponse DeleteCatalogObjectWithHttpInfo (string objectId); /// @@ -130,7 +130,7 @@ public interface ICatalogApi : IApiAccessor /// /// Thrown when fails to make API call /// 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) - /// 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) + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) /// ListCatalogResponse ListCatalogResponse ListCatalog (string cursor = null, string types = null); /// @@ -141,7 +141,7 @@ public interface ICatalogApi : IApiAccessor /// /// Thrown when fails to make API call /// 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) - /// 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) + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) /// ApiResponse of ListCatalogResponse ApiResponse ListCatalogWithHttpInfo (string cursor = null, string types = null); /// @@ -151,8 +151,8 @@ public interface ICatalogApi : IApiAccessor /// 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. /// /// Thrown when fails to make API call - /// The object ID of any type of `CatalogObject`s to be retrieved. - /// 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) + /// The object ID of any type of catalog objects to be retrieved. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) /// RetrieveCatalogObjectResponse RetrieveCatalogObjectResponse RetrieveCatalogObject (string objectId, bool? includeRelatedObjects = null); /// @@ -162,15 +162,15 @@ public interface ICatalogApi : IApiAccessor /// 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. /// /// Thrown when fails to make API call - /// The object ID of any type of `CatalogObject`s to be retrieved. - /// 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) + /// The object ID of any type of catalog objects to be retrieved. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) /// ApiResponse of RetrieveCatalogObjectResponse ApiResponse RetrieveCatalogObjectWithHttpInfo (string objectId, bool? includeRelatedObjects = null); /// /// SearchCatalogObjects /// /// - /// Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + /// Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). - - - - Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -180,7 +180,7 @@ public interface ICatalogApi : IApiAccessor /// SearchCatalogObjects /// /// - /// Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + /// Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). - - - - Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -337,7 +337,7 @@ public interface ICatalogApi : IApiAccessor /// 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. /// /// Thrown when fails to make API call - /// 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`. + /// The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). /// Task of DeleteCatalogObjectResponse System.Threading.Tasks.Task DeleteCatalogObjectAsync (string objectId); @@ -348,7 +348,7 @@ public interface ICatalogApi : IApiAccessor /// 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. /// /// Thrown when fails to make API call - /// 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`. + /// The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). /// Task of ApiResponse (DeleteCatalogObjectResponse) System.Threading.Tasks.Task> DeleteCatalogObjectAsyncWithHttpInfo (string objectId); /// @@ -359,7 +359,7 @@ public interface ICatalogApi : IApiAccessor /// /// Thrown when fails to make API call /// 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) - /// 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) + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) /// Task of ListCatalogResponse System.Threading.Tasks.Task ListCatalogAsync (string cursor = null, string types = null); @@ -371,7 +371,7 @@ public interface ICatalogApi : IApiAccessor /// /// Thrown when fails to make API call /// 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) - /// 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) + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) /// Task of ApiResponse (ListCatalogResponse) System.Threading.Tasks.Task> ListCatalogAsyncWithHttpInfo (string cursor = null, string types = null); /// @@ -381,8 +381,8 @@ public interface ICatalogApi : IApiAccessor /// 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. /// /// Thrown when fails to make API call - /// The object ID of any type of `CatalogObject`s to be retrieved. - /// 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) + /// The object ID of any type of catalog objects to be retrieved. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) /// Task of RetrieveCatalogObjectResponse System.Threading.Tasks.Task RetrieveCatalogObjectAsync (string objectId, bool? includeRelatedObjects = null); @@ -393,15 +393,15 @@ public interface ICatalogApi : IApiAccessor /// 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. /// /// Thrown when fails to make API call - /// The object ID of any type of `CatalogObject`s to be retrieved. - /// 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) + /// The object ID of any type of catalog objects to be retrieved. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) /// Task of ApiResponse (RetrieveCatalogObjectResponse) System.Threading.Tasks.Task> RetrieveCatalogObjectAsyncWithHttpInfo (string objectId, bool? includeRelatedObjects = null); /// /// SearchCatalogObjects /// /// - /// Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + /// Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). - - - - Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -412,7 +412,7 @@ public interface ICatalogApi : IApiAccessor /// SearchCatalogObjects /// /// - /// Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + /// Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). - - - - Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -638,7 +638,7 @@ public ApiResponse< BatchDeleteCatalogObjectsResponse > BatchDeleteCatalogObject String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -720,7 +720,7 @@ public async System.Threading.Tasks.Task BatchRetrieveCatalogOb String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -883,7 +883,7 @@ public async System.Threading.Tasks.Task BatchUpsertCatalogObject String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1046,7 +1046,7 @@ public async System.Threading.Tasks.Task CatalogInfoWithHttpInfo () String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); // authentication (oauth2) required // oauth required @@ -1191,7 +1191,7 @@ public async System.Threading.Tasks.Task> Catal String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); // authentication (oauth2) required // oauth required @@ -1223,7 +1223,7 @@ public async System.Threading.Tasks.Task> Catal /// 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. /// /// Thrown when fails to make API call - /// 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`. + /// The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). /// DeleteCatalogObjectResponse public DeleteCatalogObjectResponse DeleteCatalogObject (string objectId) { @@ -1235,7 +1235,7 @@ public DeleteCatalogObjectResponse DeleteCatalogObject (string objectId) /// 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. /// /// Thrown when fails to make API call - /// 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`. + /// The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). /// ApiResponse of DeleteCatalogObjectResponse public ApiResponse< DeleteCatalogObjectResponse > DeleteCatalogObjectWithHttpInfo (string objectId) { @@ -1264,7 +1264,7 @@ public ApiResponse< DeleteCatalogObjectResponse > DeleteCatalogObjectWithHttpInf String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (objectId != null) localVarPathParams.Add("object_id", Configuration.ApiClient.ParameterToString(objectId)); // path parameter // authentication (oauth2) required @@ -1297,7 +1297,7 @@ public ApiResponse< DeleteCatalogObjectResponse > DeleteCatalogObjectWithHttpInf /// 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. /// /// Thrown when fails to make API call - /// 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`. + /// The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). /// Task of DeleteCatalogObjectResponse public async System.Threading.Tasks.Task DeleteCatalogObjectAsync (string objectId) { @@ -1310,7 +1310,7 @@ public async System.Threading.Tasks.Task DeleteCata /// 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. /// /// Thrown when fails to make API call - /// 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`. + /// The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). /// Task of ApiResponse (DeleteCatalogObjectResponse) public async System.Threading.Tasks.Task> DeleteCatalogObjectAsyncWithHttpInfo (string objectId) { @@ -1339,7 +1339,7 @@ public async System.Threading.Tasks.Task /// Thrown when fails to make API call /// 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) - /// 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) + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) /// ListCatalogResponse public ListCatalogResponse ListCatalog (string cursor = null, string types = null) { @@ -1386,7 +1386,7 @@ public ListCatalogResponse ListCatalog (string cursor = null, string types = nul /// /// Thrown when fails to make API call /// 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) - /// 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) + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) /// ApiResponse of ListCatalogResponse public ApiResponse< ListCatalogResponse > ListCatalogWithHttpInfo (string cursor = null, string types = null) { @@ -1412,7 +1412,7 @@ public ApiResponse< ListCatalogResponse > ListCatalogWithHttpInfo (string cursor String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter if (types != null) localVarQueryParams.Add("types", Configuration.ApiClient.ParameterToString(types)); // query parameter @@ -1447,7 +1447,7 @@ public ApiResponse< ListCatalogResponse > ListCatalogWithHttpInfo (string cursor /// /// Thrown when fails to make API call /// 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) - /// 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) + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) /// Task of ListCatalogResponse public async System.Threading.Tasks.Task ListCatalogAsync (string cursor = null, string types = null) { @@ -1461,7 +1461,7 @@ public async System.Threading.Tasks.Task ListCatalogAsync ( /// /// Thrown when fails to make API call /// 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) - /// 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) + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. (optional) /// Task of ApiResponse (ListCatalogResponse) public async System.Threading.Tasks.Task> ListCatalogAsyncWithHttpInfo (string cursor = null, string types = null) { @@ -1487,7 +1487,7 @@ public async System.Threading.Tasks.Task> ListC String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter if (types != null) localVarQueryParams.Add("types", Configuration.ApiClient.ParameterToString(types)); // query parameter @@ -1521,8 +1521,8 @@ public async System.Threading.Tasks.Task> ListC /// 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. /// /// Thrown when fails to make API call - /// The object ID of any type of `CatalogObject`s to be retrieved. - /// 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) + /// The object ID of any type of catalog objects to be retrieved. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) /// RetrieveCatalogObjectResponse public RetrieveCatalogObjectResponse RetrieveCatalogObject (string objectId, bool? includeRelatedObjects = null) { @@ -1534,8 +1534,8 @@ public RetrieveCatalogObjectResponse RetrieveCatalogObject (string objectId, boo /// 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. /// /// Thrown when fails to make API call - /// The object ID of any type of `CatalogObject`s to be retrieved. - /// 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) + /// The object ID of any type of catalog objects to be retrieved. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) /// ApiResponse of RetrieveCatalogObjectResponse public ApiResponse< RetrieveCatalogObjectResponse > RetrieveCatalogObjectWithHttpInfo (string objectId, bool? includeRelatedObjects = null) { @@ -1564,7 +1564,7 @@ public ApiResponse< RetrieveCatalogObjectResponse > RetrieveCatalogObjectWithHtt String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (objectId != null) localVarPathParams.Add("object_id", Configuration.ApiClient.ParameterToString(objectId)); // path parameter if (includeRelatedObjects != null) localVarQueryParams.Add("include_related_objects", Configuration.ApiClient.ParameterToString(includeRelatedObjects)); // query parameter @@ -1598,8 +1598,8 @@ public ApiResponse< RetrieveCatalogObjectResponse > RetrieveCatalogObjectWithHtt /// 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. /// /// Thrown when fails to make API call - /// The object ID of any type of `CatalogObject`s to be retrieved. - /// 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) + /// The object ID of any type of catalog objects to be retrieved. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) /// Task of RetrieveCatalogObjectResponse public async System.Threading.Tasks.Task RetrieveCatalogObjectAsync (string objectId, bool? includeRelatedObjects = null) { @@ -1612,8 +1612,8 @@ public async System.Threading.Tasks.Task Retrieve /// 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. /// /// Thrown when fails to make API call - /// The object ID of any type of `CatalogObject`s to be retrieved. - /// 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) + /// The object ID of any type of catalog objects to be retrieved. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` (optional) /// Task of ApiResponse (RetrieveCatalogObjectResponse) public async System.Threading.Tasks.Task> RetrieveCatalogObjectAsyncWithHttpInfo (string objectId, bool? includeRelatedObjects = null) { @@ -1642,7 +1642,7 @@ public async System.Threading.Tasks.Task - /// SearchCatalogObjects Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + /// SearchCatalogObjects Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). - - - - Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -1685,7 +1685,7 @@ public SearchCatalogObjectsResponse SearchCatalogObjects (SearchCatalogObjectsRe } /// - /// SearchCatalogObjects Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + /// SearchCatalogObjects Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). - - - - Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -1717,7 +1717,7 @@ public ApiResponse< SearchCatalogObjectsResponse > SearchCatalogObjectsWithHttpI String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1754,7 +1754,7 @@ public ApiResponse< SearchCatalogObjectsResponse > SearchCatalogObjectsWithHttpI } /// - /// SearchCatalogObjects Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + /// SearchCatalogObjects Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). - - - - Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -1767,7 +1767,7 @@ public async System.Threading.Tasks.Task SearchCat } /// - /// SearchCatalogObjects Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). + /// SearchCatalogObjects Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). - - - - Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -1799,7 +1799,7 @@ public async System.Threading.Tasks.Task UpdateItemModifierListsWit String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1962,7 +1962,7 @@ public async System.Threading.Tasks.Task UpdateItemTaxesWithHttpInfo (Updat String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -2125,7 +2125,7 @@ public async System.Threading.Tasks.Task> U String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -2206,7 +2206,7 @@ public ApiResponse< UpsertCatalogObjectResponse > UpsertCatalogObjectWithHttpInf String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -2288,7 +2288,7 @@ public async System.Threading.Tasks.Task CreateCheckoutWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -321,7 +321,7 @@ public async System.Threading.Tasks.Task> Cr String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { diff --git a/src/Square.Connect/Api/CustomersApi.cs b/src/Square.Connect/Api/CustomersApi.cs index f5383a1..accacef 100644 --- a/src/Square.Connect/Api/CustomersApi.cs +++ b/src/Square.Connect/Api/CustomersApi.cs @@ -48,7 +48,7 @@ public interface ICustomersApi : IApiAccessor /// CreateCustomerCard /// /// - /// Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + /// Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. /// /// Thrown when fails to make API call /// The Square ID of the customer profile the card is linked to. @@ -59,7 +59,7 @@ public interface ICustomersApi : IApiAccessor /// CreateCustomerCard /// /// - /// Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + /// Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. /// /// Thrown when fails to make API call /// The Square ID of the customer profile the card is linked to. @@ -115,9 +115,9 @@ public interface ICustomersApi : IApiAccessor /// Lists a business's customers. /// /// Thrown when fails to make API call - /// 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) - /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) /// ListCustomersResponse ListCustomersResponse ListCustomers (string cursor = null, string sortField = null, string sortOrder = null); /// @@ -127,9 +127,9 @@ public interface ICustomersApi : IApiAccessor /// Lists a business's customers. /// /// Thrown when fails to make API call - /// 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) - /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) /// ApiResponse of ListCustomersResponse ApiResponse ListCustomersWithHttpInfo (string cursor = null, string sortField = null, string sortOrder = null); /// @@ -176,7 +176,7 @@ public interface ICustomersApi : IApiAccessor /// UpdateCustomer /// /// - /// Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + /// Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. /// /// Thrown when fails to make API call /// The ID of the customer to update. @@ -187,7 +187,7 @@ public interface ICustomersApi : IApiAccessor /// UpdateCustomer /// /// - /// Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + /// Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. /// /// Thrown when fails to make API call /// The ID of the customer to update. @@ -221,7 +221,7 @@ public interface ICustomersApi : IApiAccessor /// CreateCustomerCard /// /// - /// Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + /// Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. /// /// Thrown when fails to make API call /// The Square ID of the customer profile the card is linked to. @@ -233,7 +233,7 @@ public interface ICustomersApi : IApiAccessor /// CreateCustomerCard /// /// - /// Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + /// Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. /// /// Thrown when fails to make API call /// The Square ID of the customer profile the card is linked to. @@ -291,9 +291,9 @@ public interface ICustomersApi : IApiAccessor /// Lists a business's customers. /// /// Thrown when fails to make API call - /// 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) - /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) /// Task of ListCustomersResponse System.Threading.Tasks.Task ListCustomersAsync (string cursor = null, string sortField = null, string sortOrder = null); @@ -304,9 +304,9 @@ public interface ICustomersApi : IApiAccessor /// Lists a business's customers. /// /// Thrown when fails to make API call - /// 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) - /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) /// Task of ApiResponse (ListCustomersResponse) System.Threading.Tasks.Task> ListCustomersAsyncWithHttpInfo (string cursor = null, string sortField = null, string sortOrder = null); /// @@ -355,7 +355,7 @@ public interface ICustomersApi : IApiAccessor /// UpdateCustomer /// /// - /// Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + /// Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. /// /// Thrown when fails to make API call /// The ID of the customer to update. @@ -367,7 +367,7 @@ public interface ICustomersApi : IApiAccessor /// UpdateCustomer /// /// - /// Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + /// Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. /// /// Thrown when fails to make API call /// The ID of the customer to update. @@ -531,7 +531,7 @@ public ApiResponse< CreateCustomerResponse > CreateCustomerWithHttpInfo (CreateC String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -613,7 +613,7 @@ public async System.Threading.Tasks.Task> Cr String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -650,7 +650,7 @@ public async System.Threading.Tasks.Task> Cr } /// - /// CreateCustomerCard Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + /// CreateCustomerCard Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. /// /// Thrown when fails to make API call /// The Square ID of the customer profile the card is linked to. @@ -663,7 +663,7 @@ public CreateCustomerCardResponse CreateCustomerCard (string customerId, CreateC } /// - /// CreateCustomerCard Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + /// CreateCustomerCard Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. /// /// Thrown when fails to make API call /// The Square ID of the customer profile the card is linked to. @@ -699,7 +699,7 @@ public ApiResponse< CreateCustomerCardResponse > CreateCustomerCardWithHttpInfo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -737,7 +737,7 @@ public ApiResponse< CreateCustomerCardResponse > CreateCustomerCardWithHttpInfo } /// - /// CreateCustomerCard Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + /// CreateCustomerCard Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. /// /// Thrown when fails to make API call /// The Square ID of the customer profile the card is linked to. @@ -751,7 +751,7 @@ public async System.Threading.Tasks.Task CreateCusto } /// - /// CreateCustomerCard Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. Cards on file are automatically updated on a monthly basis to confirm they are still valid and can be charged. + /// CreateCustomerCard Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call. /// /// Thrown when fails to make API call /// The Square ID of the customer profile the card is linked to. @@ -787,7 +787,7 @@ public async System.Threading.Tasks.Task String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -869,7 +869,7 @@ public ApiResponse< DeleteCustomerResponse > DeleteCustomerWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter // authentication (oauth2) required @@ -944,7 +944,7 @@ public async System.Threading.Tasks.Task> De String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter // authentication (oauth2) required @@ -1023,7 +1023,7 @@ public ApiResponse< DeleteCustomerCardResponse > DeleteCustomerCardWithHttpInfo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter if (cardId != null) localVarPathParams.Add("card_id", Configuration.ApiClient.ParameterToString(cardId)); // path parameter @@ -1104,7 +1104,7 @@ public async System.Threading.Tasks.Task String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter if (cardId != null) localVarPathParams.Add("card_id", Configuration.ApiClient.ParameterToString(cardId)); // path parameter @@ -1138,9 +1138,9 @@ public async System.Threading.Tasks.Task /// ListCustomers Lists a business's customers. /// /// Thrown when fails to make API call - /// 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) - /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) /// ListCustomersResponse public ListCustomersResponse ListCustomers (string cursor = null, string sortField = null, string sortOrder = null) { @@ -1152,9 +1152,9 @@ public ListCustomersResponse ListCustomers (string cursor = null, string sortFie /// ListCustomers Lists a business's customers. /// /// Thrown when fails to make API call - /// 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) - /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) /// ApiResponse of ListCustomersResponse public ApiResponse< ListCustomersResponse > ListCustomersWithHttpInfo (string cursor = null, string sortField = null, string sortOrder = null) { @@ -1180,7 +1180,7 @@ public ApiResponse< ListCustomersResponse > ListCustomersWithHttpInfo (string cu String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter if (sortField != null) localVarQueryParams.Add("sort_field", Configuration.ApiClient.ParameterToString(sortField)); // query parameter if (sortOrder != null) localVarQueryParams.Add("sort_order", Configuration.ApiClient.ParameterToString(sortOrder)); // query parameter @@ -1215,9 +1215,9 @@ public ApiResponse< ListCustomersResponse > ListCustomersWithHttpInfo (string cu /// ListCustomers Lists a business's customers. /// /// Thrown when fails to make API call - /// 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) - /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) /// Task of ListCustomersResponse public async System.Threading.Tasks.Task ListCustomersAsync (string cursor = null, string sortField = null, string sortOrder = null) { @@ -1230,9 +1230,9 @@ public async System.Threading.Tasks.Task ListCustomersAsy /// ListCustomers Lists a business's customers. /// /// Thrown when fails to make API call - /// 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) - /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. (optional) + /// Indicates how Customers should be sorted. Default: `DEFAULT`. (optional) + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. (optional) /// Task of ApiResponse (ListCustomersResponse) public async System.Threading.Tasks.Task> ListCustomersAsyncWithHttpInfo (string cursor = null, string sortField = null, string sortOrder = null) { @@ -1258,7 +1258,7 @@ public async System.Threading.Tasks.Task> Lis String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter if (sortField != null) localVarQueryParams.Add("sort_field", Configuration.ApiClient.ParameterToString(sortField)); // query parameter if (sortOrder != null) localVarQueryParams.Add("sort_order", Configuration.ApiClient.ParameterToString(sortOrder)); // query parameter @@ -1334,7 +1334,7 @@ public ApiResponse< RetrieveCustomerResponse > RetrieveCustomerWithHttpInfo (str String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter // authentication (oauth2) required @@ -1409,7 +1409,7 @@ public async System.Threading.Tasks.Task> String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter // authentication (oauth2) required @@ -1483,7 +1483,7 @@ public ApiResponse< SearchCustomersResponse > SearchCustomersWithHttpInfo (Searc String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1565,7 +1565,7 @@ public async System.Threading.Tasks.Task> S String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1602,7 +1602,7 @@ public async System.Threading.Tasks.Task> S } /// - /// UpdateCustomer Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + /// UpdateCustomer Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. /// /// Thrown when fails to make API call /// The ID of the customer to update. @@ -1615,7 +1615,7 @@ public UpdateCustomerResponse UpdateCustomer (string customerId, UpdateCustomerR } /// - /// UpdateCustomer Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + /// UpdateCustomer Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. /// /// Thrown when fails to make API call /// The ID of the customer to update. @@ -1651,7 +1651,7 @@ public ApiResponse< UpdateCustomerResponse > UpdateCustomerWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -1689,7 +1689,7 @@ public ApiResponse< UpdateCustomerResponse > UpdateCustomerWithHttpInfo (string } /// - /// UpdateCustomer Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + /// UpdateCustomer Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. /// /// Thrown when fails to make API call /// The ID of the customer to update. @@ -1703,7 +1703,7 @@ public async System.Threading.Tasks.Task UpdateCustomerA } /// - /// UpdateCustomer Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint. + /// UpdateCustomer Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. /// /// Thrown when fails to make API call /// The ID of the customer to update. @@ -1739,7 +1739,7 @@ public async System.Threading.Tasks.Task> Up String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (customerId != null) localVarPathParams.Add("customer_id", Configuration.ApiClient.ParameterToString(customerId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { diff --git a/src/Square.Connect/Api/EmployeesApi.cs b/src/Square.Connect/Api/EmployeesApi.cs index 9e69493..9247b85 100644 --- a/src/Square.Connect/Api/EmployeesApi.cs +++ b/src/Square.Connect/Api/EmployeesApi.cs @@ -28,7 +28,7 @@ public interface IEmployeesApi : IApiAccessor /// ListEmployees /// /// - /// Gets a list of `Employee` objects for a business. + /// /// /// Thrown when fails to make API call /// Filter employees returned to only those that are associated with the specified location. (optional) @@ -41,7 +41,7 @@ public interface IEmployeesApi : IApiAccessor /// ListEmployees /// /// - /// Gets a list of `Employee` objects for a business. + /// /// /// Thrown when fails to make API call /// Filter employees returned to only those that are associated with the specified location. (optional) @@ -54,7 +54,7 @@ public interface IEmployeesApi : IApiAccessor /// RetrieveEmployee /// /// - /// Gets an `Employee` by Square-assigned employee `ID` (UUID) + /// /// /// Thrown when fails to make API call /// UUID for the employee that was requested. @@ -64,7 +64,7 @@ public interface IEmployeesApi : IApiAccessor /// RetrieveEmployee /// /// - /// Gets an `Employee` by Square-assigned employee `ID` (UUID) + /// /// /// Thrown when fails to make API call /// UUID for the employee that was requested. @@ -76,7 +76,7 @@ public interface IEmployeesApi : IApiAccessor /// ListEmployees /// /// - /// Gets a list of `Employee` objects for a business. + /// /// /// Thrown when fails to make API call /// Filter employees returned to only those that are associated with the specified location. (optional) @@ -90,7 +90,7 @@ public interface IEmployeesApi : IApiAccessor /// ListEmployees /// /// - /// Gets a list of `Employee` objects for a business. + /// /// /// Thrown when fails to make API call /// Filter employees returned to only those that are associated with the specified location. (optional) @@ -103,7 +103,7 @@ public interface IEmployeesApi : IApiAccessor /// RetrieveEmployee /// /// - /// Gets an `Employee` by Square-assigned employee `ID` (UUID) + /// /// /// Thrown when fails to make API call /// UUID for the employee that was requested. @@ -114,7 +114,7 @@ public interface IEmployeesApi : IApiAccessor /// RetrieveEmployee /// /// - /// Gets an `Employee` by Square-assigned employee `ID` (UUID) + /// /// /// Thrown when fails to make API call /// UUID for the employee that was requested. @@ -233,7 +233,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// ListEmployees Gets a list of `Employee` objects for a business. + /// ListEmployees /// /// Thrown when fails to make API call /// Filter employees returned to only those that are associated with the specified location. (optional) @@ -248,7 +248,7 @@ public ListEmployeesResponse ListEmployees (string locationId = null, string sta } /// - /// ListEmployees Gets a list of `Employee` objects for a business. + /// ListEmployees /// /// Thrown when fails to make API call /// Filter employees returned to only those that are associated with the specified location. (optional) @@ -280,7 +280,7 @@ public ApiResponse< ListEmployeesResponse > ListEmployeesWithHttpInfo (string lo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarQueryParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // query parameter if (status != null) localVarQueryParams.Add("status", Configuration.ApiClient.ParameterToString(status)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter @@ -313,7 +313,7 @@ public ApiResponse< ListEmployeesResponse > ListEmployeesWithHttpInfo (string lo } /// - /// ListEmployees Gets a list of `Employee` objects for a business. + /// ListEmployees /// /// Thrown when fails to make API call /// Filter employees returned to only those that are associated with the specified location. (optional) @@ -329,7 +329,7 @@ public async System.Threading.Tasks.Task ListEmployeesAsy } /// - /// ListEmployees Gets a list of `Employee` objects for a business. + /// ListEmployees /// /// Thrown when fails to make API call /// Filter employees returned to only those that are associated with the specified location. (optional) @@ -361,7 +361,7 @@ public async System.Threading.Tasks.Task> Lis String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarQueryParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // query parameter if (status != null) localVarQueryParams.Add("status", Configuration.ApiClient.ParameterToString(status)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter @@ -394,7 +394,7 @@ public async System.Threading.Tasks.Task> Lis } /// - /// RetrieveEmployee Gets an `Employee` by Square-assigned employee `ID` (UUID) + /// RetrieveEmployee /// /// Thrown when fails to make API call /// UUID for the employee that was requested. @@ -406,7 +406,7 @@ public RetrieveEmployeeResponse RetrieveEmployee (string id) } /// - /// RetrieveEmployee Gets an `Employee` by Square-assigned employee `ID` (UUID) + /// RetrieveEmployee /// /// Thrown when fails to make API call /// UUID for the employee that was requested. @@ -438,7 +438,7 @@ public ApiResponse< RetrieveEmployeeResponse > RetrieveEmployeeWithHttpInfo (str String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -468,7 +468,7 @@ public ApiResponse< RetrieveEmployeeResponse > RetrieveEmployeeWithHttpInfo (str } /// - /// RetrieveEmployee Gets an `Employee` by Square-assigned employee `ID` (UUID) + /// RetrieveEmployee /// /// Thrown when fails to make API call /// UUID for the employee that was requested. @@ -481,7 +481,7 @@ public async System.Threading.Tasks.Task RetrieveEmplo } /// - /// RetrieveEmployee Gets an `Employee` by Square-assigned employee `ID` (UUID) + /// RetrieveEmployee /// /// Thrown when fails to make API call /// UUID for the employee that was requested. @@ -513,7 +513,7 @@ public async System.Threading.Tasks.Task> String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required diff --git a/src/Square.Connect/Api/InventoryApi.cs b/src/Square.Connect/Api/InventoryApi.cs index b626973..a94eb92 100644 --- a/src/Square.Connect/Api/InventoryApi.cs +++ b/src/Square.Connect/Api/InventoryApi.cs @@ -113,7 +113,7 @@ public interface IInventoryApi : IApiAccessor /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// RetrieveInventoryChangesResponse RetrieveInventoryChangesResponse RetrieveInventoryChanges (string catalogObjectId, string locationIds = null, string cursor = null); /// @@ -125,7 +125,7 @@ public interface IInventoryApi : IApiAccessor /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// ApiResponse of RetrieveInventoryChangesResponse ApiResponse RetrieveInventoryChangesWithHttpInfo (string catalogObjectId, string locationIds = null, string cursor = null); /// @@ -137,7 +137,7 @@ public interface IInventoryApi : IApiAccessor /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// RetrieveInventoryCountResponse RetrieveInventoryCountResponse RetrieveInventoryCount (string catalogObjectId, string locationIds = null, string cursor = null); /// @@ -149,7 +149,7 @@ public interface IInventoryApi : IApiAccessor /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// ApiResponse of RetrieveInventoryCountResponse ApiResponse RetrieveInventoryCountWithHttpInfo (string catalogObjectId, string locationIds = null, string cursor = null); /// @@ -267,7 +267,7 @@ public interface IInventoryApi : IApiAccessor /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// Task of RetrieveInventoryChangesResponse System.Threading.Tasks.Task RetrieveInventoryChangesAsync (string catalogObjectId, string locationIds = null, string cursor = null); @@ -280,7 +280,7 @@ public interface IInventoryApi : IApiAccessor /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// Task of ApiResponse (RetrieveInventoryChangesResponse) System.Threading.Tasks.Task> RetrieveInventoryChangesAsyncWithHttpInfo (string catalogObjectId, string locationIds = null, string cursor = null); /// @@ -292,7 +292,7 @@ public interface IInventoryApi : IApiAccessor /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// Task of RetrieveInventoryCountResponse System.Threading.Tasks.Task RetrieveInventoryCountAsync (string catalogObjectId, string locationIds = null, string cursor = null); @@ -305,7 +305,7 @@ public interface IInventoryApi : IApiAccessor /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// Task of ApiResponse (RetrieveInventoryCountResponse) System.Threading.Tasks.Task> RetrieveInventoryCountAsyncWithHttpInfo (string catalogObjectId, string locationIds = null, string cursor = null); /// @@ -486,7 +486,7 @@ public ApiResponse< BatchChangeInventoryResponse > BatchChangeInventoryWithHttpI String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -568,7 +568,7 @@ public async System.Threading.Tasks.Task BatchRetrieveInvento String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -731,7 +731,7 @@ public async System.Threading.Tasks.Task BatchRetrieveInventor String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -894,7 +894,7 @@ public async System.Threading.Tasks.Task RetrieveInventoryAdjus String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (adjustmentId != null) localVarPathParams.Add("adjustment_id", Configuration.ApiClient.ParameterToString(adjustmentId)); // path parameter // authentication (oauth2) required @@ -1050,7 +1050,7 @@ public async System.Threading.Tasks.TaskThrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// RetrieveInventoryChangesResponse public RetrieveInventoryChangesResponse RetrieveInventoryChanges (string catalogObjectId, string locationIds = null, string cursor = null) { @@ -1099,7 +1099,7 @@ public RetrieveInventoryChangesResponse RetrieveInventoryChanges (string catalog /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// ApiResponse of RetrieveInventoryChangesResponse public ApiResponse< RetrieveInventoryChangesResponse > RetrieveInventoryChangesWithHttpInfo (string catalogObjectId, string locationIds = null, string cursor = null) { @@ -1128,7 +1128,7 @@ public ApiResponse< RetrieveInventoryChangesResponse > RetrieveInventoryChangesW String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (catalogObjectId != null) localVarPathParams.Add("catalog_object_id", Configuration.ApiClient.ParameterToString(catalogObjectId)); // path parameter if (locationIds != null) localVarQueryParams.Add("location_ids", Configuration.ApiClient.ParameterToString(locationIds)); // query parameter if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter @@ -1165,7 +1165,7 @@ public ApiResponse< RetrieveInventoryChangesResponse > RetrieveInventoryChangesW /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// Task of RetrieveInventoryChangesResponse public async System.Threading.Tasks.Task RetrieveInventoryChangesAsync (string catalogObjectId, string locationIds = null, string cursor = null) { @@ -1180,7 +1180,7 @@ public async System.Threading.Tasks.Task Retri /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// Task of ApiResponse (RetrieveInventoryChangesResponse) public async System.Threading.Tasks.Task> RetrieveInventoryChangesAsyncWithHttpInfo (string catalogObjectId, string locationIds = null, string cursor = null) { @@ -1209,7 +1209,7 @@ public async System.Threading.Tasks.TaskThrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// RetrieveInventoryCountResponse public RetrieveInventoryCountResponse RetrieveInventoryCount (string catalogObjectId, string locationIds = null, string cursor = null) { @@ -1260,7 +1260,7 @@ public RetrieveInventoryCountResponse RetrieveInventoryCount (string catalogObje /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// ApiResponse of RetrieveInventoryCountResponse public ApiResponse< RetrieveInventoryCountResponse > RetrieveInventoryCountWithHttpInfo (string catalogObjectId, string locationIds = null, string cursor = null) { @@ -1289,7 +1289,7 @@ public ApiResponse< RetrieveInventoryCountResponse > RetrieveInventoryCountWithH String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (catalogObjectId != null) localVarPathParams.Add("catalog_object_id", Configuration.ApiClient.ParameterToString(catalogObjectId)); // path parameter if (locationIds != null) localVarQueryParams.Add("location_ids", Configuration.ApiClient.ParameterToString(locationIds)); // query parameter if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter @@ -1326,7 +1326,7 @@ public ApiResponse< RetrieveInventoryCountResponse > RetrieveInventoryCountWithH /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// Task of RetrieveInventoryCountResponse public async System.Threading.Tasks.Task RetrieveInventoryCountAsync (string catalogObjectId, string locationIds = null, string cursor = null) { @@ -1341,7 +1341,7 @@ public async System.Threading.Tasks.Task Retriev /// Thrown when fails to make API call /// ID of the `CatalogObject` to retrieve. /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. (optional) /// Task of ApiResponse (RetrieveInventoryCountResponse) public async System.Threading.Tasks.Task> RetrieveInventoryCountAsyncWithHttpInfo (string catalogObjectId, string locationIds = null, string cursor = null) { @@ -1370,7 +1370,7 @@ public async System.Threading.Tasks.Task RetrieveInventoryPh String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (physicalCountId != null) localVarPathParams.Add("physical_count_id", Configuration.ApiClient.ParameterToString(physicalCountId)); // path parameter // authentication (oauth2) required @@ -1521,7 +1521,7 @@ public async System.Threading.Tasks.Task CreateBreakTypeWithHttpInfo (Creat String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -871,7 +871,7 @@ public async System.Threading.Tasks.Task> C String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -952,7 +952,7 @@ public ApiResponse< CreateShiftResponse > CreateShiftWithHttpInfo (CreateShiftRe String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1034,7 +1034,7 @@ public async System.Threading.Tasks.Task> Creat String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1115,7 +1115,7 @@ public ApiResponse< DeleteBreakTypeResponse > DeleteBreakTypeWithHttpInfo (strin String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1190,7 +1190,7 @@ public async System.Threading.Tasks.Task> D String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1264,7 +1264,7 @@ public ApiResponse< DeleteShiftResponse > DeleteShiftWithHttpInfo (string id) String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1339,7 +1339,7 @@ public async System.Threading.Tasks.Task> Delet String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1413,7 +1413,7 @@ public ApiResponse< GetBreakTypeResponse > GetBreakTypeWithHttpInfo (string id) String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1488,7 +1488,7 @@ public async System.Threading.Tasks.Task> GetB String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1562,7 +1562,7 @@ public ApiResponse< GetEmployeeWageResponse > GetEmployeeWageWithHttpInfo (strin String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1637,7 +1637,7 @@ public async System.Threading.Tasks.Task> G String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1711,7 +1711,7 @@ public ApiResponse< GetShiftResponse > GetShiftWithHttpInfo (string id) String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1786,7 +1786,7 @@ public async System.Threading.Tasks.Task> GetShift String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter // authentication (oauth2) required @@ -1861,7 +1861,7 @@ public ApiResponse< ListBreakTypesResponse > ListBreakTypesWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarQueryParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter @@ -1939,7 +1939,7 @@ public async System.Threading.Tasks.Task> Li String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarQueryParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter @@ -2016,7 +2016,7 @@ public ApiResponse< ListEmployeeWagesResponse > ListEmployeeWagesWithHttpInfo (s String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (employeeId != null) localVarQueryParams.Add("employee_id", Configuration.ApiClient.ParameterToString(employeeId)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter @@ -2094,7 +2094,7 @@ public async System.Threading.Tasks.Task> String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (employeeId != null) localVarQueryParams.Add("employee_id", Configuration.ApiClient.ParameterToString(employeeId)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter @@ -2169,7 +2169,7 @@ public ApiResponse< ListWorkweekConfigsResponse > ListWorkweekConfigsWithHttpInf String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter @@ -2244,7 +2244,7 @@ public async System.Threading.Tasks.Task SearchShiftsWithHttpInfo (SearchShift String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -2401,7 +2401,7 @@ public async System.Threading.Tasks.Task> Sear String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -2487,7 +2487,7 @@ public ApiResponse< UpdateBreakTypeResponse > UpdateBreakTypeWithHttpInfo (strin String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2575,7 +2575,7 @@ public async System.Threading.Tasks.Task> U String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2662,7 +2662,7 @@ public ApiResponse< UpdateShiftResponse > UpdateShiftWithHttpInfo (string id, Up String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2750,7 +2750,7 @@ public async System.Threading.Tasks.Task> Updat String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2837,7 +2837,7 @@ public ApiResponse< UpdateWorkweekConfigResponse > UpdateWorkweekConfigWithHttpI String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (id != null) localVarPathParams.Add("id", Configuration.ApiClient.ParameterToString(id)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2925,7 +2925,7 @@ public async System.Threading.Tasks.Task + /// CreateLocation + /// + /// + /// Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + /// Note: This endpoint is in beta. + /// + /// Thrown when fails to make API call + /// An object containing the fields to POST for the request. See the corresponding object definition for field details. + /// CreateLocationResponse CreateLocationResponse CreateLocation (CreateLocationRequest body); + + /// + /// CreateLocation + /// + /// + /// Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + /// + /// Thrown when fails to make API call + /// An object containing the fields to POST for the request. See the corresponding object definition for field details. + /// ApiResponse of CreateLocationResponse + ApiResponse CreateLocationWithHttpInfo (CreateLocationRequest body); + /// /// ListLocations /// /// - /// Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + /// Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. /// /// Thrown when fails to make API call /// ListLocationsResponse ListLocationsResponse ListLocations (); @@ -37,7 +58,7 @@ public interface ILocationsApi : IApiAccessor /// ListLocations /// /// - /// Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + /// Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. /// /// Thrown when fails to make API call /// ApiResponse of ListLocationsResponse @@ -47,7 +68,6 @@ public interface ILocationsApi : IApiAccessor /// /// /// Retrieves details of a location. - /// Note: This endpoint is in beta. /// /// Thrown when fails to make API call /// The ID of the location to retrieve. @@ -67,7 +87,7 @@ public interface ILocationsApi : IApiAccessor /// UpdateLocation /// /// - /// Updates the `Location` specified by the given ID. + /// Updates a location. /// Note: This endpoint is in beta. /// /// Thrown when fails to make API call @@ -79,7 +99,7 @@ public interface ILocationsApi : IApiAccessor /// UpdateLocation /// /// - /// Updates the `Location` specified by the given ID. + /// Updates a location. /// /// Thrown when fails to make API call /// The ID of the location to update. @@ -89,10 +109,31 @@ public interface ILocationsApi : IApiAccessor #endregion Synchronous Operations #region Asynchronous Operations /// + /// CreateLocation + /// + /// + /// Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + /// + /// Thrown when fails to make API call + /// An object containing the fields to POST for the request. See the corresponding object definition for field details. + /// Task of CreateLocationResponse + System.Threading.Tasks.Task CreateLocationAsync (CreateLocationRequest body); + + /// + /// CreateLocation + /// + /// + /// Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + /// + /// Thrown when fails to make API call + /// An object containing the fields to POST for the request. See the corresponding object definition for field details. + /// Task of ApiResponse (CreateLocationResponse) + System.Threading.Tasks.Task> CreateLocationAsyncWithHttpInfo (CreateLocationRequest body); + /// /// ListLocations /// /// - /// Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + /// Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. /// /// Thrown when fails to make API call /// Task of ListLocationsResponse @@ -102,7 +143,7 @@ public interface ILocationsApi : IApiAccessor /// ListLocations /// /// - /// Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + /// Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. /// /// Thrown when fails to make API call /// Task of ApiResponse (ListLocationsResponse) @@ -132,7 +173,7 @@ public interface ILocationsApi : IApiAccessor /// UpdateLocation /// /// - /// Updates the `Location` specified by the given ID. + /// Updates a location. /// /// Thrown when fails to make API call /// The ID of the location to update. @@ -144,7 +185,7 @@ public interface ILocationsApi : IApiAccessor /// UpdateLocation /// /// - /// Updates the `Location` specified by the given ID. + /// Updates a location. /// /// Thrown when fails to make API call /// The ID of the location to update. @@ -264,7 +305,170 @@ public void AddDefaultHeader(string key, string value) } /// - /// ListLocations Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + /// CreateLocation Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + /// + /// Thrown when fails to make API call + /// An object containing the fields to POST for the request. See the corresponding object definition for field details. + /// CreateLocationResponse + public CreateLocationResponse CreateLocation (CreateLocationRequest body) + { + ApiResponse localVarResponse = CreateLocationWithHttpInfo(body); + return localVarResponse.Data; + } + + /// + /// CreateLocation Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + /// + /// Thrown when fails to make API call + /// An object containing the fields to POST for the request. See the corresponding object definition for field details. + /// ApiResponse of CreateLocationResponse + public ApiResponse< CreateLocationResponse > CreateLocationWithHttpInfo (CreateLocationRequest body) + { + // verify the required parameter 'body' is set + if (body == null) + throw new ApiException(400, "Missing required parameter 'body' when calling LocationsApi->CreateLocation"); + + var localVarPath = "/v2/locations"; + var localVarPathParams = new Dictionary(); + var localVarQueryParams = new Dictionary(); + var localVarHeaderParams = new Dictionary(Configuration.DefaultHeader); + var localVarFormParams = new Dictionary(); + var localVarFileParams = new Dictionary(); + Object localVarPostBody = null; + + // to determine the Content-Type header + String[] localVarHttpContentTypes = new String[] { + "application/json" + }; + String localVarHttpContentType = Configuration.ApiClient.SelectHeaderContentType(localVarHttpContentTypes); + + // to determine the Accept header + String[] localVarHttpHeaderAccepts = new String[] { + "application/json" + }; + String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); + if (localVarHttpHeaderAccept != null) + localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); + if (body != null && body.GetType() != typeof(byte[])) + { + localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter + } + else + { + localVarPostBody = body; // byte array + } + + // authentication (oauth2) required + // oauth required + if (!String.IsNullOrEmpty(Configuration.AccessToken)) + { + localVarHeaderParams["Authorization"] = "Bearer " + Configuration.AccessToken; + } + + // make the HTTP request + IRestResponse localVarResponse = (IRestResponse) Configuration.ApiClient.CallApi(localVarPath, + Method.POST, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarFileParams, + localVarPathParams, localVarHttpContentType); + + int localVarStatusCode = (int) localVarResponse.StatusCode; + + if (ExceptionFactory != null) + { + Exception exception = ExceptionFactory("CreateLocation", localVarResponse); + if (exception != null) throw exception; + } + + return new ApiResponse(localVarStatusCode, + localVarResponse.Headers.ToDictionary(x => x.Name, x => x.Value.ToString(), StringComparer.OrdinalIgnoreCase), + (CreateLocationResponse) Configuration.ApiClient.Deserialize(localVarResponse, typeof(CreateLocationResponse))); + + } + + /// + /// CreateLocation Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + /// + /// Thrown when fails to make API call + /// An object containing the fields to POST for the request. See the corresponding object definition for field details. + /// Task of CreateLocationResponse + public async System.Threading.Tasks.Task CreateLocationAsync (CreateLocationRequest body) + { + ApiResponse localVarResponse = await CreateLocationAsyncWithHttpInfo(body); + return localVarResponse.Data; + + } + + /// + /// CreateLocation Creates a location. For more information about locations, see [Locations API Overview](/locations-api). + /// + /// Thrown when fails to make API call + /// An object containing the fields to POST for the request. See the corresponding object definition for field details. + /// Task of ApiResponse (CreateLocationResponse) + public async System.Threading.Tasks.Task> CreateLocationAsyncWithHttpInfo (CreateLocationRequest body) + { + // verify the required parameter 'body' is set + if (body == null) + throw new ApiException(400, "Missing required parameter 'body' when calling LocationsApi->CreateLocation"); + + var localVarPath = "/v2/locations"; + var localVarPathParams = new Dictionary(); + var localVarQueryParams = new Dictionary(); + var localVarHeaderParams = new Dictionary(Configuration.DefaultHeader); + var localVarFormParams = new Dictionary(); + var localVarFileParams = new Dictionary(); + Object localVarPostBody = null; + + // to determine the Content-Type header + String[] localVarHttpContentTypes = new String[] { + "application/json" + }; + String localVarHttpContentType = Configuration.ApiClient.SelectHeaderContentType(localVarHttpContentTypes); + + // to determine the Accept header + String[] localVarHttpHeaderAccepts = new String[] { + "application/json" + }; + String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); + if (localVarHttpHeaderAccept != null) + localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); + if (body != null && body.GetType() != typeof(byte[])) + { + localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter + } + else + { + localVarPostBody = body; // byte array + } + + // authentication (oauth2) required + // oauth required + if (!String.IsNullOrEmpty(Configuration.AccessToken)) + { + localVarHeaderParams["Authorization"] = "Bearer " + Configuration.AccessToken; + } + + // make the HTTP request + IRestResponse localVarResponse = (IRestResponse) await Configuration.ApiClient.CallApiAsync(localVarPath, + Method.POST, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarFileParams, + localVarPathParams, localVarHttpContentType); + + int localVarStatusCode = (int) localVarResponse.StatusCode; + + if (ExceptionFactory != null) + { + Exception exception = ExceptionFactory("CreateLocation", localVarResponse); + if (exception != null) throw exception; + } + + return new ApiResponse(localVarStatusCode, + localVarResponse.Headers.ToDictionary(x => x.Name, x => x.Value.ToString(), StringComparer.OrdinalIgnoreCase), + (CreateLocationResponse) Configuration.ApiClient.Deserialize(localVarResponse, typeof(CreateLocationResponse))); + + } + + /// + /// ListLocations Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. /// /// Thrown when fails to make API call /// ListLocationsResponse @@ -275,7 +479,7 @@ public ListLocationsResponse ListLocations () } /// - /// ListLocations Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + /// ListLocations Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. /// /// Thrown when fails to make API call /// ApiResponse of ListLocationsResponse @@ -303,7 +507,7 @@ public ApiResponse< ListLocationsResponse > ListLocationsWithHttpInfo () String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); // authentication (oauth2) required // oauth required @@ -332,7 +536,7 @@ public ApiResponse< ListLocationsResponse > ListLocationsWithHttpInfo () } /// - /// ListLocations Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + /// ListLocations Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. /// /// Thrown when fails to make API call /// Task of ListLocationsResponse @@ -344,7 +548,7 @@ public async System.Threading.Tasks.Task ListLocationsAsy } /// - /// ListLocations Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. + /// ListLocations Provides information of all locations of a business. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter. /// /// Thrown when fails to make API call /// Task of ApiResponse (ListLocationsResponse) @@ -372,7 +576,7 @@ public async System.Threading.Tasks.Task> Lis String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); // authentication (oauth2) required // oauth required @@ -445,7 +649,7 @@ public ApiResponse< RetrieveLocationResponse > RetrieveLocationWithHttpInfo (str String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -520,7 +724,7 @@ public async System.Threading.Tasks.Task> String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -550,7 +754,7 @@ public async System.Threading.Tasks.Task> } /// - /// UpdateLocation Updates the `Location` specified by the given ID. + /// UpdateLocation Updates a location. /// /// Thrown when fails to make API call /// The ID of the location to update. @@ -563,7 +767,7 @@ public UpdateLocationResponse UpdateLocation (string locationId, UpdateLocationR } /// - /// UpdateLocation Updates the `Location` specified by the given ID. + /// UpdateLocation Updates a location. /// /// Thrown when fails to make API call /// The ID of the location to update. @@ -599,7 +803,7 @@ public ApiResponse< UpdateLocationResponse > UpdateLocationWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -637,7 +841,7 @@ public ApiResponse< UpdateLocationResponse > UpdateLocationWithHttpInfo (string } /// - /// UpdateLocation Updates the `Location` specified by the given ID. + /// UpdateLocation Updates a location. /// /// Thrown when fails to make API call /// The ID of the location to update. @@ -651,7 +855,7 @@ public async System.Threading.Tasks.Task UpdateLocationA } /// - /// UpdateLocation Updates the `Location` specified by the given ID. + /// UpdateLocation Updates a location. /// /// Thrown when fails to make API call /// The ID of the location to update. @@ -687,7 +891,7 @@ public async System.Threading.Tasks.Task> Up String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { diff --git a/src/Square.Connect/Api/MerchantsApi.cs b/src/Square.Connect/Api/MerchantsApi.cs index ae27ff4..47a2e62 100644 --- a/src/Square.Connect/Api/MerchantsApi.cs +++ b/src/Square.Connect/Api/MerchantsApi.cs @@ -28,7 +28,7 @@ public interface IMerchantsApi : IApiAccessor /// ListMerchants /// /// - /// Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + /// Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. /// /// Thrown when fails to make API call /// The cursor generated by the previous response. (optional) @@ -38,7 +38,7 @@ public interface IMerchantsApi : IApiAccessor /// ListMerchants /// /// - /// Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + /// Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. /// /// Thrown when fails to make API call /// The cursor generated by the previous response. (optional) @@ -70,7 +70,7 @@ public interface IMerchantsApi : IApiAccessor /// ListMerchants /// /// - /// Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + /// Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. /// /// Thrown when fails to make API call /// The cursor generated by the previous response. (optional) @@ -81,7 +81,7 @@ public interface IMerchantsApi : IApiAccessor /// ListMerchants /// /// - /// Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + /// Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. /// /// Thrown when fails to make API call /// The cursor generated by the previous response. (optional) @@ -221,7 +221,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// ListMerchants Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + /// ListMerchants Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. /// /// Thrown when fails to make API call /// The cursor generated by the previous response. (optional) @@ -233,7 +233,7 @@ public ListMerchantsResponse ListMerchants (int? cursor = null) } /// - /// ListMerchants Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + /// ListMerchants Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. /// /// Thrown when fails to make API call /// The cursor generated by the previous response. (optional) @@ -262,7 +262,7 @@ public ApiResponse< ListMerchantsResponse > ListMerchantsWithHttpInfo (int? curs String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter // authentication (oauth2) required @@ -292,7 +292,7 @@ public ApiResponse< ListMerchantsResponse > ListMerchantsWithHttpInfo (int? curs } /// - /// ListMerchants Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + /// ListMerchants Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. /// /// Thrown when fails to make API call /// The cursor generated by the previous response. (optional) @@ -305,7 +305,7 @@ public async System.Threading.Tasks.Task ListMerchantsAsy } /// - /// ListMerchants Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. + /// ListMerchants Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](#endpoint-merchants-retrievemerchant) endpoint to get the merchant information. /// /// Thrown when fails to make API call /// The cursor generated by the previous response. (optional) @@ -334,7 +334,7 @@ public async System.Threading.Tasks.Task> Lis String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (cursor != null) localVarQueryParams.Add("cursor", Configuration.ApiClient.ParameterToString(cursor)); // query parameter // authentication (oauth2) required @@ -408,7 +408,7 @@ public ApiResponse< RetrieveMerchantResponse > RetrieveMerchantWithHttpInfo (str String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (merchantId != null) localVarPathParams.Add("merchant_id", Configuration.ApiClient.ParameterToString(merchantId)); // path parameter // authentication (oauth2) required @@ -483,7 +483,7 @@ public async System.Threading.Tasks.Task> String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (merchantId != null) localVarPathParams.Add("merchant_id", Configuration.ApiClient.ParameterToString(merchantId)); // path parameter // authentication (oauth2) required diff --git a/src/Square.Connect/Api/MobileAuthorizationApi.cs b/src/Square.Connect/Api/MobileAuthorizationApi.cs index 66f3781..64f048c 100644 --- a/src/Square.Connect/Api/MobileAuthorizationApi.cs +++ b/src/Square.Connect/Api/MobileAuthorizationApi.cs @@ -28,7 +28,7 @@ public interface IMobileAuthorizationApi : IApiAccessor /// CreateMobileAuthorizationCode /// /// - /// Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + /// Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/docs/build-basics/access-tokens). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -38,7 +38,7 @@ public interface IMobileAuthorizationApi : IApiAccessor /// CreateMobileAuthorizationCode /// /// - /// Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + /// Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/docs/build-basics/access-tokens). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -50,7 +50,7 @@ public interface IMobileAuthorizationApi : IApiAccessor /// CreateMobileAuthorizationCode /// /// - /// Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + /// Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/docs/build-basics/access-tokens). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -61,7 +61,7 @@ public interface IMobileAuthorizationApi : IApiAccessor /// CreateMobileAuthorizationCode /// /// - /// Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + /// Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/docs/build-basics/access-tokens). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -180,7 +180,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// CreateMobileAuthorizationCode Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + /// 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](/docs/build-basics/access-tokens). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -192,7 +192,7 @@ public CreateMobileAuthorizationCodeResponse CreateMobileAuthorizationCode (Crea } /// - /// CreateMobileAuthorizationCode Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + /// 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](/docs/build-basics/access-tokens). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -224,7 +224,7 @@ public ApiResponse< CreateMobileAuthorizationCodeResponse > CreateMobileAuthoriz String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -261,7 +261,7 @@ public ApiResponse< CreateMobileAuthorizationCodeResponse > CreateMobileAuthoriz } /// - /// CreateMobileAuthorizationCode Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + /// 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](/docs/build-basics/access-tokens). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -274,7 +274,7 @@ public async System.Threading.Tasks.Task } /// - /// CreateMobileAuthorizationCode Generates code to authorize a mobile application to connect to a Square card reader Authorization codes are one-time-use and expire __60 minutes__ after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](/get-started#step-4-understand-the-different-application-credentials). + /// 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](/docs/build-basics/access-tokens). /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -306,7 +306,7 @@ public async System.Threading.Tasks.Task /// - /// Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + /// Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -38,7 +38,7 @@ public interface IOAuthApi : IApiAccessor /// ObtainToken /// /// - /// Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + /// Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -48,10 +48,10 @@ public interface IOAuthApi : IApiAccessor /// RenewToken /// /// - /// `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + /// `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). /// /// Thrown when fails to make API call - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). /// An object containing the fields to POST for the request. See the corresponding object definition for field details. /// RenewTokenResponse [Obsolete] @@ -61,10 +61,10 @@ public interface IOAuthApi : IApiAccessor /// RenewToken /// /// - /// `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + /// `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). /// /// Thrown when fails to make API call - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). /// An object containing the fields to POST for the request. See the corresponding object definition for field details. /// ApiResponse of RenewTokenResponse ApiResponse RenewTokenWithHttpInfo (string clientId, RenewTokenRequest body); @@ -94,7 +94,7 @@ public interface IOAuthApi : IApiAccessor /// ObtainToken /// /// - /// Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + /// Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -105,7 +105,7 @@ public interface IOAuthApi : IApiAccessor /// ObtainToken /// /// - /// Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + /// Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -115,10 +115,10 @@ public interface IOAuthApi : IApiAccessor /// RenewToken /// /// - /// `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + /// `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). /// /// Thrown when fails to make API call - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). /// An object containing the fields to POST for the request. See the corresponding object definition for field details. /// Task of RenewTokenResponse System.Threading.Tasks.Task RenewTokenAsync (string clientId, RenewTokenRequest body); @@ -127,10 +127,10 @@ public interface IOAuthApi : IApiAccessor /// RenewToken /// /// - /// `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + /// `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). /// /// Thrown when fails to make API call - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). /// An object containing the fields to POST for the request. See the corresponding object definition for field details. /// Task of ApiResponse (RenewTokenResponse) System.Threading.Tasks.Task> RenewTokenAsyncWithHttpInfo (string clientId, RenewTokenRequest body); @@ -268,7 +268,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + /// ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -280,7 +280,7 @@ public ObtainTokenResponse ObtainToken (ObtainTokenRequest body) } /// - /// ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + /// ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -312,7 +312,7 @@ public ApiResponse< ObtainTokenResponse > ObtainTokenWithHttpInfo (ObtainTokenRe String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -343,7 +343,7 @@ public ApiResponse< ObtainTokenResponse > ObtainTokenWithHttpInfo (ObtainTokenRe } /// - /// ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + /// ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -356,7 +356,7 @@ public async System.Threading.Tasks.Task ObtainTokenAsync ( } /// - /// ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + /// ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -388,7 +388,7 @@ public async System.Threading.Tasks.Task> Obtai String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -419,10 +419,10 @@ public async System.Threading.Tasks.Task> Obtai } /// - /// RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + /// RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). /// /// Thrown when fails to make API call - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). /// An object containing the fields to POST for the request. See the corresponding object definition for field details. /// RenewTokenResponse public RenewTokenResponse RenewToken (string clientId, RenewTokenRequest body) @@ -432,10 +432,10 @@ public RenewTokenResponse RenewToken (string clientId, RenewTokenRequest body) } /// - /// RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + /// RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). /// /// Thrown when fails to make API call - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). /// An object containing the fields to POST for the request. See the corresponding object definition for field details. /// ApiResponse of RenewTokenResponse public ApiResponse< RenewTokenResponse > RenewTokenWithHttpInfo (string clientId, RenewTokenRequest body) @@ -468,7 +468,7 @@ public ApiResponse< RenewTokenResponse > RenewTokenWithHttpInfo (string clientId String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (clientId != null) localVarPathParams.Add("client_id", Configuration.ApiClient.ParameterToString(clientId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -506,10 +506,10 @@ public ApiResponse< RenewTokenResponse > RenewTokenWithHttpInfo (string clientId } /// - /// RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + /// RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). /// /// Thrown when fails to make API call - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). /// An object containing the fields to POST for the request. See the corresponding object definition for field details. /// Task of RenewTokenResponse public async System.Threading.Tasks.Task RenewTokenAsync (string clientId, RenewTokenRequest body) @@ -520,10 +520,10 @@ public async System.Threading.Tasks.Task RenewTokenAsync (st } /// - /// RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + /// RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). /// /// Thrown when fails to make API call - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// Your application ID, available from the [application dashboard](https://connect.squareup.com/apps). /// An object containing the fields to POST for the request. See the corresponding object definition for field details. /// Task of ApiResponse (RenewTokenResponse) public async System.Threading.Tasks.Task> RenewTokenAsyncWithHttpInfo (string clientId, RenewTokenRequest body) @@ -556,7 +556,7 @@ public async System.Threading.Tasks.Task> RenewT String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (clientId != null) localVarPathParams.Add("client_id", Configuration.ApiClient.ParameterToString(clientId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -637,7 +637,7 @@ public ApiResponse< RevokeTokenResponse > RevokeTokenWithHttpInfo (RevokeTokenRe String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -719,7 +719,7 @@ public async System.Threading.Tasks.Task> Revok String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter diff --git a/src/Square.Connect/Api/OrdersApi.cs b/src/Square.Connect/Api/OrdersApi.cs index 028141c..bb17f8e 100644 --- a/src/Square.Connect/Api/OrdersApi.cs +++ b/src/Square.Connect/Api/OrdersApi.cs @@ -415,7 +415,7 @@ public ApiResponse< BatchRetrieveOrdersResponse > BatchRetrieveOrdersWithHttpInf String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -503,7 +503,7 @@ public async System.Threading.Tasks.Task CreateOrderWithHttpInfo (string locati String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -678,7 +678,7 @@ public async System.Threading.Tasks.Task> Creat String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -765,7 +765,7 @@ public ApiResponse< PayOrderResponse > PayOrderWithHttpInfo (string orderId, Pay String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (orderId != null) localVarPathParams.Add("order_id", Configuration.ApiClient.ParameterToString(orderId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -853,7 +853,7 @@ public async System.Threading.Tasks.Task> PayOrder String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (orderId != null) localVarPathParams.Add("order_id", Configuration.ApiClient.ParameterToString(orderId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -935,7 +935,7 @@ public ApiResponse< SearchOrdersResponse > SearchOrdersWithHttpInfo (SearchOrder String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1017,7 +1017,7 @@ public async System.Threading.Tasks.Task> Sear String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1108,7 +1108,7 @@ public ApiResponse< UpdateOrderResponse > UpdateOrderWithHttpInfo (string locati String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (orderId != null) localVarPathParams.Add("order_id", Configuration.ApiClient.ParameterToString(orderId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -1202,7 +1202,7 @@ public async System.Threading.Tasks.Task> Updat String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (orderId != null) localVarPathParams.Add("order_id", Configuration.ApiClient.ParameterToString(orderId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) diff --git a/src/Square.Connect/Api/PaymentsApi.cs b/src/Square.Connect/Api/PaymentsApi.cs index 0a9ab9a..081a168 100644 --- a/src/Square.Connect/Api/PaymentsApi.cs +++ b/src/Square.Connect/Api/PaymentsApi.cs @@ -28,7 +28,7 @@ public interface IPaymentsApi : IApiAccessor /// CancelPayment /// /// - /// Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + /// Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). /// /// Thrown when fails to make API call /// `payment_id` identifying the payment to be canceled. @@ -38,7 +38,7 @@ public interface IPaymentsApi : IApiAccessor /// CancelPayment /// /// - /// Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + /// Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). /// /// Thrown when fails to make API call /// `payment_id` identifying the payment to be canceled. @@ -48,7 +48,7 @@ public interface IPaymentsApi : IApiAccessor /// CancelPaymentByIdempotencyKey /// /// - /// Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + /// Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -58,7 +58,7 @@ public interface IPaymentsApi : IApiAccessor /// CancelPaymentByIdempotencyKey /// /// - /// Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + /// Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -164,7 +164,7 @@ public interface IPaymentsApi : IApiAccessor /// CancelPayment /// /// - /// Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + /// Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). /// /// Thrown when fails to make API call /// `payment_id` identifying the payment to be canceled. @@ -175,7 +175,7 @@ public interface IPaymentsApi : IApiAccessor /// CancelPayment /// /// - /// Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + /// Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). /// /// Thrown when fails to make API call /// `payment_id` identifying the payment to be canceled. @@ -185,7 +185,7 @@ public interface IPaymentsApi : IApiAccessor /// CancelPaymentByIdempotencyKey /// /// - /// Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + /// Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -196,7 +196,7 @@ public interface IPaymentsApi : IApiAccessor /// CancelPaymentByIdempotencyKey /// /// - /// Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + /// Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -413,7 +413,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// CancelPayment Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + /// CancelPayment Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). /// /// Thrown when fails to make API call /// `payment_id` identifying the payment to be canceled. @@ -425,7 +425,7 @@ public CancelPaymentResponse CancelPayment (string paymentId) } /// - /// CancelPayment Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + /// CancelPayment Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). /// /// Thrown when fails to make API call /// `payment_id` identifying the payment to be canceled. @@ -457,7 +457,7 @@ public ApiResponse< CancelPaymentResponse > CancelPaymentWithHttpInfo (string pa String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (paymentId != null) localVarPathParams.Add("payment_id", Configuration.ApiClient.ParameterToString(paymentId)); // path parameter // authentication (oauth2) required @@ -487,7 +487,7 @@ public ApiResponse< CancelPaymentResponse > CancelPaymentWithHttpInfo (string pa } /// - /// CancelPayment Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + /// CancelPayment Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). /// /// Thrown when fails to make API call /// `payment_id` identifying the payment to be canceled. @@ -500,7 +500,7 @@ public async System.Threading.Tasks.Task CancelPaymentAsy } /// - /// CancelPayment Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). + /// CancelPayment Cancels (voids) a payment. If you set `autocomplete` to false when creating a payment, you can cancel the payment using this endpoint. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). /// /// Thrown when fails to make API call /// `payment_id` identifying the payment to be canceled. @@ -532,7 +532,7 @@ public async System.Threading.Tasks.Task> Can String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (paymentId != null) localVarPathParams.Add("payment_id", Configuration.ApiClient.ParameterToString(paymentId)); // path parameter // authentication (oauth2) required @@ -562,7 +562,7 @@ public async System.Threading.Tasks.Task> Can } /// - /// CancelPaymentByIdempotencyKey Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + /// CancelPaymentByIdempotencyKey Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -574,7 +574,7 @@ public CancelPaymentByIdempotencyKeyResponse CancelPaymentByIdempotencyKey (Canc } /// - /// CancelPaymentByIdempotencyKey Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + /// CancelPaymentByIdempotencyKey Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -606,7 +606,7 @@ public ApiResponse< CancelPaymentByIdempotencyKeyResponse > CancelPaymentByIdemp String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -643,7 +643,7 @@ public ApiResponse< CancelPaymentByIdempotencyKeyResponse > CancelPaymentByIdemp } /// - /// CancelPaymentByIdempotencyKey Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + /// CancelPaymentByIdempotencyKey Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -656,7 +656,7 @@ public async System.Threading.Tasks.Task } /// - /// CancelPaymentByIdempotencyKey Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. + /// CancelPaymentByIdempotencyKey Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't get a response. In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request you want to cancel. After cancelling the payment, you can submit your CreatePayment request again. Note that if no payment with the specified idempotency key is found, no action is taken, the end point returns successfully. /// /// Thrown when fails to make API call /// An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -688,7 +688,7 @@ public async System.Threading.Tasks.Task CompletePaymentWithHttpInfo (strin String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (paymentId != null) localVarPathParams.Add("payment_id", Configuration.ApiClient.ParameterToString(paymentId)); // path parameter // authentication (oauth2) required @@ -844,7 +844,7 @@ public async System.Threading.Tasks.Task> C String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (paymentId != null) localVarPathParams.Add("payment_id", Configuration.ApiClient.ParameterToString(paymentId)); // path parameter // authentication (oauth2) required @@ -918,7 +918,7 @@ public ApiResponse< CreatePaymentResponse > CreatePaymentWithHttpInfo (CreatePay String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1000,7 +1000,7 @@ public async System.Threading.Tasks.Task> Cre String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1081,7 +1081,7 @@ public ApiResponse< GetPaymentResponse > GetPaymentWithHttpInfo (string paymentI String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (paymentId != null) localVarPathParams.Add("payment_id", Configuration.ApiClient.ParameterToString(paymentId)); // path parameter // authentication (oauth2) required @@ -1156,7 +1156,7 @@ public async System.Threading.Tasks.Task> GetPay String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (paymentId != null) localVarPathParams.Add("payment_id", Configuration.ApiClient.ParameterToString(paymentId)); // path parameter // authentication (oauth2) required @@ -1241,7 +1241,7 @@ public ApiResponse< ListPaymentsResponse > ListPaymentsWithHttpInfo (string begi String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter if (sortOrder != null) localVarQueryParams.Add("sort_order", Configuration.ApiClient.ParameterToString(sortOrder)); // query parameter @@ -1334,7 +1334,7 @@ public async System.Threading.Tasks.Task> List String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter if (sortOrder != null) localVarQueryParams.Add("sort_order", Configuration.ApiClient.ParameterToString(sortOrder)); // query parameter diff --git a/src/Square.Connect/Api/RefundsApi.cs b/src/Square.Connect/Api/RefundsApi.cs index f317b10..a71aa3a 100644 --- a/src/Square.Connect/Api/RefundsApi.cs +++ b/src/Square.Connect/Api/RefundsApi.cs @@ -56,8 +56,8 @@ public interface IRefundsApi : IApiAccessor /// The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) /// 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) /// ID of location associated with payment. (optional) - /// 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) - /// 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) + /// 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) + /// 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) /// ListPaymentRefundsResponse ListPaymentRefundsResponse ListPaymentRefunds (string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null, string locationId = null, string status = null, string sourceType = null); /// @@ -72,8 +72,8 @@ public interface IRefundsApi : IApiAccessor /// The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) /// 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) /// ID of location associated with payment. (optional) - /// 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) - /// 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) + /// 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) + /// 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) /// ApiResponse of ListPaymentRefundsResponse ApiResponse ListPaymentRefundsWithHttpInfo (string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null, string locationId = null, string status = null, string sourceType = null); /// @@ -131,8 +131,8 @@ public interface IRefundsApi : IApiAccessor /// The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) /// 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) /// ID of location associated with payment. (optional) - /// 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) - /// 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) + /// 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) + /// 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) /// Task of ListPaymentRefundsResponse System.Threading.Tasks.Task ListPaymentRefundsAsync (string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null, string locationId = null, string status = null, string sourceType = null); @@ -148,8 +148,8 @@ public interface IRefundsApi : IApiAccessor /// The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) /// 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) /// ID of location associated with payment. (optional) - /// 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) - /// 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) + /// 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) + /// 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) /// Task of ApiResponse (ListPaymentRefundsResponse) System.Threading.Tasks.Task> ListPaymentRefundsAsyncWithHttpInfo (string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null, string locationId = null, string status = null, string sourceType = null); /// @@ -330,7 +330,7 @@ public ApiResponse< GetPaymentRefundResponse > GetPaymentRefundWithHttpInfo (str String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (refundId != null) localVarPathParams.Add("refund_id", Configuration.ApiClient.ParameterToString(refundId)); // path parameter // authentication (oauth2) required @@ -405,7 +405,7 @@ public async System.Threading.Tasks.Task> String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (refundId != null) localVarPathParams.Add("refund_id", Configuration.ApiClient.ParameterToString(refundId)); // path parameter // authentication (oauth2) required @@ -443,8 +443,8 @@ public async System.Threading.Tasks.Task> /// The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) /// 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) /// ID of location associated with payment. (optional) - /// 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) - /// 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) + /// 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) + /// 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) /// ListPaymentRefundsResponse public ListPaymentRefundsResponse ListPaymentRefunds (string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null, string locationId = null, string status = null, string sourceType = null) { @@ -461,8 +461,8 @@ public ListPaymentRefundsResponse ListPaymentRefunds (string beginTime = null, s /// The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) /// 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) /// ID of location associated with payment. (optional) - /// 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) - /// 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) + /// 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) + /// 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) /// ApiResponse of ListPaymentRefundsResponse public ApiResponse< ListPaymentRefundsResponse > ListPaymentRefundsWithHttpInfo (string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null, string locationId = null, string status = null, string sourceType = null) { @@ -488,7 +488,7 @@ public ApiResponse< ListPaymentRefundsResponse > ListPaymentRefundsWithHttpInfo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter if (sortOrder != null) localVarQueryParams.Add("sort_order", Configuration.ApiClient.ParameterToString(sortOrder)); // query parameter @@ -532,8 +532,8 @@ public ApiResponse< ListPaymentRefundsResponse > ListPaymentRefundsWithHttpInfo /// The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) /// 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) /// ID of location associated with payment. (optional) - /// 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) - /// 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) + /// 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) + /// 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) /// Task of ListPaymentRefundsResponse public async System.Threading.Tasks.Task ListPaymentRefundsAsync (string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null, string locationId = null, string status = null, string sourceType = null) { @@ -551,8 +551,8 @@ public async System.Threading.Tasks.Task ListPayment /// The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). (optional) /// 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) /// ID of location associated with payment. (optional) - /// 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) - /// 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) + /// 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) + /// 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) /// Task of ApiResponse (ListPaymentRefundsResponse) public async System.Threading.Tasks.Task> ListPaymentRefundsAsyncWithHttpInfo (string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null, string locationId = null, string status = null, string sourceType = null) { @@ -578,7 +578,7 @@ public async System.Threading.Tasks.Task String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter if (sortOrder != null) localVarQueryParams.Add("sort_order", Configuration.ApiClient.ParameterToString(sortOrder)); // query parameter @@ -658,7 +658,7 @@ public ApiResponse< RefundPaymentResponse > RefundPaymentWithHttpInfo (RefundPay String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -740,7 +740,7 @@ public async System.Threading.Tasks.Task> Ref String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter diff --git a/src/Square.Connect/Api/ReportingApi.cs b/src/Square.Connect/Api/ReportingApi.cs index 01e5e7a..116aaf6 100644 --- a/src/Square.Connect/Api/ReportingApi.cs +++ b/src/Square.Connect/Api/ReportingApi.cs @@ -35,7 +35,7 @@ public interface IReportingApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ListAdditionalRecipientReceivableRefundsResponse [Obsolete] ListAdditionalRecipientReceivableRefundsResponse ListAdditionalRecipientReceivableRefunds (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); @@ -51,7 +51,7 @@ public interface IReportingApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ApiResponse of ListAdditionalRecipientReceivableRefundsResponse ApiResponse ListAdditionalRecipientReceivableRefundsWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); /// @@ -65,7 +65,7 @@ public interface IReportingApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ListAdditionalRecipientReceivablesResponse [Obsolete] ListAdditionalRecipientReceivablesResponse ListAdditionalRecipientReceivables (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); @@ -81,7 +81,7 @@ public interface IReportingApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ApiResponse of ListAdditionalRecipientReceivablesResponse ApiResponse ListAdditionalRecipientReceivablesWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); #endregion Synchronous Operations @@ -97,7 +97,7 @@ public interface IReportingApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ListAdditionalRecipientReceivableRefundsResponse System.Threading.Tasks.Task ListAdditionalRecipientReceivableRefundsAsync (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); @@ -112,7 +112,7 @@ public interface IReportingApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ApiResponse (ListAdditionalRecipientReceivableRefundsResponse) System.Threading.Tasks.Task> ListAdditionalRecipientReceivableRefundsAsyncWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); /// @@ -126,7 +126,7 @@ public interface IReportingApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ListAdditionalRecipientReceivablesResponse System.Threading.Tasks.Task ListAdditionalRecipientReceivablesAsync (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); @@ -141,7 +141,7 @@ public interface IReportingApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ApiResponse (ListAdditionalRecipientReceivablesResponse) System.Threading.Tasks.Task> ListAdditionalRecipientReceivablesAsyncWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); #endregion Asynchronous Operations @@ -264,7 +264,7 @@ public void AddDefaultHeader(string key, string value) /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ListAdditionalRecipientReceivableRefundsResponse public ListAdditionalRecipientReceivableRefundsResponse ListAdditionalRecipientReceivableRefunds (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -280,7 +280,7 @@ public ListAdditionalRecipientReceivableRefundsResponse ListAdditionalRecipientR /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ApiResponse of ListAdditionalRecipientReceivableRefundsResponse public ApiResponse< ListAdditionalRecipientReceivableRefundsResponse > ListAdditionalRecipientReceivableRefundsWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -309,7 +309,7 @@ public ApiResponse< ListAdditionalRecipientReceivableRefundsResponse > ListAddit String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter @@ -350,7 +350,7 @@ public ApiResponse< ListAdditionalRecipientReceivableRefundsResponse > ListAddit /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ListAdditionalRecipientReceivableRefundsResponse public async System.Threading.Tasks.Task ListAdditionalRecipientReceivableRefundsAsync (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -367,7 +367,7 @@ public async System.Threading.Tasks.TaskThe 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ApiResponse (ListAdditionalRecipientReceivableRefundsResponse) public async System.Threading.Tasks.Task> ListAdditionalRecipientReceivableRefundsAsyncWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -396,7 +396,7 @@ public async System.Threading.Tasks.TaskThe 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ListAdditionalRecipientReceivablesResponse public ListAdditionalRecipientReceivablesResponse ListAdditionalRecipientReceivables (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -453,7 +453,7 @@ public ListAdditionalRecipientReceivablesResponse ListAdditionalRecipientReceiva /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ApiResponse of ListAdditionalRecipientReceivablesResponse public ApiResponse< ListAdditionalRecipientReceivablesResponse > ListAdditionalRecipientReceivablesWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -482,7 +482,7 @@ public ApiResponse< ListAdditionalRecipientReceivablesResponse > ListAdditionalR String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter @@ -523,7 +523,7 @@ public ApiResponse< ListAdditionalRecipientReceivablesResponse > ListAdditionalR /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ListAdditionalRecipientReceivablesResponse public async System.Threading.Tasks.Task ListAdditionalRecipientReceivablesAsync (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -540,7 +540,7 @@ public async System.Threading.Tasks.TaskThe 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ApiResponse (ListAdditionalRecipientReceivablesResponse) public async System.Threading.Tasks.Task> ListAdditionalRecipientReceivablesAsyncWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -569,7 +569,7 @@ public async System.Threading.Tasks.Task /// - /// Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -41,7 +41,7 @@ public interface ITransactionsApi : IApiAccessor /// CaptureTransaction /// /// - /// Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -52,7 +52,7 @@ public interface ITransactionsApi : IApiAccessor /// Charge /// /// - /// Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + /// Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. /// /// Thrown when fails to make API call /// The ID of the location to associate the created transaction with. @@ -65,7 +65,7 @@ public interface ITransactionsApi : IApiAccessor /// Charge /// /// - /// Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + /// Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. /// /// Thrown when fails to make API call /// The ID of the location to associate the created transaction with. @@ -109,7 +109,7 @@ public interface ITransactionsApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ListRefundsResponse [Obsolete] ListRefundsResponse ListRefunds (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); @@ -125,7 +125,7 @@ public interface ITransactionsApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ApiResponse of ListRefundsResponse ApiResponse ListRefundsWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); /// @@ -139,7 +139,7 @@ public interface ITransactionsApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ListTransactionsResponse [Obsolete] ListTransactionsResponse ListTransactions (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); @@ -155,7 +155,7 @@ public interface ITransactionsApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ApiResponse of ListTransactionsResponse ApiResponse ListTransactionsWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); /// @@ -186,7 +186,7 @@ public interface ITransactionsApi : IApiAccessor /// VoidTransaction /// /// - /// Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -199,7 +199,7 @@ public interface ITransactionsApi : IApiAccessor /// VoidTransaction /// /// - /// Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -212,7 +212,7 @@ public interface ITransactionsApi : IApiAccessor /// CaptureTransaction /// /// - /// Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -224,7 +224,7 @@ public interface ITransactionsApi : IApiAccessor /// CaptureTransaction /// /// - /// Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -235,7 +235,7 @@ public interface ITransactionsApi : IApiAccessor /// Charge /// /// - /// Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + /// Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. /// /// Thrown when fails to make API call /// The ID of the location to associate the created transaction with. @@ -247,7 +247,7 @@ public interface ITransactionsApi : IApiAccessor /// Charge /// /// - /// Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + /// Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. /// /// Thrown when fails to make API call /// The ID of the location to associate the created transaction with. @@ -290,7 +290,7 @@ public interface ITransactionsApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ListRefundsResponse System.Threading.Tasks.Task ListRefundsAsync (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); @@ -305,7 +305,7 @@ public interface ITransactionsApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ApiResponse (ListRefundsResponse) System.Threading.Tasks.Task> ListRefundsAsyncWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); /// @@ -319,7 +319,7 @@ public interface ITransactionsApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ListTransactionsResponse System.Threading.Tasks.Task ListTransactionsAsync (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); @@ -334,7 +334,7 @@ public interface ITransactionsApi : IApiAccessor /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ApiResponse (ListTransactionsResponse) System.Threading.Tasks.Task> ListTransactionsAsyncWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null); /// @@ -364,7 +364,7 @@ public interface ITransactionsApi : IApiAccessor /// VoidTransaction /// /// - /// Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -376,7 +376,7 @@ public interface ITransactionsApi : IApiAccessor /// VoidTransaction /// /// - /// Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -496,7 +496,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -509,7 +509,7 @@ public CaptureTransactionResponse CaptureTransaction (string locationId, string } /// - /// CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -545,7 +545,7 @@ public ApiResponse< CaptureTransactionResponse > CaptureTransactionWithHttpInfo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (transactionId != null) localVarPathParams.Add("transaction_id", Configuration.ApiClient.ParameterToString(transactionId)); // path parameter @@ -576,7 +576,7 @@ public ApiResponse< CaptureTransactionResponse > CaptureTransactionWithHttpInfo } /// - /// CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -590,7 +590,7 @@ public async System.Threading.Tasks.Task CaptureTran } /// - /// CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -626,7 +626,7 @@ public async System.Threading.Tasks.Task String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (transactionId != null) localVarPathParams.Add("transaction_id", Configuration.ApiClient.ParameterToString(transactionId)); // path parameter @@ -657,7 +657,7 @@ public async System.Threading.Tasks.Task } /// - /// Charge Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + /// Charge Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. /// /// Thrown when fails to make API call /// The ID of the location to associate the created transaction with. @@ -670,7 +670,7 @@ public ChargeResponse Charge (string locationId, ChargeRequest body) } /// - /// Charge Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + /// Charge Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. /// /// Thrown when fails to make API call /// The ID of the location to associate the created transaction with. @@ -706,7 +706,7 @@ public ApiResponse< ChargeResponse > ChargeWithHttpInfo (string locationId, Char String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -744,7 +744,7 @@ public ApiResponse< ChargeResponse > ChargeWithHttpInfo (string locationId, Char } /// - /// Charge Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + /// Charge Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. /// /// Thrown when fails to make API call /// The ID of the location to associate the created transaction with. @@ -758,7 +758,7 @@ public async System.Threading.Tasks.Task ChargeAsync (string loc } /// - /// Charge Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-transactions-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + /// Charge Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. /// /// Thrown when fails to make API call /// The ID of the location to associate the created transaction with. @@ -794,7 +794,7 @@ public async System.Threading.Tasks.Task> ChargeAsyn String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -886,7 +886,7 @@ public ApiResponse< CreateRefundResponse > CreateRefundWithHttpInfo (string loca String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (transactionId != null) localVarPathParams.Add("transaction_id", Configuration.ApiClient.ParameterToString(transactionId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -980,7 +980,7 @@ public async System.Threading.Tasks.Task> Crea String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (transactionId != null) localVarPathParams.Add("transaction_id", Configuration.ApiClient.ParameterToString(transactionId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -1026,7 +1026,7 @@ public async System.Threading.Tasks.Task> Crea /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ListRefundsResponse public ListRefundsResponse ListRefunds (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -1042,7 +1042,7 @@ public ListRefundsResponse ListRefunds (string locationId, string beginTime = nu /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ApiResponse of ListRefundsResponse public ApiResponse< ListRefundsResponse > ListRefundsWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -1071,7 +1071,7 @@ public ApiResponse< ListRefundsResponse > ListRefundsWithHttpInfo (string locati String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter @@ -1112,7 +1112,7 @@ public ApiResponse< ListRefundsResponse > ListRefundsWithHttpInfo (string locati /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ListRefundsResponse public async System.Threading.Tasks.Task ListRefundsAsync (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -1129,7 +1129,7 @@ public async System.Threading.Tasks.Task ListRefundsAsync ( /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ApiResponse (ListRefundsResponse) public async System.Threading.Tasks.Task> ListRefundsAsyncWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -1158,7 +1158,7 @@ public async System.Threading.Tasks.Task> ListR String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter @@ -1199,7 +1199,7 @@ public async System.Threading.Tasks.Task> ListR /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ListTransactionsResponse public ListTransactionsResponse ListTransactions (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -1215,7 +1215,7 @@ public ListTransactionsResponse ListTransactions (string locationId, string begi /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// ApiResponse of ListTransactionsResponse public ApiResponse< ListTransactionsResponse > ListTransactionsWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -1244,7 +1244,7 @@ public ApiResponse< ListTransactionsResponse > ListTransactionsWithHttpInfo (str String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter @@ -1285,7 +1285,7 @@ public ApiResponse< ListTransactionsResponse > ListTransactionsWithHttpInfo (str /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ListTransactionsResponse public async System.Threading.Tasks.Task ListTransactionsAsync (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -1302,7 +1302,7 @@ public async System.Threading.Tasks.Task ListTransacti /// 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) /// 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) /// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` (optional) - /// 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) + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. (optional) /// Task of ApiResponse (ListTransactionsResponse) public async System.Threading.Tasks.Task> ListTransactionsAsyncWithHttpInfo (string locationId, string beginTime = null, string endTime = null, string sortOrder = null, string cursor = null) { @@ -1331,7 +1331,7 @@ public async System.Threading.Tasks.Task> String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter if (endTime != null) localVarQueryParams.Add("end_time", Configuration.ApiClient.ParameterToString(endTime)); // query parameter @@ -1414,7 +1414,7 @@ public ApiResponse< RetrieveTransactionResponse > RetrieveTransactionWithHttpInf String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (transactionId != null) localVarPathParams.Add("transaction_id", Configuration.ApiClient.ParameterToString(transactionId)); // path parameter @@ -1495,7 +1495,7 @@ public async System.Threading.Tasks.Task - /// VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -1539,7 +1539,7 @@ public VoidTransactionResponse VoidTransaction (string locationId, string transa } /// - /// VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -1575,7 +1575,7 @@ public ApiResponse< VoidTransactionResponse > VoidTransactionWithHttpInfo (strin String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (transactionId != null) localVarPathParams.Add("transaction_id", Configuration.ApiClient.ParameterToString(transactionId)); // path parameter @@ -1606,7 +1606,7 @@ public ApiResponse< VoidTransactionResponse > VoidTransactionWithHttpInfo (strin } /// - /// VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -1620,7 +1620,7 @@ public async System.Threading.Tasks.Task VoidTransactio } /// - /// VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-transactions-charge) endpoint with a `delay_capture` value of `true`. See the [Delay Capture of Funds](/transactions-api/cookbook/delay-capture) recipe for more information. + /// VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. /// /// Thrown when fails to make API call /// @@ -1656,7 +1656,7 @@ public async System.Threading.Tasks.Task> V String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (transactionId != null) localVarPathParams.Add("transaction_id", Configuration.ApiClient.ParameterToString(transactionId)); // path parameter diff --git a/src/Square.Connect/Api/V1EmployeesApi.cs b/src/Square.Connect/Api/V1EmployeesApi.cs index 28a162c..09ee1d1 100644 --- a/src/Square.Connect/Api/V1EmployeesApi.cs +++ b/src/Square.Connect/Api/V1EmployeesApi.cs @@ -947,7 +947,7 @@ public ApiResponse< V1Employee > CreateEmployeeWithHttpInfo (V1Employee body) String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1029,7 +1029,7 @@ public async System.Threading.Tasks.Task> CreateEmployee String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1110,7 +1110,7 @@ public ApiResponse< V1EmployeeRole > CreateEmployeeRoleWithHttpInfo (V1EmployeeR String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (employeeRole != null && employeeRole.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(employeeRole); // http body (model) parameter @@ -1192,7 +1192,7 @@ public async System.Threading.Tasks.Task> CreateEmpl String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (employeeRole != null && employeeRole.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(employeeRole); // http body (model) parameter @@ -1273,7 +1273,7 @@ public ApiResponse< V1Timecard > CreateTimecardWithHttpInfo (V1Timecard body) String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1355,7 +1355,7 @@ public async System.Threading.Tasks.Task> CreateTimecard String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (body != null && body.GetType() != typeof(byte[])) { localVarPostBody = Configuration.ApiClient.Serialize(body); // http body (model) parameter @@ -1436,7 +1436,7 @@ public ApiResponse< Object > DeleteTimecardWithHttpInfo (string timecardId) String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (timecardId != null) localVarPathParams.Add("timecard_id", Configuration.ApiClient.ParameterToString(timecardId)); // path parameter // authentication (oauth2) required @@ -1511,7 +1511,7 @@ public async System.Threading.Tasks.Task> DeleteTimecardAsyn String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (timecardId != null) localVarPathParams.Add("timecard_id", Configuration.ApiClient.ParameterToString(timecardId)); // path parameter // authentication (oauth2) required @@ -1591,7 +1591,7 @@ public ApiResponse< List > ListCashDrawerShiftsWithHttpInfo ( String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter @@ -1675,7 +1675,7 @@ public async System.Threading.Tasks.Task>> L String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter @@ -1753,7 +1753,7 @@ public ApiResponse< List > ListEmployeeRolesWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter if (batchToken != null) localVarQueryParams.Add("batch_token", Configuration.ApiClient.ParameterToString(batchToken)); // query parameter @@ -1831,7 +1831,7 @@ public async System.Threading.Tasks.Task>> List String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter if (batchToken != null) localVarQueryParams.Add("batch_token", Configuration.ApiClient.ParameterToString(batchToken)); // query parameter @@ -1920,7 +1920,7 @@ public ApiResponse< List > ListEmployeesWithHttpInfo (string order = String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginUpdatedAt != null) localVarQueryParams.Add("begin_updated_at", Configuration.ApiClient.ParameterToString(beginUpdatedAt)); // query parameter if (endUpdatedAt != null) localVarQueryParams.Add("end_updated_at", Configuration.ApiClient.ParameterToString(endUpdatedAt)); // query parameter @@ -2016,7 +2016,7 @@ public async System.Threading.Tasks.Task>> ListEmpl String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginUpdatedAt != null) localVarQueryParams.Add("begin_updated_at", Configuration.ApiClient.ParameterToString(beginUpdatedAt)); // query parameter if (endUpdatedAt != null) localVarQueryParams.Add("end_updated_at", Configuration.ApiClient.ParameterToString(endUpdatedAt)); // query parameter @@ -2098,7 +2098,7 @@ public ApiResponse< List > ListTimecardEventsWithHttpInfo (stri String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (timecardId != null) localVarPathParams.Add("timecard_id", Configuration.ApiClient.ParameterToString(timecardId)); // path parameter // authentication (oauth2) required @@ -2173,7 +2173,7 @@ public async System.Threading.Tasks.Task>> Lis String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (timecardId != null) localVarPathParams.Add("timecard_id", Configuration.ApiClient.ParameterToString(timecardId)); // path parameter // authentication (oauth2) required @@ -2264,7 +2264,7 @@ public ApiResponse< List > ListTimecardsWithHttpInfo (string order = String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (employeeId != null) localVarQueryParams.Add("employee_id", Configuration.ApiClient.ParameterToString(employeeId)); // query parameter if (beginClockinTime != null) localVarQueryParams.Add("begin_clockin_time", Configuration.ApiClient.ParameterToString(beginClockinTime)); // query parameter @@ -2366,7 +2366,7 @@ public async System.Threading.Tasks.Task>> ListTime String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (employeeId != null) localVarQueryParams.Add("employee_id", Configuration.ApiClient.ParameterToString(employeeId)); // query parameter if (beginClockinTime != null) localVarQueryParams.Add("begin_clockin_time", Configuration.ApiClient.ParameterToString(beginClockinTime)); // query parameter @@ -2455,7 +2455,7 @@ public ApiResponse< V1CashDrawerShift > RetrieveCashDrawerShiftWithHttpInfo (str String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (shiftId != null) localVarPathParams.Add("shift_id", Configuration.ApiClient.ParameterToString(shiftId)); // path parameter @@ -2536,7 +2536,7 @@ public async System.Threading.Tasks.Task> Retriev String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (shiftId != null) localVarPathParams.Add("shift_id", Configuration.ApiClient.ParameterToString(shiftId)); // path parameter @@ -2611,7 +2611,7 @@ public ApiResponse< V1Employee > RetrieveEmployeeWithHttpInfo (string employeeId String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (employeeId != null) localVarPathParams.Add("employee_id", Configuration.ApiClient.ParameterToString(employeeId)); // path parameter // authentication (oauth2) required @@ -2686,7 +2686,7 @@ public async System.Threading.Tasks.Task> RetrieveEmploy String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (employeeId != null) localVarPathParams.Add("employee_id", Configuration.ApiClient.ParameterToString(employeeId)); // path parameter // authentication (oauth2) required @@ -2760,7 +2760,7 @@ public ApiResponse< V1EmployeeRole > RetrieveEmployeeRoleWithHttpInfo (string ro String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (roleId != null) localVarPathParams.Add("role_id", Configuration.ApiClient.ParameterToString(roleId)); // path parameter // authentication (oauth2) required @@ -2835,7 +2835,7 @@ public async System.Threading.Tasks.Task> RetrieveEm String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (roleId != null) localVarPathParams.Add("role_id", Configuration.ApiClient.ParameterToString(roleId)); // path parameter // authentication (oauth2) required @@ -2909,7 +2909,7 @@ public ApiResponse< V1Timecard > RetrieveTimecardWithHttpInfo (string timecardId String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (timecardId != null) localVarPathParams.Add("timecard_id", Configuration.ApiClient.ParameterToString(timecardId)); // path parameter // authentication (oauth2) required @@ -2984,7 +2984,7 @@ public async System.Threading.Tasks.Task> RetrieveTimeca String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (timecardId != null) localVarPathParams.Add("timecard_id", Configuration.ApiClient.ParameterToString(timecardId)); // path parameter // authentication (oauth2) required @@ -3063,7 +3063,7 @@ public ApiResponse< V1Employee > UpdateEmployeeWithHttpInfo (string employeeId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (employeeId != null) localVarPathParams.Add("employee_id", Configuration.ApiClient.ParameterToString(employeeId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3151,7 +3151,7 @@ public async System.Threading.Tasks.Task> UpdateEmployee String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (employeeId != null) localVarPathParams.Add("employee_id", Configuration.ApiClient.ParameterToString(employeeId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3238,7 +3238,7 @@ public ApiResponse< V1EmployeeRole > UpdateEmployeeRoleWithHttpInfo (string role String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (roleId != null) localVarPathParams.Add("role_id", Configuration.ApiClient.ParameterToString(roleId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3326,7 +3326,7 @@ public async System.Threading.Tasks.Task> UpdateEmpl String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (roleId != null) localVarPathParams.Add("role_id", Configuration.ApiClient.ParameterToString(roleId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3413,7 +3413,7 @@ public ApiResponse< V1Timecard > UpdateTimecardWithHttpInfo (string timecardId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (timecardId != null) localVarPathParams.Add("timecard_id", Configuration.ApiClient.ParameterToString(timecardId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3501,7 +3501,7 @@ public async System.Threading.Tasks.Task> UpdateTimecard String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (timecardId != null) localVarPathParams.Add("timecard_id", Configuration.ApiClient.ParameterToString(timecardId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { diff --git a/src/Square.Connect/Api/V1ItemsApi.cs b/src/Square.Connect/Api/V1ItemsApi.cs index 8fc03c5..dedea65 100644 --- a/src/Square.Connect/Api/V1ItemsApi.cs +++ b/src/Square.Connect/Api/V1ItemsApi.cs @@ -28,19 +28,21 @@ public interface IV1ItemsApi : IApiAccessor /// AdjustInventory /// /// - /// Adjusts an item variation's current available inventory. + /// Adjusts the current available inventory of an item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the variation to adjust inventory information for. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1InventoryEntry V1InventoryEntry AdjustInventory (string locationId, string variationId, V1AdjustInventoryRequest body); + /// V1InventoryEntry + [Obsolete] + V1InventoryEntry AdjustInventory (string locationId, string variationId, V1AdjustInventoryRequest body); /// /// AdjustInventory /// /// - /// Adjusts an item variation's current available inventory. + /// Adjusts the current available inventory of an item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -52,19 +54,21 @@ public interface IV1ItemsApi : IApiAccessor /// ApplyFee /// /// - /// Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + /// Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. /// The ID of the item to add the fee to. /// The ID of the fee to apply. - /// V1Item V1Item ApplyFee (string locationId, string itemId, string feeId); + /// V1Item + [Obsolete] + V1Item ApplyFee (string locationId, string itemId, string feeId); /// /// ApplyFee /// /// - /// Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + /// Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -76,19 +80,21 @@ public interface IV1ItemsApi : IApiAccessor /// ApplyModifierList /// /// - /// Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + /// Associates a modifier list with an item so the associated modifier options can be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the modifier list to apply. /// The ID of the item to add the modifier list to. - /// V1Item V1Item ApplyModifierList (string locationId, string modifierListId, string itemId); + /// V1Item + [Obsolete] + V1Item ApplyModifierList (string locationId, string modifierListId, string itemId); /// /// ApplyModifierList /// /// - /// Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + /// Associates a modifier list with an item so the associated modifier options can be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -100,18 +106,20 @@ public interface IV1ItemsApi : IApiAccessor /// CreateCategory /// /// - /// Creates an item category. + /// Creates an item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Category V1Category CreateCategory (string locationId, V1Category body); + /// V1Category + [Obsolete] + V1Category CreateCategory (string locationId, V1Category body); /// /// CreateCategory /// /// - /// Creates an item category. + /// Creates an item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -122,18 +130,20 @@ public interface IV1ItemsApi : IApiAccessor /// CreateDiscount /// /// - /// Creates a discount. + /// Creates a discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Discount V1Discount CreateDiscount (string locationId, V1Discount body); + /// V1Discount + [Obsolete] + V1Discount CreateDiscount (string locationId, V1Discount body); /// /// CreateDiscount /// /// - /// Creates a discount. + /// Creates a discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -144,18 +154,20 @@ public interface IV1ItemsApi : IApiAccessor /// CreateFee /// /// - /// Creates a fee (tax). + /// Creates a fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a fee for. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Fee V1Fee CreateFee (string locationId, V1Fee body); + /// V1Fee + [Obsolete] + V1Fee CreateFee (string locationId, V1Fee body); /// /// CreateFee /// /// - /// Creates a fee (tax). + /// Creates a fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a fee for. @@ -166,18 +178,20 @@ public interface IV1ItemsApi : IApiAccessor /// CreateItem /// /// - /// Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. + /// Creates an item and at least one variation for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. /// /// Thrown when fails to make API call /// The ID of the location to create an item for. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Item V1Item CreateItem (string locationId, V1Item body); + /// V1Item + [Obsolete] + V1Item CreateItem (string locationId, V1Item body); /// /// CreateItem /// /// - /// Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. + /// Creates an item and at least one variation for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -188,18 +202,20 @@ public interface IV1ItemsApi : IApiAccessor /// CreateModifierList /// /// - /// Creates an item modifier list and at least one modifier option for it. + /// Creates an item modifier list and at least 1 modifier option for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a modifier list for. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1ModifierList V1ModifierList CreateModifierList (string locationId, V1ModifierList body); + /// V1ModifierList + [Obsolete] + V1ModifierList CreateModifierList (string locationId, V1ModifierList body); /// /// CreateModifierList /// /// - /// Creates an item modifier list and at least one modifier option for it. + /// Creates an item modifier list and at least 1 modifier option for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a modifier list for. @@ -210,19 +226,21 @@ public interface IV1ItemsApi : IApiAccessor /// CreateModifierOption /// /// - /// Creates an item modifier option and adds it to a modifier list. + /// Creates an item modifier option and adds it to a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the modifier list to edit. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1ModifierOption V1ModifierOption CreateModifierOption (string locationId, string modifierListId, V1ModifierOption body); + /// V1ModifierOption + [Obsolete] + V1ModifierOption CreateModifierOption (string locationId, string modifierListId, V1ModifierOption body); /// /// CreateModifierOption /// /// - /// Creates an item modifier option and adds it to a modifier list. + /// Creates an item modifier option and adds it to a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -234,18 +252,20 @@ public interface IV1ItemsApi : IApiAccessor /// CreatePage /// /// - /// Creates a Favorites page in Square Register. + /// Creates a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Page V1Page CreatePage (string locationId, V1Page body); + /// V1Page + [Obsolete] + V1Page CreatePage (string locationId, V1Page body); /// /// CreatePage /// /// - /// Creates a Favorites page in Square Register. + /// Creates a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -256,19 +276,21 @@ public interface IV1ItemsApi : IApiAccessor /// CreateVariation /// /// - /// Creates an item variation for an existing item. + /// Creates an item variation for an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The item's ID. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Variation V1Variation CreateVariation (string locationId, string itemId, V1Variation body); + /// V1Variation + [Obsolete] + V1Variation CreateVariation (string locationId, string itemId, V1Variation body); /// /// CreateVariation /// /// - /// Creates an item variation for an existing item. + /// Creates an item variation for an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -280,18 +302,20 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteCategory /// /// - /// Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + /// Deletes an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the category to delete. - /// V1Category V1Category DeleteCategory (string locationId, string categoryId); + /// V1Category + [Obsolete] + V1Category DeleteCategory (string locationId, string categoryId); /// /// DeleteCategory /// /// - /// Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + /// Deletes an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -302,18 +326,20 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteDiscount /// /// - /// Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + /// Deletes an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the discount to delete. - /// V1Discount V1Discount DeleteDiscount (string locationId, string discountId); + /// V1Discount + [Obsolete] + V1Discount DeleteDiscount (string locationId, string discountId); /// /// DeleteDiscount /// /// - /// Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + /// Deletes an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -324,18 +350,20 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteFee /// /// - /// Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + /// Deletes an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the fee's associated location. /// The ID of the fee to delete. - /// V1Fee V1Fee DeleteFee (string locationId, string feeId); + /// V1Fee + [Obsolete] + V1Fee DeleteFee (string locationId, string feeId); /// /// DeleteFee /// /// - /// Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + /// Deletes an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -346,18 +374,20 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteItem /// /// - /// Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + /// Deletes an existing item and all item variations associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the item to modify. - /// V1Item V1Item DeleteItem (string locationId, string itemId); + /// V1Item + [Obsolete] + V1Item DeleteItem (string locationId, string itemId); /// /// DeleteItem /// /// - /// Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + /// Deletes an existing item and all item variations associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -368,18 +398,20 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteModifierList /// /// - /// Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + /// Deletes an existing item modifier list and all modifier options associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the modifier list to delete. - /// V1ModifierList V1ModifierList DeleteModifierList (string locationId, string modifierListId); + /// V1ModifierList + [Obsolete] + V1ModifierList DeleteModifierList (string locationId, string modifierListId); /// /// DeleteModifierList /// /// - /// Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + /// Deletes an existing item modifier list and all modifier options associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -390,19 +422,21 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteModifierOption /// /// - /// Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. + /// Deletes an existing item modifier option from a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the modifier list to delete. /// The ID of the modifier list to edit. - /// V1ModifierOption V1ModifierOption DeleteModifierOption (string locationId, string modifierListId, string modifierOptionId); + /// V1ModifierOption + [Obsolete] + V1ModifierOption DeleteModifierOption (string locationId, string modifierListId, string modifierOptionId); /// /// DeleteModifierOption /// /// - /// Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. + /// Deletes an existing item modifier option from a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -414,18 +448,20 @@ public interface IV1ItemsApi : IApiAccessor /// DeletePage /// /// - /// Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. + /// Deletes an existing Favorites page and all of its cells. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. /// The ID of the page to delete. - /// V1Page V1Page DeletePage (string locationId, string pageId); + /// V1Page + [Obsolete] + V1Page DeletePage (string locationId, string pageId); /// /// DeletePage /// /// - /// Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. + /// Deletes an existing Favorites page and all of its cells. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -436,20 +472,22 @@ public interface IV1ItemsApi : IApiAccessor /// DeletePageCell /// /// - /// Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + /// Deletes a cell from a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. /// The ID of the page to delete. /// The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row. (optional) /// The column of the cell to clear. Always an integer between 0 and 4, inclusive. Column 0 is the leftmost column. (optional) - /// V1Page V1Page DeletePageCell (string locationId, string pageId, string row = null, string column = null); + /// V1Page + [Obsolete] + V1Page DeletePageCell (string locationId, string pageId, string row = null, string column = null); /// /// DeletePageCell /// /// - /// Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + /// Deletes a cell from a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -462,19 +500,21 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteVariation /// /// - /// Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + /// Deletes an existing item variation from an item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the item to delete. /// The ID of the variation to delete. - /// V1Variation V1Variation DeleteVariation (string locationId, string itemId, string variationId); + /// V1Variation + [Obsolete] + V1Variation DeleteVariation (string locationId, string itemId, string variationId); /// /// DeleteVariation /// /// - /// Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + /// Deletes an existing item variation from an item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -486,17 +526,19 @@ public interface IV1ItemsApi : IApiAccessor /// ListCategories /// /// - /// Lists all of a location's item categories. + /// Lists all the item categories for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. - /// List<V1Category> List ListCategories (string locationId); + /// List<V1Category> + [Obsolete] + List ListCategories (string locationId); /// /// ListCategories /// /// - /// Lists all of a location's item categories. + /// Lists all the item categories for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -506,17 +548,19 @@ public interface IV1ItemsApi : IApiAccessor /// ListDiscounts /// /// - /// Lists all of a location's discounts. + /// Lists all the discounts for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. - /// List<V1Discount> List ListDiscounts (string locationId); + /// List<V1Discount> + [Obsolete] + List ListDiscounts (string locationId); /// /// ListDiscounts /// /// - /// Lists all of a location's discounts. + /// Lists all the discounts for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -526,17 +570,19 @@ public interface IV1ItemsApi : IApiAccessor /// ListFees /// /// - /// Lists all of a location's fees (taxes). + /// Lists all the fees (taxes) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list fees for. - /// List<V1Fee> List ListFees (string locationId); + /// List<V1Fee> + [Obsolete] + List ListFees (string locationId); /// /// ListFees /// /// - /// Lists all of a location's fees (taxes). + /// Lists all the fees (taxes) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list fees for. @@ -546,19 +592,21 @@ public interface IV1ItemsApi : IApiAccessor /// ListInventory /// /// - /// Provides inventory information for all of a merchant's inventory-enabled item variations. + /// Provides inventory information for all inventory-enabled item variations. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. (optional) /// A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) - /// List<V1InventoryEntry> List ListInventory (string locationId, int? limit = null, string batchToken = null); + /// List<V1InventoryEntry> + [Obsolete] + List ListInventory (string locationId, int? limit = null, string batchToken = null); /// /// ListInventory /// /// - /// Provides inventory information for all of a merchant's inventory-enabled item variations. + /// Provides inventory information for all inventory-enabled item variations. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -570,18 +618,20 @@ public interface IV1ItemsApi : IApiAccessor /// ListItems /// /// - /// Provides summary information for all of a location's items. + /// Provides summary information of all items for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list items for. /// A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) - /// List<V1Item> List ListItems (string locationId, string batchToken = null); + /// List<V1Item> + [Obsolete] + List ListItems (string locationId, string batchToken = null); /// /// ListItems /// /// - /// Provides summary information for all of a location's items. + /// Provides summary information of all items for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list items for. @@ -592,17 +642,19 @@ public interface IV1ItemsApi : IApiAccessor /// ListModifierLists /// /// - /// Lists all of a location's modifier lists. + /// Lists all the modifier lists for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list modifier lists for. - /// List<V1ModifierList> List ListModifierLists (string locationId); + /// List<V1ModifierList> + [Obsolete] + List ListModifierLists (string locationId); /// /// ListModifierLists /// /// - /// Lists all of a location's modifier lists. + /// Lists all the modifier lists for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list modifier lists for. @@ -612,17 +664,19 @@ public interface IV1ItemsApi : IApiAccessor /// ListPages /// /// - /// Lists all of a location's Favorites pages in Square Register. + /// Lists all Favorites pages (in Square Point of Sale) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list Favorites pages for. - /// List<V1Page> List ListPages (string locationId); + /// List<V1Page> + [Obsolete] + List ListPages (string locationId); /// /// ListPages /// /// - /// Lists all of a location's Favorites pages in Square Register. + /// Lists all Favorites pages (in Square Point of Sale) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list Favorites pages for. @@ -632,19 +686,21 @@ public interface IV1ItemsApi : IApiAccessor /// RemoveFee /// /// - /// Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + /// Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. /// The ID of the item to add the fee to. /// The ID of the fee to apply. - /// V1Item V1Item RemoveFee (string locationId, string itemId, string feeId); + /// V1Item + [Obsolete] + V1Item RemoveFee (string locationId, string itemId, string feeId); /// /// RemoveFee /// /// - /// Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + /// Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -656,19 +712,21 @@ public interface IV1ItemsApi : IApiAccessor /// RemoveModifierList /// /// - /// Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + /// Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the modifier list to remove. /// The ID of the item to remove the modifier list from. - /// V1Item V1Item RemoveModifierList (string locationId, string modifierListId, string itemId); + /// V1Item + [Obsolete] + V1Item RemoveModifierList (string locationId, string modifierListId, string itemId); /// /// RemoveModifierList /// /// - /// Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + /// Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -680,18 +738,20 @@ public interface IV1ItemsApi : IApiAccessor /// RetrieveItem /// /// - /// Provides the details for a single item, including associated modifier lists and fees. + /// Provides the details for a single item, including associated modifier lists and fees. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The item's ID. - /// V1Item V1Item RetrieveItem (string locationId, string itemId); + /// V1Item + [Obsolete] + V1Item RetrieveItem (string locationId, string itemId); /// /// RetrieveItem /// /// - /// Provides the details for a single item, including associated modifier lists and fees. + /// Provides the details for a single item, including associated modifier lists and fees. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -702,18 +762,20 @@ public interface IV1ItemsApi : IApiAccessor /// RetrieveModifierList /// /// - /// Provides the details for a single modifier list. + /// Provides the details for a single modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The modifier list's ID. - /// V1ModifierList V1ModifierList RetrieveModifierList (string locationId, string modifierListId); + /// V1ModifierList + [Obsolete] + V1ModifierList RetrieveModifierList (string locationId, string modifierListId); /// /// RetrieveModifierList /// /// - /// Provides the details for a single modifier list. + /// Provides the details for a single modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -724,19 +786,21 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateCategory /// /// - /// Modifies the details of an existing item category. + /// Modifies the details of an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. /// The ID of the category to edit. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Category V1Category UpdateCategory (string locationId, string categoryId, V1Category body); + /// V1Category + [Obsolete] + V1Category UpdateCategory (string locationId, string categoryId, V1Category body); /// /// UpdateCategory /// /// - /// Modifies the details of an existing item category. + /// Modifies the details of an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -748,19 +812,21 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateDiscount /// /// - /// Modifies the details of an existing discount. + /// Modifies the details of an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. /// The ID of the discount to edit. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Discount V1Discount UpdateDiscount (string locationId, string discountId, V1Discount body); + /// V1Discount + [Obsolete] + V1Discount UpdateDiscount (string locationId, string discountId, V1Discount body); /// /// UpdateDiscount /// /// - /// Modifies the details of an existing discount. + /// Modifies the details of an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -772,19 +838,21 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateFee /// /// - /// Modifies the details of an existing fee (tax). + /// Modifies the details of an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. /// The ID of the fee to edit. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Fee V1Fee UpdateFee (string locationId, string feeId, V1Fee body); + /// V1Fee + [Obsolete] + V1Fee UpdateFee (string locationId, string feeId, V1Fee body); /// /// UpdateFee /// /// - /// Modifies the details of an existing fee (tax). + /// Modifies the details of an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -796,19 +864,21 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateItem /// /// - /// Modifies the core details of an existing item. + /// Modifies the core details of an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the item to modify. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Item V1Item UpdateItem (string locationId, string itemId, V1Item body); + /// V1Item + [Obsolete] + V1Item UpdateItem (string locationId, string itemId, V1Item body); /// /// UpdateItem /// /// - /// Modifies the core details of an existing item. + /// Modifies the core details of an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -820,19 +890,21 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateModifierList /// /// - /// Modifies the details of an existing item modifier list. + /// Modifies the details of an existing item modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the modifier list to edit. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1ModifierList V1ModifierList UpdateModifierList (string locationId, string modifierListId, V1UpdateModifierListRequest body); + /// V1ModifierList + [Obsolete] + V1ModifierList UpdateModifierList (string locationId, string modifierListId, V1UpdateModifierListRequest body); /// /// UpdateModifierList /// /// - /// Modifies the details of an existing item modifier list. + /// Modifies the details of an existing item modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -844,20 +916,22 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateModifierOption /// /// - /// Modifies the details of an existing item modifier option. + /// Modifies the details of an existing item modifier option. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the modifier list to edit. /// The ID of the modifier list to edit. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1ModifierOption V1ModifierOption UpdateModifierOption (string locationId, string modifierListId, string modifierOptionId, V1ModifierOption body); + /// V1ModifierOption + [Obsolete] + V1ModifierOption UpdateModifierOption (string locationId, string modifierListId, string modifierOptionId, V1ModifierOption body); /// /// UpdateModifierOption /// /// - /// Modifies the details of an existing item modifier option. + /// Modifies the details of an existing item modifier option. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -870,19 +944,21 @@ public interface IV1ItemsApi : IApiAccessor /// UpdatePage /// /// - /// Modifies the details of a Favorites page in Square Register. + /// Modifies the details of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location /// The ID of the page to modify. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Page V1Page UpdatePage (string locationId, string pageId, V1Page body); + /// V1Page + [Obsolete] + V1Page UpdatePage (string locationId, string pageId, V1Page body); /// /// UpdatePage /// /// - /// Modifies the details of a Favorites page in Square Register. + /// Modifies the details of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location @@ -894,19 +970,21 @@ public interface IV1ItemsApi : IApiAccessor /// UpdatePageCell /// /// - /// Modifies a cell of a Favorites page in Square Register. + /// Modifies a cell of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. /// The ID of the page the cell belongs to. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Page V1Page UpdatePageCell (string locationId, string pageId, V1PageCell body); + /// V1Page + [Obsolete] + V1Page UpdatePageCell (string locationId, string pageId, V1PageCell body); /// /// UpdatePageCell /// /// - /// Modifies a cell of a Favorites page in Square Register. + /// Modifies a cell of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -918,20 +996,22 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateVariation /// /// - /// Modifies the details of an existing item variation. + /// Modifies the details of an existing item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. /// The ID of the item to modify. /// The ID of the variation to modify. /// An object containing the fields to POST for the request. See the corresponding object definition for field details. - /// V1Variation V1Variation UpdateVariation (string locationId, string itemId, string variationId, V1Variation body); + /// V1Variation + [Obsolete] + V1Variation UpdateVariation (string locationId, string itemId, string variationId, V1Variation body); /// /// UpdateVariation /// /// - /// Modifies the details of an existing item variation. + /// Modifies the details of an existing item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -946,7 +1026,7 @@ public interface IV1ItemsApi : IApiAccessor /// AdjustInventory /// /// - /// Adjusts an item variation's current available inventory. + /// Adjusts the current available inventory of an item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -959,7 +1039,7 @@ public interface IV1ItemsApi : IApiAccessor /// AdjustInventory /// /// - /// Adjusts an item variation's current available inventory. + /// Adjusts the current available inventory of an item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -971,7 +1051,7 @@ public interface IV1ItemsApi : IApiAccessor /// ApplyFee /// /// - /// Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + /// Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -984,7 +1064,7 @@ public interface IV1ItemsApi : IApiAccessor /// ApplyFee /// /// - /// Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + /// Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -996,7 +1076,7 @@ public interface IV1ItemsApi : IApiAccessor /// ApplyModifierList /// /// - /// Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + /// Associates a modifier list with an item so the associated modifier options can be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1009,7 +1089,7 @@ public interface IV1ItemsApi : IApiAccessor /// ApplyModifierList /// /// - /// Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + /// Associates a modifier list with an item so the associated modifier options can be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1021,7 +1101,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateCategory /// /// - /// Creates an item category. + /// Creates an item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -1033,7 +1113,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateCategory /// /// - /// Creates an item category. + /// Creates an item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -1044,7 +1124,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateDiscount /// /// - /// Creates a discount. + /// Creates a discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -1056,7 +1136,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateDiscount /// /// - /// Creates a discount. + /// Creates a discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -1067,7 +1147,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateFee /// /// - /// Creates a fee (tax). + /// Creates a fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a fee for. @@ -1079,7 +1159,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateFee /// /// - /// Creates a fee (tax). + /// Creates a fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a fee for. @@ -1090,7 +1170,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateItem /// /// - /// Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. + /// Creates an item and at least one variation for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -1102,7 +1182,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateItem /// /// - /// Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. + /// Creates an item and at least one variation for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -1113,7 +1193,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateModifierList /// /// - /// Creates an item modifier list and at least one modifier option for it. + /// Creates an item modifier list and at least 1 modifier option for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a modifier list for. @@ -1125,7 +1205,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateModifierList /// /// - /// Creates an item modifier list and at least one modifier option for it. + /// Creates an item modifier list and at least 1 modifier option for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a modifier list for. @@ -1136,7 +1216,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateModifierOption /// /// - /// Creates an item modifier option and adds it to a modifier list. + /// Creates an item modifier option and adds it to a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1149,7 +1229,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateModifierOption /// /// - /// Creates an item modifier option and adds it to a modifier list. + /// Creates an item modifier option and adds it to a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1161,7 +1241,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreatePage /// /// - /// Creates a Favorites page in Square Register. + /// Creates a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -1173,7 +1253,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreatePage /// /// - /// Creates a Favorites page in Square Register. + /// Creates a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -1184,7 +1264,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateVariation /// /// - /// Creates an item variation for an existing item. + /// Creates an item variation for an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1197,7 +1277,7 @@ public interface IV1ItemsApi : IApiAccessor /// CreateVariation /// /// - /// Creates an item variation for an existing item. + /// Creates an item variation for an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1209,7 +1289,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteCategory /// /// - /// Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + /// Deletes an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1221,7 +1301,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteCategory /// /// - /// Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + /// Deletes an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1232,7 +1312,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteDiscount /// /// - /// Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + /// Deletes an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1244,7 +1324,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteDiscount /// /// - /// Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + /// Deletes an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1255,7 +1335,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteFee /// /// - /// Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + /// Deletes an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -1267,7 +1347,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteFee /// /// - /// Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + /// Deletes an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -1278,7 +1358,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteItem /// /// - /// Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + /// Deletes an existing item and all item variations associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1290,7 +1370,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteItem /// /// - /// Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + /// Deletes an existing item and all item variations associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1301,7 +1381,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteModifierList /// /// - /// Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + /// Deletes an existing item modifier list and all modifier options associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1313,7 +1393,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteModifierList /// /// - /// Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + /// Deletes an existing item modifier list and all modifier options associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1324,7 +1404,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteModifierOption /// /// - /// Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. + /// Deletes an existing item modifier option from a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1337,7 +1417,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteModifierOption /// /// - /// Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. + /// Deletes an existing item modifier option from a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1349,7 +1429,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeletePage /// /// - /// Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. + /// Deletes an existing Favorites page and all of its cells. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -1361,7 +1441,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeletePage /// /// - /// Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. + /// Deletes an existing Favorites page and all of its cells. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -1372,7 +1452,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeletePageCell /// /// - /// Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + /// Deletes a cell from a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -1386,7 +1466,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeletePageCell /// /// - /// Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + /// Deletes a cell from a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -1399,7 +1479,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteVariation /// /// - /// Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + /// Deletes an existing item variation from an item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1412,7 +1492,7 @@ public interface IV1ItemsApi : IApiAccessor /// DeleteVariation /// /// - /// Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + /// Deletes an existing item variation from an item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1424,7 +1504,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListCategories /// /// - /// Lists all of a location's item categories. + /// Lists all the item categories for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -1435,7 +1515,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListCategories /// /// - /// Lists all of a location's item categories. + /// Lists all the item categories for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -1445,7 +1525,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListDiscounts /// /// - /// Lists all of a location's discounts. + /// Lists all the discounts for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -1456,7 +1536,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListDiscounts /// /// - /// Lists all of a location's discounts. + /// Lists all the discounts for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -1466,7 +1546,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListFees /// /// - /// Lists all of a location's fees (taxes). + /// Lists all the fees (taxes) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list fees for. @@ -1477,7 +1557,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListFees /// /// - /// Lists all of a location's fees (taxes). + /// Lists all the fees (taxes) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list fees for. @@ -1487,7 +1567,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListInventory /// /// - /// Provides inventory information for all of a merchant's inventory-enabled item variations. + /// Provides inventory information for all inventory-enabled item variations. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1500,7 +1580,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListInventory /// /// - /// Provides inventory information for all of a merchant's inventory-enabled item variations. + /// Provides inventory information for all inventory-enabled item variations. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1512,7 +1592,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListItems /// /// - /// Provides summary information for all of a location's items. + /// Provides summary information of all items for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list items for. @@ -1524,7 +1604,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListItems /// /// - /// Provides summary information for all of a location's items. + /// Provides summary information of all items for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list items for. @@ -1535,7 +1615,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListModifierLists /// /// - /// Lists all of a location's modifier lists. + /// Lists all the modifier lists for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list modifier lists for. @@ -1546,7 +1626,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListModifierLists /// /// - /// Lists all of a location's modifier lists. + /// Lists all the modifier lists for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list modifier lists for. @@ -1556,7 +1636,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListPages /// /// - /// Lists all of a location's Favorites pages in Square Register. + /// Lists all Favorites pages (in Square Point of Sale) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list Favorites pages for. @@ -1567,7 +1647,7 @@ public interface IV1ItemsApi : IApiAccessor /// ListPages /// /// - /// Lists all of a location's Favorites pages in Square Register. + /// Lists all Favorites pages (in Square Point of Sale) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list Favorites pages for. @@ -1577,7 +1657,7 @@ public interface IV1ItemsApi : IApiAccessor /// RemoveFee /// /// - /// Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + /// Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -1590,7 +1670,7 @@ public interface IV1ItemsApi : IApiAccessor /// RemoveFee /// /// - /// Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + /// Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -1602,7 +1682,7 @@ public interface IV1ItemsApi : IApiAccessor /// RemoveModifierList /// /// - /// Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + /// Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1615,7 +1695,7 @@ public interface IV1ItemsApi : IApiAccessor /// RemoveModifierList /// /// - /// Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + /// Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1627,7 +1707,7 @@ public interface IV1ItemsApi : IApiAccessor /// RetrieveItem /// /// - /// Provides the details for a single item, including associated modifier lists and fees. + /// Provides the details for a single item, including associated modifier lists and fees. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1639,7 +1719,7 @@ public interface IV1ItemsApi : IApiAccessor /// RetrieveItem /// /// - /// Provides the details for a single item, including associated modifier lists and fees. + /// Provides the details for a single item, including associated modifier lists and fees. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1650,7 +1730,7 @@ public interface IV1ItemsApi : IApiAccessor /// RetrieveModifierList /// /// - /// Provides the details for a single modifier list. + /// Provides the details for a single modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1662,7 +1742,7 @@ public interface IV1ItemsApi : IApiAccessor /// RetrieveModifierList /// /// - /// Provides the details for a single modifier list. + /// Provides the details for a single modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1673,7 +1753,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateCategory /// /// - /// Modifies the details of an existing item category. + /// Modifies the details of an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -1686,7 +1766,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateCategory /// /// - /// Modifies the details of an existing item category. + /// Modifies the details of an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -1698,7 +1778,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateDiscount /// /// - /// Modifies the details of an existing discount. + /// Modifies the details of an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -1711,7 +1791,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateDiscount /// /// - /// Modifies the details of an existing discount. + /// Modifies the details of an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -1723,7 +1803,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateFee /// /// - /// Modifies the details of an existing fee (tax). + /// Modifies the details of an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -1736,7 +1816,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateFee /// /// - /// Modifies the details of an existing fee (tax). + /// Modifies the details of an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -1748,7 +1828,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateItem /// /// - /// Modifies the core details of an existing item. + /// Modifies the core details of an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1761,7 +1841,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateItem /// /// - /// Modifies the core details of an existing item. + /// Modifies the core details of an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1773,7 +1853,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateModifierList /// /// - /// Modifies the details of an existing item modifier list. + /// Modifies the details of an existing item modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1786,7 +1866,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateModifierList /// /// - /// Modifies the details of an existing item modifier list. + /// Modifies the details of an existing item modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1798,7 +1878,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateModifierOption /// /// - /// Modifies the details of an existing item modifier option. + /// Modifies the details of an existing item modifier option. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1812,7 +1892,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateModifierOption /// /// - /// Modifies the details of an existing item modifier option. + /// Modifies the details of an existing item modifier option. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1825,7 +1905,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdatePage /// /// - /// Modifies the details of a Favorites page in Square Register. + /// Modifies the details of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location @@ -1838,7 +1918,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdatePage /// /// - /// Modifies the details of a Favorites page in Square Register. + /// Modifies the details of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location @@ -1850,7 +1930,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdatePageCell /// /// - /// Modifies a cell of a Favorites page in Square Register. + /// Modifies a cell of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -1863,7 +1943,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdatePageCell /// /// - /// Modifies a cell of a Favorites page in Square Register. + /// Modifies a cell of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -1875,7 +1955,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateVariation /// /// - /// Modifies the details of an existing item variation. + /// Modifies the details of an existing item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -1889,7 +1969,7 @@ public interface IV1ItemsApi : IApiAccessor /// UpdateVariation /// /// - /// Modifies the details of an existing item variation. + /// Modifies the details of an existing item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -2011,7 +2091,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// AdjustInventory Adjusts an item variation's current available inventory. + /// AdjustInventory Adjusts the current available inventory of an item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -2025,7 +2105,7 @@ public V1InventoryEntry AdjustInventory (string locationId, string variationId, } /// - /// AdjustInventory Adjusts an item variation's current available inventory. + /// AdjustInventory Adjusts the current available inventory of an item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -2065,7 +2145,7 @@ public ApiResponse< V1InventoryEntry > AdjustInventoryWithHttpInfo (string locat String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (variationId != null) localVarPathParams.Add("variation_id", Configuration.ApiClient.ParameterToString(variationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -2104,7 +2184,7 @@ public ApiResponse< V1InventoryEntry > AdjustInventoryWithHttpInfo (string locat } /// - /// AdjustInventory Adjusts an item variation's current available inventory. + /// AdjustInventory Adjusts the current available inventory of an item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -2119,7 +2199,7 @@ public async System.Threading.Tasks.Task AdjustInventoryAsync } /// - /// AdjustInventory Adjusts an item variation's current available inventory. + /// AdjustInventory Adjusts the current available inventory of an item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -2159,7 +2239,7 @@ public async System.Threading.Tasks.Task> AdjustIn String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (variationId != null) localVarPathParams.Add("variation_id", Configuration.ApiClient.ParameterToString(variationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -2198,7 +2278,7 @@ public async System.Threading.Tasks.Task> AdjustIn } /// - /// ApplyFee Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + /// ApplyFee Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -2212,7 +2292,7 @@ public V1Item ApplyFee (string locationId, string itemId, string feeId) } /// - /// ApplyFee Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + /// ApplyFee Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -2252,7 +2332,7 @@ public ApiResponse< V1Item > ApplyFeeWithHttpInfo (string locationId, string ite String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (feeId != null) localVarPathParams.Add("fee_id", Configuration.ApiClient.ParameterToString(feeId)); // path parameter @@ -2284,7 +2364,7 @@ public ApiResponse< V1Item > ApplyFeeWithHttpInfo (string locationId, string ite } /// - /// ApplyFee Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + /// ApplyFee Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -2299,7 +2379,7 @@ public async System.Threading.Tasks.Task ApplyFeeAsync (string locationI } /// - /// ApplyFee Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + /// ApplyFee Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -2339,7 +2419,7 @@ public async System.Threading.Tasks.Task> ApplyFeeAsyncWithH String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (feeId != null) localVarPathParams.Add("fee_id", Configuration.ApiClient.ParameterToString(feeId)); // path parameter @@ -2371,7 +2451,7 @@ public async System.Threading.Tasks.Task> ApplyFeeAsyncWithH } /// - /// ApplyModifierList Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + /// ApplyModifierList Associates a modifier list with an item so the associated modifier options can be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -2385,7 +2465,7 @@ public V1Item ApplyModifierList (string locationId, string modifierListId, strin } /// - /// ApplyModifierList Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + /// ApplyModifierList Associates a modifier list with an item so the associated modifier options can be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -2425,7 +2505,7 @@ public ApiResponse< V1Item > ApplyModifierListWithHttpInfo (string locationId, s String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter @@ -2457,7 +2537,7 @@ public ApiResponse< V1Item > ApplyModifierListWithHttpInfo (string locationId, s } /// - /// ApplyModifierList Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + /// ApplyModifierList Associates a modifier list with an item so the associated modifier options can be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -2472,7 +2552,7 @@ public async System.Threading.Tasks.Task ApplyModifierListAsync (string } /// - /// ApplyModifierList Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + /// ApplyModifierList Associates a modifier list with an item so the associated modifier options can be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -2512,7 +2592,7 @@ public async System.Threading.Tasks.Task> ApplyModifierListA String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter @@ -2544,7 +2624,7 @@ public async System.Threading.Tasks.Task> ApplyModifierListA } /// - /// CreateCategory Creates an item category. + /// CreateCategory Creates an item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -2557,7 +2637,7 @@ public V1Category CreateCategory (string locationId, V1Category body) } /// - /// CreateCategory Creates an item category. + /// CreateCategory Creates an item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -2593,7 +2673,7 @@ public ApiResponse< V1Category > CreateCategoryWithHttpInfo (string locationId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2631,7 +2711,7 @@ public ApiResponse< V1Category > CreateCategoryWithHttpInfo (string locationId, } /// - /// CreateCategory Creates an item category. + /// CreateCategory Creates an item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -2645,7 +2725,7 @@ public async System.Threading.Tasks.Task CreateCategoryAsync (string } /// - /// CreateCategory Creates an item category. + /// CreateCategory Creates an item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -2681,7 +2761,7 @@ public async System.Threading.Tasks.Task> CreateCategory String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2719,7 +2799,7 @@ public async System.Threading.Tasks.Task> CreateCategory } /// - /// CreateDiscount Creates a discount. + /// CreateDiscount Creates a discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -2732,7 +2812,7 @@ public V1Discount CreateDiscount (string locationId, V1Discount body) } /// - /// CreateDiscount Creates a discount. + /// CreateDiscount Creates a discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -2768,7 +2848,7 @@ public ApiResponse< V1Discount > CreateDiscountWithHttpInfo (string locationId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2806,7 +2886,7 @@ public ApiResponse< V1Discount > CreateDiscountWithHttpInfo (string locationId, } /// - /// CreateDiscount Creates a discount. + /// CreateDiscount Creates a discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -2820,7 +2900,7 @@ public async System.Threading.Tasks.Task CreateDiscountAsync (string } /// - /// CreateDiscount Creates a discount. + /// CreateDiscount Creates a discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -2856,7 +2936,7 @@ public async System.Threading.Tasks.Task> CreateDiscount String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2894,7 +2974,7 @@ public async System.Threading.Tasks.Task> CreateDiscount } /// - /// CreateFee Creates a fee (tax). + /// CreateFee Creates a fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a fee for. @@ -2907,7 +2987,7 @@ public V1Fee CreateFee (string locationId, V1Fee body) } /// - /// CreateFee Creates a fee (tax). + /// CreateFee Creates a fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a fee for. @@ -2943,7 +3023,7 @@ public ApiResponse< V1Fee > CreateFeeWithHttpInfo (string locationId, V1Fee body String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -2981,7 +3061,7 @@ public ApiResponse< V1Fee > CreateFeeWithHttpInfo (string locationId, V1Fee body } /// - /// CreateFee Creates a fee (tax). + /// CreateFee Creates a fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a fee for. @@ -2995,7 +3075,7 @@ public async System.Threading.Tasks.Task CreateFeeAsync (string locationI } /// - /// CreateFee Creates a fee (tax). + /// CreateFee Creates a fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a fee for. @@ -3031,7 +3111,7 @@ public async System.Threading.Tasks.Task> CreateFeeAsyncWithH String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3069,7 +3149,7 @@ public async System.Threading.Tasks.Task> CreateFeeAsyncWithH } /// - /// CreateItem Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. + /// CreateItem Creates an item and at least one variation for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -3082,7 +3162,7 @@ public V1Item CreateItem (string locationId, V1Item body) } /// - /// CreateItem Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. + /// CreateItem Creates an item and at least one variation for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -3118,7 +3198,7 @@ public ApiResponse< V1Item > CreateItemWithHttpInfo (string locationId, V1Item b String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3156,7 +3236,7 @@ public ApiResponse< V1Item > CreateItemWithHttpInfo (string locationId, V1Item b } /// - /// CreateItem Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. + /// CreateItem Creates an item and at least one variation for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -3170,7 +3250,7 @@ public async System.Threading.Tasks.Task CreateItemAsync (string locatio } /// - /// CreateItem Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. + /// CreateItem Creates an item and at least one variation for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -3206,7 +3286,7 @@ public async System.Threading.Tasks.Task> CreateItemAsyncWit String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3244,7 +3324,7 @@ public async System.Threading.Tasks.Task> CreateItemAsyncWit } /// - /// CreateModifierList Creates an item modifier list and at least one modifier option for it. + /// CreateModifierList Creates an item modifier list and at least 1 modifier option for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a modifier list for. @@ -3257,7 +3337,7 @@ public V1ModifierList CreateModifierList (string locationId, V1ModifierList body } /// - /// CreateModifierList Creates an item modifier list and at least one modifier option for it. + /// CreateModifierList Creates an item modifier list and at least 1 modifier option for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a modifier list for. @@ -3293,7 +3373,7 @@ public ApiResponse< V1ModifierList > CreateModifierListWithHttpInfo (string loca String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3331,7 +3411,7 @@ public ApiResponse< V1ModifierList > CreateModifierListWithHttpInfo (string loca } /// - /// CreateModifierList Creates an item modifier list and at least one modifier option for it. + /// CreateModifierList Creates an item modifier list and at least 1 modifier option for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a modifier list for. @@ -3345,7 +3425,7 @@ public async System.Threading.Tasks.Task CreateModifierListAsync } /// - /// CreateModifierList Creates an item modifier list and at least one modifier option for it. + /// CreateModifierList Creates an item modifier list and at least 1 modifier option for it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create a modifier list for. @@ -3381,7 +3461,7 @@ public async System.Threading.Tasks.Task> CreateModi String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3419,7 +3499,7 @@ public async System.Threading.Tasks.Task> CreateModi } /// - /// CreateModifierOption Creates an item modifier option and adds it to a modifier list. + /// CreateModifierOption Creates an item modifier option and adds it to a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -3433,7 +3513,7 @@ public V1ModifierOption CreateModifierOption (string locationId, string modifier } /// - /// CreateModifierOption Creates an item modifier option and adds it to a modifier list. + /// CreateModifierOption Creates an item modifier option and adds it to a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -3473,7 +3553,7 @@ public ApiResponse< V1ModifierOption > CreateModifierOptionWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -3512,7 +3592,7 @@ public ApiResponse< V1ModifierOption > CreateModifierOptionWithHttpInfo (string } /// - /// CreateModifierOption Creates an item modifier option and adds it to a modifier list. + /// CreateModifierOption Creates an item modifier option and adds it to a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -3527,7 +3607,7 @@ public async System.Threading.Tasks.Task CreateModifierOptionA } /// - /// CreateModifierOption Creates an item modifier option and adds it to a modifier list. + /// CreateModifierOption Creates an item modifier option and adds it to a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -3567,7 +3647,7 @@ public async System.Threading.Tasks.Task> CreateMo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -3606,7 +3686,7 @@ public async System.Threading.Tasks.Task> CreateMo } /// - /// CreatePage Creates a Favorites page in Square Register. + /// CreatePage Creates a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -3619,7 +3699,7 @@ public V1Page CreatePage (string locationId, V1Page body) } /// - /// CreatePage Creates a Favorites page in Square Register. + /// CreatePage Creates a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -3655,7 +3735,7 @@ public ApiResponse< V1Page > CreatePageWithHttpInfo (string locationId, V1Page b String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3693,7 +3773,7 @@ public ApiResponse< V1Page > CreatePageWithHttpInfo (string locationId, V1Page b } /// - /// CreatePage Creates a Favorites page in Square Register. + /// CreatePage Creates a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -3707,7 +3787,7 @@ public async System.Threading.Tasks.Task CreatePageAsync (string locatio } /// - /// CreatePage Creates a Favorites page in Square Register. + /// CreatePage Creates a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to create an item for. @@ -3743,7 +3823,7 @@ public async System.Threading.Tasks.Task> CreatePageAsyncWit String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -3781,7 +3861,7 @@ public async System.Threading.Tasks.Task> CreatePageAsyncWit } /// - /// CreateVariation Creates an item variation for an existing item. + /// CreateVariation Creates an item variation for an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -3795,7 +3875,7 @@ public V1Variation CreateVariation (string locationId, string itemId, V1Variatio } /// - /// CreateVariation Creates an item variation for an existing item. + /// CreateVariation Creates an item variation for an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -3835,7 +3915,7 @@ public ApiResponse< V1Variation > CreateVariationWithHttpInfo (string locationId String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -3874,7 +3954,7 @@ public ApiResponse< V1Variation > CreateVariationWithHttpInfo (string locationId } /// - /// CreateVariation Creates an item variation for an existing item. + /// CreateVariation Creates an item variation for an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -3889,7 +3969,7 @@ public async System.Threading.Tasks.Task CreateVariationAsync (stri } /// - /// CreateVariation Creates an item variation for an existing item. + /// CreateVariation Creates an item variation for an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -3929,7 +4009,7 @@ public async System.Threading.Tasks.Task> CreateVariati String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -3968,7 +4048,7 @@ public async System.Threading.Tasks.Task> CreateVariati } /// - /// DeleteCategory Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + /// DeleteCategory Deletes an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -3981,7 +4061,7 @@ public V1Category DeleteCategory (string locationId, string categoryId) } /// - /// DeleteCategory Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + /// DeleteCategory Deletes an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4017,7 +4097,7 @@ public ApiResponse< V1Category > DeleteCategoryWithHttpInfo (string locationId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (categoryId != null) localVarPathParams.Add("category_id", Configuration.ApiClient.ParameterToString(categoryId)); // path parameter @@ -4048,7 +4128,7 @@ public ApiResponse< V1Category > DeleteCategoryWithHttpInfo (string locationId, } /// - /// DeleteCategory Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + /// DeleteCategory Deletes an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4062,7 +4142,7 @@ public async System.Threading.Tasks.Task DeleteCategoryAsync (string } /// - /// DeleteCategory Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + /// DeleteCategory Deletes an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4098,7 +4178,7 @@ public async System.Threading.Tasks.Task> DeleteCategory String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (categoryId != null) localVarPathParams.Add("category_id", Configuration.ApiClient.ParameterToString(categoryId)); // path parameter @@ -4129,7 +4209,7 @@ public async System.Threading.Tasks.Task> DeleteCategory } /// - /// DeleteDiscount Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + /// DeleteDiscount Deletes an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4142,7 +4222,7 @@ public V1Discount DeleteDiscount (string locationId, string discountId) } /// - /// DeleteDiscount Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + /// DeleteDiscount Deletes an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4178,7 +4258,7 @@ public ApiResponse< V1Discount > DeleteDiscountWithHttpInfo (string locationId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (discountId != null) localVarPathParams.Add("discount_id", Configuration.ApiClient.ParameterToString(discountId)); // path parameter @@ -4209,7 +4289,7 @@ public ApiResponse< V1Discount > DeleteDiscountWithHttpInfo (string locationId, } /// - /// DeleteDiscount Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + /// DeleteDiscount Deletes an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4223,7 +4303,7 @@ public async System.Threading.Tasks.Task DeleteDiscountAsync (string } /// - /// DeleteDiscount Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + /// DeleteDiscount Deletes an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4259,7 +4339,7 @@ public async System.Threading.Tasks.Task> DeleteDiscount String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (discountId != null) localVarPathParams.Add("discount_id", Configuration.ApiClient.ParameterToString(discountId)); // path parameter @@ -4290,7 +4370,7 @@ public async System.Threading.Tasks.Task> DeleteDiscount } /// - /// DeleteFee Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + /// DeleteFee Deletes an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -4303,7 +4383,7 @@ public V1Fee DeleteFee (string locationId, string feeId) } /// - /// DeleteFee Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + /// DeleteFee Deletes an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -4339,7 +4419,7 @@ public ApiResponse< V1Fee > DeleteFeeWithHttpInfo (string locationId, string fee String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (feeId != null) localVarPathParams.Add("fee_id", Configuration.ApiClient.ParameterToString(feeId)); // path parameter @@ -4370,7 +4450,7 @@ public ApiResponse< V1Fee > DeleteFeeWithHttpInfo (string locationId, string fee } /// - /// DeleteFee Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + /// DeleteFee Deletes an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -4384,7 +4464,7 @@ public async System.Threading.Tasks.Task DeleteFeeAsync (string locationI } /// - /// DeleteFee Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + /// DeleteFee Deletes an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -4420,7 +4500,7 @@ public async System.Threading.Tasks.Task> DeleteFeeAsyncWithH String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (feeId != null) localVarPathParams.Add("fee_id", Configuration.ApiClient.ParameterToString(feeId)); // path parameter @@ -4451,7 +4531,7 @@ public async System.Threading.Tasks.Task> DeleteFeeAsyncWithH } /// - /// DeleteItem Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + /// DeleteItem Deletes an existing item and all item variations associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4464,7 +4544,7 @@ public V1Item DeleteItem (string locationId, string itemId) } /// - /// DeleteItem Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + /// DeleteItem Deletes an existing item and all item variations associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4500,7 +4580,7 @@ public ApiResponse< V1Item > DeleteItemWithHttpInfo (string locationId, string i String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter @@ -4531,7 +4611,7 @@ public ApiResponse< V1Item > DeleteItemWithHttpInfo (string locationId, string i } /// - /// DeleteItem Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + /// DeleteItem Deletes an existing item and all item variations associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4545,7 +4625,7 @@ public async System.Threading.Tasks.Task DeleteItemAsync (string locatio } /// - /// DeleteItem Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + /// DeleteItem Deletes an existing item and all item variations associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4581,7 +4661,7 @@ public async System.Threading.Tasks.Task> DeleteItemAsyncWit String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter @@ -4612,7 +4692,7 @@ public async System.Threading.Tasks.Task> DeleteItemAsyncWit } /// - /// DeleteModifierList Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + /// DeleteModifierList Deletes an existing item modifier list and all modifier options associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4625,7 +4705,7 @@ public V1ModifierList DeleteModifierList (string locationId, string modifierList } /// - /// DeleteModifierList Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + /// DeleteModifierList Deletes an existing item modifier list and all modifier options associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4661,7 +4741,7 @@ public ApiResponse< V1ModifierList > DeleteModifierListWithHttpInfo (string loca String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter @@ -4692,7 +4772,7 @@ public ApiResponse< V1ModifierList > DeleteModifierListWithHttpInfo (string loca } /// - /// DeleteModifierList Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + /// DeleteModifierList Deletes an existing item modifier list and all modifier options associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4706,7 +4786,7 @@ public async System.Threading.Tasks.Task DeleteModifierListAsync } /// - /// DeleteModifierList Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + /// DeleteModifierList Deletes an existing item modifier list and all modifier options associated with it. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4742,7 +4822,7 @@ public async System.Threading.Tasks.Task> DeleteModi String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter @@ -4773,7 +4853,7 @@ public async System.Threading.Tasks.Task> DeleteModi } /// - /// DeleteModifierOption Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. + /// DeleteModifierOption Deletes an existing item modifier option from a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4787,7 +4867,7 @@ public V1ModifierOption DeleteModifierOption (string locationId, string modifier } /// - /// DeleteModifierOption Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. + /// DeleteModifierOption Deletes an existing item modifier option from a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4827,7 +4907,7 @@ public ApiResponse< V1ModifierOption > DeleteModifierOptionWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (modifierOptionId != null) localVarPathParams.Add("modifier_option_id", Configuration.ApiClient.ParameterToString(modifierOptionId)); // path parameter @@ -4859,7 +4939,7 @@ public ApiResponse< V1ModifierOption > DeleteModifierOptionWithHttpInfo (string } /// - /// DeleteModifierOption Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. + /// DeleteModifierOption Deletes an existing item modifier option from a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4874,7 +4954,7 @@ public async System.Threading.Tasks.Task DeleteModifierOptionA } /// - /// DeleteModifierOption Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. + /// DeleteModifierOption Deletes an existing item modifier option from a modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -4914,7 +4994,7 @@ public async System.Threading.Tasks.Task> DeleteMo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (modifierOptionId != null) localVarPathParams.Add("modifier_option_id", Configuration.ApiClient.ParameterToString(modifierOptionId)); // path parameter @@ -4946,7 +5026,7 @@ public async System.Threading.Tasks.Task> DeleteMo } /// - /// DeletePage Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. + /// DeletePage Deletes an existing Favorites page and all of its cells. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -4959,7 +5039,7 @@ public V1Page DeletePage (string locationId, string pageId) } /// - /// DeletePage Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. + /// DeletePage Deletes an existing Favorites page and all of its cells. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -4995,7 +5075,7 @@ public ApiResponse< V1Page > DeletePageWithHttpInfo (string locationId, string p String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (pageId != null) localVarPathParams.Add("page_id", Configuration.ApiClient.ParameterToString(pageId)); // path parameter @@ -5026,7 +5106,7 @@ public ApiResponse< V1Page > DeletePageWithHttpInfo (string locationId, string p } /// - /// DeletePage Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. + /// DeletePage Deletes an existing Favorites page and all of its cells. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -5040,7 +5120,7 @@ public async System.Threading.Tasks.Task DeletePageAsync (string locatio } /// - /// DeletePage Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. + /// DeletePage Deletes an existing Favorites page and all of its cells. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -5076,7 +5156,7 @@ public async System.Threading.Tasks.Task> DeletePageAsyncWit String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (pageId != null) localVarPathParams.Add("page_id", Configuration.ApiClient.ParameterToString(pageId)); // path parameter @@ -5107,7 +5187,7 @@ public async System.Threading.Tasks.Task> DeletePageAsyncWit } /// - /// DeletePageCell Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + /// DeletePageCell Deletes a cell from a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -5122,7 +5202,7 @@ public V1Page DeletePageCell (string locationId, string pageId, string row = nul } /// - /// DeletePageCell Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + /// DeletePageCell Deletes a cell from a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -5160,7 +5240,7 @@ public ApiResponse< V1Page > DeletePageCellWithHttpInfo (string locationId, stri String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (pageId != null) localVarPathParams.Add("page_id", Configuration.ApiClient.ParameterToString(pageId)); // path parameter if (row != null) localVarQueryParams.Add("row", Configuration.ApiClient.ParameterToString(row)); // query parameter @@ -5193,7 +5273,7 @@ public ApiResponse< V1Page > DeletePageCellWithHttpInfo (string locationId, stri } /// - /// DeletePageCell Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + /// DeletePageCell Deletes a cell from a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -5209,7 +5289,7 @@ public async System.Threading.Tasks.Task DeletePageCellAsync (string loc } /// - /// DeletePageCell Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + /// DeletePageCell Deletes a cell from a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -5247,7 +5327,7 @@ public async System.Threading.Tasks.Task> DeletePageCellAsyn String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (pageId != null) localVarPathParams.Add("page_id", Configuration.ApiClient.ParameterToString(pageId)); // path parameter if (row != null) localVarQueryParams.Add("row", Configuration.ApiClient.ParameterToString(row)); // query parameter @@ -5280,7 +5360,7 @@ public async System.Threading.Tasks.Task> DeletePageCellAsyn } /// - /// DeleteVariation Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + /// DeleteVariation Deletes an existing item variation from an item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -5294,7 +5374,7 @@ public V1Variation DeleteVariation (string locationId, string itemId, string var } /// - /// DeleteVariation Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + /// DeleteVariation Deletes an existing item variation from an item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -5334,7 +5414,7 @@ public ApiResponse< V1Variation > DeleteVariationWithHttpInfo (string locationId String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (variationId != null) localVarPathParams.Add("variation_id", Configuration.ApiClient.ParameterToString(variationId)); // path parameter @@ -5366,7 +5446,7 @@ public ApiResponse< V1Variation > DeleteVariationWithHttpInfo (string locationId } /// - /// DeleteVariation Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + /// DeleteVariation Deletes an existing item variation from an item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -5381,7 +5461,7 @@ public async System.Threading.Tasks.Task DeleteVariationAsync (stri } /// - /// DeleteVariation Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + /// DeleteVariation Deletes an existing item variation from an item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -5421,7 +5501,7 @@ public async System.Threading.Tasks.Task> DeleteVariati String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (variationId != null) localVarPathParams.Add("variation_id", Configuration.ApiClient.ParameterToString(variationId)); // path parameter @@ -5453,7 +5533,7 @@ public async System.Threading.Tasks.Task> DeleteVariati } /// - /// ListCategories Lists all of a location's item categories. + /// ListCategories Lists all the item categories for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -5465,7 +5545,7 @@ public List ListCategories (string locationId) } /// - /// ListCategories Lists all of a location's item categories. + /// ListCategories Lists all the item categories for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -5497,7 +5577,7 @@ public ApiResponse< List > ListCategoriesWithHttpInfo (string locati String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -5527,7 +5607,7 @@ public ApiResponse< List > ListCategoriesWithHttpInfo (string locati } /// - /// ListCategories Lists all of a location's item categories. + /// ListCategories Lists all the item categories for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -5540,7 +5620,7 @@ public async System.Threading.Tasks.Task> ListCategoriesAsync ( } /// - /// ListCategories Lists all of a location's item categories. + /// ListCategories Lists all the item categories for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -5572,7 +5652,7 @@ public async System.Threading.Tasks.Task>> ListCate String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -5602,7 +5682,7 @@ public async System.Threading.Tasks.Task>> ListCate } /// - /// ListDiscounts Lists all of a location's discounts. + /// ListDiscounts Lists all the discounts for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -5614,7 +5694,7 @@ public List ListDiscounts (string locationId) } /// - /// ListDiscounts Lists all of a location's discounts. + /// ListDiscounts Lists all the discounts for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -5646,7 +5726,7 @@ public ApiResponse< List > ListDiscountsWithHttpInfo (string locatio String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -5676,7 +5756,7 @@ public ApiResponse< List > ListDiscountsWithHttpInfo (string locatio } /// - /// ListDiscounts Lists all of a location's discounts. + /// ListDiscounts Lists all the discounts for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -5689,7 +5769,7 @@ public async System.Threading.Tasks.Task> ListDiscountsAsync (s } /// - /// ListDiscounts Lists all of a location's discounts. + /// ListDiscounts Lists all the discounts for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list categories for. @@ -5721,7 +5801,7 @@ public async System.Threading.Tasks.Task>> ListDisc String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -5751,7 +5831,7 @@ public async System.Threading.Tasks.Task>> ListDisc } /// - /// ListFees Lists all of a location's fees (taxes). + /// ListFees Lists all the fees (taxes) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list fees for. @@ -5763,7 +5843,7 @@ public List ListFees (string locationId) } /// - /// ListFees Lists all of a location's fees (taxes). + /// ListFees Lists all the fees (taxes) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list fees for. @@ -5795,7 +5875,7 @@ public ApiResponse< List > ListFeesWithHttpInfo (string locationId) String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -5825,7 +5905,7 @@ public ApiResponse< List > ListFeesWithHttpInfo (string locationId) } /// - /// ListFees Lists all of a location's fees (taxes). + /// ListFees Lists all the fees (taxes) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list fees for. @@ -5838,7 +5918,7 @@ public async System.Threading.Tasks.Task> ListFeesAsync (string loca } /// - /// ListFees Lists all of a location's fees (taxes). + /// ListFees Lists all the fees (taxes) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list fees for. @@ -5870,7 +5950,7 @@ public async System.Threading.Tasks.Task>> ListFeesAsync String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -5900,7 +5980,7 @@ public async System.Threading.Tasks.Task>> ListFeesAsync } /// - /// ListInventory Provides inventory information for all of a merchant's inventory-enabled item variations. + /// ListInventory Provides inventory information for all inventory-enabled item variations. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -5914,7 +5994,7 @@ public List ListInventory (string locationId, int? limit = nul } /// - /// ListInventory Provides inventory information for all of a merchant's inventory-enabled item variations. + /// ListInventory Provides inventory information for all inventory-enabled item variations. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -5948,7 +6028,7 @@ public ApiResponse< List > ListInventoryWithHttpInfo (string l String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter if (batchToken != null) localVarQueryParams.Add("batch_token", Configuration.ApiClient.ParameterToString(batchToken)); // query parameter @@ -5980,7 +6060,7 @@ public ApiResponse< List > ListInventoryWithHttpInfo (string l } /// - /// ListInventory Provides inventory information for all of a merchant's inventory-enabled item variations. + /// ListInventory Provides inventory information for all inventory-enabled item variations. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -5995,7 +6075,7 @@ public async System.Threading.Tasks.Task> ListInventoryAs } /// - /// ListInventory Provides inventory information for all of a merchant's inventory-enabled item variations. + /// ListInventory Provides inventory information for all inventory-enabled item variations. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -6029,7 +6109,7 @@ public async System.Threading.Tasks.Task>> Li String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter if (batchToken != null) localVarQueryParams.Add("batch_token", Configuration.ApiClient.ParameterToString(batchToken)); // query parameter @@ -6061,7 +6141,7 @@ public async System.Threading.Tasks.Task>> Li } /// - /// ListItems Provides summary information for all of a location's items. + /// ListItems Provides summary information of all items for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list items for. @@ -6074,7 +6154,7 @@ public List ListItems (string locationId, string batchToken = null) } /// - /// ListItems Provides summary information for all of a location's items. + /// ListItems Provides summary information of all items for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list items for. @@ -6107,7 +6187,7 @@ public ApiResponse< List > ListItemsWithHttpInfo (string locationId, str String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (batchToken != null) localVarQueryParams.Add("batch_token", Configuration.ApiClient.ParameterToString(batchToken)); // query parameter @@ -6138,7 +6218,7 @@ public ApiResponse< List > ListItemsWithHttpInfo (string locationId, str } /// - /// ListItems Provides summary information for all of a location's items. + /// ListItems Provides summary information of all items for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list items for. @@ -6152,7 +6232,7 @@ public async System.Threading.Tasks.Task> ListItemsAsync (string lo } /// - /// ListItems Provides summary information for all of a location's items. + /// ListItems Provides summary information of all items for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list items for. @@ -6185,7 +6265,7 @@ public async System.Threading.Tasks.Task>> ListItemsAsy String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (batchToken != null) localVarQueryParams.Add("batch_token", Configuration.ApiClient.ParameterToString(batchToken)); // query parameter @@ -6216,7 +6296,7 @@ public async System.Threading.Tasks.Task>> ListItemsAsy } /// - /// ListModifierLists Lists all of a location's modifier lists. + /// ListModifierLists Lists all the modifier lists for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list modifier lists for. @@ -6228,7 +6308,7 @@ public List ListModifierLists (string locationId) } /// - /// ListModifierLists Lists all of a location's modifier lists. + /// ListModifierLists Lists all the modifier lists for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list modifier lists for. @@ -6260,7 +6340,7 @@ public ApiResponse< List > ListModifierListsWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -6290,7 +6370,7 @@ public ApiResponse< List > ListModifierListsWithHttpInfo (string } /// - /// ListModifierLists Lists all of a location's modifier lists. + /// ListModifierLists Lists all the modifier lists for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list modifier lists for. @@ -6303,7 +6383,7 @@ public async System.Threading.Tasks.Task> ListModifierLists } /// - /// ListModifierLists Lists all of a location's modifier lists. + /// ListModifierLists Lists all the modifier lists for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list modifier lists for. @@ -6335,7 +6415,7 @@ public async System.Threading.Tasks.Task>> List String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -6365,7 +6445,7 @@ public async System.Threading.Tasks.Task>> List } /// - /// ListPages Lists all of a location's Favorites pages in Square Register. + /// ListPages Lists all Favorites pages (in Square Point of Sale) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list Favorites pages for. @@ -6377,7 +6457,7 @@ public List ListPages (string locationId) } /// - /// ListPages Lists all of a location's Favorites pages in Square Register. + /// ListPages Lists all Favorites pages (in Square Point of Sale) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list Favorites pages for. @@ -6409,7 +6489,7 @@ public ApiResponse< List > ListPagesWithHttpInfo (string locationId) String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -6439,7 +6519,7 @@ public ApiResponse< List > ListPagesWithHttpInfo (string locationId) } /// - /// ListPages Lists all of a location's Favorites pages in Square Register. + /// ListPages Lists all Favorites pages (in Square Point of Sale) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list Favorites pages for. @@ -6452,7 +6532,7 @@ public async System.Threading.Tasks.Task> ListPagesAsync (string lo } /// - /// ListPages Lists all of a location's Favorites pages in Square Register. + /// ListPages Lists all Favorites pages (in Square Point of Sale) for a given location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the location to list Favorites pages for. @@ -6484,7 +6564,7 @@ public async System.Threading.Tasks.Task>> ListPagesAsy String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -6514,7 +6594,7 @@ public async System.Threading.Tasks.Task>> ListPagesAsy } /// - /// RemoveFee Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + /// RemoveFee Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -6528,7 +6608,7 @@ public V1Item RemoveFee (string locationId, string itemId, string feeId) } /// - /// RemoveFee Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + /// RemoveFee Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -6568,7 +6648,7 @@ public ApiResponse< V1Item > RemoveFeeWithHttpInfo (string locationId, string it String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (feeId != null) localVarPathParams.Add("fee_id", Configuration.ApiClient.ParameterToString(feeId)); // path parameter @@ -6600,7 +6680,7 @@ public ApiResponse< V1Item > RemoveFeeWithHttpInfo (string locationId, string it } /// - /// RemoveFee Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + /// RemoveFee Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -6615,7 +6695,7 @@ public async System.Threading.Tasks.Task RemoveFeeAsync (string location } /// - /// RemoveFee Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + /// RemoveFee Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -6655,7 +6735,7 @@ public async System.Threading.Tasks.Task> RemoveFeeAsyncWith String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (feeId != null) localVarPathParams.Add("fee_id", Configuration.ApiClient.ParameterToString(feeId)); // path parameter @@ -6687,7 +6767,7 @@ public async System.Threading.Tasks.Task> RemoveFeeAsyncWith } /// - /// RemoveModifierList Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + /// RemoveModifierList Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -6701,7 +6781,7 @@ public V1Item RemoveModifierList (string locationId, string modifierListId, stri } /// - /// RemoveModifierList Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + /// RemoveModifierList Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -6741,7 +6821,7 @@ public ApiResponse< V1Item > RemoveModifierListWithHttpInfo (string locationId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter @@ -6773,7 +6853,7 @@ public ApiResponse< V1Item > RemoveModifierListWithHttpInfo (string locationId, } /// - /// RemoveModifierList Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + /// RemoveModifierList Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -6788,7 +6868,7 @@ public async System.Threading.Tasks.Task RemoveModifierListAsync (string } /// - /// RemoveModifierList Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + /// RemoveModifierList Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -6828,7 +6908,7 @@ public async System.Threading.Tasks.Task> RemoveModifierList String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter @@ -6860,7 +6940,7 @@ public async System.Threading.Tasks.Task> RemoveModifierList } /// - /// RetrieveItem Provides the details for a single item, including associated modifier lists and fees. + /// RetrieveItem Provides the details for a single item, including associated modifier lists and fees. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -6873,7 +6953,7 @@ public V1Item RetrieveItem (string locationId, string itemId) } /// - /// RetrieveItem Provides the details for a single item, including associated modifier lists and fees. + /// RetrieveItem Provides the details for a single item, including associated modifier lists and fees. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -6909,7 +6989,7 @@ public ApiResponse< V1Item > RetrieveItemWithHttpInfo (string locationId, string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter @@ -6940,7 +7020,7 @@ public ApiResponse< V1Item > RetrieveItemWithHttpInfo (string locationId, string } /// - /// RetrieveItem Provides the details for a single item, including associated modifier lists and fees. + /// RetrieveItem Provides the details for a single item, including associated modifier lists and fees. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -6954,7 +7034,7 @@ public async System.Threading.Tasks.Task RetrieveItemAsync (string locat } /// - /// RetrieveItem Provides the details for a single item, including associated modifier lists and fees. + /// RetrieveItem Provides the details for a single item, including associated modifier lists and fees. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -6990,7 +7070,7 @@ public async System.Threading.Tasks.Task> RetrieveItemAsyncW String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter @@ -7021,7 +7101,7 @@ public async System.Threading.Tasks.Task> RetrieveItemAsyncW } /// - /// RetrieveModifierList Provides the details for a single modifier list. + /// RetrieveModifierList Provides the details for a single modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7034,7 +7114,7 @@ public V1ModifierList RetrieveModifierList (string locationId, string modifierLi } /// - /// RetrieveModifierList Provides the details for a single modifier list. + /// RetrieveModifierList Provides the details for a single modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7070,7 +7150,7 @@ public ApiResponse< V1ModifierList > RetrieveModifierListWithHttpInfo (string lo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter @@ -7101,7 +7181,7 @@ public ApiResponse< V1ModifierList > RetrieveModifierListWithHttpInfo (string lo } /// - /// RetrieveModifierList Provides the details for a single modifier list. + /// RetrieveModifierList Provides the details for a single modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7115,7 +7195,7 @@ public async System.Threading.Tasks.Task RetrieveModifierListAsy } /// - /// RetrieveModifierList Provides the details for a single modifier list. + /// RetrieveModifierList Provides the details for a single modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7151,7 +7231,7 @@ public async System.Threading.Tasks.Task> RetrieveMo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter @@ -7182,7 +7262,7 @@ public async System.Threading.Tasks.Task> RetrieveMo } /// - /// UpdateCategory Modifies the details of an existing item category. + /// UpdateCategory Modifies the details of an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -7196,7 +7276,7 @@ public V1Category UpdateCategory (string locationId, string categoryId, V1Catego } /// - /// UpdateCategory Modifies the details of an existing item category. + /// UpdateCategory Modifies the details of an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -7236,7 +7316,7 @@ public ApiResponse< V1Category > UpdateCategoryWithHttpInfo (string locationId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (categoryId != null) localVarPathParams.Add("category_id", Configuration.ApiClient.ParameterToString(categoryId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -7275,7 +7355,7 @@ public ApiResponse< V1Category > UpdateCategoryWithHttpInfo (string locationId, } /// - /// UpdateCategory Modifies the details of an existing item category. + /// UpdateCategory Modifies the details of an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -7290,7 +7370,7 @@ public async System.Threading.Tasks.Task UpdateCategoryAsync (string } /// - /// UpdateCategory Modifies the details of an existing item category. + /// UpdateCategory Modifies the details of an existing item category. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -7330,7 +7410,7 @@ public async System.Threading.Tasks.Task> UpdateCategory String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (categoryId != null) localVarPathParams.Add("category_id", Configuration.ApiClient.ParameterToString(categoryId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -7369,7 +7449,7 @@ public async System.Threading.Tasks.Task> UpdateCategory } /// - /// UpdateDiscount Modifies the details of an existing discount. + /// UpdateDiscount Modifies the details of an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -7383,7 +7463,7 @@ public V1Discount UpdateDiscount (string locationId, string discountId, V1Discou } /// - /// UpdateDiscount Modifies the details of an existing discount. + /// UpdateDiscount Modifies the details of an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -7423,7 +7503,7 @@ public ApiResponse< V1Discount > UpdateDiscountWithHttpInfo (string locationId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (discountId != null) localVarPathParams.Add("discount_id", Configuration.ApiClient.ParameterToString(discountId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -7462,7 +7542,7 @@ public ApiResponse< V1Discount > UpdateDiscountWithHttpInfo (string locationId, } /// - /// UpdateDiscount Modifies the details of an existing discount. + /// UpdateDiscount Modifies the details of an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -7477,7 +7557,7 @@ public async System.Threading.Tasks.Task UpdateDiscountAsync (string } /// - /// UpdateDiscount Modifies the details of an existing discount. + /// UpdateDiscount Modifies the details of an existing discount. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the category's associated location. @@ -7517,7 +7597,7 @@ public async System.Threading.Tasks.Task> UpdateDiscount String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (discountId != null) localVarPathParams.Add("discount_id", Configuration.ApiClient.ParameterToString(discountId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -7556,7 +7636,7 @@ public async System.Threading.Tasks.Task> UpdateDiscount } /// - /// UpdateFee Modifies the details of an existing fee (tax). + /// UpdateFee Modifies the details of an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -7570,7 +7650,7 @@ public V1Fee UpdateFee (string locationId, string feeId, V1Fee body) } /// - /// UpdateFee Modifies the details of an existing fee (tax). + /// UpdateFee Modifies the details of an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -7610,7 +7690,7 @@ public ApiResponse< V1Fee > UpdateFeeWithHttpInfo (string locationId, string fee String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (feeId != null) localVarPathParams.Add("fee_id", Configuration.ApiClient.ParameterToString(feeId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -7649,7 +7729,7 @@ public ApiResponse< V1Fee > UpdateFeeWithHttpInfo (string locationId, string fee } /// - /// UpdateFee Modifies the details of an existing fee (tax). + /// UpdateFee Modifies the details of an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -7664,7 +7744,7 @@ public async System.Threading.Tasks.Task UpdateFeeAsync (string locationI } /// - /// UpdateFee Modifies the details of an existing fee (tax). + /// UpdateFee Modifies the details of an existing fee (tax). - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the fee's associated location. @@ -7704,7 +7784,7 @@ public async System.Threading.Tasks.Task> UpdateFeeAsyncWithH String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (feeId != null) localVarPathParams.Add("fee_id", Configuration.ApiClient.ParameterToString(feeId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -7743,7 +7823,7 @@ public async System.Threading.Tasks.Task> UpdateFeeAsyncWithH } /// - /// UpdateItem Modifies the core details of an existing item. + /// UpdateItem Modifies the core details of an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7757,7 +7837,7 @@ public V1Item UpdateItem (string locationId, string itemId, V1Item body) } /// - /// UpdateItem Modifies the core details of an existing item. + /// UpdateItem Modifies the core details of an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7797,7 +7877,7 @@ public ApiResponse< V1Item > UpdateItemWithHttpInfo (string locationId, string i String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -7836,7 +7916,7 @@ public ApiResponse< V1Item > UpdateItemWithHttpInfo (string locationId, string i } /// - /// UpdateItem Modifies the core details of an existing item. + /// UpdateItem Modifies the core details of an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7851,7 +7931,7 @@ public async System.Threading.Tasks.Task UpdateItemAsync (string locatio } /// - /// UpdateItem Modifies the core details of an existing item. + /// UpdateItem Modifies the core details of an existing item. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7891,7 +7971,7 @@ public async System.Threading.Tasks.Task> UpdateItemAsyncWit String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -7930,7 +8010,7 @@ public async System.Threading.Tasks.Task> UpdateItemAsyncWit } /// - /// UpdateModifierList Modifies the details of an existing item modifier list. + /// UpdateModifierList Modifies the details of an existing item modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7944,7 +8024,7 @@ public V1ModifierList UpdateModifierList (string locationId, string modifierList } /// - /// UpdateModifierList Modifies the details of an existing item modifier list. + /// UpdateModifierList Modifies the details of an existing item modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -7984,7 +8064,7 @@ public ApiResponse< V1ModifierList > UpdateModifierListWithHttpInfo (string loca String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -8023,7 +8103,7 @@ public ApiResponse< V1ModifierList > UpdateModifierListWithHttpInfo (string loca } /// - /// UpdateModifierList Modifies the details of an existing item modifier list. + /// UpdateModifierList Modifies the details of an existing item modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8038,7 +8118,7 @@ public async System.Threading.Tasks.Task UpdateModifierListAsync } /// - /// UpdateModifierList Modifies the details of an existing item modifier list. + /// UpdateModifierList Modifies the details of an existing item modifier list. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8078,7 +8158,7 @@ public async System.Threading.Tasks.Task> UpdateModi String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -8117,7 +8197,7 @@ public async System.Threading.Tasks.Task> UpdateModi } /// - /// UpdateModifierOption Modifies the details of an existing item modifier option. + /// UpdateModifierOption Modifies the details of an existing item modifier option. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8132,7 +8212,7 @@ public V1ModifierOption UpdateModifierOption (string locationId, string modifier } /// - /// UpdateModifierOption Modifies the details of an existing item modifier option. + /// UpdateModifierOption Modifies the details of an existing item modifier option. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8176,7 +8256,7 @@ public ApiResponse< V1ModifierOption > UpdateModifierOptionWithHttpInfo (string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (modifierOptionId != null) localVarPathParams.Add("modifier_option_id", Configuration.ApiClient.ParameterToString(modifierOptionId)); // path parameter @@ -8216,7 +8296,7 @@ public ApiResponse< V1ModifierOption > UpdateModifierOptionWithHttpInfo (string } /// - /// UpdateModifierOption Modifies the details of an existing item modifier option. + /// UpdateModifierOption Modifies the details of an existing item modifier option. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8232,7 +8312,7 @@ public async System.Threading.Tasks.Task UpdateModifierOptionA } /// - /// UpdateModifierOption Modifies the details of an existing item modifier option. + /// UpdateModifierOption Modifies the details of an existing item modifier option. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8276,7 +8356,7 @@ public async System.Threading.Tasks.Task> UpdateMo String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (modifierListId != null) localVarPathParams.Add("modifier_list_id", Configuration.ApiClient.ParameterToString(modifierListId)); // path parameter if (modifierOptionId != null) localVarPathParams.Add("modifier_option_id", Configuration.ApiClient.ParameterToString(modifierOptionId)); // path parameter @@ -8316,7 +8396,7 @@ public async System.Threading.Tasks.Task> UpdateMo } /// - /// UpdatePage Modifies the details of a Favorites page in Square Register. + /// UpdatePage Modifies the details of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location @@ -8330,7 +8410,7 @@ public V1Page UpdatePage (string locationId, string pageId, V1Page body) } /// - /// UpdatePage Modifies the details of a Favorites page in Square Register. + /// UpdatePage Modifies the details of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location @@ -8370,7 +8450,7 @@ public ApiResponse< V1Page > UpdatePageWithHttpInfo (string locationId, string p String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (pageId != null) localVarPathParams.Add("page_id", Configuration.ApiClient.ParameterToString(pageId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -8409,7 +8489,7 @@ public ApiResponse< V1Page > UpdatePageWithHttpInfo (string locationId, string p } /// - /// UpdatePage Modifies the details of a Favorites page in Square Register. + /// UpdatePage Modifies the details of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location @@ -8424,7 +8504,7 @@ public async System.Threading.Tasks.Task UpdatePageAsync (string locatio } /// - /// UpdatePage Modifies the details of a Favorites page in Square Register. + /// UpdatePage Modifies the details of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location @@ -8464,7 +8544,7 @@ public async System.Threading.Tasks.Task> UpdatePageAsyncWit String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (pageId != null) localVarPathParams.Add("page_id", Configuration.ApiClient.ParameterToString(pageId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -8503,7 +8583,7 @@ public async System.Threading.Tasks.Task> UpdatePageAsyncWit } /// - /// UpdatePageCell Modifies a cell of a Favorites page in Square Register. + /// UpdatePageCell Modifies a cell of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -8517,7 +8597,7 @@ public V1Page UpdatePageCell (string locationId, string pageId, V1PageCell body) } /// - /// UpdatePageCell Modifies a cell of a Favorites page in Square Register. + /// UpdatePageCell Modifies a cell of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -8557,7 +8637,7 @@ public ApiResponse< V1Page > UpdatePageCellWithHttpInfo (string locationId, stri String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (pageId != null) localVarPathParams.Add("page_id", Configuration.ApiClient.ParameterToString(pageId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -8596,7 +8676,7 @@ public ApiResponse< V1Page > UpdatePageCellWithHttpInfo (string locationId, stri } /// - /// UpdatePageCell Modifies a cell of a Favorites page in Square Register. + /// UpdatePageCell Modifies a cell of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -8611,7 +8691,7 @@ public async System.Threading.Tasks.Task UpdatePageCellAsync (string loc } /// - /// UpdatePageCell Modifies a cell of a Favorites page in Square Register. + /// UpdatePageCell Modifies a cell of a Favorites page in Square Point of Sale. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the Favorites page's associated location. @@ -8651,7 +8731,7 @@ public async System.Threading.Tasks.Task> UpdatePageCellAsyn String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (pageId != null) localVarPathParams.Add("page_id", Configuration.ApiClient.ParameterToString(pageId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -8690,7 +8770,7 @@ public async System.Threading.Tasks.Task> UpdatePageCellAsyn } /// - /// UpdateVariation Modifies the details of an existing item variation. + /// UpdateVariation Modifies the details of an existing item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8705,7 +8785,7 @@ public V1Variation UpdateVariation (string locationId, string itemId, string var } /// - /// UpdateVariation Modifies the details of an existing item variation. + /// UpdateVariation Modifies the details of an existing item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8749,7 +8829,7 @@ public ApiResponse< V1Variation > UpdateVariationWithHttpInfo (string locationId String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (variationId != null) localVarPathParams.Add("variation_id", Configuration.ApiClient.ParameterToString(variationId)); // path parameter @@ -8789,7 +8869,7 @@ public ApiResponse< V1Variation > UpdateVariationWithHttpInfo (string locationId } /// - /// UpdateVariation Modifies the details of an existing item variation. + /// UpdateVariation Modifies the details of an existing item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8805,7 +8885,7 @@ public async System.Threading.Tasks.Task UpdateVariationAsync (stri } /// - /// UpdateVariation Modifies the details of an existing item variation. + /// UpdateVariation Modifies the details of an existing item variation. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) - -- /// /// Thrown when fails to make API call /// The ID of the item's associated location. @@ -8849,7 +8929,7 @@ public async System.Threading.Tasks.Task> UpdateVariati String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (itemId != null) localVarPathParams.Add("item_id", Configuration.ApiClient.ParameterToString(itemId)); // path parameter if (variationId != null) localVarPathParams.Add("variation_id", Configuration.ApiClient.ParameterToString(variationId)); // path parameter diff --git a/src/Square.Connect/Api/V1LocationsApi.cs b/src/Square.Connect/Api/V1LocationsApi.cs index ea85dca..bccd0dc 100644 --- a/src/Square.Connect/Api/V1LocationsApi.cs +++ b/src/Square.Connect/Api/V1LocationsApi.cs @@ -28,16 +28,18 @@ public interface IV1LocationsApi : IApiAccessor /// ListLocations /// /// - /// Provides details for a business's locations, including their IDs. + /// Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call - /// List<V1Merchant> List ListLocations (); + /// List<V1Merchant> + [Obsolete] + List ListLocations (); /// /// ListLocations /// /// - /// Provides details for a business's locations, including their IDs. + /// Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// ApiResponse of List<V1Merchant> @@ -46,16 +48,18 @@ public interface IV1LocationsApi : IApiAccessor /// RetrieveBusiness /// /// - /// Get a business's information. + /// Get the general information for a business. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call - /// V1Merchant V1Merchant RetrieveBusiness (); + /// V1Merchant + [Obsolete] + V1Merchant RetrieveBusiness (); /// /// RetrieveBusiness /// /// - /// Get a business's information. + /// Get the general information for a business. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// ApiResponse of V1Merchant @@ -66,7 +70,7 @@ public interface IV1LocationsApi : IApiAccessor /// ListLocations /// /// - /// Provides details for a business's locations, including their IDs. + /// Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// Task of List<V1Merchant> @@ -76,7 +80,7 @@ public interface IV1LocationsApi : IApiAccessor /// ListLocations /// /// - /// Provides details for a business's locations, including their IDs. + /// Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// Task of ApiResponse (List<V1Merchant>) @@ -85,7 +89,7 @@ public interface IV1LocationsApi : IApiAccessor /// RetrieveBusiness /// /// - /// Get a business's information. + /// Get the general information for a business. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// Task of V1Merchant @@ -95,7 +99,7 @@ public interface IV1LocationsApi : IApiAccessor /// RetrieveBusiness /// /// - /// Get a business's information. + /// Get the general information for a business. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// Task of ApiResponse (V1Merchant) @@ -213,7 +217,7 @@ public void AddDefaultHeader(string key, string value) } /// - /// ListLocations Provides details for a business's locations, including their IDs. + /// ListLocations Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// List<V1Merchant> @@ -224,7 +228,7 @@ public List ListLocations () } /// - /// ListLocations Provides details for a business's locations, including their IDs. + /// ListLocations Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// ApiResponse of List<V1Merchant> @@ -252,7 +256,7 @@ public ApiResponse< List > ListLocationsWithHttpInfo () String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); // authentication (oauth2) required // oauth required @@ -281,7 +285,7 @@ public ApiResponse< List > ListLocationsWithHttpInfo () } /// - /// ListLocations Provides details for a business's locations, including their IDs. + /// ListLocations Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// Task of List<V1Merchant> @@ -293,7 +297,7 @@ public async System.Threading.Tasks.Task> ListLocationsAsync () } /// - /// ListLocations Provides details for a business's locations, including their IDs. + /// ListLocations Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// Task of ApiResponse (List<V1Merchant>) @@ -321,7 +325,7 @@ public async System.Threading.Tasks.Task>> ListLoca String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); // authentication (oauth2) required // oauth required @@ -350,7 +354,7 @@ public async System.Threading.Tasks.Task>> ListLoca } /// - /// RetrieveBusiness Get a business's information. + /// RetrieveBusiness Get the general information for a business. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// V1Merchant @@ -361,7 +365,7 @@ public V1Merchant RetrieveBusiness () } /// - /// RetrieveBusiness Get a business's information. + /// RetrieveBusiness Get the general information for a business. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// ApiResponse of V1Merchant @@ -389,7 +393,7 @@ public ApiResponse< V1Merchant > RetrieveBusinessWithHttpInfo () String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); // authentication (oauth2) required // oauth required @@ -418,7 +422,7 @@ public ApiResponse< V1Merchant > RetrieveBusinessWithHttpInfo () } /// - /// RetrieveBusiness Get a business's information. + /// RetrieveBusiness Get the general information for a business. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// Task of V1Merchant @@ -430,7 +434,7 @@ public async System.Threading.Tasks.Task RetrieveBusinessAsync () } /// - /// RetrieveBusiness Get a business's information. + /// RetrieveBusiness Get the general information for a business. - -- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) - -- /// /// Thrown when fails to make API call /// Task of ApiResponse (V1Merchant) @@ -458,7 +462,7 @@ public async System.Threading.Tasks.Task> RetrieveBusine String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); // authentication (oauth2) required // oauth required diff --git a/src/Square.Connect/Api/V1TransactionsApi.cs b/src/Square.Connect/Api/V1TransactionsApi.cs index 00e1120..a53e4a9 100644 --- a/src/Square.Connect/Api/V1TransactionsApi.cs +++ b/src/Square.Connect/Api/V1TransactionsApi.cs @@ -747,7 +747,7 @@ public ApiResponse< V1Refund > CreateRefundWithHttpInfo (string locationId, V1Cr String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -835,7 +835,7 @@ public async System.Threading.Tasks.Task> CreateRefundAsyn String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) { @@ -917,7 +917,7 @@ public ApiResponse< List > ListBankAccountsWithHttpInfo (string l String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -992,7 +992,7 @@ public async System.Threading.Tasks.Task>> ListB String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter // authentication (oauth2) required @@ -1072,7 +1072,7 @@ public ApiResponse< List > ListOrdersWithHttpInfo (string locationId, s String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter @@ -1156,7 +1156,7 @@ public async System.Threading.Tasks.Task>> ListOrdersA String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (limit != null) localVarQueryParams.Add("limit", Configuration.ApiClient.ParameterToString(limit)); // query parameter @@ -1245,7 +1245,7 @@ public ApiResponse< List > ListPaymentsWithHttpInfo (string locationI String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter @@ -1338,7 +1338,7 @@ public async System.Threading.Tasks.Task>> ListPayme String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter @@ -1428,7 +1428,7 @@ public ApiResponse< List > ListRefundsWithHttpInfo (string locationId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter @@ -1518,7 +1518,7 @@ public async System.Threading.Tasks.Task>> ListRefund String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter @@ -1609,7 +1609,7 @@ public ApiResponse< List > ListSettlementsWithHttpInfo (string loc String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter @@ -1702,7 +1702,7 @@ public async System.Threading.Tasks.Task>> ListSe String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (order != null) localVarQueryParams.Add("order", Configuration.ApiClient.ParameterToString(order)); // query parameter if (beginTime != null) localVarQueryParams.Add("begin_time", Configuration.ApiClient.ParameterToString(beginTime)); // query parameter @@ -1787,7 +1787,7 @@ public ApiResponse< V1BankAccount > RetrieveBankAccountWithHttpInfo (string loca String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (bankAccountId != null) localVarPathParams.Add("bank_account_id", Configuration.ApiClient.ParameterToString(bankAccountId)); // path parameter @@ -1868,7 +1868,7 @@ public async System.Threading.Tasks.Task> RetrieveBan String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (bankAccountId != null) localVarPathParams.Add("bank_account_id", Configuration.ApiClient.ParameterToString(bankAccountId)); // path parameter @@ -1948,7 +1948,7 @@ public ApiResponse< V1Order > RetrieveOrderWithHttpInfo (string locationId, stri String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (orderId != null) localVarPathParams.Add("order_id", Configuration.ApiClient.ParameterToString(orderId)); // path parameter @@ -2029,7 +2029,7 @@ public async System.Threading.Tasks.Task> RetrieveOrderAsyn String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (orderId != null) localVarPathParams.Add("order_id", Configuration.ApiClient.ParameterToString(orderId)); // path parameter @@ -2109,7 +2109,7 @@ public ApiResponse< V1Payment > RetrievePaymentWithHttpInfo (string locationId, String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (paymentId != null) localVarPathParams.Add("payment_id", Configuration.ApiClient.ParameterToString(paymentId)); // path parameter @@ -2190,7 +2190,7 @@ public async System.Threading.Tasks.Task> RetrievePayment String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (paymentId != null) localVarPathParams.Add("payment_id", Configuration.ApiClient.ParameterToString(paymentId)); // path parameter @@ -2270,7 +2270,7 @@ public ApiResponse< V1Settlement > RetrieveSettlementWithHttpInfo (string locati String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (settlementId != null) localVarPathParams.Add("settlement_id", Configuration.ApiClient.ParameterToString(settlementId)); // path parameter @@ -2351,7 +2351,7 @@ public async System.Threading.Tasks.Task> RetrieveSett String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (settlementId != null) localVarPathParams.Add("settlement_id", Configuration.ApiClient.ParameterToString(settlementId)); // path parameter @@ -2436,7 +2436,7 @@ public ApiResponse< V1Order > UpdateOrderWithHttpInfo (string locationId, string String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (orderId != null) localVarPathParams.Add("order_id", Configuration.ApiClient.ParameterToString(orderId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) @@ -2530,7 +2530,7 @@ public async System.Threading.Tasks.Task> UpdateOrderAsyncW String localVarHttpHeaderAccept = Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts); if (localVarHttpHeaderAccept != null) localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept); - localVarHeaderParams.Add("Square-Version", "2019-10-23"); + localVarHeaderParams.Add("Square-Version", "2019-11-20"); if (locationId != null) localVarPathParams.Add("location_id", Configuration.ApiClient.ParameterToString(locationId)); // path parameter if (orderId != null) localVarPathParams.Add("order_id", Configuration.ApiClient.ParameterToString(orderId)); // path parameter if (body != null && body.GetType() != typeof(byte[])) diff --git a/src/Square.Connect/Client/Configuration.cs b/src/Square.Connect/Client/Configuration.cs index 3f2ff2b..8bf69e8 100644 --- a/src/Square.Connect/Client/Configuration.cs +++ b/src/Square.Connect/Client/Configuration.cs @@ -46,7 +46,7 @@ public Configuration(ApiClient apiClient = null, string tempFolderPath = null, string dateTimeFormat = null, int timeout = 100000, - string userAgent = "Square-Connect-CSharp/2.20191023.0" + string userAgent = "Square-Connect-CSharp/2.20191120.0" ) { setApiClientUsingDefault(apiClient); @@ -81,7 +81,7 @@ public Configuration(ApiClient apiClient) /// Version of the package. /// /// Version of the package. - public const string Version = "2.24.0"; + public const string Version = "2.25.0"; /// /// Gets or sets the default Configuration. @@ -318,7 +318,7 @@ public static String ToDebugReport() .GetReferencedAssemblies() .Where(x => x.Name == "System.Core").First().Version.ToString() + "\n"; report += " Version of the API: 2.0\n"; - report += " SDK Package Version: 2.24.0\n"; + report += " SDK Package Version: 2.25.0\n"; return report; } diff --git a/src/Square.Connect/Model/AdditionalRecipient.cs b/src/Square.Connect/Model/AdditionalRecipient.cs index 5d791d2..bb4f485 100644 --- a/src/Square.Connect/Model/AdditionalRecipient.cs +++ b/src/Square.Connect/Model/AdditionalRecipient.cs @@ -132,6 +132,7 @@ public override bool Equals(object obj) // credit: http://stackoverflow.com/a/10454552/677735 return this.Equals(obj as AdditionalRecipient); } + /// /// Returns true if AdditionalRecipient instances are equal /// diff --git a/src/Square.Connect/Model/BatchDeleteCatalogObjectsRequest.cs b/src/Square.Connect/Model/BatchDeleteCatalogObjectsRequest.cs index fdce3b7..6e51cd9 100644 --- a/src/Square.Connect/Model/BatchDeleteCatalogObjectsRequest.cs +++ b/src/Square.Connect/Model/BatchDeleteCatalogObjectsRequest.cs @@ -32,16 +32,16 @@ public partial class BatchDeleteCatalogObjectsRequest : IEquatable /// Initializes a new instance of the class. /// - /// The IDs of the `CatalogObject`s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a `CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation`.. + /// The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a CatalogItem will delete its CatalogItemVariation.. public BatchDeleteCatalogObjectsRequest(List ObjectIds = default(List)) { this.ObjectIds = ObjectIds; } /// - /// The IDs of the `CatalogObject`s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a `CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation`. + /// The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a CatalogItem will delete its CatalogItemVariation. /// - /// The IDs of the `CatalogObject`s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a `CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation`. + /// The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a CatalogItem will delete its CatalogItemVariation. [DataMember(Name="object_ids", EmitDefaultValue=false)] public List ObjectIds { get; set; } /// diff --git a/src/Square.Connect/Model/BatchDeleteCatalogObjectsResponse.cs b/src/Square.Connect/Model/BatchDeleteCatalogObjectsResponse.cs index deeb662..2f3a15b 100644 --- a/src/Square.Connect/Model/BatchDeleteCatalogObjectsResponse.cs +++ b/src/Square.Connect/Model/BatchDeleteCatalogObjectsResponse.cs @@ -32,9 +32,9 @@ public partial class BatchDeleteCatalogObjectsResponse : IEquatable /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. - /// The IDs of all `CatalogObject`s deleted by this request.. - /// The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".. + /// The set of Errors encountered.. + /// The IDs of all CatalogObjects deleted by this request.. + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".. public BatchDeleteCatalogObjectsResponse(List Errors = default(List), List DeletedObjectIds = default(List), string DeletedAt = default(string)) { this.Errors = Errors; @@ -43,21 +43,21 @@ public partial class BatchDeleteCatalogObjectsResponse : IEquatable - /// The set of `Error`s encountered. + /// The set of Errors encountered. /// - /// The set of `Error`s encountered. + /// The set of Errors encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// - /// The IDs of all `CatalogObject`s deleted by this request. + /// The IDs of all CatalogObjects deleted by this request. /// - /// The IDs of all `CatalogObject`s deleted by this request. + /// The IDs of all CatalogObjects deleted by this request. [DataMember(Name="deleted_object_ids", EmitDefaultValue=false)] public List DeletedObjectIds { get; set; } /// - /// The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". /// - /// The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". [DataMember(Name="deleted_at", EmitDefaultValue=false)] public string DeletedAt { get; set; } /// diff --git a/src/Square.Connect/Model/BatchRetrieveCatalogObjectsRequest.cs b/src/Square.Connect/Model/BatchRetrieveCatalogObjectsRequest.cs index 71afe2d..60d9e6b 100644 --- a/src/Square.Connect/Model/BatchRetrieveCatalogObjectsRequest.cs +++ b/src/Square.Connect/Model/BatchRetrieveCatalogObjectsRequest.cs @@ -37,8 +37,8 @@ protected BatchRetrieveCatalogObjectsRequest() { } /// /// Initializes a new instance of the class. /// - /// The IDs of the `CatalogObject`s to be retrieved. (required). - /// 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.. + /// The IDs of the CatalogObjects to be retrieved. (required). + /// If `true`, the response will include additional objects that are related to the requested objects, as follows: If the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response.. public BatchRetrieveCatalogObjectsRequest(List ObjectIds = default(List), bool? IncludeRelatedObjects = default(bool?)) { // to ensure "ObjectIds" is required (not null) @@ -54,15 +54,15 @@ protected BatchRetrieveCatalogObjectsRequest() { } } /// - /// The IDs of the `CatalogObject`s to be retrieved. + /// The IDs of the CatalogObjects to be retrieved. /// - /// The IDs of the `CatalogObject`s to be retrieved. + /// The IDs of the CatalogObjects to be retrieved. [DataMember(Name="object_ids", EmitDefaultValue=false)] public List ObjectIds { get; set; } /// - /// If `true`, the response will include additional objects that are related to the requested objects, as follows: If the `objects` field of the response contains a `CatalogItem`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. + /// If `true`, the response will include additional objects that are related to the requested objects, as follows: If the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. /// - /// If `true`, the response will include additional objects that are related to the requested objects, as follows: If the `objects` field of the response contains a `CatalogItem`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. + /// If `true`, the response will include additional objects that are related to the requested objects, as follows: If the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. [DataMember(Name="include_related_objects", EmitDefaultValue=false)] public bool? IncludeRelatedObjects { get; set; } /// diff --git a/src/Square.Connect/Model/BatchRetrieveInventoryChangesRequest.cs b/src/Square.Connect/Model/BatchRetrieveInventoryChangesRequest.cs index afe6d9d..ed7e684 100644 --- a/src/Square.Connect/Model/BatchRetrieveInventoryChangesRequest.cs +++ b/src/Square.Connect/Model/BatchRetrieveInventoryChangesRequest.cs @@ -38,7 +38,7 @@ public partial class BatchRetrieveInventoryChangesRequest : IEquatableFilters `ADJUSTMENT` query results by `InventoryState`. Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values. /// 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`).. /// 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`).. - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.. public BatchRetrieveInventoryChangesRequest(List CatalogObjectIds = default(List), List LocationIds = default(List), List Types = default(List), List States = default(List), string UpdatedAfter = default(string), string UpdatedBefore = default(string), string Cursor = default(string)) { this.CatalogObjectIds = CatalogObjectIds; @@ -87,9 +87,9 @@ public partial class BatchRetrieveInventoryChangesRequest : IEquatable - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/BatchRetrieveInventoryChangesResponse.cs b/src/Square.Connect/Model/BatchRetrieveInventoryChangesResponse.cs index fea5ea9..de91a89 100644 --- a/src/Square.Connect/Model/BatchRetrieveInventoryChangesResponse.cs +++ b/src/Square.Connect/Model/BatchRetrieveInventoryChangesResponse.cs @@ -34,7 +34,7 @@ public partial class BatchRetrieveInventoryChangesResponse : IEquatable /// Any errors that occurred during the request.. /// The current calculated inventory changes for the requested objects and locations.. - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.. public BatchRetrieveInventoryChangesResponse(List Errors = default(List), List Changes = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -55,9 +55,9 @@ public partial class BatchRetrieveInventoryChangesResponse : IEquatable Changes { get; set; } /// - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. /// - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/BatchRetrieveInventoryCountsRequest.cs b/src/Square.Connect/Model/BatchRetrieveInventoryCountsRequest.cs index 8b31c93..d766e99 100644 --- a/src/Square.Connect/Model/BatchRetrieveInventoryCountsRequest.cs +++ b/src/Square.Connect/Model/BatchRetrieveInventoryCountsRequest.cs @@ -35,7 +35,7 @@ public partial class BatchRetrieveInventoryCountsRequest : IEquatableFilters results by `CatalogObject` ID. Only applied when set. Default: unset.. /// Filters results by `Location` ID. Only applied when set. Default: unset.. /// 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`).. - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.. public BatchRetrieveInventoryCountsRequest(List CatalogObjectIds = default(List), List LocationIds = default(List), string UpdatedAfter = default(string), string Cursor = default(string)) { this.CatalogObjectIds = CatalogObjectIds; @@ -63,9 +63,9 @@ public partial class BatchRetrieveInventoryCountsRequest : IEquatable - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/BatchRetrieveInventoryCountsResponse.cs b/src/Square.Connect/Model/BatchRetrieveInventoryCountsResponse.cs index f8b750c..db67fad 100644 --- a/src/Square.Connect/Model/BatchRetrieveInventoryCountsResponse.cs +++ b/src/Square.Connect/Model/BatchRetrieveInventoryCountsResponse.cs @@ -34,7 +34,7 @@ public partial class BatchRetrieveInventoryCountsResponse : IEquatable /// Any errors that occurred during the request.. /// The current calculated inventory counts for the requested objects and locations.. - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.. public BatchRetrieveInventoryCountsResponse(List Errors = default(List), List Counts = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -55,9 +55,9 @@ public partial class BatchRetrieveInventoryCountsResponse : IEquatable Counts { get; set; } /// - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. /// - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/BatchUpsertCatalogObjectsRequest.cs b/src/Square.Connect/Model/BatchUpsertCatalogObjectsRequest.cs index c66f966..29980c5 100644 --- a/src/Square.Connect/Model/BatchUpsertCatalogObjectsRequest.cs +++ b/src/Square.Connect/Model/BatchUpsertCatalogObjectsRequest.cs @@ -38,7 +38,7 @@ protected BatchUpsertCatalogObjectsRequest() { } /// Initializes a new instance of the class. /// /// 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. (required). - /// A batch of `CatalogObject`s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a `CatalogItem` with ID `#ABC` and a `CatalogItemVariation` with its `item_id` attribute set to `#ABC` in order to associate the `CatalogItemVariation` with its parent `CatalogItem`. Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated.. + /// A batch of CatalogObjects to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a CatalogItem with ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to `#ABC` in order to associate the CatalogItemVariation with its parent CatalogItem. Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated.. public BatchUpsertCatalogObjectsRequest(string IdempotencyKey = default(string), List Batches = default(List)) { // to ensure "IdempotencyKey" is required (not null) @@ -60,9 +60,9 @@ protected BatchUpsertCatalogObjectsRequest() { } [DataMember(Name="idempotency_key", EmitDefaultValue=false)] public string IdempotencyKey { get; set; } /// - /// A batch of `CatalogObject`s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a `CatalogItem` with ID `#ABC` and a `CatalogItemVariation` with its `item_id` attribute set to `#ABC` in order to associate the `CatalogItemVariation` with its parent `CatalogItem`. Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. + /// A batch of CatalogObjects to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a CatalogItem with ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to `#ABC` in order to associate the CatalogItemVariation with its parent CatalogItem. Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. /// - /// A batch of `CatalogObject`s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a `CatalogItem` with ID `#ABC` and a `CatalogItemVariation` with its `item_id` attribute set to `#ABC` in order to associate the `CatalogItemVariation` with its parent `CatalogItem`. Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. + /// A batch of CatalogObjects to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a CatalogItem with ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to `#ABC` in order to associate the CatalogItemVariation with its parent CatalogItem. Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. [DataMember(Name="batches", EmitDefaultValue=false)] public List Batches { get; set; } /// diff --git a/src/Square.Connect/Model/BatchUpsertCatalogObjectsResponse.cs b/src/Square.Connect/Model/BatchUpsertCatalogObjectsResponse.cs index 7c9f088..2490c1a 100644 --- a/src/Square.Connect/Model/BatchUpsertCatalogObjectsResponse.cs +++ b/src/Square.Connect/Model/BatchUpsertCatalogObjectsResponse.cs @@ -32,10 +32,10 @@ public partial class BatchUpsertCatalogObjectsResponse : IEquatable /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. - /// The created `CatalogObject`s. - /// The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".. - /// The mapping between client and server IDs for this Upsert.. + /// Information on any errors that encountered.. + /// The created successfully created CatalogObjects.. + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".. + /// The mapping between client and server IDs for this upsert.. public BatchUpsertCatalogObjectsResponse(List Errors = default(List), List Objects = default(List), string UpdatedAt = default(string), List IdMappings = default(List)) { this.Errors = Errors; @@ -45,27 +45,27 @@ public partial class BatchUpsertCatalogObjectsResponse : IEquatable - /// The set of `Error`s encountered. + /// Information on any errors that encountered. /// - /// The set of `Error`s encountered. + /// Information on any errors that encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// - /// The created `CatalogObject`s + /// The created successfully created CatalogObjects. /// - /// The created `CatalogObject`s + /// The created successfully created CatalogObjects. [DataMember(Name="objects", EmitDefaultValue=false)] public List Objects { get; set; } /// - /// The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". /// - /// The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". [DataMember(Name="updated_at", EmitDefaultValue=false)] public string UpdatedAt { get; set; } /// - /// The mapping between client and server IDs for this Upsert. + /// The mapping between client and server IDs for this upsert. /// - /// The mapping between client and server IDs for this Upsert. + /// The mapping between client and server IDs for this upsert. [DataMember(Name="id_mappings", EmitDefaultValue=false)] public List IdMappings { get; set; } /// diff --git a/src/Square.Connect/Model/BusinessHours.cs b/src/Square.Connect/Model/BusinessHours.cs index 567f5b0..d676476 100644 --- a/src/Square.Connect/Model/BusinessHours.cs +++ b/src/Square.Connect/Model/BusinessHours.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents the hours of operation for a business location. + /// Represents the hours of operation for a business location. /// [DataContract] public partial class BusinessHours : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/BusinessHoursPeriod.cs b/src/Square.Connect/Model/BusinessHoursPeriod.cs index 858640f..a567e8e 100644 --- a/src/Square.Connect/Model/BusinessHoursPeriod.cs +++ b/src/Square.Connect/Model/BusinessHoursPeriod.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents a period of time during which a business location is open. + /// Represents a period of time during which a business location is open. /// [DataContract] public partial class BusinessHoursPeriod : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/CaptureTransactionRequest.cs b/src/Square.Connect/Model/CaptureTransactionRequest.cs index 1ab16a1..e43445f 100644 --- a/src/Square.Connect/Model/CaptureTransactionRequest.cs +++ b/src/Square.Connect/Model/CaptureTransactionRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the query parameters for calls to the CaptureTransaction endpoint. + /// /// [DataContract] [Obsolete] diff --git a/src/Square.Connect/Model/Card.cs b/src/Square.Connect/Model/Card.cs index 530fdc3..511dc84 100644 --- a/src/Square.Connect/Model/Card.cs +++ b/src/Square.Connect/Model/Card.cs @@ -33,13 +33,13 @@ public partial class Card : IEquatable, IValidatableObject /// Initializes a new instance of the class. /// /// Unique ID for this card. Generated by Square.. - /// The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for possible values. + /// The card's brand (such as `VISA`). See `CardBrand` for all possible values. See [CardBrand](#type-cardbrand) for possible values. /// The last 4 digits of the card number.. /// The expiration month of the associated card as an integer between 1 and 12.. /// The four-digit year of the card's expiration date.. /// The name of the cardholder.. /// The billing address for this card.. - /// A unique, Square-assigned ID that identifies the card across multiple locations and applications for a single Square account.. + /// __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.. /// The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.. public Card(string Id = default(string), string CardBrand = default(string), string Last4 = default(string), long? ExpMonth = default(long?), long? ExpYear = default(long?), string CardholderName = default(string), Address BillingAddress = default(Address), string Fingerprint = default(string), string Bin = default(string)) { @@ -61,9 +61,9 @@ public partial class Card : IEquatable, IValidatableObject [DataMember(Name="id", EmitDefaultValue=false)] public string Id { get; set; } /// - /// The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for possible values + /// The card's brand (such as `VISA`). See `CardBrand` for all possible values. See [CardBrand](#type-cardbrand) for possible values /// - /// The card's brand (such as `VISA`). See [CardBrand](#type-cardbrand) for possible values + /// The card's brand (such as `VISA`). See `CardBrand` for all possible values. See [CardBrand](#type-cardbrand) for possible values [DataMember(Name="card_brand", EmitDefaultValue=false)] public string CardBrand { get; set; } /// @@ -97,9 +97,9 @@ public partial class Card : IEquatable, IValidatableObject [DataMember(Name="billing_address", EmitDefaultValue=false)] public Address BillingAddress { get; set; } /// - /// A unique, Square-assigned ID that identifies the card across multiple locations and applications for a single Square account. + /// __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. /// - /// A unique, Square-assigned ID that identifies the card across multiple locations and applications for a single Square account. + /// __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. [DataMember(Name="fingerprint", EmitDefaultValue=false)] public string Fingerprint { get; set; } /// diff --git a/src/Square.Connect/Model/CashPaymentDetails.cs b/src/Square.Connect/Model/CashPaymentDetails.cs new file mode 100644 index 0000000..eccc6da --- /dev/null +++ b/src/Square.Connect/Model/CashPaymentDetails.cs @@ -0,0 +1,151 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Text.RegularExpressions; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using System.ComponentModel.DataAnnotations; + +namespace Square.Connect.Model +{ + /// + /// Additional details about CASH type payments. + /// + [DataContract] + public partial class CashPaymentDetails : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected CashPaymentDetails() { } + /// + /// Initializes a new instance of the class. + /// + /// The amount and currency of the money supplied by the buyer. (required). + /// The amount of change due back to the buyer. Read Only field calculated from the amount_money and buyer_supplied_money fields.. + public CashPaymentDetails(Money BuyerSuppliedMoney = default(Money), Money ChangeBackMoney = default(Money)) + { + // to ensure "BuyerSuppliedMoney" is required (not null) + if (BuyerSuppliedMoney == null) + { + throw new InvalidDataException("BuyerSuppliedMoney is a required property for CashPaymentDetails and cannot be null"); + } + else + { + this.BuyerSuppliedMoney = BuyerSuppliedMoney; + } + this.ChangeBackMoney = ChangeBackMoney; + } + + /// + /// The amount and currency of the money supplied by the buyer. + /// + /// The amount and currency of the money supplied by the buyer. + [DataMember(Name="buyer_supplied_money", EmitDefaultValue=false)] + public Money BuyerSuppliedMoney { get; set; } + /// + /// The amount of change due back to the buyer. Read Only field calculated from the amount_money and buyer_supplied_money fields. + /// + /// The amount of change due back to the buyer. Read Only field calculated from the amount_money and buyer_supplied_money fields. + [DataMember(Name="change_back_money", EmitDefaultValue=false)] + public Money ChangeBackMoney { get; set; } + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CashPaymentDetails {\n"); + sb.Append(" BuyerSuppliedMoney: ").Append(BuyerSuppliedMoney).Append("\n"); + sb.Append(" ChangeBackMoney: ").Append(ChangeBackMoney).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object obj) + { + // credit: http://stackoverflow.com/a/10454552/677735 + return this.Equals(obj as CashPaymentDetails); + } + + /// + /// Returns true if CashPaymentDetails instances are equal + /// + /// Instance of CashPaymentDetails to be compared + /// Boolean + public bool Equals(CashPaymentDetails other) + { + // credit: http://stackoverflow.com/a/10454552/677735 + if (other == null) + return false; + + return + ( + this.BuyerSuppliedMoney == other.BuyerSuppliedMoney || + this.BuyerSuppliedMoney != null && + this.BuyerSuppliedMoney.Equals(other.BuyerSuppliedMoney) + ) && + ( + this.ChangeBackMoney == other.ChangeBackMoney || + this.ChangeBackMoney != null && + this.ChangeBackMoney.Equals(other.ChangeBackMoney) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + // credit: http://stackoverflow.com/a/263416/677735 + unchecked // Overflow is fine, just wrap + { + int hash = 41; + // Suitable nullity checks etc, of course :) + if (this.BuyerSuppliedMoney != null) + hash = hash * 59 + this.BuyerSuppliedMoney.GetHashCode(); + if (this.ChangeBackMoney != null) + hash = hash * 59 + this.ChangeBackMoney.GetHashCode(); + return hash; + } + } + + public IEnumerable Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Square.Connect/Model/CatalogCategory.cs b/src/Square.Connect/Model/CatalogCategory.cs index 993e107..2f8e4f4 100644 --- a/src/Square.Connect/Model/CatalogCategory.cs +++ b/src/Square.Connect/Model/CatalogCategory.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model. + /// A category to which a `CatalogItem` belongs in the `Catalog` object model. /// [DataContract] public partial class CatalogCategory : IEquatable, IValidatableObject @@ -32,16 +32,16 @@ public partial class CatalogCategory : IEquatable, IValidatabl /// /// Initializes a new instance of the class. /// - /// The category's name. Searchable. This field has max length of 255 Unicode code points.. + /// The category name. Searchable. This field has max length of 255 Unicode code points.. public CatalogCategory(string Name = default(string)) { this.Name = Name; } /// - /// The category's name. Searchable. This field has max length of 255 Unicode code points. + /// The category name. Searchable. This field has max length of 255 Unicode code points. /// - /// The category's name. Searchable. This field has max length of 255 Unicode code points. + /// The category name. Searchable. This field has max length of 255 Unicode code points. [DataMember(Name="name", EmitDefaultValue=false)] public string Name { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogDiscount.cs b/src/Square.Connect/Model/CatalogDiscount.cs index 426e862..9842506 100644 --- a/src/Square.Connect/Model/CatalogDiscount.cs +++ b/src/Square.Connect/Model/CatalogDiscount.cs @@ -32,13 +32,14 @@ public partial class CatalogDiscount : IEquatable, IValidatabl /// /// Initializes a new instance of the class. /// - /// The discount's name. Searchable. This field has max length of 255 Unicode code points.. + /// The discount name. Searchable. This field has max length of 255 Unicode code points.. /// Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for possible values. /// The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`. Do not include this field for amount-based or variable discounts.. /// The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`. Do not include this field for percentage-based or variable discounts.. /// Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app.. - /// The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code.. - public CatalogDiscount(string Name = default(string), string DiscountType = default(string), string Percentage = default(string), Money AmountMoney = default(Money), bool? PinRequired = default(bool?), string LabelColor = default(string)) + /// The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code.. + /// Indicates whether this discount should reduce the price used to calculate tax. Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must be calculated based on an item's price, ignoring a particular discount. For example, in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a customer pays but does not reduce the sale price used to calculate how much sales tax is due. In this case, the discount representing that manufacturer coupon should have `DO_NOT_MODIFY_TAX_BASIS` for this field. If you are unsure whether you need to use this field, consult your tax professional. See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values. + public CatalogDiscount(string Name = default(string), string DiscountType = default(string), string Percentage = default(string), Money AmountMoney = default(Money), bool? PinRequired = default(bool?), string LabelColor = default(string), string ModifyTaxBasis = default(string)) { this.Name = Name; this.DiscountType = DiscountType; @@ -46,12 +47,13 @@ public partial class CatalogDiscount : IEquatable, IValidatabl this.AmountMoney = AmountMoney; this.PinRequired = PinRequired; this.LabelColor = LabelColor; + this.ModifyTaxBasis = ModifyTaxBasis; } /// - /// The discount's name. Searchable. This field has max length of 255 Unicode code points. + /// The discount name. Searchable. This field has max length of 255 Unicode code points. /// - /// The discount's name. Searchable. This field has max length of 255 Unicode code points. + /// The discount name. Searchable. This field has max length of 255 Unicode code points. [DataMember(Name="name", EmitDefaultValue=false)] public string Name { get; set; } /// @@ -79,12 +81,18 @@ public partial class CatalogDiscount : IEquatable, IValidatabl [DataMember(Name="pin_required", EmitDefaultValue=false)] public bool? PinRequired { get; set; } /// - /// The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code. + /// The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code. /// - /// The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code. + /// The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code. [DataMember(Name="label_color", EmitDefaultValue=false)] public string LabelColor { get; set; } /// + /// Indicates whether this discount should reduce the price used to calculate tax. Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must be calculated based on an item's price, ignoring a particular discount. For example, in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a customer pays but does not reduce the sale price used to calculate how much sales tax is due. In this case, the discount representing that manufacturer coupon should have `DO_NOT_MODIFY_TAX_BASIS` for this field. If you are unsure whether you need to use this field, consult your tax professional. See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values + /// + /// Indicates whether this discount should reduce the price used to calculate tax. Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must be calculated based on an item's price, ignoring a particular discount. For example, in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a customer pays but does not reduce the sale price used to calculate how much sales tax is due. In this case, the discount representing that manufacturer coupon should have `DO_NOT_MODIFY_TAX_BASIS` for this field. If you are unsure whether you need to use this field, consult your tax professional. See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values + [DataMember(Name="modify_tax_basis", EmitDefaultValue=false)] + public string ModifyTaxBasis { get; set; } + /// /// Returns the string presentation of the object /// /// String presentation of the object @@ -98,6 +106,7 @@ public override string ToString() sb.Append(" AmountMoney: ").Append(AmountMoney).Append("\n"); sb.Append(" PinRequired: ").Append(PinRequired).Append("\n"); sb.Append(" LabelColor: ").Append(LabelColor).Append("\n"); + sb.Append(" ModifyTaxBasis: ").Append(ModifyTaxBasis).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -163,6 +172,11 @@ public bool Equals(CatalogDiscount other) this.LabelColor == other.LabelColor || this.LabelColor != null && this.LabelColor.Equals(other.LabelColor) + ) && + ( + this.ModifyTaxBasis == other.ModifyTaxBasis || + this.ModifyTaxBasis != null && + this.ModifyTaxBasis.Equals(other.ModifyTaxBasis) ); } @@ -189,6 +203,8 @@ public override int GetHashCode() hash = hash * 59 + this.PinRequired.GetHashCode(); if (this.LabelColor != null) hash = hash * 59 + this.LabelColor.GetHashCode(); + if (this.ModifyTaxBasis != null) + hash = hash * 59 + this.ModifyTaxBasis.GetHashCode(); return hash; } } diff --git a/src/Square.Connect/Model/CatalogIdMapping.cs b/src/Square.Connect/Model/CatalogIdMapping.cs index cdb4e82..38dc2ae 100644 --- a/src/Square.Connect/Model/CatalogIdMapping.cs +++ b/src/Square.Connect/Model/CatalogIdMapping.cs @@ -33,7 +33,7 @@ public partial class CatalogIdMapping : IEquatable, IValidata /// Initializes a new instance of the class. /// /// The client-supplied, temporary `#`-prefixed ID for a new `CatalogObject`.. - /// The permanent ID for the `CatalogObject` created by the server.. + /// The permanent ID for the CatalogObject created by the server.. public CatalogIdMapping(string ClientObjectId = default(string), string ObjectId = default(string)) { this.ClientObjectId = ClientObjectId; @@ -47,9 +47,9 @@ public partial class CatalogIdMapping : IEquatable, IValidata [DataMember(Name="client_object_id", EmitDefaultValue=false)] public string ClientObjectId { get; set; } /// - /// The permanent ID for the `CatalogObject` created by the server. + /// The permanent ID for the CatalogObject created by the server. /// - /// The permanent ID for the `CatalogObject` created by the server. + /// The permanent ID for the CatalogObject created by the server. [DataMember(Name="object_id", EmitDefaultValue=false)] public string ObjectId { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogInfoResponse.cs b/src/Square.Connect/Model/CatalogInfoResponse.cs index e9242b0..186cf1e 100644 --- a/src/Square.Connect/Model/CatalogInfoResponse.cs +++ b/src/Square.Connect/Model/CatalogInfoResponse.cs @@ -32,7 +32,7 @@ public partial class CatalogInfoResponse : IEquatable, IVa /// /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. + /// The set of errors encountered.. /// . /// Names and abbreviations for standard units.. public CatalogInfoResponse(List Errors = default(List), CatalogInfoResponseLimits Limits = default(CatalogInfoResponseLimits), StandardUnitDescriptionGroup StandardUnitDescriptionGroup = default(StandardUnitDescriptionGroup)) @@ -43,9 +43,9 @@ public partial class CatalogInfoResponse : IEquatable, IVa } /// - /// The set of `Error`s encountered. + /// The set of errors encountered. /// - /// The set of `Error`s encountered. + /// The set of errors encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogItem.cs b/src/Square.Connect/Model/CatalogItem.cs index 5396754..37d1779 100644 --- a/src/Square.Connect/Model/CatalogItem.cs +++ b/src/Square.Connect/Model/CatalogItem.cs @@ -40,9 +40,9 @@ public partial class CatalogItem : IEquatable, IValidatableObject /// If `true`, the item can be added to pickup orders from the merchant's online store.. /// If `true`, the item can be added to electronically fulfilled orders from the merchant's online store.. /// The ID of the item's category, if any.. - /// A set of IDs indicating the `CatalogTax`es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. `CatalogTax`es may also be added to or deleted from an item using `UpdateItemTaxes`.. - /// A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. `CatalogModifierList`s may also be added to or deleted from an item using `UpdateItemModifierLists`.. - /// A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations. + /// A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item. Taxes may also be added to or deleted from an item using `UpdateItemTaxes`.. + /// A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. Modifier lists may also be added to or deleted from an item using `UpdateItemModifierLists`.. + /// A list of CatalogObjects containing the `CatalogItemVariation`s for this item.. /// 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. /// 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.. /// [beta] List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options.. @@ -113,21 +113,21 @@ public partial class CatalogItem : IEquatable, IValidatableObject [DataMember(Name="category_id", EmitDefaultValue=false)] public string CategoryId { get; set; } /// - /// A set of IDs indicating the `CatalogTax`es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. `CatalogTax`es may also be added to or deleted from an item using `UpdateItemTaxes`. + /// A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item. Taxes may also be added to or deleted from an item using `UpdateItemTaxes`. /// - /// A set of IDs indicating the `CatalogTax`es that are enabled for this item. When updating an item, any taxes listed here will be added to the item. `CatalogTax`es may also be added to or deleted from an item using `UpdateItemTaxes`. + /// A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item. Taxes may also be added to or deleted from an item using `UpdateItemTaxes`. [DataMember(Name="tax_ids", EmitDefaultValue=false)] public List TaxIds { get; set; } /// - /// A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. `CatalogModifierList`s may also be added to or deleted from an item using `UpdateItemModifierLists`. + /// A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. Modifier lists may also be added to or deleted from an item using `UpdateItemModifierLists`. /// - /// A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. `CatalogModifierList`s may also be added to or deleted from an item using `UpdateItemModifierLists`. + /// A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. Modifier lists may also be added to or deleted from an item using `UpdateItemModifierLists`. [DataMember(Name="modifier_list_info", EmitDefaultValue=false)] public List ModifierListInfo { get; set; } /// - /// A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations + /// A list of CatalogObjects containing the `CatalogItemVariation`s for this item. /// - /// A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations + /// A list of CatalogObjects containing the `CatalogItemVariation`s for this item. [DataMember(Name="variations", EmitDefaultValue=false)] public List Variations { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogItemModifierListInfo.cs b/src/Square.Connect/Model/CatalogItemModifierListInfo.cs index f2e75ba..53dc4b8 100644 --- a/src/Square.Connect/Model/CatalogItemModifierListInfo.cs +++ b/src/Square.Connect/Model/CatalogItemModifierListInfo.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Controls the properties of a [CatalogModifierList](#type-catalogmodifierlist) as it applies to this [CatalogItem](#type-catalogitem). + /// Controls the properties of a `CatalogModifierList` as it applies to this `CatalogItem`. /// [DataContract] public partial class CatalogItemModifierListInfo : IEquatable, IValidatableObject @@ -37,10 +37,10 @@ protected CatalogItemModifierListInfo() { } /// /// Initializes a new instance of the class. /// - /// The ID of the `CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo`. (required). - /// A set of `CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier` is enabled by default.. - /// If zero or larger, the smallest number of `CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList`.. - /// If zero or larger, the largest number of `CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList`.. + /// The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`. (required). + /// A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default.. + /// If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`.. + /// If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`.. /// If `true`, enable this `CatalogModifierList`.. public CatalogItemModifierListInfo(string ModifierListId = default(string), List ModifierOverrides = default(List), int? MinSelectedModifiers = default(int?), int? MaxSelectedModifiers = default(int?), bool? Enabled = default(bool?)) { @@ -60,27 +60,27 @@ protected CatalogItemModifierListInfo() { } } /// - /// The ID of the `CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo`. + /// The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`. /// - /// The ID of the `CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo`. + /// The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`. [DataMember(Name="modifier_list_id", EmitDefaultValue=false)] public string ModifierListId { get; set; } /// - /// A set of `CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier` is enabled by default. + /// A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. /// - /// A set of `CatalogModifierOverride](#type-catalogmodifieroverride) objects that override whether a given [CatalogModifier` is enabled by default. + /// A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. [DataMember(Name="modifier_overrides", EmitDefaultValue=false)] public List ModifierOverrides { get; set; } /// - /// If zero or larger, the smallest number of `CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList`. + /// If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. /// - /// If zero or larger, the smallest number of `CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList`. + /// If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. [DataMember(Name="min_selected_modifiers", EmitDefaultValue=false)] public int? MinSelectedModifiers { get; set; } /// - /// If zero or larger, the largest number of `CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList`. + /// If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. /// - /// If zero or larger, the largest number of `CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList`. + /// If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. [DataMember(Name="max_selected_modifiers", EmitDefaultValue=false)] public int? MaxSelectedModifiers { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogItemOption.cs b/src/Square.Connect/Model/CatalogItemOption.cs index 920b0df..34e9070 100644 --- a/src/Square.Connect/Model/CatalogItemOption.cs +++ b/src/Square.Connect/Model/CatalogItemOption.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// A group of variations for a [CatalogItem](#type-catalogitem)'s. + /// A group of variations for a `CatalogItem`. /// Note: This endpoint is in beta. /// [DataContract] @@ -35,9 +35,9 @@ public partial class CatalogItemOption : IEquatable, IValida /// /// The item option's display name for the seller. Must be unique across all item options. Searchable.. /// The item option's display name for the customer. Searchable.. - /// The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer.. + /// The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer.. /// If true, display colors for entries in `values` when present.. - /// A list of `CatalogObject`s containing the `CatalogItemOptionValue`s for this item.. + /// A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item.. /// 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 CatalogItemOption(string Name = default(string), string DisplayName = default(string), string Description = default(string), bool? ShowColors = default(bool?), List Values = default(List), long? ItemCount = default(long?)) { @@ -62,9 +62,9 @@ public partial class CatalogItemOption : IEquatable, IValida [DataMember(Name="display_name", EmitDefaultValue=false)] public string DisplayName { get; set; } /// - /// The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. + /// The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. /// - /// The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. + /// The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. [DataMember(Name="description", EmitDefaultValue=false)] public string Description { get; set; } /// @@ -74,9 +74,9 @@ public partial class CatalogItemOption : IEquatable, IValida [DataMember(Name="show_colors", EmitDefaultValue=false)] public bool? ShowColors { get; set; } /// - /// A list of `CatalogObject`s containing the `CatalogItemOptionValue`s for this item. + /// A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item. /// - /// A list of `CatalogObject`s containing the `CatalogItemOptionValue`s for this item. + /// A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item. [DataMember(Name="values", EmitDefaultValue=false)] public List Values { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogItemOptionValue.cs b/src/Square.Connect/Model/CatalogItemOptionValue.cs index 7e2e436..c7838b0 100644 --- a/src/Square.Connect/Model/CatalogItemOptionValue.cs +++ b/src/Square.Connect/Model/CatalogItemOptionValue.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// An enumerated value that can link a [CatalogItemVariation(#type-catalogitemvariation) to an item option as one of its item option values. + /// An enumerated value that can link a `CatalogItemVariation` to an item option as one of its item option values. /// Note: This endpoint is in beta. /// [DataContract] @@ -35,10 +35,10 @@ public partial class CatalogItemOptionValue : IEquatable /// Unique ID of the associated item option.. /// Name of this item option value. Searchable.. - /// The option value's human-readable description.. + /// A human-readable description for the option value.. /// The HTML-supported hex color for the item option (e.g., \"#ff8d4e85\"). Only displayed if `show_colors` is enabled on the parent `ItemOption`. When left unset, `color` defaults to white (\"#ffffff\") when `show_colors` is enabled on the parent `ItemOption`.. /// Determines where this option value appears in a list of option values.. - /// The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts.. + /// The number of `CatalogItemVariation`s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts.. public CatalogItemOptionValue(string ItemOptionId = default(string), string Name = default(string), string Description = default(string), string Color = default(string), int? Ordinal = default(int?), long? ItemVariationCount = default(long?)) { this.ItemOptionId = ItemOptionId; @@ -62,9 +62,9 @@ public partial class CatalogItemOptionValue : IEquatable - /// The option value's human-readable description. + /// A human-readable description for the option value. /// - /// The option value's human-readable description. + /// A human-readable description for the option value. [DataMember(Name="description", EmitDefaultValue=false)] public string Description { get; set; } /// @@ -80,9 +80,9 @@ public partial class CatalogItemOptionValue : IEquatable - /// The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. + /// The number of `CatalogItemVariation`s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. /// - /// The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. + /// The number of `CatalogItemVariation`s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. [DataMember(Name="item_variation_count", EmitDefaultValue=false)] public long? ItemVariationCount { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogItemOptionValueForItemVariation.cs b/src/Square.Connect/Model/CatalogItemOptionValueForItemVariation.cs index f94761a..dea591d 100644 --- a/src/Square.Connect/Model/CatalogItemOptionValueForItemVariation.cs +++ b/src/Square.Connect/Model/CatalogItemOptionValueForItemVariation.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// A [CatalogItemOptionValue](#type-catalogitemoptionvalue) links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, “Color:Red, Size:Small” or “Color:Blue, Size:Medium”. + /// A `CatalogItemOptionValue` links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, \"Color:Red, Size:Small\" or \"Color:Blue, Size:Medium\". /// Note: This endpoint is in beta. /// [DataContract] diff --git a/src/Square.Connect/Model/CatalogItemVariation.cs b/src/Square.Connect/Model/CatalogItemVariation.cs index 3a3b21d..a595e96 100644 --- a/src/Square.Connect/Model/CatalogItemVariation.cs +++ b/src/Square.Connect/Model/CatalogItemVariation.cs @@ -39,11 +39,11 @@ public partial class CatalogItemVariation : IEquatable, I /// 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.. /// Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for possible values. /// The item variation's price, if fixed pricing is used.. - /// Per-`location` price and inventory overrides.. + /// Per-location price and inventory overrides.. /// If `true`, inventory tracking is active for the variation.. /// 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. /// 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.. - /// Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable.. + /// Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points.. /// 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).. /// [beta] List of item option values associated with this item variation. Listed in the same order as the item options of the parent item.. /// [beta] 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.. @@ -109,9 +109,9 @@ public partial class CatalogItemVariation : IEquatable, I [DataMember(Name="price_money", EmitDefaultValue=false)] public Money PriceMoney { get; set; } /// - /// Per-`location` price and inventory overrides. + /// Per-location price and inventory overrides. /// - /// Per-`location` price and inventory overrides. + /// Per-location price and inventory overrides. [DataMember(Name="location_overrides", EmitDefaultValue=false)] public List LocationOverrides { get; set; } /// @@ -133,9 +133,9 @@ public partial class CatalogItemVariation : IEquatable, I [DataMember(Name="inventory_alert_threshold", EmitDefaultValue=false)] public long? InventoryAlertThreshold { get; set; } /// - /// Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. + /// Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. /// - /// Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. + /// Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. [DataMember(Name="user_data", EmitDefaultValue=false)] public string UserData { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogMeasurementUnit.cs b/src/Square.Connect/Model/CatalogMeasurementUnit.cs index f5e5355..50c8c89 100644 --- a/src/Square.Connect/Model/CatalogMeasurementUnit.cs +++ b/src/Square.Connect/Model/CatalogMeasurementUnit.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents the unit used to measure a [CatalogItemVariation](#type-catalogitemvariation) and specifies the precision for decimal quantities. + /// Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities. /// Note: This endpoint is in beta. /// [DataContract] @@ -34,7 +34,7 @@ public partial class CatalogMeasurementUnit : IEquatable class. /// /// Indicates the unit used to measure the quantity of a catalog item variation.. - /// Represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example, if the precision is 2, then an itemization’s quantity can be 0.01, 0.12, etc. Min: 0 Max: 5 Default: 3. + /// An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3. public CatalogMeasurementUnit(MeasurementUnit MeasurementUnit = default(MeasurementUnit), int? Precision = default(int?)) { this.MeasurementUnit = MeasurementUnit; @@ -48,9 +48,9 @@ public partial class CatalogMeasurementUnit : IEquatable - /// Represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example, if the precision is 2, then an itemization’s quantity can be 0.01, 0.12, etc. Min: 0 Max: 5 Default: 3 + /// An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3 /// - /// Represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example, if the precision is 2, then an itemization’s quantity can be 0.01, 0.12, etc. Min: 0 Max: 5 Default: 3 + /// An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3 [DataMember(Name="precision", EmitDefaultValue=false)] public int? Precision { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogModifier.cs b/src/Square.Connect/Model/CatalogModifier.cs index 79697c8..fb4250c 100644 --- a/src/Square.Connect/Model/CatalogModifier.cs +++ b/src/Square.Connect/Model/CatalogModifier.cs @@ -32,8 +32,8 @@ public partial class CatalogModifier : IEquatable, IValidatabl /// /// Initializes a new instance of the class. /// - /// The modifier's name. Searchable. This field has max length of 255 Unicode code points.. - /// The modifier's price.. + /// The modifier name. Searchable. This field has max length of 255 Unicode code points.. + /// The modifier price.. public CatalogModifier(string Name = default(string), Money PriceMoney = default(Money)) { this.Name = Name; @@ -41,15 +41,15 @@ public partial class CatalogModifier : IEquatable, IValidatabl } /// - /// The modifier's name. Searchable. This field has max length of 255 Unicode code points. + /// The modifier name. Searchable. This field has max length of 255 Unicode code points. /// - /// The modifier's name. Searchable. This field has max length of 255 Unicode code points. + /// The modifier name. Searchable. This field has max length of 255 Unicode code points. [DataMember(Name="name", EmitDefaultValue=false)] public string Name { get; set; } /// - /// The modifier's price. + /// The modifier price. /// - /// The modifier's price. + /// The modifier price. [DataMember(Name="price_money", EmitDefaultValue=false)] public Money PriceMoney { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogModifierList.cs b/src/Square.Connect/Model/CatalogModifierList.cs index 5de5abd..9a24537 100644 --- a/src/Square.Connect/Model/CatalogModifierList.cs +++ b/src/Square.Connect/Model/CatalogModifierList.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// A modifier list in the Catalog object model. A [CatalogModifierList](#type-catalogmodifierlist) contains [Modifier](#type-catalogmodifier)s that can be applied to a [CatalogItem](#type-catalogitem) at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" [CatalogItem](#type-catalogitem) might contain [CatalogModifier](#type-catalogmodifier)s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed. + /// A modifier list in the Catalog object model. A `CatalogModifierList` contains `CatalogModifier` objects that can be applied to a `CatalogItem` at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" `CatalogItem` might contain `CatalogModifier`s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed. /// [DataContract] public partial class CatalogModifierList : IEquatable, IValidatableObject @@ -32,9 +32,9 @@ public partial class CatalogModifierList : IEquatable, IVa /// /// Initializes a new instance of the class. /// - /// The `CatalogModifierList`'s name. Searchable. This field has max length of 255 Unicode code points.. + /// A searchable name for the `CatalogModifierList`. This field has max length of 255 Unicode code points.. /// Indicates whether multiple options from the `CatalogModifierList` can be applied to a single `CatalogItem`. See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values. - /// The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each `CatalogObject` must have type `MODIFIER` and contain `CatalogModifier` data.. + /// The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each CatalogObject must have type `MODIFIER` and contain `CatalogModifier` data.. public CatalogModifierList(string Name = default(string), string SelectionType = default(string), List Modifiers = default(List)) { this.Name = Name; @@ -43,9 +43,9 @@ public partial class CatalogModifierList : IEquatable, IVa } /// - /// The `CatalogModifierList`'s name. Searchable. This field has max length of 255 Unicode code points. + /// A searchable name for the `CatalogModifierList`. This field has max length of 255 Unicode code points. /// - /// The `CatalogModifierList`'s name. Searchable. This field has max length of 255 Unicode code points. + /// A searchable name for the `CatalogModifierList`. This field has max length of 255 Unicode code points. [DataMember(Name="name", EmitDefaultValue=false)] public string Name { get; set; } /// @@ -55,9 +55,9 @@ public partial class CatalogModifierList : IEquatable, IVa [DataMember(Name="selection_type", EmitDefaultValue=false)] public string SelectionType { get; set; } /// - /// The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each `CatalogObject` must have type `MODIFIER` and contain `CatalogModifier` data. + /// The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each CatalogObject must have type `MODIFIER` and contain `CatalogModifier` data. /// - /// The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each `CatalogObject` must have type `MODIFIER` and contain `CatalogModifier` data. + /// The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each CatalogObject must have type `MODIFIER` and contain `CatalogModifier` data. [DataMember(Name="modifiers", EmitDefaultValue=false)] public List Modifiers { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogModifierOverride.cs b/src/Square.Connect/Model/CatalogModifierOverride.cs index cbf1647..56269f7 100644 --- a/src/Square.Connect/Model/CatalogModifierOverride.cs +++ b/src/Square.Connect/Model/CatalogModifierOverride.cs @@ -38,7 +38,7 @@ protected CatalogModifierOverride() { } /// Initializes a new instance of the class. /// /// The ID of the `CatalogModifier` whose default behavior is being overridden. (required). - /// If `true`, this `CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem`.. + /// If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`.. public CatalogModifierOverride(string ModifierId = default(string), bool? OnByDefault = default(bool?)) { // to ensure "ModifierId" is required (not null) @@ -60,9 +60,9 @@ protected CatalogModifierOverride() { } [DataMember(Name="modifier_id", EmitDefaultValue=false)] public string ModifierId { get; set; } /// - /// If `true`, this `CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem`. + /// If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`. /// - /// If `true`, this `CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem`. + /// If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`. [DataMember(Name="on_by_default", EmitDefaultValue=false)] public bool? OnByDefault { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogObject.cs b/src/Square.Connect/Model/CatalogObject.cs index 940c007..9df96cf 100644 --- a/src/Square.Connect/Model/CatalogObject.cs +++ b/src/Square.Connect/Model/CatalogObject.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid [CatalogItem](#type-catalogitem) object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid [CatalogItemVariation](#type-catalogitemvariation) object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid [CatalogModifier](#type-catalogmodifier) object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid [CatalogModifierList](#type-catalogmodifierlist) object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid [CatalogCategory](#type-catalogcategory) object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid [CatalogDiscount](#type-catalogdiscount) object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid [CatalogTax](#type-catalogtax) object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid [CatalogImage](#type-catalogimage) object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. + /// The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid `CatalogItem` object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid `CatalogItemVariation` object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid `CatalogModifier` object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid `CatalogModifierList` object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid `CatalogCategory` object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid `CatalogDiscount` object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid `CatalogTax` object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid `CatalogImage` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. /// [DataContract] public partial class CatalogObject : IEquatable, IValidatableObject @@ -38,11 +38,11 @@ protected CatalogObject() { } /// Initializes a new instance of the class. /// /// The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See [CatalogObjectType](#type-catalogobjecttype) for possible values (required). - /// An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. (required). - /// 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.. + /// An identifier to reference this object in the catalog. When a new `CatalogObject` is inserted, the client should set the id to a temporary identifier starting with a \"`#`\" character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. (required). + /// Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds.. /// 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.. /// 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.. - /// The Connect V1 IDs for this object at each `location` where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs.. + /// The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs.. /// 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`.. /// A list of locations where the object is present, even if `present_at_all_locations` is `false`.. /// A list of locations where the object is not present, even if `present_at_all_locations` is `true`.. @@ -112,15 +112,15 @@ protected CatalogObject() { } [DataMember(Name="type", EmitDefaultValue=false)] public string Type { get; set; } /// - /// An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. + /// An identifier to reference this object in the catalog. When a new `CatalogObject` is inserted, the client should set the id to a temporary identifier starting with a \"`#`\" character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. /// - /// An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. + /// An identifier to reference this object in the catalog. When a new `CatalogObject` is inserted, the client should set the id to a temporary identifier starting with a \"`#`\" character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. [DataMember(Name="id", EmitDefaultValue=false)] public string Id { get; set; } /// - /// Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. + /// Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. /// - /// Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. + /// Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. [DataMember(Name="updated_at", EmitDefaultValue=false)] public string UpdatedAt { get; set; } /// @@ -136,9 +136,9 @@ protected CatalogObject() { } [DataMember(Name="is_deleted", EmitDefaultValue=false)] public bool? IsDeleted { get; set; } /// - /// The Connect V1 IDs for this object at each `location` where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. + /// The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. /// - /// The Connect V1 IDs for this object at each `location` where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. + /// The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. [DataMember(Name="catalog_v1_ids", EmitDefaultValue=false)] public List CatalogV1Ids { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogObjectBatch.cs b/src/Square.Connect/Model/CatalogObjectBatch.cs index 891990a..707a009 100644 --- a/src/Square.Connect/Model/CatalogObjectBatch.cs +++ b/src/Square.Connect/Model/CatalogObjectBatch.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// A batch of [CatalogObject](#type-catalogobject)s. + /// A batch of catalog objects. /// [DataContract] public partial class CatalogObjectBatch : IEquatable, IValidatableObject @@ -32,16 +32,16 @@ public partial class CatalogObjectBatch : IEquatable, IVali /// /// Initializes a new instance of the class. /// - /// A list of `CatalogObject`s belonging to this batch.. + /// A list of CatalogObjects belonging to this batch.. public CatalogObjectBatch(List Objects = default(List)) { this.Objects = Objects; } /// - /// A list of `CatalogObject`s belonging to this batch. + /// A list of CatalogObjects belonging to this batch. /// - /// A list of `CatalogObject`s belonging to this batch. + /// A list of CatalogObjects belonging to this batch. [DataMember(Name="objects", EmitDefaultValue=false)] public List Objects { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogPricingRule.cs b/src/Square.Connect/Model/CatalogPricingRule.cs index 98b2a5d..743b219 100644 --- a/src/Square.Connect/Model/CatalogPricingRule.cs +++ b/src/Square.Connect/Model/CatalogPricingRule.cs @@ -34,16 +34,16 @@ public partial class CatalogPricingRule : IEquatable, IVali /// Initializes a new instance of the class. /// /// User-defined name for the pricing rule. For example, \"Buy one get one free\" or \"10% off\".. - /// Unique ID for the `CatalogTimePeriod`s when this pricing rule is in effect. If left unset, the pricing rule is always in effect.. + /// A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect.. /// Unique ID for the `CatalogDiscount` to take off the price of all matched items.. - /// Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart.. - /// [deprecated] `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. This field has been deprecated: new pricing rules should prefer the exclude_products_id field. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount.. - /// 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.. + /// Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. A match rule can match multiple times in the cart. If no `ProductSet` is present, the rule will match all products.. + /// [deprecated] __Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.. + /// `CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.. /// Represents the date the Pricing Rule is valid from. Represented in RFC3339 full-date format (YYYY-MM-DD).. - /// Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.. - /// Represents the date the pricing rule will become inactive. Represented in RFC3339 full-date format (YYYY-MM-DD).. - /// Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.. - /// If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. See `ExcludeStrategy` for all possible values. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values. + /// Represents the local time the pricing rule should be valid from. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.. + /// Represents the date the Pricing Rule is valid until. Represented in RFC3339 full-date format (YYYY-MM-DD).. + /// Represents the local time the pricing rule should be valid until. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.. + /// If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values. public CatalogPricingRule(string Name = default(string), List TimePeriodIds = default(List), string DiscountId = default(string), string MatchProductsId = default(string), string ApplyProductsId = default(string), string ExcludeProductsId = default(string), string ValidFromDate = default(string), string ValidFromLocalTime = default(string), string ValidUntilDate = default(string), string ValidUntilLocalTime = default(string), string ExcludeStrategy = default(string)) { this.Name = Name; @@ -66,9 +66,9 @@ public partial class CatalogPricingRule : IEquatable, IVali [DataMember(Name="name", EmitDefaultValue=false)] public string Name { get; set; } /// - /// Unique ID for the `CatalogTimePeriod`s when this pricing rule is in effect. If left unset, the pricing rule is always in effect. + /// A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect. /// - /// Unique ID for the `CatalogTimePeriod`s when this pricing rule is in effect. If left unset, the pricing rule is always in effect. + /// A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect. [DataMember(Name="time_period_ids", EmitDefaultValue=false)] public List TimePeriodIds { get; set; } /// @@ -78,21 +78,21 @@ public partial class CatalogPricingRule : IEquatable, IVali [DataMember(Name="discount_id", EmitDefaultValue=false)] public string DiscountId { get; set; } /// - /// Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. + /// Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. A match rule can match multiple times in the cart. If no `ProductSet` is present, the rule will match all products. /// - /// Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. + /// Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart. A match rule can match multiple times in the cart. If no `ProductSet` is present, the rule will match all products. [DataMember(Name="match_products_id", EmitDefaultValue=false)] public string MatchProductsId { get; set; } /// - /// `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. This field has been deprecated: new pricing rules should prefer the exclude_products_id field. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. + /// __Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. /// - /// `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. This field has been deprecated: new pricing rules should prefer the exclude_products_id field. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. + /// __Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. [DataMember(Name="apply_products_id", EmitDefaultValue=false)] public string ApplyProductsId { get; set; } /// - /// Identifies the `CatalogProductSet` to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. + /// `CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. /// - /// Identifies the `CatalogProductSet` to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. + /// `CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. [DataMember(Name="exclude_products_id", EmitDefaultValue=false)] public string ExcludeProductsId { get; set; } /// @@ -102,27 +102,27 @@ public partial class CatalogPricingRule : IEquatable, IVali [DataMember(Name="valid_from_date", EmitDefaultValue=false)] public string ValidFromDate { get; set; } /// - /// Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. + /// Represents the local time the pricing rule should be valid from. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. /// - /// Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. + /// Represents the local time the pricing rule should be valid from. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. [DataMember(Name="valid_from_local_time", EmitDefaultValue=false)] public string ValidFromLocalTime { get; set; } /// - /// Represents the date the pricing rule will become inactive. Represented in RFC3339 full-date format (YYYY-MM-DD). + /// Represents the date the Pricing Rule is valid until. Represented in RFC3339 full-date format (YYYY-MM-DD). /// - /// Represents the date the pricing rule will become inactive. Represented in RFC3339 full-date format (YYYY-MM-DD). + /// Represents the date the Pricing Rule is valid until. Represented in RFC3339 full-date format (YYYY-MM-DD). [DataMember(Name="valid_until_date", EmitDefaultValue=false)] public string ValidUntilDate { get; set; } /// - /// Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. + /// Represents the local time the pricing rule should be valid until. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. /// - /// Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. + /// Represents the local time the pricing rule should be valid until. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. [DataMember(Name="valid_until_local_time", EmitDefaultValue=false)] public string ValidUntilLocalTime { get; set; } /// - /// If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. See `ExcludeStrategy` for all possible values. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values + /// If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values /// - /// If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. See `ExcludeStrategy` for all possible values. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values + /// If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts. Default value: `LEAST_EXPENSIVE` See [ExcludeStrategy](#type-excludestrategy) for possible values [DataMember(Name="exclude_strategy", EmitDefaultValue=false)] public string ExcludeStrategy { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogProductSet.cs b/src/Square.Connect/Model/CatalogProductSet.cs index 09bba32..fe64de9 100644 --- a/src/Square.Connect/Model/CatalogProductSet.cs +++ b/src/Square.Connect/Model/CatalogProductSet.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents a collection of catalog objects for the purpose of applying a [PricingRule](#type-pricingrule). Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations. + /// Represents a collection of catalog objects for the purpose of applying a `PricingRule`. Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations. /// Note: This endpoint is in beta. /// [DataContract] @@ -33,9 +33,9 @@ public partial class CatalogProductSet : IEquatable, IValida /// /// Initializes a new instance of the class. /// - /// User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\".. - /// Unique IDs for any `CatalogObjects`s to include in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.. - /// Unique IDs for `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.. + /// User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\".. + /// Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.. + /// Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.. /// 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`.. /// 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.. /// If set, the pricing rule will apply to a maximum of this many items from `products_any` or `products_all`.. @@ -52,21 +52,21 @@ public partial class CatalogProductSet : IEquatable, IValida } /// - /// User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". + /// User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". /// - /// User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". + /// User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\". [DataMember(Name="name", EmitDefaultValue=false)] public string Name { get; set; } /// - /// Unique IDs for any `CatalogObjects`s to include in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. + /// Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. /// - /// Unique IDs for any `CatalogObjects`s to include in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. + /// Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. [DataMember(Name="product_ids_any", EmitDefaultValue=false)] public List ProductIdsAny { get; set; } /// - /// Unique IDs for `CatalogObjects` to include in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. + /// Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. /// - /// Unique IDs for `CatalogObjects` to include in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. + /// Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. [DataMember(Name="product_ids_all", EmitDefaultValue=false)] public List ProductIdsAll { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogQuery.cs b/src/Square.Connect/Model/CatalogQuery.cs index 735c718..15b7a5c 100644 --- a/src/Square.Connect/Model/CatalogQuery.cs +++ b/src/Square.Connect/Model/CatalogQuery.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest). Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. + /// A query to be applied to a `SearchCatalogObjectsRequest`. Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) (`CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifierList`, `CatalogModifier`). For example, a query that should return Items may specify attribute names from any of the searchable fields of the `CatalogItem` data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. /// [DataContract] public partial class CatalogQuery : IEquatable, IValidatableObject @@ -37,10 +37,10 @@ public partial class CatalogQuery : IEquatable, IValidatableObjec /// A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix.. /// A query that returns only objects for which the given (integer-valued) attribute lies in the given range.. /// 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\"]}`.. - /// A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax`es enabled.. - /// A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList`s enabled.. - /// A query that returns all `CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption`s.. - /// A query that returns all `CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption` values.. + /// A query that returns all `CatalogItem`s that have any of the given `CatalogTax`es enabled.. + /// A query that returns all `CatalogItem`s that have any of the given `CatalogModifierList`s enabled.. + /// A query that returns all `CatalogItem`s that have all of the given `CatalogItemOption`s.. + /// A query that returns all `CatalogItemVariation`s that have all of the given `CatalogItemOption` values.. public CatalogQuery(CatalogQuerySortedAttribute SortedAttributeQuery = default(CatalogQuerySortedAttribute), CatalogQueryExact ExactQuery = default(CatalogQueryExact), CatalogQueryPrefix PrefixQuery = default(CatalogQueryPrefix), CatalogQueryRange RangeQuery = default(CatalogQueryRange), CatalogQueryText TextQuery = default(CatalogQueryText), CatalogQueryItemsForTax ItemsForTaxQuery = default(CatalogQueryItemsForTax), CatalogQueryItemsForModifierList ItemsForModifierListQuery = default(CatalogQueryItemsForModifierList), CatalogQueryItemsForItemOptions ItemsForItemOptionsQuery = default(CatalogQueryItemsForItemOptions), CatalogQueryItemVariationsForItemOptionValues ItemVariationsForItemOptionValuesQuery = default(CatalogQueryItemVariationsForItemOptionValues)) { this.SortedAttributeQuery = SortedAttributeQuery; @@ -85,27 +85,27 @@ public partial class CatalogQuery : IEquatable, IValidatableObjec [DataMember(Name="text_query", EmitDefaultValue=false)] public CatalogQueryText TextQuery { get; set; } /// - /// A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax`es enabled. + /// A query that returns all `CatalogItem`s that have any of the given `CatalogTax`es enabled. /// - /// A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax`es enabled. + /// A query that returns all `CatalogItem`s that have any of the given `CatalogTax`es enabled. [DataMember(Name="items_for_tax_query", EmitDefaultValue=false)] public CatalogQueryItemsForTax ItemsForTaxQuery { get; set; } /// - /// A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList`s enabled. + /// A query that returns all `CatalogItem`s that have any of the given `CatalogModifierList`s enabled. /// - /// A query that returns all `CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList`s enabled. + /// A query that returns all `CatalogItem`s that have any of the given `CatalogModifierList`s enabled. [DataMember(Name="items_for_modifier_list_query", EmitDefaultValue=false)] public CatalogQueryItemsForModifierList ItemsForModifierListQuery { get; set; } /// - /// A query that returns all `CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption`s. + /// A query that returns all `CatalogItem`s that have all of the given `CatalogItemOption`s. /// - /// A query that returns all `CatalogItem](#type-catalogitem)s that have all of the given [CatalogItemOption`s. + /// A query that returns all `CatalogItem`s that have all of the given `CatalogItemOption`s. [DataMember(Name="items_for_item_options_query", EmitDefaultValue=false)] public CatalogQueryItemsForItemOptions ItemsForItemOptionsQuery { get; set; } /// - /// A query that returns all `CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption` values. + /// A query that returns all `CatalogItemVariation`s that have all of the given `CatalogItemOption` values. /// - /// A query that returns all `CatalogItemVariation](#type-catalogitemvariations)s that have all of the given [CatalogItemOption` values. + /// A query that returns all `CatalogItemVariation`s that have all of the given `CatalogItemOption` values. [DataMember(Name="item_variations_for_item_option_values_query", EmitDefaultValue=false)] public CatalogQueryItemVariationsForItemOptionValues ItemVariationsForItemOptionValuesQuery { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogQueryCustomAttributeUsage.cs b/src/Square.Connect/Model/CatalogQueryCustomAttributeUsage.cs new file mode 100644 index 0000000..0f123bf --- /dev/null +++ b/src/Square.Connect/Model/CatalogQueryCustomAttributeUsage.cs @@ -0,0 +1,138 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Text.RegularExpressions; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using System.ComponentModel.DataAnnotations; + +namespace Square.Connect.Model +{ + /// + /// + /// + [DataContract] + public partial class CatalogQueryCustomAttributeUsage : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// . + /// . + public CatalogQueryCustomAttributeUsage(List CustomAttributeDefinitionIds = default(List), bool? HasValue = default(bool?)) + { + this.CustomAttributeDefinitionIds = CustomAttributeDefinitionIds; + this.HasValue = HasValue; + } + + /// + /// + /// + /// + [DataMember(Name="custom_attribute_definition_ids", EmitDefaultValue=false)] + public List CustomAttributeDefinitionIds { get; set; } + /// + /// + /// + /// + [DataMember(Name="has_value", EmitDefaultValue=false)] + public bool? HasValue { get; set; } + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CatalogQueryCustomAttributeUsage {\n"); + sb.Append(" CustomAttributeDefinitionIds: ").Append(CustomAttributeDefinitionIds).Append("\n"); + sb.Append(" HasValue: ").Append(HasValue).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object obj) + { + // credit: http://stackoverflow.com/a/10454552/677735 + return this.Equals(obj as CatalogQueryCustomAttributeUsage); + } + + /// + /// Returns true if CatalogQueryCustomAttributeUsage instances are equal + /// + /// Instance of CatalogQueryCustomAttributeUsage to be compared + /// Boolean + public bool Equals(CatalogQueryCustomAttributeUsage other) + { + // credit: http://stackoverflow.com/a/10454552/677735 + if (other == null) + return false; + + return + ( + this.CustomAttributeDefinitionIds == other.CustomAttributeDefinitionIds || + this.CustomAttributeDefinitionIds != null && + this.CustomAttributeDefinitionIds.SequenceEqual(other.CustomAttributeDefinitionIds) + ) && + ( + this.HasValue == other.HasValue || + this.HasValue != null && + this.HasValue.Equals(other.HasValue) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + // credit: http://stackoverflow.com/a/263416/677735 + unchecked // Overflow is fine, just wrap + { + int hash = 41; + // Suitable nullity checks etc, of course :) + if (this.CustomAttributeDefinitionIds != null) + hash = hash * 59 + this.CustomAttributeDefinitionIds.GetHashCode(); + if (this.HasValue != null) + hash = hash * 59 + this.HasValue.GetHashCode(); + return hash; + } + } + + public IEnumerable Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Square.Connect/Model/CatalogQueryFilteredItems.cs b/src/Square.Connect/Model/CatalogQueryFilteredItems.cs new file mode 100644 index 0000000..00474d8 --- /dev/null +++ b/src/Square.Connect/Model/CatalogQueryFilteredItems.cs @@ -0,0 +1,266 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Text.RegularExpressions; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using System.ComponentModel.DataAnnotations; + +namespace Square.Connect.Model +{ + /// + /// + /// + [DataContract] + public partial class CatalogQueryFilteredItems : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// . + /// . + /// . + /// See [CatalogQueryFilteredItemsStockLevel](#type-catalogqueryfiltereditemsstocklevel) for possible values. + /// . + /// . + /// See [CatalogItemProductType](#type-catalogitemproducttype) for possible values. + /// . + /// See [CatalogQueryFilteredItemsNullableAttribute](#type-catalogqueryfiltereditemsnullableattribute) for possible values. + /// See [SortOrder](#type-sortorder) for possible values. + public CatalogQueryFilteredItems(string TextFilter = default(string), bool? SearchVendorCode = default(bool?), List CategoryIds = default(List), List StockLevels = default(List), List EnabledLocationIds = default(List), List VendorIds = default(List), List ProductTypes = default(List), List CustomAttributeFilters = default(List), List DoesNotExist = default(List), string SortOrder = default(string)) + { + this.TextFilter = TextFilter; + this.SearchVendorCode = SearchVendorCode; + this.CategoryIds = CategoryIds; + this.StockLevels = StockLevels; + this.EnabledLocationIds = EnabledLocationIds; + this.VendorIds = VendorIds; + this.ProductTypes = ProductTypes; + this.CustomAttributeFilters = CustomAttributeFilters; + this.DoesNotExist = DoesNotExist; + this.SortOrder = SortOrder; + } + + /// + /// + /// + /// + [DataMember(Name="text_filter", EmitDefaultValue=false)] + public string TextFilter { get; set; } + /// + /// + /// + /// + [DataMember(Name="search_vendor_code", EmitDefaultValue=false)] + public bool? SearchVendorCode { get; set; } + /// + /// + /// + /// + [DataMember(Name="category_ids", EmitDefaultValue=false)] + public List CategoryIds { get; set; } + /// + /// See [CatalogQueryFilteredItemsStockLevel](#type-catalogqueryfiltereditemsstocklevel) for possible values + /// + /// See [CatalogQueryFilteredItemsStockLevel](#type-catalogqueryfiltereditemsstocklevel) for possible values + [DataMember(Name="stock_levels", EmitDefaultValue=false)] + public List StockLevels { get; set; } + /// + /// + /// + /// + [DataMember(Name="enabled_location_ids", EmitDefaultValue=false)] + public List EnabledLocationIds { get; set; } + /// + /// + /// + /// + [DataMember(Name="vendor_ids", EmitDefaultValue=false)] + public List VendorIds { get; set; } + /// + /// See [CatalogItemProductType](#type-catalogitemproducttype) for possible values + /// + /// See [CatalogItemProductType](#type-catalogitemproducttype) for possible values + [DataMember(Name="product_types", EmitDefaultValue=false)] + public List ProductTypes { get; set; } + /// + /// + /// + /// + [DataMember(Name="custom_attribute_filters", EmitDefaultValue=false)] + public List CustomAttributeFilters { get; set; } + /// + /// See [CatalogQueryFilteredItemsNullableAttribute](#type-catalogqueryfiltereditemsnullableattribute) for possible values + /// + /// See [CatalogQueryFilteredItemsNullableAttribute](#type-catalogqueryfiltereditemsnullableattribute) for possible values + [DataMember(Name="does_not_exist", EmitDefaultValue=false)] + public List DoesNotExist { get; set; } + /// + /// See [SortOrder](#type-sortorder) for possible values + /// + /// See [SortOrder](#type-sortorder) for possible values + [DataMember(Name="sort_order", EmitDefaultValue=false)] + public string SortOrder { get; set; } + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CatalogQueryFilteredItems {\n"); + sb.Append(" TextFilter: ").Append(TextFilter).Append("\n"); + sb.Append(" SearchVendorCode: ").Append(SearchVendorCode).Append("\n"); + sb.Append(" CategoryIds: ").Append(CategoryIds).Append("\n"); + sb.Append(" StockLevels: ").Append(StockLevels).Append("\n"); + sb.Append(" EnabledLocationIds: ").Append(EnabledLocationIds).Append("\n"); + sb.Append(" VendorIds: ").Append(VendorIds).Append("\n"); + sb.Append(" ProductTypes: ").Append(ProductTypes).Append("\n"); + sb.Append(" CustomAttributeFilters: ").Append(CustomAttributeFilters).Append("\n"); + sb.Append(" DoesNotExist: ").Append(DoesNotExist).Append("\n"); + sb.Append(" SortOrder: ").Append(SortOrder).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object obj) + { + // credit: http://stackoverflow.com/a/10454552/677735 + return this.Equals(obj as CatalogQueryFilteredItems); + } + + /// + /// Returns true if CatalogQueryFilteredItems instances are equal + /// + /// Instance of CatalogQueryFilteredItems to be compared + /// Boolean + public bool Equals(CatalogQueryFilteredItems other) + { + // credit: http://stackoverflow.com/a/10454552/677735 + if (other == null) + return false; + + return + ( + this.TextFilter == other.TextFilter || + this.TextFilter != null && + this.TextFilter.Equals(other.TextFilter) + ) && + ( + this.SearchVendorCode == other.SearchVendorCode || + this.SearchVendorCode != null && + this.SearchVendorCode.Equals(other.SearchVendorCode) + ) && + ( + this.CategoryIds == other.CategoryIds || + this.CategoryIds != null && + this.CategoryIds.SequenceEqual(other.CategoryIds) + ) && + ( + this.StockLevels == other.StockLevels || + this.StockLevels != null && + this.StockLevels.SequenceEqual(other.StockLevels) + ) && + ( + this.EnabledLocationIds == other.EnabledLocationIds || + this.EnabledLocationIds != null && + this.EnabledLocationIds.SequenceEqual(other.EnabledLocationIds) + ) && + ( + this.VendorIds == other.VendorIds || + this.VendorIds != null && + this.VendorIds.SequenceEqual(other.VendorIds) + ) && + ( + this.ProductTypes == other.ProductTypes || + this.ProductTypes != null && + this.ProductTypes.SequenceEqual(other.ProductTypes) + ) && + ( + this.CustomAttributeFilters == other.CustomAttributeFilters || + this.CustomAttributeFilters != null && + this.CustomAttributeFilters.SequenceEqual(other.CustomAttributeFilters) + ) && + ( + this.DoesNotExist == other.DoesNotExist || + this.DoesNotExist != null && + this.DoesNotExist.SequenceEqual(other.DoesNotExist) + ) && + ( + this.SortOrder == other.SortOrder || + this.SortOrder != null && + this.SortOrder.Equals(other.SortOrder) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + // credit: http://stackoverflow.com/a/263416/677735 + unchecked // Overflow is fine, just wrap + { + int hash = 41; + // Suitable nullity checks etc, of course :) + if (this.TextFilter != null) + hash = hash * 59 + this.TextFilter.GetHashCode(); + if (this.SearchVendorCode != null) + hash = hash * 59 + this.SearchVendorCode.GetHashCode(); + if (this.CategoryIds != null) + hash = hash * 59 + this.CategoryIds.GetHashCode(); + if (this.StockLevels != null) + hash = hash * 59 + this.StockLevels.GetHashCode(); + if (this.EnabledLocationIds != null) + hash = hash * 59 + this.EnabledLocationIds.GetHashCode(); + if (this.VendorIds != null) + hash = hash * 59 + this.VendorIds.GetHashCode(); + if (this.ProductTypes != null) + hash = hash * 59 + this.ProductTypes.GetHashCode(); + if (this.CustomAttributeFilters != null) + hash = hash * 59 + this.CustomAttributeFilters.GetHashCode(); + if (this.DoesNotExist != null) + hash = hash * 59 + this.DoesNotExist.GetHashCode(); + if (this.SortOrder != null) + hash = hash * 59 + this.SortOrder.GetHashCode(); + return hash; + } + } + + public IEnumerable Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Square.Connect/Model/CatalogQueryFilteredItemsCustomAttributeFilter.cs b/src/Square.Connect/Model/CatalogQueryFilteredItemsCustomAttributeFilter.cs new file mode 100644 index 0000000..e95875a --- /dev/null +++ b/src/Square.Connect/Model/CatalogQueryFilteredItemsCustomAttributeFilter.cs @@ -0,0 +1,202 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Text.RegularExpressions; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using System.ComponentModel.DataAnnotations; + +namespace Square.Connect.Model +{ + /// + /// + /// + [DataContract] + public partial class CatalogQueryFilteredItemsCustomAttributeFilter : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values. + /// . + /// . + /// . + /// . + /// . + public CatalogQueryFilteredItemsCustomAttributeFilter(string FilterType = default(string), List CustomAttributeDefinitionIds = default(List), string CustomAttributeValueExact = default(string), string CustomAttributeValuePrefix = default(string), string CustomAttributeMinValue = default(string), string CustomAttributeMaxValue = default(string)) + { + this.FilterType = FilterType; + this.CustomAttributeDefinitionIds = CustomAttributeDefinitionIds; + this.CustomAttributeValueExact = CustomAttributeValueExact; + this.CustomAttributeValuePrefix = CustomAttributeValuePrefix; + this.CustomAttributeMinValue = CustomAttributeMinValue; + this.CustomAttributeMaxValue = CustomAttributeMaxValue; + } + + /// + /// See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values + /// + /// See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values + [DataMember(Name="filter_type", EmitDefaultValue=false)] + public string FilterType { get; set; } + /// + /// + /// + /// + [DataMember(Name="custom_attribute_definition_ids", EmitDefaultValue=false)] + public List CustomAttributeDefinitionIds { get; set; } + /// + /// + /// + /// + [DataMember(Name="custom_attribute_value_exact", EmitDefaultValue=false)] + public string CustomAttributeValueExact { get; set; } + /// + /// + /// + /// + [DataMember(Name="custom_attribute_value_prefix", EmitDefaultValue=false)] + public string CustomAttributeValuePrefix { get; set; } + /// + /// + /// + /// + [DataMember(Name="custom_attribute_min_value", EmitDefaultValue=false)] + public string CustomAttributeMinValue { get; set; } + /// + /// + /// + /// + [DataMember(Name="custom_attribute_max_value", EmitDefaultValue=false)] + public string CustomAttributeMaxValue { get; set; } + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CatalogQueryFilteredItemsCustomAttributeFilter {\n"); + sb.Append(" FilterType: ").Append(FilterType).Append("\n"); + sb.Append(" CustomAttributeDefinitionIds: ").Append(CustomAttributeDefinitionIds).Append("\n"); + sb.Append(" CustomAttributeValueExact: ").Append(CustomAttributeValueExact).Append("\n"); + sb.Append(" CustomAttributeValuePrefix: ").Append(CustomAttributeValuePrefix).Append("\n"); + sb.Append(" CustomAttributeMinValue: ").Append(CustomAttributeMinValue).Append("\n"); + sb.Append(" CustomAttributeMaxValue: ").Append(CustomAttributeMaxValue).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object obj) + { + // credit: http://stackoverflow.com/a/10454552/677735 + return this.Equals(obj as CatalogQueryFilteredItemsCustomAttributeFilter); + } + + /// + /// Returns true if CatalogQueryFilteredItemsCustomAttributeFilter instances are equal + /// + /// Instance of CatalogQueryFilteredItemsCustomAttributeFilter to be compared + /// Boolean + public bool Equals(CatalogQueryFilteredItemsCustomAttributeFilter other) + { + // credit: http://stackoverflow.com/a/10454552/677735 + if (other == null) + return false; + + return + ( + this.FilterType == other.FilterType || + this.FilterType != null && + this.FilterType.Equals(other.FilterType) + ) && + ( + this.CustomAttributeDefinitionIds == other.CustomAttributeDefinitionIds || + this.CustomAttributeDefinitionIds != null && + this.CustomAttributeDefinitionIds.SequenceEqual(other.CustomAttributeDefinitionIds) + ) && + ( + this.CustomAttributeValueExact == other.CustomAttributeValueExact || + this.CustomAttributeValueExact != null && + this.CustomAttributeValueExact.Equals(other.CustomAttributeValueExact) + ) && + ( + this.CustomAttributeValuePrefix == other.CustomAttributeValuePrefix || + this.CustomAttributeValuePrefix != null && + this.CustomAttributeValuePrefix.Equals(other.CustomAttributeValuePrefix) + ) && + ( + this.CustomAttributeMinValue == other.CustomAttributeMinValue || + this.CustomAttributeMinValue != null && + this.CustomAttributeMinValue.Equals(other.CustomAttributeMinValue) + ) && + ( + this.CustomAttributeMaxValue == other.CustomAttributeMaxValue || + this.CustomAttributeMaxValue != null && + this.CustomAttributeMaxValue.Equals(other.CustomAttributeMaxValue) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + // credit: http://stackoverflow.com/a/263416/677735 + unchecked // Overflow is fine, just wrap + { + int hash = 41; + // Suitable nullity checks etc, of course :) + if (this.FilterType != null) + hash = hash * 59 + this.FilterType.GetHashCode(); + if (this.CustomAttributeDefinitionIds != null) + hash = hash * 59 + this.CustomAttributeDefinitionIds.GetHashCode(); + if (this.CustomAttributeValueExact != null) + hash = hash * 59 + this.CustomAttributeValueExact.GetHashCode(); + if (this.CustomAttributeValuePrefix != null) + hash = hash * 59 + this.CustomAttributeValuePrefix.GetHashCode(); + if (this.CustomAttributeMinValue != null) + hash = hash * 59 + this.CustomAttributeMinValue.GetHashCode(); + if (this.CustomAttributeMaxValue != null) + hash = hash * 59 + this.CustomAttributeMaxValue.GetHashCode(); + return hash; + } + } + + public IEnumerable Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Square.Connect/Model/CatalogQueryItemsForItemOptions.cs b/src/Square.Connect/Model/CatalogQueryItemsForItemOptions.cs index 66869e4..0a2521a 100644 --- a/src/Square.Connect/Model/CatalogQueryItemsForItemOptions.cs +++ b/src/Square.Connect/Model/CatalogQueryItemsForItemOptions.cs @@ -33,16 +33,16 @@ public partial class CatalogQueryItemsForItemOptions : IEquatable /// Initializes a new instance of the class. /// - /// A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` will be returned.. + /// A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem`s. All Items that contain all of the given Item Options (in any order) will be returned.. public CatalogQueryItemsForItemOptions(List ItemOptionIds = default(List)) { this.ItemOptionIds = ItemOptionIds; } /// - /// A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` will be returned. + /// A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem`s. All Items that contain all of the given Item Options (in any order) will be returned. /// - /// A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem` will be returned. + /// A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem`s. All Items that contain all of the given Item Options (in any order) will be returned. [DataMember(Name="item_option_ids", EmitDefaultValue=false)] public List ItemOptionIds { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogQueryItemsForModifierList.cs b/src/Square.Connect/Model/CatalogQueryItemsForModifierList.cs index 55c2b57..4db5a29 100644 --- a/src/Square.Connect/Model/CatalogQueryItemsForModifierList.cs +++ b/src/Square.Connect/Model/CatalogQueryItemsForModifierList.cs @@ -37,7 +37,7 @@ protected CatalogQueryItemsForModifierList() { } /// /// Initializes a new instance of the class. /// - /// A set of `CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem`s. (required). + /// A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. (required). public CatalogQueryItemsForModifierList(List ModifierListIds = default(List)) { // to ensure "ModifierListIds" is required (not null) @@ -52,9 +52,9 @@ protected CatalogQueryItemsForModifierList() { } } /// - /// A set of `CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem`s. + /// A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. /// - /// A set of `CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem`s. + /// A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. [DataMember(Name="modifier_list_ids", EmitDefaultValue=false)] public List ModifierListIds { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogQueryItemsForTax.cs b/src/Square.Connect/Model/CatalogQueryItemsForTax.cs index 697ec7e..70da2ba 100644 --- a/src/Square.Connect/Model/CatalogQueryItemsForTax.cs +++ b/src/Square.Connect/Model/CatalogQueryItemsForTax.cs @@ -37,7 +37,7 @@ protected CatalogQueryItemsForTax() { } /// /// Initializes a new instance of the class. /// - /// A set of `CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem`s. (required). + /// A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. (required). public CatalogQueryItemsForTax(List TaxIds = default(List)) { // to ensure "TaxIds" is required (not null) @@ -52,9 +52,9 @@ protected CatalogQueryItemsForTax() { } } /// - /// A set of `CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem`s. + /// A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. /// - /// A set of `CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem`s. + /// A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. [DataMember(Name="tax_ids", EmitDefaultValue=false)] public List TaxIds { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogQuerySortedAttribute.cs b/src/Square.Connect/Model/CatalogQuerySortedAttribute.cs index 0fa1c08..8c2d02f 100644 --- a/src/Square.Connect/Model/CatalogQuerySortedAttribute.cs +++ b/src/Square.Connect/Model/CatalogQuerySortedAttribute.cs @@ -39,7 +39,7 @@ protected CatalogQuerySortedAttribute() { } /// /// The attribute whose value should be used as the sort key. (required). /// 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).. - /// The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values. + /// The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values. public CatalogQuerySortedAttribute(string AttributeName = default(string), string InitialAttributeValue = default(string), string SortOrder = default(string)) { // to ensure "AttributeName" is required (not null) @@ -68,9 +68,9 @@ protected CatalogQuerySortedAttribute() { } [DataMember(Name="initial_attribute_value", EmitDefaultValue=false)] public string InitialAttributeValue { get; set; } /// - /// The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values + /// The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values /// - /// The desired `SortOrder`. See [SortOrder](#type-sortorder) for possible values + /// The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values [DataMember(Name="sort_order", EmitDefaultValue=false)] public string SortOrder { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogQueryText.cs b/src/Square.Connect/Model/CatalogQueryText.cs index a65c429..057a109 100644 --- a/src/Square.Connect/Model/CatalogQueryText.cs +++ b/src/Square.Connect/Model/CatalogQueryText.cs @@ -37,7 +37,7 @@ protected CatalogQueryText() { } /// /// Initializes a new instance of the class. /// - /// A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored. (required). + /// A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 characters are ignored. (required). public CatalogQueryText(List Keywords = default(List)) { // to ensure "Keywords" is required (not null) @@ -52,9 +52,9 @@ protected CatalogQueryText() { } } /// - /// A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored. + /// A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 characters are ignored. /// - /// A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored. + /// A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 characters are ignored. [DataMember(Name="keywords", EmitDefaultValue=false)] public List Keywords { get; set; } /// diff --git a/src/Square.Connect/Model/CatalogV1Id.cs b/src/Square.Connect/Model/CatalogV1Id.cs index 5545b61..aba817d 100644 --- a/src/Square.Connect/Model/CatalogV1Id.cs +++ b/src/Square.Connect/Model/CatalogV1Id.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// An Items Connect V1 object ID along with its associated [location](#type-location) ID. + /// An Items Connect V1 object ID along with its associated location ID. /// [DataContract] public partial class CatalogV1Id : IEquatable, IValidatableObject @@ -33,7 +33,7 @@ public partial class CatalogV1Id : IEquatable, IValidatableObject /// Initializes a new instance of the class. /// /// The ID for an object in Connect V1, if different from its Connect V2 ID.. - /// The ID of the `location` this Connect V1 ID is associated with.. + /// The ID of the `Location` this Connect V1 ID is associated with.. public CatalogV1Id(string _CatalogV1Id = default(string), string LocationId = default(string)) { this._CatalogV1Id = _CatalogV1Id; @@ -47,9 +47,9 @@ public partial class CatalogV1Id : IEquatable, IValidatableObject [DataMember(Name="catalog_v1_id", EmitDefaultValue=false)] public string _CatalogV1Id { get; set; } /// - /// The ID of the `location` this Connect V1 ID is associated with. + /// The ID of the `Location` this Connect V1 ID is associated with. /// - /// The ID of the `location` this Connect V1 ID is associated with. + /// The ID of the `Location` this Connect V1 ID is associated with. [DataMember(Name="location_id", EmitDefaultValue=false)] public string LocationId { get; set; } /// diff --git a/src/Square.Connect/Model/ChargeRequest.cs b/src/Square.Connect/Model/ChargeRequest.cs index 2f6456c..34bfc20 100644 --- a/src/Square.Connect/Model/ChargeRequest.cs +++ b/src/Square.Connect/Model/ChargeRequest.cs @@ -38,7 +38,7 @@ protected ChargeRequest() { } /// /// Initializes a new instance of the class. /// - /// 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. (required). + /// A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. (required). /// The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The value of `currency` must match the currency associated with the business that is charging the card. (required). /// 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`.. /// 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`.. @@ -46,12 +46,12 @@ protected ChargeRequest() { } /// 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.. /// An optional note to associate with the transaction. This value cannot exceed 60 characters.. /// 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.. - /// The buyer's billing address.. - /// The buyer's shipping address, if available.. - /// The buyer's email address, if available.. + /// The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided.. + /// The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided.. + /// The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided.. /// The ID of the order to associate with this transaction. If you provide this value, the `amount_money` value of your request must __exactly match__ the value of the order's `total_money` field.. /// The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in the charge request. The `location_id` must be the valid location of the app owner merchant. This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox.. - /// An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity.. + /// A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result.. public ChargeRequest(string IdempotencyKey = default(string), Money AmountMoney = default(Money), string CardNonce = default(string), string CustomerCardId = default(string), bool? DelayCapture = default(bool?), string ReferenceId = default(string), string Note = default(string), string CustomerId = default(string), Address BillingAddress = default(Address), Address ShippingAddress = default(Address), string BuyerEmailAddress = default(string), string OrderId = default(string), List AdditionalRecipients = default(List), string VerificationToken = default(string)) { // to ensure "IdempotencyKey" is required (not null) @@ -87,9 +87,9 @@ protected ChargeRequest() { } } /// - /// A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + /// A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. /// - /// A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + /// A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. [DataMember(Name="idempotency_key", EmitDefaultValue=false)] public string IdempotencyKey { get; set; } /// @@ -135,21 +135,21 @@ protected ChargeRequest() { } [DataMember(Name="customer_id", EmitDefaultValue=false)] public string CustomerId { get; set; } /// - /// The buyer's billing address. + /// The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided. /// - /// The buyer's billing address. + /// The buyer's billing address. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `shipping_address` is provided. [DataMember(Name="billing_address", EmitDefaultValue=false)] public Address BillingAddress { get; set; } /// - /// The buyer's shipping address, if available. + /// The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. /// - /// The buyer's shipping address, if available. + /// The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. [DataMember(Name="shipping_address", EmitDefaultValue=false)] public Address ShippingAddress { get; set; } /// - /// The buyer's email address, if available. + /// The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. /// - /// The buyer's email address, if available. + /// The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. [DataMember(Name="buyer_email_address", EmitDefaultValue=false)] public string BuyerEmailAddress { get; set; } /// @@ -165,9 +165,9 @@ protected ChargeRequest() { } [DataMember(Name="additional_recipients", EmitDefaultValue=false)] public List AdditionalRecipients { get; set; } /// - /// An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. + /// A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result. /// - /// An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. + /// A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result. [DataMember(Name="verification_token", EmitDefaultValue=false)] public string VerificationToken { get; set; } /// diff --git a/src/Square.Connect/Model/Coordinates.cs b/src/Square.Connect/Model/Coordinates.cs index 4af8775..24acc89 100644 --- a/src/Square.Connect/Model/Coordinates.cs +++ b/src/Square.Connect/Model/Coordinates.cs @@ -32,8 +32,8 @@ public partial class Coordinates : IEquatable, IValidatableObject /// /// Initializes a new instance of the class. /// - /// The coordinate's latitude expressed in degrees.. - /// The coordinate's longitude expressed in degrees.. + /// The latitude of the coordinate expressed in degrees.. + /// The longitude of the coordinate expressed in degrees.. public Coordinates(decimal? Latitude = default(decimal?), decimal? Longitude = default(decimal?)) { this.Latitude = Latitude; @@ -41,15 +41,15 @@ public partial class Coordinates : IEquatable, IValidatableObject } /// - /// The coordinate's latitude expressed in degrees. + /// The latitude of the coordinate expressed in degrees. /// - /// The coordinate's latitude expressed in degrees. + /// The latitude of the coordinate expressed in degrees. [DataMember(Name="latitude", EmitDefaultValue=false)] public decimal? Latitude { get; set; } /// - /// The coordinate's longitude expressed in degrees. + /// The longitude of the coordinate expressed in degrees. /// - /// The coordinate's longitude expressed in degrees. + /// The longitude of the coordinate expressed in degrees. [DataMember(Name="longitude", EmitDefaultValue=false)] public decimal? Longitude { get; set; } /// diff --git a/src/Square.Connect/Model/CreateCatalogImageRequest.cs b/src/Square.Connect/Model/CreateCatalogImageRequest.cs new file mode 100644 index 0000000..df46ded --- /dev/null +++ b/src/Square.Connect/Model/CreateCatalogImageRequest.cs @@ -0,0 +1,173 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Text.RegularExpressions; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using System.ComponentModel.DataAnnotations; + +namespace Square.Connect.Model +{ + /// + /// + /// + [DataContract] + public partial class CreateCatalogImageRequest : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected CreateCatalogImageRequest() { } + /// + /// Initializes a new instance of the class. + /// + /// A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. (required). + /// Unique ID of the `CatalogObject` to attach to this `CatalogImage`. Leave this field empty to create unattached images, for example if you are building an integration where these images can be attached to catalog items at a later time.. + /// The new `IMAGE`-type `CatalogObject` to be attached to this `CatalogImage`. If the `CatalogObject` already has a `CatalogImage`, this call will overwrite it.. + public CreateCatalogImageRequest(string IdempotencyKey = default(string), string ObjectId = default(string), CatalogObject Image = default(CatalogObject)) + { + // to ensure "IdempotencyKey" is required (not null) + if (IdempotencyKey == null) + { + throw new InvalidDataException("IdempotencyKey is a required property for CreateCatalogImageRequest and cannot be null"); + } + else + { + this.IdempotencyKey = IdempotencyKey; + } + this.ObjectId = ObjectId; + this.Image = Image; + } + + /// + /// A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + /// + /// A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + [DataMember(Name="idempotency_key", EmitDefaultValue=false)] + public string IdempotencyKey { get; set; } + /// + /// Unique ID of the `CatalogObject` to attach to this `CatalogImage`. Leave this field empty to create unattached images, for example if you are building an integration where these images can be attached to catalog items at a later time. + /// + /// Unique ID of the `CatalogObject` to attach to this `CatalogImage`. Leave this field empty to create unattached images, for example if you are building an integration where these images can be attached to catalog items at a later time. + [DataMember(Name="object_id", EmitDefaultValue=false)] + public string ObjectId { get; set; } + /// + /// The new `IMAGE`-type `CatalogObject` to be attached to this `CatalogImage`. If the `CatalogObject` already has a `CatalogImage`, this call will overwrite it. + /// + /// The new `IMAGE`-type `CatalogObject` to be attached to this `CatalogImage`. If the `CatalogObject` already has a `CatalogImage`, this call will overwrite it. + [DataMember(Name="image", EmitDefaultValue=false)] + public CatalogObject Image { get; set; } + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateCatalogImageRequest {\n"); + sb.Append(" IdempotencyKey: ").Append(IdempotencyKey).Append("\n"); + sb.Append(" ObjectId: ").Append(ObjectId).Append("\n"); + sb.Append(" Image: ").Append(Image).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object obj) + { + // credit: http://stackoverflow.com/a/10454552/677735 + return this.Equals(obj as CreateCatalogImageRequest); + } + + /// + /// Returns true if CreateCatalogImageRequest instances are equal + /// + /// Instance of CreateCatalogImageRequest to be compared + /// Boolean + public bool Equals(CreateCatalogImageRequest other) + { + // credit: http://stackoverflow.com/a/10454552/677735 + if (other == null) + return false; + + return + ( + this.IdempotencyKey == other.IdempotencyKey || + this.IdempotencyKey != null && + this.IdempotencyKey.Equals(other.IdempotencyKey) + ) && + ( + this.ObjectId == other.ObjectId || + this.ObjectId != null && + this.ObjectId.Equals(other.ObjectId) + ) && + ( + this.Image == other.Image || + this.Image != null && + this.Image.Equals(other.Image) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + // credit: http://stackoverflow.com/a/263416/677735 + unchecked // Overflow is fine, just wrap + { + int hash = 41; + // Suitable nullity checks etc, of course :) + if (this.IdempotencyKey != null) + hash = hash * 59 + this.IdempotencyKey.GetHashCode(); + if (this.ObjectId != null) + hash = hash * 59 + this.ObjectId.GetHashCode(); + if (this.Image != null) + hash = hash * 59 + this.Image.GetHashCode(); + return hash; + } + } + + public IEnumerable Validate(ValidationContext validationContext) + { + // IdempotencyKey (string) minLength + if(this.IdempotencyKey != null && this.IdempotencyKey.Length < 1) + { + yield return new ValidationResult("Invalid value for IdempotencyKey, length must be greater than 1.", new [] { "IdempotencyKey" }); + } + + yield break; + } + } + +} diff --git a/src/Square.Connect/Model/CreateCatalogImageResponse.cs b/src/Square.Connect/Model/CreateCatalogImageResponse.cs new file mode 100644 index 0000000..f2cc074 --- /dev/null +++ b/src/Square.Connect/Model/CreateCatalogImageResponse.cs @@ -0,0 +1,138 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Text.RegularExpressions; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using System.ComponentModel.DataAnnotations; + +namespace Square.Connect.Model +{ + /// + /// + /// + [DataContract] + public partial class CreateCatalogImageResponse : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// Information on any errors encountered.. + /// The newly created `CatalogImage` including a Square-generated URL for each image.. + public CreateCatalogImageResponse(List Errors = default(List), CatalogObject Image = default(CatalogObject)) + { + this.Errors = Errors; + this.Image = Image; + } + + /// + /// Information on any errors encountered. + /// + /// Information on any errors encountered. + [DataMember(Name="errors", EmitDefaultValue=false)] + public List Errors { get; set; } + /// + /// The newly created `CatalogImage` including a Square-generated URL for each image. + /// + /// The newly created `CatalogImage` including a Square-generated URL for each image. + [DataMember(Name="image", EmitDefaultValue=false)] + public CatalogObject Image { get; set; } + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateCatalogImageResponse {\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" Image: ").Append(Image).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object obj) + { + // credit: http://stackoverflow.com/a/10454552/677735 + return this.Equals(obj as CreateCatalogImageResponse); + } + + /// + /// Returns true if CreateCatalogImageResponse instances are equal + /// + /// Instance of CreateCatalogImageResponse to be compared + /// Boolean + public bool Equals(CreateCatalogImageResponse other) + { + // credit: http://stackoverflow.com/a/10454552/677735 + if (other == null) + return false; + + return + ( + this.Errors == other.Errors || + this.Errors != null && + this.Errors.SequenceEqual(other.Errors) + ) && + ( + this.Image == other.Image || + this.Image != null && + this.Image.Equals(other.Image) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + // credit: http://stackoverflow.com/a/263416/677735 + unchecked // Overflow is fine, just wrap + { + int hash = 41; + // Suitable nullity checks etc, of course :) + if (this.Errors != null) + hash = hash * 59 + this.Errors.GetHashCode(); + if (this.Image != null) + hash = hash * 59 + this.Image.GetHashCode(); + return hash; + } + } + + public IEnumerable Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Square.Connect/Model/CreateCheckoutRequest.cs b/src/Square.Connect/Model/CreateCheckoutRequest.cs index f350ad3..f495af4 100644 --- a/src/Square.Connect/Model/CreateCheckoutRequest.cs +++ b/src/Square.Connect/Model/CreateCheckoutRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the parameters that can be included in the body of a request to the CreateCheckout endpoint. + /// Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. /// [DataContract] public partial class CreateCheckoutRequest : IEquatable, IValidatableObject @@ -37,7 +37,7 @@ protected CreateCheckoutRequest() { } /// /// Initializes a new instance of the class. /// - /// 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. (required). + /// A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency keys](#idempotencykeys) for more information. (required). /// The order including line items to be checked out. (required). /// 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`.. /// 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.. @@ -76,9 +76,9 @@ protected CreateCheckoutRequest() { } } /// - /// A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + /// A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency keys](#idempotencykeys) for more information. /// - /// A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + /// A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency keys](#idempotencykeys) for more information. [DataMember(Name="idempotency_key", EmitDefaultValue=false)] public string IdempotencyKey { get; set; } /// diff --git a/src/Square.Connect/Model/CreateCheckoutResponse.cs b/src/Square.Connect/Model/CreateCheckoutResponse.cs index e27d71f..0c0eec6 100644 --- a/src/Square.Connect/Model/CreateCheckoutResponse.cs +++ b/src/Square.Connect/Model/CreateCheckoutResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in the response body of a request to the CreateCheckout endpoint. + /// Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. /// [DataContract] public partial class CreateCheckoutResponse : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/CreateCustomerCardRequest.cs b/src/Square.Connect/Model/CreateCustomerCardRequest.cs index abdcd2a..637f5ec 100644 --- a/src/Square.Connect/Model/CreateCustomerCardRequest.cs +++ b/src/Square.Connect/Model/CreateCustomerCardRequest.cs @@ -37,7 +37,7 @@ protected CreateCustomerCardRequest() { } /// /// Initializes a new instance of the class. /// - /// 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. (required). + /// A card nonce representing the credit card to link to the customer. Card nonces are generated by the Square Payment Form when customers enter their card information. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __NOTE:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. (required). /// Address information for the card on file. Only the `postal_code` field is required for payments in the US and Canada.. /// The full name printed on the credit card.. /// 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.. @@ -58,9 +58,9 @@ protected CreateCustomerCardRequest() { } } /// - /// A card nonce representing the credit card to link to the customer. Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __Note:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. + /// A card nonce representing the credit card to link to the customer. Card nonces are generated by the Square Payment Form when customers enter their card information. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __NOTE:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. /// - /// A card nonce representing the credit card to link to the customer. Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __Note:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. + /// A card nonce representing the credit card to link to the customer. Card nonces are generated by the Square Payment Form when customers enter their card information. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information. __NOTE:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card. [DataMember(Name="card_nonce", EmitDefaultValue=false)] public string CardNonce { get; set; } /// diff --git a/src/Square.Connect/Model/CreateCustomerRequest.cs b/src/Square.Connect/Model/CreateCustomerRequest.cs index 92116a8..6379a7d 100644 --- a/src/Square.Connect/Model/CreateCustomerRequest.cs +++ b/src/Square.Connect/Model/CreateCustomerRequest.cs @@ -32,17 +32,17 @@ public partial class CreateCustomerRequest : IEquatable, /// /// Initializes a new instance of the class. /// - /// The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information.. - /// The customer's given (i.e., first) name.. - /// The customer's family (i.e., last) name.. - /// The name of the customer's company.. - /// A nickname for the customer.. - /// The customer's email address.. - /// The customer's physical address.. - /// The customer's phone number.. - /// An optional second ID you can set to associate the customer with an entity in another system.. - /// An optional note to associate with the customer.. - /// The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.. + /// The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) guide for more information.. + /// The given (i.e., first) name associated with the customer profile.. + /// The family (i.e., last) name associated with the customer profile.. + /// A business name associated with the customer profile.. + /// A nickname for the customer profile.. + /// The email address associated with the customer profile.. + /// The physical address associated with the customer profile.. + /// The 11-digit phone number associated with the customer profile.. + /// An optional, second ID used to associate the customer profile with an entity in another system.. + /// A custom note associated with the customer profile.. + /// The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__.. public CreateCustomerRequest(string IdempotencyKey = default(string), string GivenName = default(string), string FamilyName = default(string), string CompanyName = default(string), string Nickname = default(string), string EmailAddress = default(string), Address Address = default(Address), string PhoneNumber = default(string), string ReferenceId = default(string), string Note = default(string), string Birthday = default(string)) { this.IdempotencyKey = IdempotencyKey; @@ -59,69 +59,69 @@ public partial class CreateCustomerRequest : IEquatable, } /// - /// The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information. + /// The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) guide for more information. /// - /// The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information. + /// The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) guide for more information. [DataMember(Name="idempotency_key", EmitDefaultValue=false)] public string IdempotencyKey { get; set; } /// - /// The customer's given (i.e., first) name. + /// The given (i.e., first) name associated with the customer profile. /// - /// The customer's given (i.e., first) name. + /// The given (i.e., first) name associated with the customer profile. [DataMember(Name="given_name", EmitDefaultValue=false)] public string GivenName { get; set; } /// - /// The customer's family (i.e., last) name. + /// The family (i.e., last) name associated with the customer profile. /// - /// The customer's family (i.e., last) name. + /// The family (i.e., last) name associated with the customer profile. [DataMember(Name="family_name", EmitDefaultValue=false)] public string FamilyName { get; set; } /// - /// The name of the customer's company. + /// A business name associated with the customer profile. /// - /// The name of the customer's company. + /// A business name associated with the customer profile. [DataMember(Name="company_name", EmitDefaultValue=false)] public string CompanyName { get; set; } /// - /// A nickname for the customer. + /// A nickname for the customer profile. /// - /// A nickname for the customer. + /// A nickname for the customer profile. [DataMember(Name="nickname", EmitDefaultValue=false)] public string Nickname { get; set; } /// - /// The customer's email address. + /// The email address associated with the customer profile. /// - /// The customer's email address. + /// The email address associated with the customer profile. [DataMember(Name="email_address", EmitDefaultValue=false)] public string EmailAddress { get; set; } /// - /// The customer's physical address. + /// The physical address associated with the customer profile. /// - /// The customer's physical address. + /// The physical address associated with the customer profile. [DataMember(Name="address", EmitDefaultValue=false)] public Address Address { get; set; } /// - /// The customer's phone number. + /// The 11-digit phone number associated with the customer profile. /// - /// The customer's phone number. + /// The 11-digit phone number associated with the customer profile. [DataMember(Name="phone_number", EmitDefaultValue=false)] public string PhoneNumber { get; set; } /// - /// An optional second ID you can set to associate the customer with an entity in another system. + /// An optional, second ID used to associate the customer profile with an entity in another system. /// - /// An optional second ID you can set to associate the customer with an entity in another system. + /// An optional, second ID used to associate the customer profile with an entity in another system. [DataMember(Name="reference_id", EmitDefaultValue=false)] public string ReferenceId { get; set; } /// - /// An optional note to associate with the customer. + /// A custom note associated with the customer profile. /// - /// An optional note to associate with the customer. + /// A custom note associated with the customer profile. [DataMember(Name="note", EmitDefaultValue=false)] public string Note { get; set; } /// - /// The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. + /// The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. /// - /// The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. + /// The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. [DataMember(Name="birthday", EmitDefaultValue=false)] public string Birthday { get; set; } /// diff --git a/src/Square.Connect/Model/CreateLocationRequest.cs b/src/Square.Connect/Model/CreateLocationRequest.cs new file mode 100644 index 0000000..cfe9df2 --- /dev/null +++ b/src/Square.Connect/Model/CreateLocationRequest.cs @@ -0,0 +1,123 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Text.RegularExpressions; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using System.ComponentModel.DataAnnotations; + +namespace Square.Connect.Model +{ + /// + /// Request object for the [CreateLocation](#endpoint-createlocation) endpoint. + /// Note: This endpoint is in beta. + /// + [DataContract] + public partial class CreateLocationRequest : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// The initial values of the location being created. The `name` field is required. All other fields are optional. Unspecified fields will be set to default values using existing location data.. + public CreateLocationRequest(Location Location = default(Location)) + { + this.Location = Location; + } + + /// + /// The initial values of the location being created. The `name` field is required. All other fields are optional. Unspecified fields will be set to default values using existing location data. + /// + /// The initial values of the location being created. The `name` field is required. All other fields are optional. Unspecified fields will be set to default values using existing location data. + [DataMember(Name="location", EmitDefaultValue=false)] + public Location Location { get; set; } + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateLocationRequest {\n"); + sb.Append(" Location: ").Append(Location).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object obj) + { + // credit: http://stackoverflow.com/a/10454552/677735 + return this.Equals(obj as CreateLocationRequest); + } + + /// + /// Returns true if CreateLocationRequest instances are equal + /// + /// Instance of CreateLocationRequest to be compared + /// Boolean + public bool Equals(CreateLocationRequest other) + { + // credit: http://stackoverflow.com/a/10454552/677735 + if (other == null) + return false; + + return + ( + this.Location == other.Location || + this.Location != null && + this.Location.Equals(other.Location) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + // credit: http://stackoverflow.com/a/263416/677735 + unchecked // Overflow is fine, just wrap + { + int hash = 41; + // Suitable nullity checks etc, of course :) + if (this.Location != null) + hash = hash * 59 + this.Location.GetHashCode(); + return hash; + } + } + + public IEnumerable Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Square.Connect/Model/CreateLocationResponse.cs b/src/Square.Connect/Model/CreateLocationResponse.cs new file mode 100644 index 0000000..5192875 --- /dev/null +++ b/src/Square.Connect/Model/CreateLocationResponse.cs @@ -0,0 +1,139 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Text.RegularExpressions; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using System.ComponentModel.DataAnnotations; + +namespace Square.Connect.Model +{ + /// + /// Response object returned by the [CreateLocation](#endpoint-createlocation) endpoint. + /// Note: This endpoint is in beta. + /// + [DataContract] + public partial class CreateLocationResponse : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + /// Information on errors encountered during the request.. + /// The newly created `Location`.. + public CreateLocationResponse(List Errors = default(List), Location Location = default(Location)) + { + this.Errors = Errors; + this.Location = Location; + } + + /// + /// Information on errors encountered during the request. + /// + /// Information on errors encountered during the request. + [DataMember(Name="errors", EmitDefaultValue=false)] + public List Errors { get; set; } + /// + /// The newly created `Location`. + /// + /// The newly created `Location`. + [DataMember(Name="location", EmitDefaultValue=false)] + public Location Location { get; set; } + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateLocationResponse {\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" Location: ").Append(Location).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object obj) + { + // credit: http://stackoverflow.com/a/10454552/677735 + return this.Equals(obj as CreateLocationResponse); + } + + /// + /// Returns true if CreateLocationResponse instances are equal + /// + /// Instance of CreateLocationResponse to be compared + /// Boolean + public bool Equals(CreateLocationResponse other) + { + // credit: http://stackoverflow.com/a/10454552/677735 + if (other == null) + return false; + + return + ( + this.Errors == other.Errors || + this.Errors != null && + this.Errors.SequenceEqual(other.Errors) + ) && + ( + this.Location == other.Location || + this.Location != null && + this.Location.Equals(other.Location) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + // credit: http://stackoverflow.com/a/263416/677735 + unchecked // Overflow is fine, just wrap + { + int hash = 41; + // Suitable nullity checks etc, of course :) + if (this.Errors != null) + hash = hash * 59 + this.Errors.GetHashCode(); + if (this.Location != null) + hash = hash * 59 + this.Location.GetHashCode(); + return hash; + } + } + + public IEnumerable Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Square.Connect/Model/CreateMobileAuthorizationCodeRequest.cs b/src/Square.Connect/Model/CreateMobileAuthorizationCodeRequest.cs index 7903cf9..d3ae6bd 100644 --- a/src/Square.Connect/Model/CreateMobileAuthorizationCodeRequest.cs +++ b/src/Square.Connect/Model/CreateMobileAuthorizationCodeRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the body parameters that can be provided in a request to the CreateMobileAuthorizationCode endpoint. + /// Defines the body parameters that can be provided in a request to the __CreateMobileAuthorizationCode__ endpoint. /// [DataContract] public partial class CreateMobileAuthorizationCodeRequest : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/CreateMobileAuthorizationCodeResponse.cs b/src/Square.Connect/Model/CreateMobileAuthorizationCodeResponse.cs index 1421bd0..baeb0ca 100644 --- a/src/Square.Connect/Model/CreateMobileAuthorizationCodeResponse.cs +++ b/src/Square.Connect/Model/CreateMobileAuthorizationCodeResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in the response body of a request to the CreateMobileAuthorizationCode endpoint. + /// Defines the fields that are included in the response body of a request to the __CreateMobileAuthorizationCode__ endpoint. /// [DataContract] public partial class CreateMobileAuthorizationCodeResponse : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/CreatePaymentRequest.cs b/src/Square.Connect/Model/CreatePaymentRequest.cs index c1f89f1..4a3c9c4 100644 --- a/src/Square.Connect/Model/CreatePaymentRequest.cs +++ b/src/Square.Connect/Model/CreatePaymentRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees). + /// Creates a payment from the source (nonce, card on file, etc.) The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds Overview](/payments-api/overview). For information about application fees in a payment, see [Collect Fees](/payments-api/take-payments-and-collect-fees). /// [DataContract] public partial class CreatePaymentRequest : IEquatable, IValidatableObject @@ -38,22 +38,23 @@ protected CreatePaymentRequest() { } /// Initializes a new instance of the class. /// /// 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. (required). - /// 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. (required). + /// 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. (required). /// 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. (required). /// 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.. - /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).. + /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).. /// 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. /// Associate a previously created order with this payment. /// 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.. /// The location ID to associate with the payment. If not specified, the default location is used.. /// 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.. - /// 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.. - /// [beta] 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. + /// An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/sca-overview) for more.. + /// [beta] 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. /// The buyer's e-mail address. /// The buyer's billing address.. /// The buyer's shipping address.. /// An optional note to be entered by the developer when creating a payment Limit 500 characters.. - public CreatePaymentRequest(string SourceId = default(string), string IdempotencyKey = default(string), Money AmountMoney = default(Money), Money TipMoney = default(Money), Money AppFeeMoney = default(Money), bool? Autocomplete = default(bool?), string OrderId = default(string), string CustomerId = default(string), string LocationId = default(string), string ReferenceId = default(string), string VerificationToken = default(string), bool? AcceptPartialAuthorization = default(bool?), string BuyerEmailAddress = default(string), Address BillingAddress = default(Address), Address ShippingAddress = default(Address), string Note = default(string)) + /// [beta] Optional additional payment information to include on the customer's card statement as part of statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Limit 20 characters. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment.. + public CreatePaymentRequest(string SourceId = default(string), string IdempotencyKey = default(string), Money AmountMoney = default(Money), Money TipMoney = default(Money), Money AppFeeMoney = default(Money), bool? Autocomplete = default(bool?), string OrderId = default(string), string CustomerId = default(string), string LocationId = default(string), string ReferenceId = default(string), string VerificationToken = default(string), bool? AcceptPartialAuthorization = default(bool?), string BuyerEmailAddress = default(string), Address BillingAddress = default(Address), Address ShippingAddress = default(Address), string Note = default(string), string StatementDescriptionIdentifier = default(string)) { // to ensure "SourceId" is required (not null) if (SourceId == null) @@ -95,6 +96,7 @@ protected CreatePaymentRequest() { } this.BillingAddress = BillingAddress; this.ShippingAddress = ShippingAddress; this.Note = Note; + this.StatementDescriptionIdentifier = StatementDescriptionIdentifier; } /// @@ -104,9 +106,9 @@ protected CreatePaymentRequest() { } [DataMember(Name="source_id", EmitDefaultValue=false)] public string SourceId { get; set; } /// - /// A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + /// A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. /// - /// A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + /// A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. [DataMember(Name="idempotency_key", EmitDefaultValue=false)] public string IdempotencyKey { get; set; } /// @@ -122,9 +124,9 @@ protected CreatePaymentRequest() { } [DataMember(Name="tip_money", EmitDefaultValue=false)] public Money TipMoney { get; set; } /// - /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). /// - /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). [DataMember(Name="app_fee_money", EmitDefaultValue=false)] public Money AppFeeMoney { get; set; } /// @@ -158,15 +160,15 @@ protected CreatePaymentRequest() { } [DataMember(Name="reference_id", EmitDefaultValue=false)] public string ReferenceId { get; set; } /// - /// An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/docs/sca-overview) for more. + /// An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/sca-overview) for more. /// - /// An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/docs/sca-overview) for more. + /// An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](https://developer.squareup.com/sca-overview) for more. [DataMember(Name="verification_token", EmitDefaultValue=false)] public string VerificationToken { get; set; } /// - /// If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false + /// If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true`. For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false /// - /// If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false + /// If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true`. For more information, see [Partial amount with Square gift cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card). Default: false [DataMember(Name="accept_partial_authorization", EmitDefaultValue=false)] public bool? AcceptPartialAuthorization { get; set; } /// @@ -194,6 +196,12 @@ protected CreatePaymentRequest() { } [DataMember(Name="note", EmitDefaultValue=false)] public string Note { get; set; } /// + /// Optional additional payment information to include on the customer's card statement as part of statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Limit 20 characters. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. + /// + /// Optional additional payment information to include on the customer's card statement as part of statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Limit 20 characters. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. + [DataMember(Name="statement_description_identifier", EmitDefaultValue=false)] + public string StatementDescriptionIdentifier { get; set; } + /// /// Returns the string presentation of the object /// /// String presentation of the object @@ -217,6 +225,7 @@ public override string ToString() sb.Append(" BillingAddress: ").Append(BillingAddress).Append("\n"); sb.Append(" ShippingAddress: ").Append(ShippingAddress).Append("\n"); sb.Append(" Note: ").Append(Note).Append("\n"); + sb.Append(" StatementDescriptionIdentifier: ").Append(StatementDescriptionIdentifier).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -332,6 +341,11 @@ public bool Equals(CreatePaymentRequest other) this.Note == other.Note || this.Note != null && this.Note.Equals(other.Note) + ) && + ( + this.StatementDescriptionIdentifier == other.StatementDescriptionIdentifier || + this.StatementDescriptionIdentifier != null && + this.StatementDescriptionIdentifier.Equals(other.StatementDescriptionIdentifier) ); } @@ -378,6 +392,8 @@ public override int GetHashCode() hash = hash * 59 + this.ShippingAddress.GetHashCode(); if (this.Note != null) hash = hash * 59 + this.Note.GetHashCode(); + if (this.StatementDescriptionIdentifier != null) + hash = hash * 59 + this.StatementDescriptionIdentifier.GetHashCode(); return hash; } } @@ -420,6 +436,12 @@ public IEnumerable Validate(ValidationContext validationContex yield return new ValidationResult("Invalid value for Note, length must be less than 500.", new [] { "Note" }); } + // StatementDescriptionIdentifier (string) maxLength + if(this.StatementDescriptionIdentifier != null && this.StatementDescriptionIdentifier.Length > 20) + { + yield return new ValidationResult("Invalid value for StatementDescriptionIdentifier, length must be less than 20.", new [] { "StatementDescriptionIdentifier" }); + } + yield break; } } diff --git a/src/Square.Connect/Model/CreateRefundRequest.cs b/src/Square.Connect/Model/CreateRefundRequest.cs index ce36c87..d1fc3c7 100644 --- a/src/Square.Connect/Model/CreateRefundRequest.cs +++ b/src/Square.Connect/Model/CreateRefundRequest.cs @@ -38,7 +38,7 @@ protected CreateRefundRequest() { } /// /// Initializes a new instance of the class. /// - /// 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. (required). + /// A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information. (required). /// 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. (required). /// A description of the reason for the refund. Default value: `Refund via API`. /// The amount of money to refund. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`. (required). @@ -75,9 +75,9 @@ protected CreateRefundRequest() { } } /// - /// A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + /// A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information. /// - /// A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. + /// A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information. [DataMember(Name="idempotency_key", EmitDefaultValue=false)] public string IdempotencyKey { get; set; } /// diff --git a/src/Square.Connect/Model/Customer.cs b/src/Square.Connect/Model/Customer.cs index 5aecb9b..606010e 100644 --- a/src/Square.Connect/Model/Customer.cs +++ b/src/Square.Connect/Model/Customer.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents one of a business's customers, which can have one or more cards on file associated with it. + /// Represents a Square customer profile, which can have one or more cards on file associated with it. /// [DataContract] public partial class Customer : IEquatable, IValidatableObject @@ -37,21 +37,21 @@ protected Customer() { } /// /// Initializes a new instance of the class. /// - /// The customer's unique ID. (required). - /// The time when the customer was created, in RFC 3339 format. (required). - /// The time when the customer was last updated, in RFC 3339 format. (required). - /// The payment details of the customer's cards on file.. - /// The customer's given (i.e., first) name.. - /// The customer's family (i.e., last) name.. - /// The customer's nickname.. - /// The name of the customer's company.. - /// The customer's email address.. - /// The customer's physical address.. - /// The customer's phone number.. - /// The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.. - /// A second ID you can set to associate the customer with an entity in another system.. - /// A note to associate with the customer.. - /// The customer's preferences.. + /// A unique, Square-assigned object ID. (required). + /// The time when the customer profile was created, in RFC 3339 format. (required). + /// The time when the customer profile was last updated, in RFC 3339 format. (required). + /// Payment details of cards stored on file for the customer profile.. + /// The given (i.e., first) name associated with the customer profile.. + /// The family (i.e., last) name associated with the customer profile.. + /// A nickname for the customer profile.. + /// A business name associated with the customer profile.. + /// The email address associated with the customer profile.. + /// The physical address associated with the customer profile.. + /// The 11-digit phone number associated with the customer profile.. + /// The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__.. + /// An optional, second ID used to associate the customer profile with an entity in another system.. + /// A custom note associated with the customer profile.. + /// Represents general customer preferences.. /// The groups the customer belongs to.. /// A creation source represents the method used to create the customer profile. See [CustomerCreationSource](#type-customercreationsource) for possible values. public Customer(string Id = default(string), string CreatedAt = default(string), string UpdatedAt = default(string), List Cards = default(List), string GivenName = default(string), string FamilyName = default(string), string Nickname = default(string), string CompanyName = default(string), string EmailAddress = default(string), Address Address = default(Address), string PhoneNumber = default(string), string Birthday = default(string), string ReferenceId = default(string), string Note = default(string), CustomerPreferences Preferences = default(CustomerPreferences), List Groups = default(List), string CreationSource = default(string)) @@ -100,93 +100,93 @@ protected Customer() { } } /// - /// The customer's unique ID. + /// A unique, Square-assigned object ID. /// - /// The customer's unique ID. + /// A unique, Square-assigned object ID. [DataMember(Name="id", EmitDefaultValue=false)] public string Id { get; set; } /// - /// The time when the customer was created, in RFC 3339 format. + /// The time when the customer profile was created, in RFC 3339 format. /// - /// The time when the customer was created, in RFC 3339 format. + /// The time when the customer profile was created, in RFC 3339 format. [DataMember(Name="created_at", EmitDefaultValue=false)] public string CreatedAt { get; set; } /// - /// The time when the customer was last updated, in RFC 3339 format. + /// The time when the customer profile was last updated, in RFC 3339 format. /// - /// The time when the customer was last updated, in RFC 3339 format. + /// The time when the customer profile was last updated, in RFC 3339 format. [DataMember(Name="updated_at", EmitDefaultValue=false)] public string UpdatedAt { get; set; } /// - /// The payment details of the customer's cards on file. + /// Payment details of cards stored on file for the customer profile. /// - /// The payment details of the customer's cards on file. + /// Payment details of cards stored on file for the customer profile. [DataMember(Name="cards", EmitDefaultValue=false)] public List Cards { get; set; } /// - /// The customer's given (i.e., first) name. + /// The given (i.e., first) name associated with the customer profile. /// - /// The customer's given (i.e., first) name. + /// The given (i.e., first) name associated with the customer profile. [DataMember(Name="given_name", EmitDefaultValue=false)] public string GivenName { get; set; } /// - /// The customer's family (i.e., last) name. + /// The family (i.e., last) name associated with the customer profile. /// - /// The customer's family (i.e., last) name. + /// The family (i.e., last) name associated with the customer profile. [DataMember(Name="family_name", EmitDefaultValue=false)] public string FamilyName { get; set; } /// - /// The customer's nickname. + /// A nickname for the customer profile. /// - /// The customer's nickname. + /// A nickname for the customer profile. [DataMember(Name="nickname", EmitDefaultValue=false)] public string Nickname { get; set; } /// - /// The name of the customer's company. + /// A business name associated with the customer profile. /// - /// The name of the customer's company. + /// A business name associated with the customer profile. [DataMember(Name="company_name", EmitDefaultValue=false)] public string CompanyName { get; set; } /// - /// The customer's email address. + /// The email address associated with the customer profile. /// - /// The customer's email address. + /// The email address associated with the customer profile. [DataMember(Name="email_address", EmitDefaultValue=false)] public string EmailAddress { get; set; } /// - /// The customer's physical address. + /// The physical address associated with the customer profile. /// - /// The customer's physical address. + /// The physical address associated with the customer profile. [DataMember(Name="address", EmitDefaultValue=false)] public Address Address { get; set; } /// - /// The customer's phone number. + /// The 11-digit phone number associated with the customer profile. /// - /// The customer's phone number. + /// The 11-digit phone number associated with the customer profile. [DataMember(Name="phone_number", EmitDefaultValue=false)] public string PhoneNumber { get; set; } /// - /// The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. + /// The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. /// - /// The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. + /// The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. [DataMember(Name="birthday", EmitDefaultValue=false)] public string Birthday { get; set; } /// - /// A second ID you can set to associate the customer with an entity in another system. + /// An optional, second ID used to associate the customer profile with an entity in another system. /// - /// A second ID you can set to associate the customer with an entity in another system. + /// An optional, second ID used to associate the customer profile with an entity in another system. [DataMember(Name="reference_id", EmitDefaultValue=false)] public string ReferenceId { get; set; } /// - /// A note to associate with the customer. + /// A custom note associated with the customer profile. /// - /// A note to associate with the customer. + /// A custom note associated with the customer profile. [DataMember(Name="note", EmitDefaultValue=false)] public string Note { get; set; } /// - /// The customer's preferences. + /// Represents general customer preferences. /// - /// The customer's preferences. + /// Represents general customer preferences. [DataMember(Name="preferences", EmitDefaultValue=false)] public CustomerPreferences Preferences { get; set; } /// diff --git a/src/Square.Connect/Model/CustomerCreationSourceFilter.cs b/src/Square.Connect/Model/CustomerCreationSourceFilter.cs index 74b075f..0ad84f3 100644 --- a/src/Square.Connect/Model/CustomerCreationSourceFilter.cs +++ b/src/Square.Connect/Model/CustomerCreationSourceFilter.cs @@ -33,7 +33,7 @@ public partial class CustomerCreationSourceFilter : IEquatable class. /// /// The list of creation sources used as filtering criteria. See [CustomerCreationSource](#type-customercreationsource) for possible values. - /// Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values. + /// Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values. public CustomerCreationSourceFilter(List Values = default(List), string Rule = default(string)) { this.Values = Values; @@ -47,9 +47,9 @@ public partial class CustomerCreationSourceFilter : IEquatable Values { get; set; } /// - /// Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values + /// Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values /// - /// Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values + /// Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values [DataMember(Name="rule", EmitDefaultValue=false)] public string Rule { get; set; } /// diff --git a/src/Square.Connect/Model/CustomerFilter.cs b/src/Square.Connect/Model/CustomerFilter.cs index ad06048..971a4b6 100644 --- a/src/Square.Connect/Model/CustomerFilter.cs +++ b/src/Square.Connect/Model/CustomerFilter.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents a set of `CustomerQuery` filters used to limit the set of Customers returned by SearchCustomers. + /// Represents a set of `CustomerQuery` filters used to limit the set of `Customers` returned by SearchCustomers. /// [DataContract] public partial class CustomerFilter : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/CustomerPreferences.cs b/src/Square.Connect/Model/CustomerPreferences.cs index c215d0f..574e196 100644 --- a/src/Square.Connect/Model/CustomerPreferences.cs +++ b/src/Square.Connect/Model/CustomerPreferences.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents a particular customer's preferences. + /// Represents communication preferences for the customer profile. /// [DataContract] public partial class CustomerPreferences : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/CustomerSort.cs b/src/Square.Connect/Model/CustomerSort.cs index f61fb19..585791c 100644 --- a/src/Square.Connect/Model/CustomerSort.cs +++ b/src/Square.Connect/Model/CustomerSort.cs @@ -32,8 +32,8 @@ public partial class CustomerSort : IEquatable, IValidatableObjec /// /// Initializes a new instance of the class. /// - /// Indicates the information used to sort the results. For example, by creation date. Default value: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. - /// Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default value: `ASC`. See [SortOrder](#type-sortorder) for possible values. + /// Indicates the information used to sort the results. For example, by creation date. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. + /// Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. public CustomerSort(string Field = default(string), string Order = default(string)) { this.Field = Field; @@ -41,15 +41,15 @@ public partial class CustomerSort : IEquatable, IValidatableObjec } /// - /// Indicates the information used to sort the results. For example, by creation date. Default value: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values + /// Indicates the information used to sort the results. For example, by creation date. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values /// - /// Indicates the information used to sort the results. For example, by creation date. Default value: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values + /// Indicates the information used to sort the results. For example, by creation date. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values [DataMember(Name="field", EmitDefaultValue=false)] public string Field { get; set; } /// - /// Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default value: `ASC`. See [SortOrder](#type-sortorder) for possible values + /// Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values /// - /// Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default value: `ASC`. See [SortOrder](#type-sortorder) for possible values + /// Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values [DataMember(Name="order", EmitDefaultValue=false)] public string Order { get; set; } /// diff --git a/src/Square.Connect/Model/DeleteCatalogObjectResponse.cs b/src/Square.Connect/Model/DeleteCatalogObjectResponse.cs index ac23fac..16af721 100644 --- a/src/Square.Connect/Model/DeleteCatalogObjectResponse.cs +++ b/src/Square.Connect/Model/DeleteCatalogObjectResponse.cs @@ -32,9 +32,9 @@ public partial class DeleteCatalogObjectResponse : IEquatable /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. - /// The IDs of all `CatalogObject`s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a `CatalogItemVariation` when its parent `CatalogItem` is deleted.. - /// The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".. + /// Information on any errors encountered.. + /// The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted.. + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`.. public DeleteCatalogObjectResponse(List Errors = default(List), List DeletedObjectIds = default(List), string DeletedAt = default(string)) { this.Errors = Errors; @@ -43,21 +43,21 @@ public partial class DeleteCatalogObjectResponse : IEquatable - /// The set of `Error`s encountered. + /// Information on any errors encountered. /// - /// The set of `Error`s encountered. + /// Information on any errors encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// - /// The IDs of all `CatalogObject`s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a `CatalogItemVariation` when its parent `CatalogItem` is deleted. + /// The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted. /// - /// The IDs of all `CatalogObject`s deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a `CatalogItemVariation` when its parent `CatalogItem` is deleted. + /// The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted. [DataMember(Name="deleted_object_ids", EmitDefaultValue=false)] public List DeletedObjectIds { get; set; } /// - /// The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. /// - /// The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. [DataMember(Name="deleted_at", EmitDefaultValue=false)] public string DeletedAt { get; set; } /// diff --git a/src/Square.Connect/Model/Device.cs b/src/Square.Connect/Model/Device.cs index d710d73..bd46295 100644 --- a/src/Square.Connect/Model/Device.cs +++ b/src/Square.Connect/Model/Device.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class Device : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/Employee.cs b/src/Square.Connect/Model/Employee.cs index 04ea04e..0c6cd9d 100644 --- a/src/Square.Connect/Model/Employee.cs +++ b/src/Square.Connect/Model/Employee.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// An employee created in the **Square Dashboard** account of a business. Used by the Labor API. + /// An employee object that is used by the external API. /// [DataContract] public partial class Employee : IEquatable, IValidatableObject @@ -32,13 +32,13 @@ public partial class Employee : IEquatable, IValidatableObject /// /// Initializes a new instance of the class. /// - /// UUID for this `Employee`.. - /// Given (first) name of the employee.. - /// Family (last) name of the employee. - /// Email of the employee. - /// Phone number of the employee in E.164 format, i.e. \"+12125554250\". - /// A list of location IDs where this employee has access.. - /// Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values. + /// UUID for this object.. + /// The employee's first name.. + /// The employee's last name.. + /// The employee's email address. + /// The employee's phone number in E.164 format, i.e. \"+12125554250\". + /// A list of location IDs where this employee has access to.. + /// Specifies the status of the employees being fetched. See [EmployeeStatus](#type-employeestatus) for possible values. /// A read-only timestamp in RFC 3339 format.. /// A read-only timestamp in RFC 3339 format.. public Employee(string Id = default(string), string FirstName = default(string), string LastName = default(string), string Email = default(string), string PhoneNumber = default(string), List LocationIds = default(List), string Status = default(string), string CreatedAt = default(string), string UpdatedAt = default(string)) @@ -55,45 +55,45 @@ public partial class Employee : IEquatable, IValidatableObject } /// - /// UUID for this `Employee`. + /// UUID for this object. /// - /// UUID for this `Employee`. + /// UUID for this object. [DataMember(Name="id", EmitDefaultValue=false)] public string Id { get; set; } /// - /// Given (first) name of the employee. + /// The employee's first name. /// - /// Given (first) name of the employee. + /// The employee's first name. [DataMember(Name="first_name", EmitDefaultValue=false)] public string FirstName { get; set; } /// - /// Family (last) name of the employee + /// The employee's last name. /// - /// Family (last) name of the employee + /// The employee's last name. [DataMember(Name="last_name", EmitDefaultValue=false)] public string LastName { get; set; } /// - /// Email of the employee + /// The employee's email address /// - /// Email of the employee + /// The employee's email address [DataMember(Name="email", EmitDefaultValue=false)] public string Email { get; set; } /// - /// Phone number of the employee in E.164 format, i.e. \"+12125554250\" + /// The employee's phone number in E.164 format, i.e. \"+12125554250\" /// - /// Phone number of the employee in E.164 format, i.e. \"+12125554250\" + /// The employee's phone number in E.164 format, i.e. \"+12125554250\" [DataMember(Name="phone_number", EmitDefaultValue=false)] public string PhoneNumber { get; set; } /// - /// A list of location IDs where this employee has access. + /// A list of location IDs where this employee has access to. /// - /// A list of location IDs where this employee has access. + /// A list of location IDs where this employee has access to. [DataMember(Name="location_ids", EmitDefaultValue=false)] public List LocationIds { get; set; } /// - /// Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values + /// Specifies the status of the employees being fetched. See [EmployeeStatus](#type-employeestatus) for possible values /// - /// Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values + /// Specifies the status of the employees being fetched. See [EmployeeStatus](#type-employeestatus) for possible values [DataMember(Name="status", EmitDefaultValue=false)] public string Status { get; set; } /// diff --git a/src/Square.Connect/Model/Error.cs b/src/Square.Connect/Model/Error.cs index cf240ee..eda2680 100644 --- a/src/Square.Connect/Model/Error.cs +++ b/src/Square.Connect/Model/Error.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents an error encountered during a request to the Connect API. + /// Represents an error encountered during a request to the Connect API. See [Handling errors](#handlingerrors) for more information. /// [DataContract] public partial class Error : IEquatable, IValidatableObject @@ -37,8 +37,8 @@ protected Error() { } /// /// Initializes a new instance of the class. /// - /// The high-level category for the error. See [ErrorCategory](#type-errorcategory) for possible values (required). - /// The specific code of the error. See [ErrorCode](#type-errorcode) for possible values (required). + /// The high-level category for the error. See `ErrorCategory` for possible values. See [ErrorCategory](#type-errorcategory) for possible values (required). + /// The specific code of the error. See `ErrorCode` for possible values See [ErrorCode](#type-errorcode) for possible values (required). /// A human-readable description of the error for debugging purposes.. /// The name of the field provided in the original request (if any) that the error pertains to.. public Error(string Category = default(string), string Code = default(string), string Detail = default(string), string Field = default(string)) @@ -66,15 +66,15 @@ protected Error() { } } /// - /// The high-level category for the error. See [ErrorCategory](#type-errorcategory) for possible values + /// The high-level category for the error. See `ErrorCategory` for possible values. See [ErrorCategory](#type-errorcategory) for possible values /// - /// The high-level category for the error. See [ErrorCategory](#type-errorcategory) for possible values + /// The high-level category for the error. See `ErrorCategory` for possible values. See [ErrorCategory](#type-errorcategory) for possible values [DataMember(Name="category", EmitDefaultValue=false)] public string Category { get; set; } /// - /// The specific code of the error. See [ErrorCode](#type-errorcode) for possible values + /// The specific code of the error. See `ErrorCode` for possible values See [ErrorCode](#type-errorcode) for possible values /// - /// The specific code of the error. See [ErrorCode](#type-errorcode) for possible values + /// The specific code of the error. See `ErrorCode` for possible values See [ErrorCode](#type-errorcode) for possible values [DataMember(Name="code", EmitDefaultValue=false)] public string Code { get; set; } /// diff --git a/src/Square.Connect/Model/ExternalPaymentDetails.cs b/src/Square.Connect/Model/ExternalPaymentDetails.cs new file mode 100644 index 0000000..cdf398f --- /dev/null +++ b/src/Square.Connect/Model/ExternalPaymentDetails.cs @@ -0,0 +1,191 @@ +/* + * Square Connect API + * + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + */ + +using System; +using System.Linq; +using System.IO; +using System.Text; +using System.Text.RegularExpressions; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Runtime.Serialization; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using System.ComponentModel.DataAnnotations; + +namespace Square.Connect.Model +{ + /// + /// Additional details about EXTERNAL type payments. + /// + [DataContract] + public partial class ExternalPaymentDetails : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected ExternalPaymentDetails() { } + /// + /// Initializes a new instance of the class. + /// + /// The type of External payment which can be one of: CHECK - Paid by a physical check BANK_TRANSFER - Paid by ACH or other bank transfer OTHER_GIFT_CARD - Paid by a non-square gift card CRYPTO - Paid via a crypto currency SQUARE_CASH - Paid via Square Cash app SOCIAL - Venmo, WeChatPay, AliPay, etc. EXTERNAL - A 3rd party application gathered this payment outside of Square EMONEY - A Japanese e-money brand Square doesn’t support CREDIT/DEBIT - A credit/debit card Square doesn’t support OTHER - A type not listed here (required). + /// A description of the source of the external payment, e.g. “Uber Eats”, “Stripe”, “Shopify”. Limit 255 characters (required). + /// An ID to associate this payment to its originating source Limit 255 characters.. + /// The total of fees paid to the source. (amount_money - source_fee_money) = net money to the merchant. + public ExternalPaymentDetails(string Type = default(string), string Source = default(string), string SourceId = default(string), Money SourceFeeMoney = default(Money)) + { + // to ensure "Type" is required (not null) + if (Type == null) + { + throw new InvalidDataException("Type is a required property for ExternalPaymentDetails and cannot be null"); + } + else + { + this.Type = Type; + } + // to ensure "Source" is required (not null) + if (Source == null) + { + throw new InvalidDataException("Source is a required property for ExternalPaymentDetails and cannot be null"); + } + else + { + this.Source = Source; + } + this.SourceId = SourceId; + this.SourceFeeMoney = SourceFeeMoney; + } + + /// + /// The type of External payment which can be one of: CHECK - Paid by a physical check BANK_TRANSFER - Paid by ACH or other bank transfer OTHER_GIFT_CARD - Paid by a non-square gift card CRYPTO - Paid via a crypto currency SQUARE_CASH - Paid via Square Cash app SOCIAL - Venmo, WeChatPay, AliPay, etc. EXTERNAL - A 3rd party application gathered this payment outside of Square EMONEY - A Japanese e-money brand Square doesn’t support CREDIT/DEBIT - A credit/debit card Square doesn’t support OTHER - A type not listed here + /// + /// The type of External payment which can be one of: CHECK - Paid by a physical check BANK_TRANSFER - Paid by ACH or other bank transfer OTHER_GIFT_CARD - Paid by a non-square gift card CRYPTO - Paid via a crypto currency SQUARE_CASH - Paid via Square Cash app SOCIAL - Venmo, WeChatPay, AliPay, etc. EXTERNAL - A 3rd party application gathered this payment outside of Square EMONEY - A Japanese e-money brand Square doesn’t support CREDIT/DEBIT - A credit/debit card Square doesn’t support OTHER - A type not listed here + [DataMember(Name="type", EmitDefaultValue=false)] + public string Type { get; set; } + /// + /// A description of the source of the external payment, e.g. “Uber Eats”, “Stripe”, “Shopify”. Limit 255 characters + /// + /// A description of the source of the external payment, e.g. “Uber Eats”, “Stripe”, “Shopify”. Limit 255 characters + [DataMember(Name="source", EmitDefaultValue=false)] + public string Source { get; set; } + /// + /// An ID to associate this payment to its originating source Limit 255 characters. + /// + /// An ID to associate this payment to its originating source Limit 255 characters. + [DataMember(Name="source_id", EmitDefaultValue=false)] + public string SourceId { get; set; } + /// + /// The total of fees paid to the source. (amount_money - source_fee_money) = net money to the merchant + /// + /// The total of fees paid to the source. (amount_money - source_fee_money) = net money to the merchant + [DataMember(Name="source_fee_money", EmitDefaultValue=false)] + public Money SourceFeeMoney { get; set; } + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class ExternalPaymentDetails {\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Source: ").Append(Source).Append("\n"); + sb.Append(" SourceId: ").Append(SourceId).Append("\n"); + sb.Append(" SourceFeeMoney: ").Append(SourceFeeMoney).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public string ToJson() + { + return JsonConvert.SerializeObject(this, Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object obj) + { + // credit: http://stackoverflow.com/a/10454552/677735 + return this.Equals(obj as ExternalPaymentDetails); + } + + /// + /// Returns true if ExternalPaymentDetails instances are equal + /// + /// Instance of ExternalPaymentDetails to be compared + /// Boolean + public bool Equals(ExternalPaymentDetails other) + { + // credit: http://stackoverflow.com/a/10454552/677735 + if (other == null) + return false; + + return + ( + this.Type == other.Type || + this.Type != null && + this.Type.Equals(other.Type) + ) && + ( + this.Source == other.Source || + this.Source != null && + this.Source.Equals(other.Source) + ) && + ( + this.SourceId == other.SourceId || + this.SourceId != null && + this.SourceId.Equals(other.SourceId) + ) && + ( + this.SourceFeeMoney == other.SourceFeeMoney || + this.SourceFeeMoney != null && + this.SourceFeeMoney.Equals(other.SourceFeeMoney) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + // credit: http://stackoverflow.com/a/263416/677735 + unchecked // Overflow is fine, just wrap + { + int hash = 41; + // Suitable nullity checks etc, of course :) + if (this.Type != null) + hash = hash * 59 + this.Type.GetHashCode(); + if (this.Source != null) + hash = hash * 59 + this.Source.GetHashCode(); + if (this.SourceId != null) + hash = hash * 59 + this.SourceId.GetHashCode(); + if (this.SourceFeeMoney != null) + hash = hash * 59 + this.SourceFeeMoney.GetHashCode(); + return hash; + } + } + + public IEnumerable Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Square.Connect/Model/InventoryAdjustment.cs b/src/Square.Connect/Model/InventoryAdjustment.cs index 564cc3f..4ea95be 100644 --- a/src/Square.Connect/Model/InventoryAdjustment.cs +++ b/src/Square.Connect/Model/InventoryAdjustment.cs @@ -39,7 +39,7 @@ public partial class InventoryAdjustment : IEquatable, IVa /// The Square ID of the `Location` where the related quantity of items are being tracked.. /// The Square generated ID of the `CatalogObject` being tracked.. /// The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type.. - /// [beta] 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.. + /// [beta] The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information.. /// The read-only total price paid for goods associated with the adjustment. Present if and only if `to_state` is `SOLD`. Always non-negative.. /// 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.. /// A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment.. @@ -113,9 +113,9 @@ public partial class InventoryAdjustment : IEquatable, IVa [DataMember(Name="catalog_object_type", EmitDefaultValue=false)] public string CatalogObjectType { get; set; } /// - /// The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + /// The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. /// - /// The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + /// The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. [DataMember(Name="quantity", EmitDefaultValue=false)] public string Quantity { get; set; } /// diff --git a/src/Square.Connect/Model/InventoryChange.cs b/src/Square.Connect/Model/InventoryChange.cs index 5637dff..62935c4 100644 --- a/src/Square.Connect/Model/InventoryChange.cs +++ b/src/Square.Connect/Model/InventoryChange.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular [CatalogObject](#type-catalogobject). + /// Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular `CatalogObject`. /// [DataContract] public partial class InventoryChange : IEquatable, IValidatableObject @@ -32,7 +32,7 @@ public partial class InventoryChange : IEquatable, IValidatabl /// /// Initializes a new instance of the class. /// - /// Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for possible values. + /// Indicates how the inventory change was applied. See `InventoryChangeType` for all possible values. See [InventoryChangeType](#type-inventorychangetype) for possible values. /// Contains details about the physical count when `type` is `PHYSICAL_COUNT` and unset for all other types.. /// Contains details about the inventory adjustment when `type` is `ADJUSTMENT` and unset for all other types.. /// Contains details about the inventory transfer when `type` is `TRANSFER` and unset for all other types.. @@ -45,9 +45,9 @@ public partial class InventoryChange : IEquatable, IValidatabl } /// - /// Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for possible values + /// Indicates how the inventory change was applied. See `InventoryChangeType` for all possible values. See [InventoryChangeType](#type-inventorychangetype) for possible values /// - /// Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for possible values + /// Indicates how the inventory change was applied. See `InventoryChangeType` for all possible values. See [InventoryChangeType](#type-inventorychangetype) for possible values [DataMember(Name="type", EmitDefaultValue=false)] public string Type { get; set; } /// diff --git a/src/Square.Connect/Model/InventoryCount.cs b/src/Square.Connect/Model/InventoryCount.cs index 5a1130d..caccaf4 100644 --- a/src/Square.Connect/Model/InventoryCount.cs +++ b/src/Square.Connect/Model/InventoryCount.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments + /// Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments. /// [DataContract] public partial class InventoryCount : IEquatable, IValidatableObject @@ -36,7 +36,7 @@ public partial class InventoryCount : IEquatable, IValidatableO /// The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type.. /// The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values. /// The Square ID of the `Location` where the related quantity of items are being tracked.. - /// [beta] 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.. + /// [beta] The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information.. /// 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.. public InventoryCount(string CatalogObjectId = default(string), string CatalogObjectType = default(string), string State = default(string), string LocationId = default(string), string Quantity = default(string), string CalculatedAt = default(string)) { @@ -73,9 +73,9 @@ public partial class InventoryCount : IEquatable, IValidatableO [DataMember(Name="location_id", EmitDefaultValue=false)] public string LocationId { get; set; } /// - /// The number of items in the count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + /// The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. /// - /// The number of items in the count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + /// The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. [DataMember(Name="quantity", EmitDefaultValue=false)] public string Quantity { get; set; } /// diff --git a/src/Square.Connect/Model/InventoryPhysicalCount.cs b/src/Square.Connect/Model/InventoryPhysicalCount.cs index af8223d..c4e5fe8 100644 --- a/src/Square.Connect/Model/InventoryPhysicalCount.cs +++ b/src/Square.Connect/Model/InventoryPhysicalCount.cs @@ -38,7 +38,7 @@ public partial class InventoryPhysicalCount : IEquatableThe `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type.. /// The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values. /// The Square ID of the `Location` where the related quantity of items are being tracked.. - /// [beta] 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.. + /// [beta] The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information.. /// Read-only information about the application that submitted the physical count.. /// The Square ID of the `Employee` responsible for the physical count.. /// 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.. @@ -95,9 +95,9 @@ public partial class InventoryPhysicalCount : IEquatable - /// The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + /// The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. /// - /// The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + /// The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. [DataMember(Name="quantity", EmitDefaultValue=false)] public string Quantity { get; set; } /// diff --git a/src/Square.Connect/Model/InventoryTransfer.cs b/src/Square.Connect/Model/InventoryTransfer.cs index 6b0cb22..b71ccaa 100644 --- a/src/Square.Connect/Model/InventoryTransfer.cs +++ b/src/Square.Connect/Model/InventoryTransfer.cs @@ -39,7 +39,7 @@ public partial class InventoryTransfer : IEquatable, IValida /// The Square ID of the `Location` where the related quantity of items were tracked after the transfer.. /// The Square generated ID of the `CatalogObject` being tracked.. /// The `CatalogObjectType` of the `CatalogObject` being tracked.Tracking is only supported for the `ITEM_VARIATION` type.. - /// [beta] 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.. + /// [beta] The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information.. /// 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.. /// A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request.. /// Read-only information about the application that initiated the inventory transfer.. @@ -103,9 +103,9 @@ public partial class InventoryTransfer : IEquatable, IValida [DataMember(Name="catalog_object_type", EmitDefaultValue=false)] public string CatalogObjectType { get; set; } /// - /// The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + /// The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. /// - /// The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/orders-api/what-it-does#decimal-quantities) for more information. + /// The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](https://developer.squareup.com/docs/docs/inventory-api/what-it-does#decimal-quantities-beta) for more information. [DataMember(Name="quantity", EmitDefaultValue=false)] public string Quantity { get; set; } /// diff --git a/src/Square.Connect/Model/ItemVariationLocationOverrides.cs b/src/Square.Connect/Model/ItemVariationLocationOverrides.cs index 11d2188..d54a5c0 100644 --- a/src/Square.Connect/Model/ItemVariationLocationOverrides.cs +++ b/src/Square.Connect/Model/ItemVariationLocationOverrides.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Price and inventory alerting overrides for a [CatalogItemVariation](#type-catalogitemvariation) at a specific [location](#type-location). + /// Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`. /// [DataContract] public partial class ItemVariationLocationOverrides : IEquatable, IValidatableObject @@ -32,10 +32,10 @@ public partial class ItemVariationLocationOverrides : IEquatable /// Initializes a new instance of the class. /// - /// The ID of the `location`.. - /// The price of the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`, or blank for variable pricing.. - /// The pricing type (fixed or variable) for the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values. - /// If `true`, inventory tracking is active for the `CatalogItemVariation](#type-catalogitemvariation) at this [location`.. + /// The ID of the `Location`.. + /// The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing.. + /// The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values. + /// If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`.. /// 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. /// 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.. public ItemVariationLocationOverrides(string LocationId = default(string), Money PriceMoney = default(Money), string PricingType = default(string), bool? TrackInventory = default(bool?), string InventoryAlertType = default(string), long? InventoryAlertThreshold = default(long?)) @@ -49,27 +49,27 @@ public partial class ItemVariationLocationOverrides : IEquatable - /// The ID of the `location`. + /// The ID of the `Location`. /// - /// The ID of the `location`. + /// The ID of the `Location`. [DataMember(Name="location_id", EmitDefaultValue=false)] public string LocationId { get; set; } /// - /// The price of the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`, or blank for variable pricing. + /// The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing. /// - /// The price of the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`, or blank for variable pricing. + /// The price of the `CatalogItemVariation` at the given `Location`, or blank for variable pricing. [DataMember(Name="price_money", EmitDefaultValue=false)] public Money PriceMoney { get; set; } /// - /// The pricing type (fixed or variable) for the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values + /// The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values /// - /// The pricing type (fixed or variable) for the `CatalogItemVariation](#type-catalogitemvariation) at the given [location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values + /// The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`. See [CatalogPricingType](#type-catalogpricingtype) for possible values [DataMember(Name="pricing_type", EmitDefaultValue=false)] public string PricingType { get; set; } /// - /// If `true`, inventory tracking is active for the `CatalogItemVariation](#type-catalogitemvariation) at this [location`. + /// If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`. /// - /// If `true`, inventory tracking is active for the `CatalogItemVariation](#type-catalogitemvariation) at this [location`. + /// If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`. [DataMember(Name="track_inventory", EmitDefaultValue=false)] public bool? TrackInventory { get; set; } /// diff --git a/src/Square.Connect/Model/ListAdditionalRecipientReceivableRefundsRequest.cs b/src/Square.Connect/Model/ListAdditionalRecipientReceivableRefundsRequest.cs index 9459893..de4a06a 100644 --- a/src/Square.Connect/Model/ListAdditionalRecipientReceivableRefundsRequest.cs +++ b/src/Square.Connect/Model/ListAdditionalRecipientReceivableRefundsRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivableRefunds endpoint. + /// Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. /// [DataContract] [Obsolete] @@ -36,7 +36,7 @@ public partial class ListAdditionalRecipientReceivableRefundsRequest : IEquatab /// 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.. /// 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.. /// 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. - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.. public ListAdditionalRecipientReceivableRefundsRequest(string BeginTime = default(string), string EndTime = default(string), string SortOrder = default(string), string Cursor = default(string)) { this.BeginTime = BeginTime; @@ -64,9 +64,9 @@ public partial class ListAdditionalRecipientReceivableRefundsRequest : IEquatab [DataMember(Name="sort_order", EmitDefaultValue=false)] public string SortOrder { get; set; } /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/ListAdditionalRecipientReceivableRefundsResponse.cs b/src/Square.Connect/Model/ListAdditionalRecipientReceivableRefundsResponse.cs index 57c7c37..1c5845d 100644 --- a/src/Square.Connect/Model/ListAdditionalRecipientReceivableRefundsResponse.cs +++ b/src/Square.Connect/Model/ListAdditionalRecipientReceivableRefundsResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivableRefunds endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both). + /// Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both). /// [DataContract] [Obsolete] @@ -35,7 +35,7 @@ public partial class ListAdditionalRecipientReceivableRefundsResponse : IEquata /// /// Any errors that occurred during the request.. /// An array of AdditionalRecipientReceivableRefunds that match your query.. - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information.. public ListAdditionalRecipientReceivableRefundsResponse(List Errors = default(List), List ReceivableRefunds = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -56,9 +56,9 @@ public partial class ListAdditionalRecipientReceivableRefundsResponse : IEquata [DataMember(Name="receivable_refunds", EmitDefaultValue=false)] public List ReceivableRefunds { get; set; } /// - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. /// - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/ListAdditionalRecipientReceivablesRequest.cs b/src/Square.Connect/Model/ListAdditionalRecipientReceivablesRequest.cs index 93cbd18..46a8182 100644 --- a/src/Square.Connect/Model/ListAdditionalRecipientReceivablesRequest.cs +++ b/src/Square.Connect/Model/ListAdditionalRecipientReceivablesRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the query parameters that can be included in a request to the ListAdditionalRecipientReceivables endpoint. + /// Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. /// [DataContract] [Obsolete] @@ -36,7 +36,7 @@ public partial class ListAdditionalRecipientReceivablesRequest : IEquatableThe 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.. /// 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.. /// 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. - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.. public ListAdditionalRecipientReceivablesRequest(string BeginTime = default(string), string EndTime = default(string), string SortOrder = default(string), string Cursor = default(string)) { this.BeginTime = BeginTime; @@ -64,9 +64,9 @@ public partial class ListAdditionalRecipientReceivablesRequest : IEquatable - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/ListAdditionalRecipientReceivablesResponse.cs b/src/Square.Connect/Model/ListAdditionalRecipientReceivablesResponse.cs index 796e74d..36e81cb 100644 --- a/src/Square.Connect/Model/ListAdditionalRecipientReceivablesResponse.cs +++ b/src/Square.Connect/Model/ListAdditionalRecipientReceivablesResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in the response body of a request to the ListAdditionalRecipientReceivables endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both). + /// Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both). /// [DataContract] [Obsolete] @@ -35,7 +35,7 @@ public partial class ListAdditionalRecipientReceivablesResponse : IEquatable
  • /// Any errors that occurred during the request.. /// An array of AdditionalRecipientReceivables that match your query.. - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information.. public ListAdditionalRecipientReceivablesResponse(List Errors = default(List), List Receivables = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -56,9 +56,9 @@ public partial class ListAdditionalRecipientReceivablesResponse : IEquatable
  • Receivables { get; set; } /// - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. /// - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/ListCatalogRequest.cs b/src/Square.Connect/Model/ListCatalogRequest.cs index 7bf9f58..839b37a 100644 --- a/src/Square.Connect/Model/ListCatalogRequest.cs +++ b/src/Square.Connect/Model/ListCatalogRequest.cs @@ -33,7 +33,7 @@ public partial class ListCatalogRequest : IEquatable, IVali /// Initializes a new instance of the class. /// /// 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.. - /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.. + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.. public ListCatalogRequest(string Cursor = default(string), string Types = default(string)) { this.Cursor = Cursor; @@ -47,9 +47,9 @@ public partial class ListCatalogRequest : IEquatable, IVali [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// - /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. /// - /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the `CatalogObjectType` enumeration, namely `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. + /// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. [DataMember(Name="types", EmitDefaultValue=false)] public string Types { get; set; } /// diff --git a/src/Square.Connect/Model/ListCatalogResponse.cs b/src/Square.Connect/Model/ListCatalogResponse.cs index 8d353cd..9d2fbe4 100644 --- a/src/Square.Connect/Model/ListCatalogResponse.cs +++ b/src/Square.Connect/Model/ListCatalogResponse.cs @@ -32,9 +32,9 @@ public partial class ListCatalogResponse : IEquatable, IVa /// /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. + /// Information on any errors encountered.. /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. - /// The `CatalogObject`s returned.. + /// The CatalogObjects returned.. public ListCatalogResponse(List Errors = default(List), string Cursor = default(string), List Objects = default(List)) { this.Errors = Errors; @@ -43,9 +43,9 @@ public partial class ListCatalogResponse : IEquatable, IVa } /// - /// The set of `Error`s encountered. + /// Information on any errors encountered. /// - /// The set of `Error`s encountered. + /// Information on any errors encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// @@ -55,9 +55,9 @@ public partial class ListCatalogResponse : IEquatable, IVa [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// - /// The `CatalogObject`s returned. + /// The CatalogObjects returned. /// - /// The `CatalogObject`s returned. + /// The CatalogObjects returned. [DataMember(Name="objects", EmitDefaultValue=false)] public List Objects { get; set; } /// diff --git a/src/Square.Connect/Model/ListCustomersRequest.cs b/src/Square.Connect/Model/ListCustomersRequest.cs index 7c9ee83..1338e15 100644 --- a/src/Square.Connect/Model/ListCustomersRequest.cs +++ b/src/Square.Connect/Model/ListCustomersRequest.cs @@ -32,9 +32,9 @@ public partial class ListCustomersRequest : IEquatable, I /// /// Initializes a new instance of the class. /// - /// 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.. - /// Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.. + /// Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. public ListCustomersRequest(string Cursor = default(string), string SortField = default(string), string SortOrder = default(string)) { this.Cursor = Cursor; @@ -43,21 +43,21 @@ public partial class ListCustomersRequest : IEquatable, I } /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// - /// Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values + /// Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values /// - /// Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values + /// Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values [DataMember(Name="sort_field", EmitDefaultValue=false)] public string SortField { get; set; } /// - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values /// - /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values + /// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values [DataMember(Name="sort_order", EmitDefaultValue=false)] public string SortOrder { get; set; } /// diff --git a/src/Square.Connect/Model/ListCustomersResponse.cs b/src/Square.Connect/Model/ListCustomersResponse.cs index eba030e..2c86170 100644 --- a/src/Square.Connect/Model/ListCustomersResponse.cs +++ b/src/Square.Connect/Model/ListCustomersResponse.cs @@ -33,8 +33,8 @@ public partial class ListCustomersResponse : IEquatable, /// Initializes a new instance of the class. /// /// Any errors that occurred during the request.. - /// An array of `Customer` objects that match your query.. - /// 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.. + /// An array of `Customer` objects that match the provided query.. + /// A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.. public ListCustomersResponse(List Errors = default(List), List Customers = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -49,15 +49,15 @@ public partial class ListCustomersResponse : IEquatable, [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// - /// An array of `Customer` objects that match your query. + /// An array of `Customer` objects that match the provided query. /// - /// An array of `Customer` objects that match your query. + /// An array of `Customer` objects that match the provided query. [DataMember(Name="customers", EmitDefaultValue=false)] public List Customers { get; set; } /// - /// A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. /// - /// A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/ListEmployeesRequest.cs b/src/Square.Connect/Model/ListEmployeesRequest.cs index 3ffd241..f972a3f 100644 --- a/src/Square.Connect/Model/ListEmployeesRequest.cs +++ b/src/Square.Connect/Model/ListEmployeesRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Retrieve a paged-list of employees for a Square account + /// /// [DataContract] public partial class ListEmployeesRequest : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/ListEmployeesResponse.cs b/src/Square.Connect/Model/ListEmployeesResponse.cs index 66be04f..ba4895e 100644 --- a/src/Square.Connect/Model/ListEmployeesResponse.cs +++ b/src/Square.Connect/Model/ListEmployeesResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in the response body of a request to the ListEmployees endpoint. One of `errors` or `employees` is present in a given response (never both). + /// /// [DataContract] public partial class ListEmployeesResponse : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/ListLocationsRequest.cs b/src/Square.Connect/Model/ListLocationsRequest.cs index 035449d..b24cd62 100644 --- a/src/Square.Connect/Model/ListLocationsRequest.cs +++ b/src/Square.Connect/Model/ListLocationsRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in requests to the ListLocations endpoint. + /// Defines the fields that are included in requests to the __ListLocations__ endpoint. /// [DataContract] public partial class ListLocationsRequest : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/ListLocationsResponse.cs b/src/Square.Connect/Model/ListLocationsResponse.cs index 5cdc904..312979c 100644 --- a/src/Square.Connect/Model/ListLocationsResponse.cs +++ b/src/Square.Connect/Model/ListLocationsResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in the response body of a request to the ListLocations endpoint. One of `errors` or `locations` is present in a given response (never both). + /// Defines the fields that are included in the response body of a request to the __ListLocations__ endpoint. One of `errors` or `locations` is present in a given response (never both). /// [DataContract] public partial class ListLocationsResponse : IEquatable, IValidatableObject @@ -33,7 +33,7 @@ public partial class ListLocationsResponse : IEquatable, /// Initializes a new instance of the class. /// /// Any errors that occurred during the request.. - /// The business's locations.. + /// The business locations.. public ListLocationsResponse(List Errors = default(List), List Locations = default(List)) { this.Errors = Errors; @@ -47,9 +47,9 @@ public partial class ListLocationsResponse : IEquatable, [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// - /// The business's locations. + /// The business locations. /// - /// The business's locations. + /// The business locations. [DataMember(Name="locations", EmitDefaultValue=false)] public List Locations { get; set; } /// diff --git a/src/Square.Connect/Model/ListPaymentRefundsRequest.cs b/src/Square.Connect/Model/ListPaymentRefundsRequest.cs index a6eb861..39821cc 100644 --- a/src/Square.Connect/Model/ListPaymentRefundsRequest.cs +++ b/src/Square.Connect/Model/ListPaymentRefundsRequest.cs @@ -37,8 +37,8 @@ public partial class ListPaymentRefundsRequest : IEquatableThe order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default).. /// 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.. /// ID of location associated with payment.. - /// If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status.. - /// If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type.. + /// If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status.. + /// If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type.. public ListPaymentRefundsRequest(string BeginTime = default(string), string EndTime = default(string), string SortOrder = default(string), string Cursor = default(string), string LocationId = default(string), string Status = default(string), string SourceType = default(string)) { this.BeginTime = BeginTime; @@ -81,15 +81,15 @@ public partial class ListPaymentRefundsRequest : IEquatable - /// If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. + /// If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. /// - /// If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. + /// If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. [DataMember(Name="status", EmitDefaultValue=false)] public string Status { get; set; } /// - /// If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. + /// If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. /// - /// If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. + /// If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. [DataMember(Name="source_type", EmitDefaultValue=false)] public string SourceType { get; set; } /// diff --git a/src/Square.Connect/Model/ListRefundsRequest.cs b/src/Square.Connect/Model/ListRefundsRequest.cs index 0e21e52..5590f40 100644 --- a/src/Square.Connect/Model/ListRefundsRequest.cs +++ b/src/Square.Connect/Model/ListRefundsRequest.cs @@ -36,7 +36,7 @@ public partial class ListRefundsRequest : IEquatable, IVali /// 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.. /// 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.. /// 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. - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.. public ListRefundsRequest(string BeginTime = default(string), string EndTime = default(string), string SortOrder = default(string), string Cursor = default(string)) { this.BeginTime = BeginTime; @@ -64,9 +64,9 @@ public partial class ListRefundsRequest : IEquatable, IVali [DataMember(Name="sort_order", EmitDefaultValue=false)] public string SortOrder { get; set; } /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/ListRefundsResponse.cs b/src/Square.Connect/Model/ListRefundsResponse.cs index 38b5af3..3d08551 100644 --- a/src/Square.Connect/Model/ListRefundsResponse.cs +++ b/src/Square.Connect/Model/ListRefundsResponse.cs @@ -35,7 +35,7 @@ public partial class ListRefundsResponse : IEquatable, IVa /// /// Any errors that occurred during the request.. /// An array of refunds that match your query.. - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information.. public ListRefundsResponse(List Errors = default(List), List Refunds = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -56,9 +56,9 @@ public partial class ListRefundsResponse : IEquatable, IVa [DataMember(Name="refunds", EmitDefaultValue=false)] public List Refunds { get; set; } /// - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. /// - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/ListTransactionsRequest.cs b/src/Square.Connect/Model/ListTransactionsRequest.cs index e58484f..efced56 100644 --- a/src/Square.Connect/Model/ListTransactionsRequest.cs +++ b/src/Square.Connect/Model/ListTransactionsRequest.cs @@ -36,7 +36,7 @@ public partial class ListTransactionsRequest : IEquatableThe 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.. /// 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.. /// 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. - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.. public ListTransactionsRequest(string BeginTime = default(string), string EndTime = default(string), string SortOrder = default(string), string Cursor = default(string)) { this.BeginTime = BeginTime; @@ -64,9 +64,9 @@ public partial class ListTransactionsRequest : IEquatable - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/ListTransactionsResponse.cs b/src/Square.Connect/Model/ListTransactionsResponse.cs index d4c16b5..0defa4e 100644 --- a/src/Square.Connect/Model/ListTransactionsResponse.cs +++ b/src/Square.Connect/Model/ListTransactionsResponse.cs @@ -35,7 +35,7 @@ public partial class ListTransactionsResponse : IEquatable /// Any errors that occurred during the request.. /// An array of transactions that match your query.. - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information.. public ListTransactionsResponse(List Errors = default(List), List Transactions = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -56,9 +56,9 @@ public partial class ListTransactionsResponse : IEquatable Transactions { get; set; } /// - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. /// - /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/Location.cs b/src/Square.Connect/Model/Location.cs index 0cfbb53..bcfff53 100644 --- a/src/Square.Connect/Model/Location.cs +++ b/src/Square.Connect/Model/Location.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents one of a business's locations. + /// /// [DataContract] public partial class Location : IEquatable, IValidatableObject @@ -33,29 +33,29 @@ public partial class Location : IEquatable, IValidatableObject /// Initializes a new instance of the class. /// /// The Square-issued ID of the location.. - /// The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname. - /// The location's physical address.. - /// The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone.. + /// The name of the location. This information appears in the dashboard as the nickname.. + /// The physical address of the location.. + /// The [IANA Timezone](https://www.iana.org/time-zones) identifier for the timezone of the location.. /// The Square features that are enabled for the location. See `LocationCapability` for possible values. See [LocationCapability](#type-locationcapability) for possible values. - /// The location's status See [LocationStatus](#type-locationstatus) for possible values. + /// The status of the location, either active or inactive. See [LocationStatus](#type-locationstatus) for possible values. /// The time when the location was created, in RFC 3339 format.. /// The ID of the merchant that owns the location.. /// The country of the location, in ISO 3166-1-alpha-2 format. See `Country` for possible values. See [Country](#type-country) for possible values. - /// The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).. - /// The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values. - /// The location's phone_number.. - /// The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts.. - /// The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values. - /// The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set.. - /// The hours of operation for a business location. Default: none; only exists if explicitly set.. - /// The email of the location.. - /// The business description of the location.. + /// The language associated with the location, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).. + /// The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values. + /// The phone number of the location in human readable format.. + /// The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts.. + /// The type of the location, either physical or mobile. See [LocationType](#type-locationtype) for possible values. + /// The website URL of the location.. + /// Represents the hours of operation for the location.. + /// The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts.. + /// The description of the location.. /// The Twitter username of the location without the '&#64;' symbol.. /// The Instagram username of the location without the '&#64;' symbol.. /// The Facebook profile URL of the location. The URL should begin with 'facebook.com/'.. /// The physical coordinates (latitude and longitude) of the location.. - /// The logo image URL of the location.. - /// The Point of Sale background image URL of the location.. + /// The URL of the logo image for the location.. + /// The URL of the Point of Sale background image for the location.. /// [beta] 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 Location(string Id = default(string), string Name = default(string), Address Address = default(Address), string Timezone = default(string), List Capabilities = default(List), string Status = default(string), string CreatedAt = default(string), string MerchantId = default(string), string Country = default(string), string LanguageCode = default(string), string Currency = default(string), string PhoneNumber = default(string), string BusinessName = default(string), string Type = default(string), string WebsiteUrl = default(string), BusinessHours BusinessHours = default(BusinessHours), string BusinessEmail = default(string), string Description = default(string), string TwitterUsername = default(string), string InstagramUsername = default(string), string FacebookUrl = default(string), Coordinates Coordinates = default(Coordinates), string LogoUrl = default(string), string PosBackgroundUrl = default(string), string Mcc = default(string)) { @@ -93,21 +93,21 @@ public partial class Location : IEquatable, IValidatableObject [DataMember(Name="id", EmitDefaultValue=false)] public string Id { get; set; } /// - /// The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname + /// The name of the location. This information appears in the dashboard as the nickname. /// - /// The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname + /// The name of the location. This information appears in the dashboard as the nickname. [DataMember(Name="name", EmitDefaultValue=false)] public string Name { get; set; } /// - /// The location's physical address. + /// The physical address of the location. /// - /// The location's physical address. + /// The physical address of the location. [DataMember(Name="address", EmitDefaultValue=false)] public Address Address { get; set; } /// - /// The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone. + /// The [IANA Timezone](https://www.iana.org/time-zones) identifier for the timezone of the location. /// - /// The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone. + /// The [IANA Timezone](https://www.iana.org/time-zones) identifier for the timezone of the location. [DataMember(Name="timezone", EmitDefaultValue=false)] public string Timezone { get; set; } /// @@ -117,9 +117,9 @@ public partial class Location : IEquatable, IValidatableObject [DataMember(Name="capabilities", EmitDefaultValue=false)] public List Capabilities { get; set; } /// - /// The location's status See [LocationStatus](#type-locationstatus) for possible values + /// The status of the location, either active or inactive. See [LocationStatus](#type-locationstatus) for possible values /// - /// The location's status See [LocationStatus](#type-locationstatus) for possible values + /// The status of the location, either active or inactive. See [LocationStatus](#type-locationstatus) for possible values [DataMember(Name="status", EmitDefaultValue=false)] public string Status { get; set; } /// @@ -141,57 +141,57 @@ public partial class Location : IEquatable, IValidatableObject [DataMember(Name="country", EmitDefaultValue=false)] public string Country { get; set; } /// - /// The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). + /// The language associated with the location, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). /// - /// The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). + /// The language associated with the location, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). [DataMember(Name="language_code", EmitDefaultValue=false)] public string LanguageCode { get; set; } /// - /// The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values + /// The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values /// - /// The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values + /// The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values [DataMember(Name="currency", EmitDefaultValue=false)] public string Currency { get; set; } /// - /// The location's phone_number. + /// The phone number of the location in human readable format. /// - /// The location's phone_number. + /// The phone number of the location in human readable format. [DataMember(Name="phone_number", EmitDefaultValue=false)] public string PhoneNumber { get; set; } /// - /// The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts. + /// The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts. /// - /// The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts. + /// The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts. [DataMember(Name="business_name", EmitDefaultValue=false)] public string BusinessName { get; set; } /// - /// The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values + /// The type of the location, either physical or mobile. See [LocationType](#type-locationtype) for possible values /// - /// The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values + /// The type of the location, either physical or mobile. See [LocationType](#type-locationtype) for possible values [DataMember(Name="type", EmitDefaultValue=false)] public string Type { get; set; } /// - /// The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set. + /// The website URL of the location. /// - /// The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set. + /// The website URL of the location. [DataMember(Name="website_url", EmitDefaultValue=false)] public string WebsiteUrl { get; set; } /// - /// The hours of operation for a business location. Default: none; only exists if explicitly set. + /// Represents the hours of operation for the location. /// - /// The hours of operation for a business location. Default: none; only exists if explicitly set. + /// Represents the hours of operation for the location. [DataMember(Name="business_hours", EmitDefaultValue=false)] public BusinessHours BusinessHours { get; set; } /// - /// The email of the location. + /// The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts. /// - /// The email of the location. + /// The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts. [DataMember(Name="business_email", EmitDefaultValue=false)] public string BusinessEmail { get; set; } /// - /// The business description of the location. + /// The description of the location. /// - /// The business description of the location. + /// The description of the location. [DataMember(Name="description", EmitDefaultValue=false)] public string Description { get; set; } /// @@ -219,15 +219,15 @@ public partial class Location : IEquatable, IValidatableObject [DataMember(Name="coordinates", EmitDefaultValue=false)] public Coordinates Coordinates { get; set; } /// - /// The logo image URL of the location. + /// The URL of the logo image for the location. /// - /// The logo image URL of the location. + /// The URL of the logo image for the location. [DataMember(Name="logo_url", EmitDefaultValue=false)] public string LogoUrl { get; set; } /// - /// The Point of Sale background image URL of the location. + /// The URL of the Point of Sale background image for the location. /// - /// The Point of Sale background image URL of the location. + /// The URL of the Point of Sale background image for the location. [DataMember(Name="pos_background_url", EmitDefaultValue=false)] public string PosBackgroundUrl { get; set; } /// diff --git a/src/Square.Connect/Model/Money.cs b/src/Square.Connect/Model/Money.cs index 112d4fc..3b7ba82 100644 --- a/src/Square.Connect/Model/Money.cs +++ b/src/Square.Connect/Model/Money.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Represents an amount of money. `Money` fields can be signed or unsigned. + /// Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](/build-basics/working-with-monetary-amounts) for more information. /// [DataContract] public partial class Money : IEquatable, IValidatableObject @@ -32,7 +32,7 @@ public partial class Money : IEquatable, IValidatableObject /// /// Initializes a new instance of the class. /// - /// The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case.. + /// The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.. /// 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 Money(long? Amount = default(long?), string Currency = default(string)) { @@ -41,9 +41,9 @@ public partial class Money : IEquatable, IValidatableObject } /// - /// The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case. + /// The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case. /// - /// The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case. + /// The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case. [DataMember(Name="amount", EmitDefaultValue=false)] public long? Amount { get; set; } /// diff --git a/src/Square.Connect/Model/ObtainTokenResponse.cs b/src/Square.Connect/Model/ObtainTokenResponse.cs index bf83533..431e8e2 100644 --- a/src/Square.Connect/Model/ObtainTokenResponse.cs +++ b/src/Square.Connect/Model/ObtainTokenResponse.cs @@ -37,7 +37,7 @@ public partial class ObtainTokenResponse : IEquatable, IVa /// The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.. /// The ID of the authorizing merchant's business.. /// __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.. - /// __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.. + /// T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.. /// Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request.. /// 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 ObtainTokenResponse(string AccessToken = default(string), string TokenType = default(string), string ExpiresAt = default(string), string MerchantId = default(string), string SubscriptionId = default(string), string PlanId = default(string), string IdToken = default(string), string RefreshToken = default(string)) @@ -83,9 +83,9 @@ public partial class ObtainTokenResponse : IEquatable, IVa [DataMember(Name="subscription_id", EmitDefaultValue=false)] public string SubscriptionId { get; set; } /// - /// __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. + /// T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. /// - /// __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. + /// T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. [DataMember(Name="plan_id", EmitDefaultValue=false)] public string PlanId { get; set; } /// diff --git a/src/Square.Connect/Model/Payment.cs b/src/Square.Connect/Model/Payment.cs index 80c2155..87bf4ef 100644 --- a/src/Square.Connect/Model/Payment.cs +++ b/src/Square.Connect/Model/Payment.cs @@ -35,10 +35,10 @@ public partial class Payment : IEquatable, IValidatableObject /// Unique ID for the payment.. /// Timestamp of when the payment was created, in RFC 3339 format.. /// Timestamp of when the payment was last updated, in RFC 3339 format.. - /// The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).. + /// The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts).. /// The amount designated as a tip. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.. - /// The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.. - /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value.. + /// The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.. + /// The 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.. /// Processing fees and fee adjustments assessed by Square on this payment.. /// 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.. /// Indicates whether the payment is `APPROVED`, `COMPLETED`, `CANCELED`, or `FAILED`.. @@ -54,7 +54,8 @@ public partial class Payment : IEquatable, IValidatableObject /// The buyer's billing address. /// The buyer's shipping address. /// An optional note to include when creating a payment. - public Payment(string Id = default(string), string CreatedAt = default(string), string UpdatedAt = default(string), Money AmountMoney = default(Money), Money TipMoney = default(Money), Money TotalMoney = default(Money), Money AppFeeMoney = default(Money), List ProcessingFee = default(List), Money RefundedMoney = default(Money), string Status = default(string), string SourceType = default(string), CardPaymentDetails CardDetails = default(CardPaymentDetails), string LocationId = default(string), string OrderId = default(string), string ReferenceId = default(string), string CustomerId = default(string), string EmployeeId = default(string), List RefundIds = default(List), string BuyerEmailAddress = default(string), Address BillingAddress = default(Address), Address ShippingAddress = default(Address), string Note = default(string)) + /// [beta] Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment.. + public Payment(string Id = default(string), string CreatedAt = default(string), string UpdatedAt = default(string), Money AmountMoney = default(Money), Money TipMoney = default(Money), Money TotalMoney = default(Money), Money AppFeeMoney = default(Money), List ProcessingFee = default(List), Money RefundedMoney = default(Money), string Status = default(string), string SourceType = default(string), CardPaymentDetails CardDetails = default(CardPaymentDetails), string LocationId = default(string), string OrderId = default(string), string ReferenceId = default(string), string CustomerId = default(string), string EmployeeId = default(string), List RefundIds = default(List), string BuyerEmailAddress = default(string), Address BillingAddress = default(Address), Address ShippingAddress = default(Address), string Note = default(string), string StatementDescriptionIdentifier = default(string)) { this.Id = Id; this.CreatedAt = CreatedAt; @@ -78,6 +79,7 @@ public partial class Payment : IEquatable, IValidatableObject this.BillingAddress = BillingAddress; this.ShippingAddress = ShippingAddress; this.Note = Note; + this.StatementDescriptionIdentifier = StatementDescriptionIdentifier; } /// @@ -99,9 +101,9 @@ public partial class Payment : IEquatable, IValidatableObject [DataMember(Name="updated_at", EmitDefaultValue=false)] public string UpdatedAt { get; set; } /// - /// The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + /// The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). /// - /// The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + /// The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). [DataMember(Name="amount_money", EmitDefaultValue=false)] public Money AmountMoney { get; set; } /// @@ -111,15 +113,15 @@ public partial class Payment : IEquatable, IValidatableObject [DataMember(Name="tip_money", EmitDefaultValue=false)] public Money TipMoney { get; set; } /// - /// The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. + /// The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. /// - /// The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. + /// The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. [DataMember(Name="total_money", EmitDefaultValue=false)] public Money TotalMoney { get; set; } /// - /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. + /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. /// - /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. + /// The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. [DataMember(Name="app_fee_money", EmitDefaultValue=false)] public Money AppFeeMoney { get; set; } /// @@ -213,6 +215,12 @@ public partial class Payment : IEquatable, IValidatableObject [DataMember(Name="note", EmitDefaultValue=false)] public string Note { get; set; } /// + /// Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. + /// + /// Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the statement_description_identifier may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. + [DataMember(Name="statement_description_identifier", EmitDefaultValue=false)] + public string StatementDescriptionIdentifier { get; set; } + /// /// Returns the string presentation of the object /// /// String presentation of the object @@ -242,6 +250,7 @@ public override string ToString() sb.Append(" BillingAddress: ").Append(BillingAddress).Append("\n"); sb.Append(" ShippingAddress: ").Append(ShippingAddress).Append("\n"); sb.Append(" Note: ").Append(Note).Append("\n"); + sb.Append(" StatementDescriptionIdentifier: ").Append(StatementDescriptionIdentifier).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -387,6 +396,11 @@ public bool Equals(Payment other) this.Note == other.Note || this.Note != null && this.Note.Equals(other.Note) + ) && + ( + this.StatementDescriptionIdentifier == other.StatementDescriptionIdentifier || + this.StatementDescriptionIdentifier != null && + this.StatementDescriptionIdentifier.Equals(other.StatementDescriptionIdentifier) ); } @@ -445,6 +459,8 @@ public override int GetHashCode() hash = hash * 59 + this.ShippingAddress.GetHashCode(); if (this.Note != null) hash = hash * 59 + this.Note.GetHashCode(); + if (this.StatementDescriptionIdentifier != null) + hash = hash * 59 + this.StatementDescriptionIdentifier.GetHashCode(); return hash; } } diff --git a/src/Square.Connect/Model/RefundPaymentRequest.cs b/src/Square.Connect/Model/RefundPaymentRequest.cs index 3810bf5..d1e6dac 100644 --- a/src/Square.Connect/Model/RefundPaymentRequest.cs +++ b/src/Square.Connect/Model/RefundPaymentRequest.cs @@ -37,9 +37,9 @@ protected RefundPaymentRequest() { } /// /// Initializes a new instance of the class. /// - /// 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). (required). + /// A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). (required). /// 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. (required). - /// Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). + /// Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). /// Unique ID of the payment being refunded.. /// A description of the reason for the refund.. public RefundPaymentRequest(string IdempotencyKey = default(string), Money AmountMoney = default(Money), Money AppFeeMoney = default(Money), string PaymentId = default(string), string Reason = default(string)) @@ -68,9 +68,9 @@ protected RefundPaymentRequest() { } } /// - /// A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency). + /// A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). /// - /// A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency). + /// A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). [DataMember(Name="idempotency_key", EmitDefaultValue=false)] public string IdempotencyKey { get; set; } /// @@ -80,9 +80,9 @@ protected RefundPaymentRequest() { } [DataMember(Name="amount_money", EmitDefaultValue=false)] public Money AmountMoney { get; set; } /// - /// Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) + /// Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) /// - /// Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) + /// Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) [DataMember(Name="app_fee_money", EmitDefaultValue=false)] public Money AppFeeMoney { get; set; } /// diff --git a/src/Square.Connect/Model/RegisterDomainRequest.cs b/src/Square.Connect/Model/RegisterDomainRequest.cs index 47c4d9c..2a7fd15 100644 --- a/src/Square.Connect/Model/RegisterDomainRequest.cs +++ b/src/Square.Connect/Model/RegisterDomainRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the parameters that can be included in the body of a request to the RegisterDomain endpoint. + /// Defines the parameters that can be included in the body of a request to the __RegisterDomain__ endpoint. /// [DataContract] public partial class RegisterDomainRequest : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/RegisterDomainResponse.cs b/src/Square.Connect/Model/RegisterDomainResponse.cs index 8d29798..de26433 100644 --- a/src/Square.Connect/Model/RegisterDomainResponse.cs +++ b/src/Square.Connect/Model/RegisterDomainResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in the response body of a request to the RegisterDomain endpoint. Either `errors` or `status` will be present in a given response (never both). + /// Defines the fields that are included in the response body of a request to the __RegisterDomain__ endpoint. Either `errors` or `status` will be present in a given response (never both). /// [DataContract] public partial class RegisterDomainResponse : IEquatable, IValidatableObject @@ -33,7 +33,7 @@ public partial class RegisterDomainResponse : IEquatable class. /// /// Any errors that occurred during the request.. - /// Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values. + /// Status of the domain registration. See `RegisterDomainResponseStatus` for possible values. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values. public RegisterDomainResponse(List Errors = default(List), string Status = default(string)) { this.Errors = Errors; @@ -47,9 +47,9 @@ public partial class RegisterDomainResponse : IEquatable Errors { get; set; } /// - /// Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values + /// Status of the domain registration. See `RegisterDomainResponseStatus` for possible values. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values /// - /// Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values + /// Status of the domain registration. See `RegisterDomainResponseStatus` for possible values. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values [DataMember(Name="status", EmitDefaultValue=false)] public string Status { get; set; } /// diff --git a/src/Square.Connect/Model/RenewTokenResponse.cs b/src/Square.Connect/Model/RenewTokenResponse.cs index fceb18d..c04e98a 100644 --- a/src/Square.Connect/Model/RenewTokenResponse.cs +++ b/src/Square.Connect/Model/RenewTokenResponse.cs @@ -33,11 +33,11 @@ public partial class RenewTokenResponse : IEquatable, IVali /// /// Initializes a new instance of the class. /// - /// The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://docs.connect.squareup.com/api/connect/v2/#requestandresponseheaders) for the format of this header.. + /// The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://developer.squareup.com/docs/api/connect/v2/#requestandresponseheaders) for the format of this header.. /// This value is always _bearer_.. /// The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.. /// The ID of the authorizing merchant's business.. - /// __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization.. + /// __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization... /// __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.. public RenewTokenResponse(string AccessToken = default(string), string TokenType = default(string), string ExpiresAt = default(string), string MerchantId = default(string), string SubscriptionId = default(string), string PlanId = default(string)) { @@ -50,9 +50,9 @@ public partial class RenewTokenResponse : IEquatable, IVali } /// - /// The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://docs.connect.squareup.com/api/connect/v2/#requestandresponseheaders) for the format of this header. + /// The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://developer.squareup.com/docs/api/connect/v2/#requestandresponseheaders) for the format of this header. /// - /// The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://docs.connect.squareup.com/api/connect/v2/#requestandresponseheaders) for the format of this header. + /// The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://developer.squareup.com/docs/api/connect/v2/#requestandresponseheaders) for the format of this header. [DataMember(Name="access_token", EmitDefaultValue=false)] public string AccessToken { get; set; } /// @@ -74,9 +74,9 @@ public partial class RenewTokenResponse : IEquatable, IVali [DataMember(Name="merchant_id", EmitDefaultValue=false)] public string MerchantId { get; set; } /// - /// __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization. + /// __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization.. /// - /// __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization. + /// __LEGACY FIELD__. The ID of the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization.. [DataMember(Name="subscription_id", EmitDefaultValue=false)] public string SubscriptionId { get; set; } /// diff --git a/src/Square.Connect/Model/RetrieveCatalogObjectRequest.cs b/src/Square.Connect/Model/RetrieveCatalogObjectRequest.cs index dbf5d74..24c0734 100644 --- a/src/Square.Connect/Model/RetrieveCatalogObjectRequest.cs +++ b/src/Square.Connect/Model/RetrieveCatalogObjectRequest.cs @@ -32,16 +32,16 @@ public partial class RetrieveCatalogObjectRequest : IEquatable /// Initializes a new instance of the class. /// - /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a `CatalogItem`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false`. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false`. public RetrieveCatalogObjectRequest(bool? IncludeRelatedObjects = default(bool?)) { this.IncludeRelatedObjects = 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` + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` /// - /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a `CatalogItem`, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` [DataMember(Name="include_related_objects", EmitDefaultValue=false)] public bool? IncludeRelatedObjects { get; set; } /// diff --git a/src/Square.Connect/Model/RetrieveCatalogObjectResponse.cs b/src/Square.Connect/Model/RetrieveCatalogObjectResponse.cs index 6100b24..e02fa2a 100644 --- a/src/Square.Connect/Model/RetrieveCatalogObjectResponse.cs +++ b/src/Square.Connect/Model/RetrieveCatalogObjectResponse.cs @@ -32,9 +32,9 @@ public partial class RetrieveCatalogObjectResponse : IEquatable /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. - /// The `CatalogObject`s returned.. - /// A list of `CatalogObject`s referenced by the object in the `object` field.. + /// Information on any errors encountered.. + /// The CatalogObjects returned.. + /// A list of CatalogObjects referenced by the object in the `object` field.. public RetrieveCatalogObjectResponse(List Errors = default(List), CatalogObject _Object = default(CatalogObject), List RelatedObjects = default(List)) { this.Errors = Errors; @@ -43,21 +43,21 @@ public partial class RetrieveCatalogObjectResponse : IEquatable - /// The set of `Error`s encountered. + /// Information on any errors encountered. /// - /// The set of `Error`s encountered. + /// Information on any errors encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// - /// The `CatalogObject`s returned. + /// The CatalogObjects returned. /// - /// The `CatalogObject`s returned. + /// The CatalogObjects returned. [DataMember(Name="object", EmitDefaultValue=false)] public CatalogObject _Object { get; set; } /// - /// A list of `CatalogObject`s referenced by the object in the `object` field. + /// A list of CatalogObjects referenced by the object in the `object` field. /// - /// A list of `CatalogObject`s referenced by the object in the `object` field. + /// A list of CatalogObjects referenced by the object in the `object` field. [DataMember(Name="related_objects", EmitDefaultValue=false)] public List RelatedObjects { get; set; } /// diff --git a/src/Square.Connect/Model/RetrieveEmployeeRequest.cs b/src/Square.Connect/Model/RetrieveEmployeeRequest.cs index 30959d5..62e5228 100644 --- a/src/Square.Connect/Model/RetrieveEmployeeRequest.cs +++ b/src/Square.Connect/Model/RetrieveEmployeeRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Retrieve an employee by `Employee.id` + /// /// [DataContract] public partial class RetrieveEmployeeRequest : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/RetrieveEmployeeResponse.cs b/src/Square.Connect/Model/RetrieveEmployeeResponse.cs index f24e738..7e5f1c8 100644 --- a/src/Square.Connect/Model/RetrieveEmployeeResponse.cs +++ b/src/Square.Connect/Model/RetrieveEmployeeResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in the response body of a request to the RetrieveEmployee endpoint. One of `errors` or `employee` is present in a given response (never both). + /// /// [DataContract] public partial class RetrieveEmployeeResponse : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/RetrieveInventoryChangesRequest.cs b/src/Square.Connect/Model/RetrieveInventoryChangesRequest.cs index fbbeeef..d2d2cd6 100644 --- a/src/Square.Connect/Model/RetrieveInventoryChangesRequest.cs +++ b/src/Square.Connect/Model/RetrieveInventoryChangesRequest.cs @@ -33,7 +33,7 @@ public partial class RetrieveInventoryChangesRequest : IEquatable class. /// /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations.. - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.. public RetrieveInventoryChangesRequest(string LocationIds = default(string), string Cursor = default(string)) { this.LocationIds = LocationIds; @@ -47,9 +47,9 @@ public partial class RetrieveInventoryChangesRequest : IEquatable - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/RetrieveInventoryChangesResponse.cs b/src/Square.Connect/Model/RetrieveInventoryChangesResponse.cs index e1d33cb..39a5928 100644 --- a/src/Square.Connect/Model/RetrieveInventoryChangesResponse.cs +++ b/src/Square.Connect/Model/RetrieveInventoryChangesResponse.cs @@ -34,7 +34,7 @@ public partial class RetrieveInventoryChangesResponse : IEquatable /// Any errors that occurred during the request.. /// The set of inventory changes for the requested object and locations.. - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.. public RetrieveInventoryChangesResponse(List Errors = default(List), List Changes = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -55,9 +55,9 @@ public partial class RetrieveInventoryChangesResponse : IEquatable Changes { get; set; } /// - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. /// - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/RetrieveInventoryCountRequest.cs b/src/Square.Connect/Model/RetrieveInventoryCountRequest.cs index 09d1a90..ee77a23 100644 --- a/src/Square.Connect/Model/RetrieveInventoryCountRequest.cs +++ b/src/Square.Connect/Model/RetrieveInventoryCountRequest.cs @@ -33,7 +33,7 @@ public partial class RetrieveInventoryCountRequest : IEquatable class. /// /// The `Location` IDs to look up as a comma-separated list. An empty list queries all locations.. - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.. public RetrieveInventoryCountRequest(string LocationIds = default(string), string Cursor = default(string)) { this.LocationIds = LocationIds; @@ -47,9 +47,9 @@ public partial class RetrieveInventoryCountRequest : IEquatable - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. /// - /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/RetrieveInventoryCountResponse.cs b/src/Square.Connect/Model/RetrieveInventoryCountResponse.cs index 76bcce9..99d29f9 100644 --- a/src/Square.Connect/Model/RetrieveInventoryCountResponse.cs +++ b/src/Square.Connect/Model/RetrieveInventoryCountResponse.cs @@ -34,7 +34,7 @@ public partial class RetrieveInventoryCountResponse : IEquatable /// Any errors that occurred during the request.. /// The current calculated inventory counts for the requested object and locations.. - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.. public RetrieveInventoryCountResponse(List Errors = default(List), List Counts = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -55,9 +55,9 @@ public partial class RetrieveInventoryCountResponse : IEquatable Counts { get; set; } /// - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. /// - /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/RetrieveLocationRequest.cs b/src/Square.Connect/Model/RetrieveLocationRequest.cs index 663fed7..9e278ef 100644 --- a/src/Square.Connect/Model/RetrieveLocationRequest.cs +++ b/src/Square.Connect/Model/RetrieveLocationRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that are included in the request body for the [RetrieveLocation](#endpoint-locations-retrievelocation) endpoint. + /// Defines the fields that are included in the request body for the __RetrieveLocation__ endpoint. /// [DataContract] public partial class RetrieveLocationRequest : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/RetrieveLocationResponse.cs b/src/Square.Connect/Model/RetrieveLocationResponse.cs index e1ce8b1..4982ca1 100644 --- a/src/Square.Connect/Model/RetrieveLocationResponse.cs +++ b/src/Square.Connect/Model/RetrieveLocationResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. + /// Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. /// [DataContract] public partial class RetrieveLocationResponse : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/RetrieveMerchantResponse.cs b/src/Square.Connect/Model/RetrieveMerchantResponse.cs index 170d989..0dfecd5 100644 --- a/src/Square.Connect/Model/RetrieveMerchantResponse.cs +++ b/src/Square.Connect/Model/RetrieveMerchantResponse.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// The response obeject returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. + /// The response object returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. /// [DataContract] public partial class RetrieveMerchantResponse : IEquatable, IValidatableObject diff --git a/src/Square.Connect/Model/RetrieveTransactionRequest.cs b/src/Square.Connect/Model/RetrieveTransactionRequest.cs index 63d2de8..59bd6cb 100644 --- a/src/Square.Connect/Model/RetrieveTransactionRequest.cs +++ b/src/Square.Connect/Model/RetrieveTransactionRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the request body fields for calls to the RetrieveTransaction endpoint. + /// /// [DataContract] [Obsolete] diff --git a/src/Square.Connect/Model/RevokeTokenRequest.cs b/src/Square.Connect/Model/RevokeTokenRequest.cs index 596bc4d..e168c1d 100644 --- a/src/Square.Connect/Model/RevokeTokenRequest.cs +++ b/src/Square.Connect/Model/RevokeTokenRequest.cs @@ -32,7 +32,7 @@ public partial class RevokeTokenRequest : IEquatable, IVali /// /// Initializes a new instance of the class. /// - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps).. + /// The Square issued ID for your application, available from the [application dashboard](https://connect.squareup.com/apps).. /// The access token of the merchant whose token you want to revoke. Do not provide a value for merchant_id if you provide this parameter.. /// The ID of the merchant whose token you want to revoke. Do not provide a value for access_token if you provide this parameter.. public RevokeTokenRequest(string ClientId = default(string), string AccessToken = default(string), string MerchantId = default(string)) @@ -43,9 +43,9 @@ public partial class RevokeTokenRequest : IEquatable, IVali } /// - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// The Square issued ID for your application, available from the [application dashboard](https://connect.squareup.com/apps). /// - /// Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + /// The Square issued ID for your application, available from the [application dashboard](https://connect.squareup.com/apps). [DataMember(Name="client_id", EmitDefaultValue=false)] public string ClientId { get; set; } /// diff --git a/src/Square.Connect/Model/SearchCatalogObjectsRequest.cs b/src/Square.Connect/Model/SearchCatalogObjectsRequest.cs index cd17cdc..7fd1665 100644 --- a/src/Square.Connect/Model/SearchCatalogObjectsRequest.cs +++ b/src/Square.Connect/Model/SearchCatalogObjectsRequest.cs @@ -33,10 +33,10 @@ public partial class SearchCatalogObjectsRequest : IEquatable class. /// /// 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.. - /// The desired set of object types to appear in the search results. The legal values are taken from the `CatalogObjectType` enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values. + /// The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values. /// If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`.. - /// 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 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.. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response. If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response.. + /// Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response.. /// A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned.. /// 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.. public SearchCatalogObjectsRequest(string Cursor = default(string), List ObjectTypes = default(List), bool? IncludeDeletedObjects = default(bool?), bool? IncludeRelatedObjects = default(bool?), string BeginTime = default(string), CatalogQuery Query = default(CatalogQuery), int? Limit = default(int?)) @@ -57,9 +57,9 @@ public partial class SearchCatalogObjectsRequest : IEquatable - /// The desired set of object types to appear in the search results. The legal values are taken from the `CatalogObjectType` enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values + /// The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values /// - /// The desired set of object types to appear in the search results. The legal values are taken from the `CatalogObjectType` enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values + /// The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values [DataMember(Name="object_types", EmitDefaultValue=false)] public List ObjectTypes { get; set; } /// @@ -69,15 +69,15 @@ public partial class SearchCatalogObjectsRequest : IEquatable - /// If `true`, the response will include additional objects that are related to the requested object, as follows: If a `CatalogItem` is returned in the object field of the response, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be included in the `related_objects` field of the response. If a `CatalogItemVariation` is returned in the object field of the response, its parent `CatalogItem` will be included in the `related_objects` field of the response. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response. If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response. /// - /// If `true`, the response will include additional objects that are related to the requested object, as follows: If a `CatalogItem` is returned in the object field of the response, its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be included in the `related_objects` field of the response. If a `CatalogItemVariation` is returned in the object field of the response, its parent `CatalogItem` will be included in the `related_objects` field of the response. + /// If `true`, the response will include additional objects that are related to the requested object, as follows: If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response. If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response. [DataMember(Name="include_related_objects", EmitDefaultValue=false)] public bool? IncludeRelatedObjects { get; set; } /// - /// Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. + /// Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. /// - /// Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. + /// Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. [DataMember(Name="begin_time", EmitDefaultValue=false)] public string BeginTime { get; set; } /// diff --git a/src/Square.Connect/Model/SearchCatalogObjectsResponse.cs b/src/Square.Connect/Model/SearchCatalogObjectsResponse.cs index 8495782..90f39c9 100644 --- a/src/Square.Connect/Model/SearchCatalogObjectsResponse.cs +++ b/src/Square.Connect/Model/SearchCatalogObjectsResponse.cs @@ -32,11 +32,11 @@ public partial class SearchCatalogObjectsResponse : IEquatable /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. + /// Information on any errors encountered.. /// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. - /// The `CatalogObject`s returned.. - /// A list of `CatalogObject`s referenced by the objects in the `objects` field.. - /// [beta] When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request.. + /// The CatalogObjects returned.. + /// A list of CatalogObjects referenced by the objects in the `objects` field.. + /// [beta] When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request.. public SearchCatalogObjectsResponse(List Errors = default(List), string Cursor = default(string), List Objects = default(List), List RelatedObjects = default(List), string LatestTime = default(string)) { this.Errors = Errors; @@ -47,9 +47,9 @@ public partial class SearchCatalogObjectsResponse : IEquatable - /// The set of `Error`s encountered. + /// Information on any errors encountered. /// - /// The set of `Error`s encountered. + /// Information on any errors encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// @@ -59,21 +59,21 @@ public partial class SearchCatalogObjectsResponse : IEquatable - /// The `CatalogObject`s returned. + /// The CatalogObjects returned. /// - /// The `CatalogObject`s returned. + /// The CatalogObjects returned. [DataMember(Name="objects", EmitDefaultValue=false)] public List Objects { get; set; } /// - /// A list of `CatalogObject`s referenced by the objects in the `objects` field. + /// A list of CatalogObjects referenced by the objects in the `objects` field. /// - /// A list of `CatalogObject`s referenced by the objects in the `objects` field. + /// A list of CatalogObjects referenced by the objects in the `objects` field. [DataMember(Name="related_objects", EmitDefaultValue=false)] public List RelatedObjects { get; set; } /// - /// When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. + /// When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. /// - /// When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. + /// When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. [DataMember(Name="latest_time", EmitDefaultValue=false)] public string LatestTime { get; set; } /// diff --git a/src/Square.Connect/Model/SearchCustomersRequest.cs b/src/Square.Connect/Model/SearchCustomersRequest.cs index 68ac7c7..519e5ba 100644 --- a/src/Square.Connect/Model/SearchCustomersRequest.cs +++ b/src/Square.Connect/Model/SearchCustomersRequest.cs @@ -32,7 +32,7 @@ public partial class SearchCustomersRequest : IEquatable /// Initializes a new instance of the class. /// - /// Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.. /// 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.. /// 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`.. public SearchCustomersRequest(string Cursor = default(string), long? Limit = default(long?), CustomerQuery Query = default(CustomerQuery)) @@ -43,9 +43,9 @@ public partial class SearchCustomersRequest : IEquatable - /// Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. /// - /// Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/SearchCustomersResponse.cs b/src/Square.Connect/Model/SearchCustomersResponse.cs index 4814c4d..0999557 100644 --- a/src/Square.Connect/Model/SearchCustomersResponse.cs +++ b/src/Square.Connect/Model/SearchCustomersResponse.cs @@ -34,7 +34,7 @@ public partial class SearchCustomersResponse : IEquatable /// Any errors that occurred during the request.. /// An array of `Customer` objects that match a query.. - /// A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.. + /// A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.. public SearchCustomersResponse(List Errors = default(List), List Customers = default(List), string Cursor = default(string)) { this.Errors = Errors; @@ -55,9 +55,9 @@ public partial class SearchCustomersResponse : IEquatable Customers { get; set; } /// - /// A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. /// - /// A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + /// A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. [DataMember(Name="cursor", EmitDefaultValue=false)] public string Cursor { get; set; } /// diff --git a/src/Square.Connect/Model/Shift.cs b/src/Square.Connect/Model/Shift.cs index 299b5b9..447cc96 100644 --- a/src/Square.Connect/Model/Shift.cs +++ b/src/Square.Connect/Model/Shift.cs @@ -43,7 +43,7 @@ protected Shift() { } /// Read-only convenience value that is calculated from the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone.. /// RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated. (required). /// RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the shift length is calculated. For example, a shift from `00:00` to `08:01` is considered an 8 hour shift (midnight to 8am).. - /// Job and pay related information.. + /// Job and pay related information. If wage is not set on create, will default to a wage of zero money. If title is not set on create, will default to the name of the role the employee is assigned to, if any.. /// A list of any paid or unpaid breaks that were taken during this shift.. /// Describes working state of the current `Shift`. See [ShiftStatus](#type-shiftstatus) for possible values. /// Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write.. @@ -118,9 +118,9 @@ protected Shift() { } [DataMember(Name="end_at", EmitDefaultValue=false)] public string EndAt { get; set; } /// - /// Job and pay related information. + /// Job and pay related information. If wage is not set on create, will default to a wage of zero money. If title is not set on create, will default to the name of the role the employee is assigned to, if any. /// - /// Job and pay related information. + /// Job and pay related information. If wage is not set on create, will default to a wage of zero money. If title is not set on create, will default to the name of the role the employee is assigned to, if any. [DataMember(Name="wage", EmitDefaultValue=false)] public ShiftWage Wage { get; set; } /// diff --git a/src/Square.Connect/Model/ShiftFilter.cs b/src/Square.Connect/Model/ShiftFilter.cs index cff2522..8ebeea2 100644 --- a/src/Square.Connect/Model/ShiftFilter.cs +++ b/src/Square.Connect/Model/ShiftFilter.cs @@ -32,16 +32,16 @@ public partial class ShiftFilter : IEquatable, IValidatableObject /// /// Initializes a new instance of the class. /// - /// Fetch shifts for the specified location.. - /// Fetch shifts for the specified employee.. + /// Fetch shifts for the specified location.. + /// Fetch shifts for the specified employee.. /// Fetch a `Shift` instance by `Shift.status`. See [ShiftFilterStatus](#type-shiftfilterstatus) for possible values. /// Fetch `Shift`s that start in the time range - Inclusive.. /// Fetch the `Shift`s that end in the time range - Inclusive.. /// Fetch the `Shift`s based on workday date range.. - public ShiftFilter(List LocationId = default(List), List EmployeeId = default(List), string Status = default(string), TimeRange Start = default(TimeRange), TimeRange End = default(TimeRange), ShiftWorkday Workday = default(ShiftWorkday)) + public ShiftFilter(List LocationIds = default(List), List EmployeeIds = default(List), string Status = default(string), TimeRange Start = default(TimeRange), TimeRange End = default(TimeRange), ShiftWorkday Workday = default(ShiftWorkday)) { - this.LocationId = LocationId; - this.EmployeeId = EmployeeId; + this.LocationIds = LocationIds; + this.EmployeeIds = EmployeeIds; this.Status = Status; this.Start = Start; this.End = End; @@ -52,14 +52,14 @@ public partial class ShiftFilter : IEquatable, IValidatableObject /// Fetch shifts for the specified location. /// /// Fetch shifts for the specified location. - [DataMember(Name="location_id", EmitDefaultValue=false)] - public List LocationId { get; set; } + [DataMember(Name="location_ids", EmitDefaultValue=false)] + public List LocationIds { get; set; } /// /// Fetch shifts for the specified employee. /// /// Fetch shifts for the specified employee. - [DataMember(Name="employee_id", EmitDefaultValue=false)] - public List EmployeeId { get; set; } + [DataMember(Name="employee_ids", EmitDefaultValue=false)] + public List EmployeeIds { get; set; } /// /// Fetch a `Shift` instance by `Shift.status`. See [ShiftFilterStatus](#type-shiftfilterstatus) for possible values /// @@ -92,8 +92,8 @@ public override string ToString() { var sb = new StringBuilder(); sb.Append("class ShiftFilter {\n"); - sb.Append(" LocationId: ").Append(LocationId).Append("\n"); - sb.Append(" EmployeeId: ").Append(EmployeeId).Append("\n"); + sb.Append(" LocationIds: ").Append(LocationIds).Append("\n"); + sb.Append(" EmployeeIds: ").Append(EmployeeIds).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" Start: ").Append(Start).Append("\n"); sb.Append(" End: ").Append(End).Append("\n"); @@ -135,14 +135,14 @@ public bool Equals(ShiftFilter other) return ( - this.LocationId == other.LocationId || - this.LocationId != null && - this.LocationId.SequenceEqual(other.LocationId) + this.LocationIds == other.LocationIds || + this.LocationIds != null && + this.LocationIds.SequenceEqual(other.LocationIds) ) && ( - this.EmployeeId == other.EmployeeId || - this.EmployeeId != null && - this.EmployeeId.SequenceEqual(other.EmployeeId) + this.EmployeeIds == other.EmployeeIds || + this.EmployeeIds != null && + this.EmployeeIds.SequenceEqual(other.EmployeeIds) ) && ( this.Status == other.Status || @@ -177,10 +177,10 @@ public override int GetHashCode() { int hash = 41; // Suitable nullity checks etc, of course :) - if (this.LocationId != null) - hash = hash * 59 + this.LocationId.GetHashCode(); - if (this.EmployeeId != null) - hash = hash * 59 + this.EmployeeId.GetHashCode(); + if (this.LocationIds != null) + hash = hash * 59 + this.LocationIds.GetHashCode(); + if (this.EmployeeIds != null) + hash = hash * 59 + this.EmployeeIds.GetHashCode(); if (this.Status != null) hash = hash * 59 + this.Status.GetHashCode(); if (this.Start != null) diff --git a/src/Square.Connect/Model/StandardUnitDescription.cs b/src/Square.Connect/Model/StandardUnitDescription.cs index d187a1d..84f2b40 100644 --- a/src/Square.Connect/Model/StandardUnitDescription.cs +++ b/src/Square.Connect/Model/StandardUnitDescription.cs @@ -33,8 +33,8 @@ public partial class StandardUnitDescription : IEquatable class. /// /// Identifies the measurement unit being described.. - /// Display name of the measurement unit. For example, 'Pound'.. - /// Abbreviation for the measurement unit. For example, 'lb'.. + /// UI display name of the measurement unit. For example, 'Pound'.. + /// UI display abbreviation for the measurement unit. For example, 'lb'.. public StandardUnitDescription(MeasurementUnit Unit = default(MeasurementUnit), string Name = default(string), string Abbreviation = default(string)) { this.Unit = Unit; @@ -49,15 +49,15 @@ public partial class StandardUnitDescription : IEquatable - /// Display name of the measurement unit. For example, 'Pound'. + /// UI display name of the measurement unit. For example, 'Pound'. /// - /// Display name of the measurement unit. For example, 'Pound'. + /// UI display name of the measurement unit. For example, 'Pound'. [DataMember(Name="name", EmitDefaultValue=false)] public string Name { get; set; } /// - /// Abbreviation for the measurement unit. For example, 'lb'. + /// UI display abbreviation for the measurement unit. For example, 'lb'. /// - /// Abbreviation for the measurement unit. For example, 'lb'. + /// UI display abbreviation for the measurement unit. For example, 'lb'. [DataMember(Name="abbreviation", EmitDefaultValue=false)] public string Abbreviation { get; set; } /// diff --git a/src/Square.Connect/Model/StandardUnitDescriptionGroup.cs b/src/Square.Connect/Model/StandardUnitDescriptionGroup.cs index 9629b45..d2e3c81 100644 --- a/src/Square.Connect/Model/StandardUnitDescriptionGroup.cs +++ b/src/Square.Connect/Model/StandardUnitDescriptionGroup.cs @@ -32,7 +32,7 @@ public partial class StandardUnitDescriptionGroup : IEquatable /// Initializes a new instance of the class. /// - /// List of measurement units in this description group.. + /// List of standard (non-custom) measurement units in this description group.. /// IETF language tag.. public StandardUnitDescriptionGroup(List StandardUnitDescriptions = default(List), string LanguageCode = default(string)) { @@ -41,9 +41,9 @@ public partial class StandardUnitDescriptionGroup : IEquatable - /// List of measurement units in this description group. + /// List of standard (non-custom) measurement units in this description group. /// - /// List of measurement units in this description group. + /// List of standard (non-custom) measurement units in this description group. [DataMember(Name="standard_unit_descriptions", EmitDefaultValue=false)] public List StandardUnitDescriptions { get; set; } /// diff --git a/src/Square.Connect/Model/TenderCardDetails.cs b/src/Square.Connect/Model/TenderCardDetails.cs index 43a567f..0fb01c9 100644 --- a/src/Square.Connect/Model/TenderCardDetails.cs +++ b/src/Square.Connect/Model/TenderCardDetails.cs @@ -32,7 +32,7 @@ public partial class TenderCardDetails : IEquatable, IValida /// /// Initializes a new instance of the class. /// - /// The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values. + /// The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See `TenderCardDetailsStatus` for possible values. See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values. /// The credit card's non-confidential details.. /// The method used to enter the card's details for the transaction. See [TenderCardDetailsEntryMethod](#type-tendercarddetailsentrymethod) for possible values. public TenderCardDetails(string Status = default(string), Card Card = default(Card), string EntryMethod = default(string)) @@ -43,9 +43,9 @@ public partial class TenderCardDetails : IEquatable, IValida } /// - /// The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values + /// The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See `TenderCardDetailsStatus` for possible values. See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values /// - /// The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values + /// The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See `TenderCardDetailsStatus` for possible values. See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values [DataMember(Name="status", EmitDefaultValue=false)] public string Status { get; set; } /// diff --git a/src/Square.Connect/Model/UpdateBreakTypeRequest.cs b/src/Square.Connect/Model/UpdateBreakTypeRequest.cs index cfe779d..114b48a 100644 --- a/src/Square.Connect/Model/UpdateBreakTypeRequest.cs +++ b/src/Square.Connect/Model/UpdateBreakTypeRequest.cs @@ -32,10 +32,23 @@ public partial class UpdateBreakTypeRequest : IEquatable /// Initializes a new instance of the class. /// - /// The updated `BreakType`.. + [JsonConstructorAttribute] + protected UpdateBreakTypeRequest() { } + /// + /// Initializes a new instance of the class. + /// + /// The updated `BreakType`. (required). public UpdateBreakTypeRequest(BreakType BreakType = default(BreakType)) { - this.BreakType = BreakType; + // to ensure "BreakType" is required (not null) + if (BreakType == null) + { + throw new InvalidDataException("BreakType is a required property for UpdateBreakTypeRequest and cannot be null"); + } + else + { + this.BreakType = BreakType; + } } /// diff --git a/src/Square.Connect/Model/UpdateCustomerRequest.cs b/src/Square.Connect/Model/UpdateCustomerRequest.cs index e07ef72..271e0b2 100644 --- a/src/Square.Connect/Model/UpdateCustomerRequest.cs +++ b/src/Square.Connect/Model/UpdateCustomerRequest.cs @@ -32,16 +32,16 @@ public partial class UpdateCustomerRequest : IEquatable, /// /// Initializes a new instance of the class. /// - /// The customer's given (i.e., first) name.. - /// The customer's family (i.e., last) name.. - /// The name of the customer's company.. - /// A nickname for the customer.. - /// The customer's email address.. - /// The customer's physical address.. - /// The customer's phone number.. - /// An optional second ID you can set to associate the customer with an entity in another system.. - /// An optional note to associate with the customer.. - /// The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.. + /// The given (i.e., first) name associated with the customer profile.. + /// The family (i.e., last) name associated with the customer profile.. + /// A business name associated with the customer profile.. + /// A nickname for the customer profile.. + /// The email address associated with the customer profile.. + /// The physical address associated with the customer profile.. + /// The 11-digit phone number associated with the customer profile.. + /// An optional, second ID used to associate the customer profile with an entity in another system.. + /// A custom note associated with the customer profile.. + /// The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__.. public UpdateCustomerRequest(string GivenName = default(string), string FamilyName = default(string), string CompanyName = default(string), string Nickname = default(string), string EmailAddress = default(string), Address Address = default(Address), string PhoneNumber = default(string), string ReferenceId = default(string), string Note = default(string), string Birthday = default(string)) { this.GivenName = GivenName; @@ -57,63 +57,63 @@ public partial class UpdateCustomerRequest : IEquatable, } /// - /// The customer's given (i.e., first) name. + /// The given (i.e., first) name associated with the customer profile. /// - /// The customer's given (i.e., first) name. + /// The given (i.e., first) name associated with the customer profile. [DataMember(Name="given_name", EmitDefaultValue=false)] public string GivenName { get; set; } /// - /// The customer's family (i.e., last) name. + /// The family (i.e., last) name associated with the customer profile. /// - /// The customer's family (i.e., last) name. + /// The family (i.e., last) name associated with the customer profile. [DataMember(Name="family_name", EmitDefaultValue=false)] public string FamilyName { get; set; } /// - /// The name of the customer's company. + /// A business name associated with the customer profile. /// - /// The name of the customer's company. + /// A business name associated with the customer profile. [DataMember(Name="company_name", EmitDefaultValue=false)] public string CompanyName { get; set; } /// - /// A nickname for the customer. + /// A nickname for the customer profile. /// - /// A nickname for the customer. + /// A nickname for the customer profile. [DataMember(Name="nickname", EmitDefaultValue=false)] public string Nickname { get; set; } /// - /// The customer's email address. + /// The email address associated with the customer profile. /// - /// The customer's email address. + /// The email address associated with the customer profile. [DataMember(Name="email_address", EmitDefaultValue=false)] public string EmailAddress { get; set; } /// - /// The customer's physical address. + /// The physical address associated with the customer profile. /// - /// The customer's physical address. + /// The physical address associated with the customer profile. [DataMember(Name="address", EmitDefaultValue=false)] public Address Address { get; set; } /// - /// The customer's phone number. + /// The 11-digit phone number associated with the customer profile. /// - /// The customer's phone number. + /// The 11-digit phone number associated with the customer profile. [DataMember(Name="phone_number", EmitDefaultValue=false)] public string PhoneNumber { get; set; } /// - /// An optional second ID you can set to associate the customer with an entity in another system. + /// An optional, second ID used to associate the customer profile with an entity in another system. /// - /// An optional second ID you can set to associate the customer with an entity in another system. + /// An optional, second ID used to associate the customer profile with an entity in another system. [DataMember(Name="reference_id", EmitDefaultValue=false)] public string ReferenceId { get; set; } /// - /// An optional note to associate with the customer. + /// A custom note associated with the customer profile. /// - /// An optional note to associate with the customer. + /// A custom note associated with the customer profile. [DataMember(Name="note", EmitDefaultValue=false)] public string Note { get; set; } /// - /// The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. + /// The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. /// - /// The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. + /// The birthday associated with the customer profile, in RFC-3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__. [DataMember(Name="birthday", EmitDefaultValue=false)] public string Birthday { get; set; } /// diff --git a/src/Square.Connect/Model/UpdateItemModifierListsRequest.cs b/src/Square.Connect/Model/UpdateItemModifierListsRequest.cs index f3175c0..f5ca94d 100644 --- a/src/Square.Connect/Model/UpdateItemModifierListsRequest.cs +++ b/src/Square.Connect/Model/UpdateItemModifierListsRequest.cs @@ -37,9 +37,9 @@ protected UpdateItemModifierListsRequest() { } /// /// Initializes a new instance of the class. /// - /// The `CatalogItem](#type-catalogitem)s whose [CatalogModifierList`s are being updated. (required). - /// The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem`.. - /// The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem`.. + /// The IDs of the catalog items associated with the CatalogModifierList objects being updated. (required). + /// The IDs of the CatalogModifierList objects to enable for the CatalogItem.. + /// The IDs of the CatalogModifierList objects to disable for the CatalogItem.. public UpdateItemModifierListsRequest(List ItemIds = default(List), List ModifierListsToEnable = default(List), List ModifierListsToDisable = default(List)) { // to ensure "ItemIds" is required (not null) @@ -56,21 +56,21 @@ protected UpdateItemModifierListsRequest() { } } /// - /// The `CatalogItem](#type-catalogitem)s whose [CatalogModifierList`s are being updated. + /// The IDs of the catalog items associated with the CatalogModifierList objects being updated. /// - /// The `CatalogItem](#type-catalogitem)s whose [CatalogModifierList`s are being updated. + /// The IDs of the catalog items associated with the CatalogModifierList objects being updated. [DataMember(Name="item_ids", EmitDefaultValue=false)] public List ItemIds { get; set; } /// - /// The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem`. + /// The IDs of the CatalogModifierList objects to enable for the CatalogItem. /// - /// The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to enable for the [CatalogItem`. + /// The IDs of the CatalogModifierList objects to enable for the CatalogItem. [DataMember(Name="modifier_lists_to_enable", EmitDefaultValue=false)] public List ModifierListsToEnable { get; set; } /// - /// The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem`. + /// The IDs of the CatalogModifierList objects to disable for the CatalogItem. /// - /// The set of `CatalogModifierList](#type-catalogmodifierlist)s (referenced by ID) to disable for the [CatalogItem`. + /// The IDs of the CatalogModifierList objects to disable for the CatalogItem. [DataMember(Name="modifier_lists_to_disable", EmitDefaultValue=false)] public List ModifierListsToDisable { get; set; } /// diff --git a/src/Square.Connect/Model/UpdateItemModifierListsResponse.cs b/src/Square.Connect/Model/UpdateItemModifierListsResponse.cs index 62c5a52..23c574e 100644 --- a/src/Square.Connect/Model/UpdateItemModifierListsResponse.cs +++ b/src/Square.Connect/Model/UpdateItemModifierListsResponse.cs @@ -32,8 +32,8 @@ public partial class UpdateItemModifierListsResponse : IEquatable /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. - /// The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".. + /// Information on any errors encountered.. + /// . public UpdateItemModifierListsResponse(List Errors = default(List), string UpdatedAt = default(string)) { this.Errors = Errors; @@ -41,15 +41,15 @@ public partial class UpdateItemModifierListsResponse : IEquatable - /// The set of `Error`s encountered. + /// Information on any errors encountered. /// - /// The set of `Error`s encountered. + /// Information on any errors encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// - /// The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// /// - /// The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// [DataMember(Name="updated_at", EmitDefaultValue=false)] public string UpdatedAt { get; set; } /// diff --git a/src/Square.Connect/Model/UpdateItemTaxesRequest.cs b/src/Square.Connect/Model/UpdateItemTaxesRequest.cs index 1f63481..ad52adf 100644 --- a/src/Square.Connect/Model/UpdateItemTaxesRequest.cs +++ b/src/Square.Connect/Model/UpdateItemTaxesRequest.cs @@ -37,9 +37,9 @@ protected UpdateItemTaxesRequest() { } /// /// Initializes a new instance of the class. /// - /// The `CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax`es are being updated. (required). - /// The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem`.. - /// The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem`.. + /// IDs for the CatalogItems associated with the CatalogTax objects being updated. (required). + /// IDs of the CatalogTax objects to enable.. + /// IDs of the CatalogTax objects to disable.. public UpdateItemTaxesRequest(List ItemIds = default(List), List TaxesToEnable = default(List), List TaxesToDisable = default(List)) { // to ensure "ItemIds" is required (not null) @@ -56,21 +56,21 @@ protected UpdateItemTaxesRequest() { } } /// - /// The `CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax`es are being updated. + /// IDs for the CatalogItems associated with the CatalogTax objects being updated. /// - /// The `CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax`es are being updated. + /// IDs for the CatalogItems associated with the CatalogTax objects being updated. [DataMember(Name="item_ids", EmitDefaultValue=false)] public List ItemIds { get; set; } /// - /// The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem`. + /// IDs of the CatalogTax objects to enable. /// - /// The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem`. + /// IDs of the CatalogTax objects to enable. [DataMember(Name="taxes_to_enable", EmitDefaultValue=false)] public List TaxesToEnable { get; set; } /// - /// The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem`. + /// IDs of the CatalogTax objects to disable. /// - /// The set of `CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem`. + /// IDs of the CatalogTax objects to disable. [DataMember(Name="taxes_to_disable", EmitDefaultValue=false)] public List TaxesToDisable { get; set; } /// diff --git a/src/Square.Connect/Model/UpdateItemTaxesResponse.cs b/src/Square.Connect/Model/UpdateItemTaxesResponse.cs index bc0a0aa..8812ec0 100644 --- a/src/Square.Connect/Model/UpdateItemTaxesResponse.cs +++ b/src/Square.Connect/Model/UpdateItemTaxesResponse.cs @@ -32,8 +32,8 @@ public partial class UpdateItemTaxesResponse : IEquatable /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. - /// The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".. + /// Information on any errors encountered.. + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-date) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`.. public UpdateItemTaxesResponse(List Errors = default(List), string UpdatedAt = default(string)) { this.Errors = Errors; @@ -41,15 +41,15 @@ public partial class UpdateItemTaxesResponse : IEquatable - /// The set of `Error`s encountered. + /// Information on any errors encountered. /// - /// The set of `Error`s encountered. + /// Information on any errors encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// - /// The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-date) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. /// - /// The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". + /// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-date) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. [DataMember(Name="updated_at", EmitDefaultValue=false)] public string UpdatedAt { get; set; } /// diff --git a/src/Square.Connect/Model/UpdateWorkweekConfigRequest.cs b/src/Square.Connect/Model/UpdateWorkweekConfigRequest.cs index f8c85ae..d5d057b 100644 --- a/src/Square.Connect/Model/UpdateWorkweekConfigRequest.cs +++ b/src/Square.Connect/Model/UpdateWorkweekConfigRequest.cs @@ -32,10 +32,23 @@ public partial class UpdateWorkweekConfigRequest : IEquatable /// Initializes a new instance of the class. /// - /// The updated `WorkweekConfig` object.. + [JsonConstructorAttribute] + protected UpdateWorkweekConfigRequest() { } + /// + /// Initializes a new instance of the class. + /// + /// The updated `WorkweekConfig` object. (required). public UpdateWorkweekConfigRequest(WorkweekConfig WorkweekConfig = default(WorkweekConfig)) { - this.WorkweekConfig = WorkweekConfig; + // to ensure "WorkweekConfig" is required (not null) + if (WorkweekConfig == null) + { + throw new InvalidDataException("WorkweekConfig is a required property for UpdateWorkweekConfigRequest and cannot be null"); + } + else + { + this.WorkweekConfig = WorkweekConfig; + } } /// diff --git a/src/Square.Connect/Model/UpsertCatalogObjectRequest.cs b/src/Square.Connect/Model/UpsertCatalogObjectRequest.cs index 7bbc0ff..9ba4247 100644 --- a/src/Square.Connect/Model/UpsertCatalogObjectRequest.cs +++ b/src/Square.Connect/Model/UpsertCatalogObjectRequest.cs @@ -38,7 +38,7 @@ protected UpsertCatalogObjectRequest() { } /// Initializes a new instance of the class. /// /// 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. (required). - /// 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. (required). + /// 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. (required). public UpsertCatalogObjectRequest(string IdempotencyKey = default(string), CatalogObject _Object = default(CatalogObject)) { // to ensure "IdempotencyKey" is required (not null) @@ -68,9 +68,9 @@ protected UpsertCatalogObjectRequest() { } [DataMember(Name="idempotency_key", EmitDefaultValue=false)] public string IdempotencyKey { get; set; } /// - /// A `CatalogObject` to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. + /// A CatalogObject to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. /// - /// A `CatalogObject` to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. + /// A CatalogObject to be created or updated. - For updates, the object must be active (the `is_deleted` field is not `true`). - For creates, the object ID must start with `#`. The provided ID is replaced with a server-generated ID. [DataMember(Name="object", EmitDefaultValue=false)] public CatalogObject _Object { get; set; } /// diff --git a/src/Square.Connect/Model/UpsertCatalogObjectResponse.cs b/src/Square.Connect/Model/UpsertCatalogObjectResponse.cs index 636ad35..f6e2329 100644 --- a/src/Square.Connect/Model/UpsertCatalogObjectResponse.cs +++ b/src/Square.Connect/Model/UpsertCatalogObjectResponse.cs @@ -32,9 +32,9 @@ public partial class UpsertCatalogObjectResponse : IEquatable /// Initializes a new instance of the class. /// - /// The set of `Error`s encountered.. - /// The created `CatalogObject`.. - /// The mapping between client and server IDs for this Upsert.. + /// Information on any errors encountered.. + /// The successfully created or updated CatalogObject.. + /// The mapping between client and server IDs for this upsert.. public UpsertCatalogObjectResponse(List Errors = default(List), CatalogObject CatalogObject = default(CatalogObject), List IdMappings = default(List)) { this.Errors = Errors; @@ -43,21 +43,21 @@ public partial class UpsertCatalogObjectResponse : IEquatable - /// The set of `Error`s encountered. + /// Information on any errors encountered. /// - /// The set of `Error`s encountered. + /// Information on any errors encountered. [DataMember(Name="errors", EmitDefaultValue=false)] public List Errors { get; set; } /// - /// The created `CatalogObject`. + /// The successfully created or updated CatalogObject. /// - /// The created `CatalogObject`. + /// The successfully created or updated CatalogObject. [DataMember(Name="catalog_object", EmitDefaultValue=false)] public CatalogObject CatalogObject { get; set; } /// - /// The mapping between client and server IDs for this Upsert. + /// The mapping between client and server IDs for this upsert. /// - /// The mapping between client and server IDs for this Upsert. + /// The mapping between client and server IDs for this upsert. [DataMember(Name="id_mappings", EmitDefaultValue=false)] public List IdMappings { get; set; } /// diff --git a/src/Square.Connect/Model/V1AdjustInventoryRequest.cs b/src/Square.Connect/Model/V1AdjustInventoryRequest.cs index 7b6c221..fa2a4d6 100644 --- a/src/Square.Connect/Model/V1AdjustInventoryRequest.cs +++ b/src/Square.Connect/Model/V1AdjustInventoryRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1AdjustInventoryRequest /// [DataContract] + [Obsolete] public partial class V1AdjustInventoryRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ApplyFeeRequest.cs b/src/Square.Connect/Model/V1ApplyFeeRequest.cs index d926962..998fd3b 100644 --- a/src/Square.Connect/Model/V1ApplyFeeRequest.cs +++ b/src/Square.Connect/Model/V1ApplyFeeRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ApplyFeeRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ApplyModifierListRequest.cs b/src/Square.Connect/Model/V1ApplyModifierListRequest.cs index a8b44ca..b77a993 100644 --- a/src/Square.Connect/Model/V1ApplyModifierListRequest.cs +++ b/src/Square.Connect/Model/V1ApplyModifierListRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ApplyModifierListRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1Category.cs b/src/Square.Connect/Model/V1Category.cs index 3a9a30a..56a6a6b 100644 --- a/src/Square.Connect/Model/V1Category.cs +++ b/src/Square.Connect/Model/V1Category.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1Category /// [DataContract] + [Obsolete] public partial class V1Category : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1CreateCategoryRequest.cs b/src/Square.Connect/Model/V1CreateCategoryRequest.cs index 9fbebb4..a5f8f2d 100644 --- a/src/Square.Connect/Model/V1CreateCategoryRequest.cs +++ b/src/Square.Connect/Model/V1CreateCategoryRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1CreateCategoryRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1CreateDiscountRequest.cs b/src/Square.Connect/Model/V1CreateDiscountRequest.cs index 49080fe..3627c26 100644 --- a/src/Square.Connect/Model/V1CreateDiscountRequest.cs +++ b/src/Square.Connect/Model/V1CreateDiscountRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1CreateDiscountRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1CreateFeeRequest.cs b/src/Square.Connect/Model/V1CreateFeeRequest.cs index 11319ff..b172ca1 100644 --- a/src/Square.Connect/Model/V1CreateFeeRequest.cs +++ b/src/Square.Connect/Model/V1CreateFeeRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1CreateFeeRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1CreateItemRequest.cs b/src/Square.Connect/Model/V1CreateItemRequest.cs index cbbc594..868a8c0 100644 --- a/src/Square.Connect/Model/V1CreateItemRequest.cs +++ b/src/Square.Connect/Model/V1CreateItemRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1CreateItemRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1CreateModifierListRequest.cs b/src/Square.Connect/Model/V1CreateModifierListRequest.cs index 6b0b5a0..a58e888 100644 --- a/src/Square.Connect/Model/V1CreateModifierListRequest.cs +++ b/src/Square.Connect/Model/V1CreateModifierListRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1CreateModifierListRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1CreateModifierOptionRequest.cs b/src/Square.Connect/Model/V1CreateModifierOptionRequest.cs index 4450811..30cb82a 100644 --- a/src/Square.Connect/Model/V1CreateModifierOptionRequest.cs +++ b/src/Square.Connect/Model/V1CreateModifierOptionRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1CreateModifierOptionRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1CreatePageRequest.cs b/src/Square.Connect/Model/V1CreatePageRequest.cs index 8d7b0d7..e8f1633 100644 --- a/src/Square.Connect/Model/V1CreatePageRequest.cs +++ b/src/Square.Connect/Model/V1CreatePageRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1CreatePageRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1CreateVariationRequest.cs b/src/Square.Connect/Model/V1CreateVariationRequest.cs index 22873d7..5269dc1 100644 --- a/src/Square.Connect/Model/V1CreateVariationRequest.cs +++ b/src/Square.Connect/Model/V1CreateVariationRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1CreateVariationRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1DeleteCategoryRequest.cs b/src/Square.Connect/Model/V1DeleteCategoryRequest.cs index 19534eb..1dba15d 100644 --- a/src/Square.Connect/Model/V1DeleteCategoryRequest.cs +++ b/src/Square.Connect/Model/V1DeleteCategoryRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1DeleteCategoryRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1DeleteDiscountRequest.cs b/src/Square.Connect/Model/V1DeleteDiscountRequest.cs index efc64e0..fd29cf6 100644 --- a/src/Square.Connect/Model/V1DeleteDiscountRequest.cs +++ b/src/Square.Connect/Model/V1DeleteDiscountRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1DeleteDiscountRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1DeleteFeeRequest.cs b/src/Square.Connect/Model/V1DeleteFeeRequest.cs index c36534b..72b6d68 100644 --- a/src/Square.Connect/Model/V1DeleteFeeRequest.cs +++ b/src/Square.Connect/Model/V1DeleteFeeRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1DeleteFeeRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1DeleteItemRequest.cs b/src/Square.Connect/Model/V1DeleteItemRequest.cs index c223831..6cbbdff 100644 --- a/src/Square.Connect/Model/V1DeleteItemRequest.cs +++ b/src/Square.Connect/Model/V1DeleteItemRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1DeleteItemRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1DeleteModifierListRequest.cs b/src/Square.Connect/Model/V1DeleteModifierListRequest.cs index 03d99c7..fe33806 100644 --- a/src/Square.Connect/Model/V1DeleteModifierListRequest.cs +++ b/src/Square.Connect/Model/V1DeleteModifierListRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1DeleteModifierListRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1DeleteModifierOptionRequest.cs b/src/Square.Connect/Model/V1DeleteModifierOptionRequest.cs index 5caa92a..8fde86b 100644 --- a/src/Square.Connect/Model/V1DeleteModifierOptionRequest.cs +++ b/src/Square.Connect/Model/V1DeleteModifierOptionRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1DeleteModifierOptionRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1DeletePageCellRequest.cs b/src/Square.Connect/Model/V1DeletePageCellRequest.cs index 4511cce..ef495bc 100644 --- a/src/Square.Connect/Model/V1DeletePageCellRequest.cs +++ b/src/Square.Connect/Model/V1DeletePageCellRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1DeletePageCellRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1DeletePageRequest.cs b/src/Square.Connect/Model/V1DeletePageRequest.cs index 45921e3..9c668fb 100644 --- a/src/Square.Connect/Model/V1DeletePageRequest.cs +++ b/src/Square.Connect/Model/V1DeletePageRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1DeletePageRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1DeleteVariationRequest.cs b/src/Square.Connect/Model/V1DeleteVariationRequest.cs index 2da03be..665fa8a 100644 --- a/src/Square.Connect/Model/V1DeleteVariationRequest.cs +++ b/src/Square.Connect/Model/V1DeleteVariationRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1DeleteVariationRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1Discount.cs b/src/Square.Connect/Model/V1Discount.cs index 51cd5b6..27947f2 100644 --- a/src/Square.Connect/Model/V1Discount.cs +++ b/src/Square.Connect/Model/V1Discount.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1Discount /// [DataContract] + [Obsolete] public partial class V1Discount : IEquatable, IValidatableObject { /// @@ -38,7 +39,7 @@ public partial class V1Discount : IEquatable, IValidatableObject /// The amount of the discount. This amount is 0 if discount_type is VARIABLE_AMOUNT. This field is not included for rate-based discounts.. /// Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values. /// Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.. - /// The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values. + /// The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values. /// The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.. public V1Discount(string Id = default(string), string Name = default(string), string Rate = default(string), V1Money AmountMoney = default(V1Money), string DiscountType = default(string), bool? PinRequired = default(bool?), string Color = default(string), string V2Id = default(string)) { @@ -89,9 +90,9 @@ public partial class V1Discount : IEquatable, IValidatableObject [DataMember(Name="pin_required", EmitDefaultValue=false)] public bool? PinRequired { get; set; } /// - /// The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values + /// The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values /// - /// The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values + /// The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values [DataMember(Name="color", EmitDefaultValue=false)] public string Color { get; set; } /// diff --git a/src/Square.Connect/Model/V1Fee.cs b/src/Square.Connect/Model/V1Fee.cs index 5350cc9..9b4e138 100644 --- a/src/Square.Connect/Model/V1Fee.cs +++ b/src/Square.Connect/Model/V1Fee.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1Fee /// [DataContract] + [Obsolete] public partial class V1Fee : IEquatable, IValidatableObject { /// @@ -37,7 +38,7 @@ public partial class V1Fee : IEquatable, IValidatableObject /// The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.. /// Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values. /// The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values. - /// If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item.. + /// If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item.. /// If true, the fee is applied to all appropriate items. If false, the fee is not applied at all.. /// Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values. /// In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values. @@ -87,9 +88,9 @@ public partial class V1Fee : IEquatable, IValidatableObject [DataMember(Name="adjustment_type", EmitDefaultValue=false)] public string AdjustmentType { get; set; } /// - /// If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item. + /// If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item. /// - /// If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item. + /// If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item. [DataMember(Name="applies_to_custom_amounts", EmitDefaultValue=false)] public bool? AppliesToCustomAmounts { get; set; } /// diff --git a/src/Square.Connect/Model/V1InventoryEntry.cs b/src/Square.Connect/Model/V1InventoryEntry.cs index f40d75e..1973555 100644 --- a/src/Square.Connect/Model/V1InventoryEntry.cs +++ b/src/Square.Connect/Model/V1InventoryEntry.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1InventoryEntry /// [DataContract] + [Obsolete] public partial class V1InventoryEntry : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1Item.cs b/src/Square.Connect/Model/V1Item.cs index e177c1b..c3e0b40 100644 --- a/src/Square.Connect/Model/V1Item.cs +++ b/src/Square.Connect/Model/V1Item.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1Item /// [DataContract] + [Obsolete] public partial class V1Item : IEquatable, IValidatableObject { /// @@ -36,8 +37,8 @@ public partial class V1Item : IEquatable, IValidatableObject /// The item's name.. /// The item's description.. /// The item's type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values. - /// The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values. - /// The text of the item's display label in Square Register. Only up to the first five characters of the string are used.. + /// The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values. + /// The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used.. /// Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values. /// If true, the item can be added to shipping orders from the merchant's online store.. /// The item's master image, if any.. @@ -95,15 +96,15 @@ public partial class V1Item : IEquatable, IValidatableObject [DataMember(Name="type", EmitDefaultValue=false)] public string Type { get; set; } /// - /// The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values + /// The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values /// - /// The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values + /// The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values [DataMember(Name="color", EmitDefaultValue=false)] public string Color { get; set; } /// - /// The text of the item's display label in Square Register. Only up to the first five characters of the string are used. + /// The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used. /// - /// The text of the item's display label in Square Register. Only up to the first five characters of the string are used. + /// The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used. [DataMember(Name="abbreviation", EmitDefaultValue=false)] public string Abbreviation { get; set; } /// diff --git a/src/Square.Connect/Model/V1ItemImage.cs b/src/Square.Connect/Model/V1ItemImage.cs index 6628a08..e8201e9 100644 --- a/src/Square.Connect/Model/V1ItemImage.cs +++ b/src/Square.Connect/Model/V1ItemImage.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1ItemImage /// [DataContract] + [Obsolete] public partial class V1ItemImage : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListCategoriesRequest.cs b/src/Square.Connect/Model/V1ListCategoriesRequest.cs index 407c0e5..e4e8dfa 100644 --- a/src/Square.Connect/Model/V1ListCategoriesRequest.cs +++ b/src/Square.Connect/Model/V1ListCategoriesRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListCategoriesRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListCategoriesResponse.cs b/src/Square.Connect/Model/V1ListCategoriesResponse.cs index e2f68a5..491ba64 100644 --- a/src/Square.Connect/Model/V1ListCategoriesResponse.cs +++ b/src/Square.Connect/Model/V1ListCategoriesResponse.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListCategoriesResponse : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListDiscountsRequest.cs b/src/Square.Connect/Model/V1ListDiscountsRequest.cs index 2dfb98d..506be73 100644 --- a/src/Square.Connect/Model/V1ListDiscountsRequest.cs +++ b/src/Square.Connect/Model/V1ListDiscountsRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListDiscountsRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListDiscountsResponse.cs b/src/Square.Connect/Model/V1ListDiscountsResponse.cs index 8792295..e7cd453 100644 --- a/src/Square.Connect/Model/V1ListDiscountsResponse.cs +++ b/src/Square.Connect/Model/V1ListDiscountsResponse.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListDiscountsResponse : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListFeesRequest.cs b/src/Square.Connect/Model/V1ListFeesRequest.cs index 76f743d..f01ed71 100644 --- a/src/Square.Connect/Model/V1ListFeesRequest.cs +++ b/src/Square.Connect/Model/V1ListFeesRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListFeesRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListFeesResponse.cs b/src/Square.Connect/Model/V1ListFeesResponse.cs index 3914200..70e2ff3 100644 --- a/src/Square.Connect/Model/V1ListFeesResponse.cs +++ b/src/Square.Connect/Model/V1ListFeesResponse.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListFeesResponse : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListInventoryRequest.cs b/src/Square.Connect/Model/V1ListInventoryRequest.cs index 3524b26..4fec52f 100644 --- a/src/Square.Connect/Model/V1ListInventoryRequest.cs +++ b/src/Square.Connect/Model/V1ListInventoryRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListInventoryRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListInventoryResponse.cs b/src/Square.Connect/Model/V1ListInventoryResponse.cs index 54ee792..5b650f0 100644 --- a/src/Square.Connect/Model/V1ListInventoryResponse.cs +++ b/src/Square.Connect/Model/V1ListInventoryResponse.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListInventoryResponse : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListItemsRequest.cs b/src/Square.Connect/Model/V1ListItemsRequest.cs index fadbd2a..9e9e133 100644 --- a/src/Square.Connect/Model/V1ListItemsRequest.cs +++ b/src/Square.Connect/Model/V1ListItemsRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListItemsRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListItemsResponse.cs b/src/Square.Connect/Model/V1ListItemsResponse.cs index f461e7d..5f36ef7 100644 --- a/src/Square.Connect/Model/V1ListItemsResponse.cs +++ b/src/Square.Connect/Model/V1ListItemsResponse.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListItemsResponse : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListLocationsRequest.cs b/src/Square.Connect/Model/V1ListLocationsRequest.cs index debaa2f..c6c4d3e 100644 --- a/src/Square.Connect/Model/V1ListLocationsRequest.cs +++ b/src/Square.Connect/Model/V1ListLocationsRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListLocationsRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListLocationsResponse.cs b/src/Square.Connect/Model/V1ListLocationsResponse.cs index bf0d0dc..393a9f1 100644 --- a/src/Square.Connect/Model/V1ListLocationsResponse.cs +++ b/src/Square.Connect/Model/V1ListLocationsResponse.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListLocationsResponse : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListModifierListsRequest.cs b/src/Square.Connect/Model/V1ListModifierListsRequest.cs index bd49a73..37210d9 100644 --- a/src/Square.Connect/Model/V1ListModifierListsRequest.cs +++ b/src/Square.Connect/Model/V1ListModifierListsRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListModifierListsRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListModifierListsResponse.cs b/src/Square.Connect/Model/V1ListModifierListsResponse.cs index bfd0fa2..1456212 100644 --- a/src/Square.Connect/Model/V1ListModifierListsResponse.cs +++ b/src/Square.Connect/Model/V1ListModifierListsResponse.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListModifierListsResponse : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListPagesRequest.cs b/src/Square.Connect/Model/V1ListPagesRequest.cs index 4afb0b9..e8da8f7 100644 --- a/src/Square.Connect/Model/V1ListPagesRequest.cs +++ b/src/Square.Connect/Model/V1ListPagesRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListPagesRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ListPagesResponse.cs b/src/Square.Connect/Model/V1ListPagesResponse.cs index 96cd97e..bf47d05 100644 --- a/src/Square.Connect/Model/V1ListPagesResponse.cs +++ b/src/Square.Connect/Model/V1ListPagesResponse.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1ListPagesResponse : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1Merchant.cs b/src/Square.Connect/Model/V1Merchant.cs index 1349765..43e9530 100644 --- a/src/Square.Connect/Model/V1Merchant.cs +++ b/src/Square.Connect/Model/V1Merchant.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// Defines the fields that are included in the response body of a request to the **RetrieveBusiness** endpoint. /// [DataContract] + [Obsolete] public partial class V1Merchant : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1MerchantLocationDetails.cs b/src/Square.Connect/Model/V1MerchantLocationDetails.cs index 2928808..4e95dd6 100644 --- a/src/Square.Connect/Model/V1MerchantLocationDetails.cs +++ b/src/Square.Connect/Model/V1MerchantLocationDetails.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// Additional information for a single-location account specified by its associated business account, if it has one. /// [DataContract] + [Obsolete] public partial class V1MerchantLocationDetails : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ModifierList.cs b/src/Square.Connect/Model/V1ModifierList.cs index 5fe3f00..550dac3 100644 --- a/src/Square.Connect/Model/V1ModifierList.cs +++ b/src/Square.Connect/Model/V1ModifierList.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1ModifierList /// [DataContract] + [Obsolete] public partial class V1ModifierList : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1ModifierOption.cs b/src/Square.Connect/Model/V1ModifierOption.cs index 0384ebc..cd826f4 100644 --- a/src/Square.Connect/Model/V1ModifierOption.cs +++ b/src/Square.Connect/Model/V1ModifierOption.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1ModifierOption /// [DataContract] + [Obsolete] public partial class V1ModifierOption : IEquatable, IValidatableObject { /// @@ -36,7 +37,7 @@ public partial class V1ModifierOption : IEquatable, IValidata /// The modifier option's name.. /// The modifier option's price.. /// If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.. - /// Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.. + /// Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.. /// The ID of the modifier list the option belongs to.. /// The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.. public V1ModifierOption(string Id = default(string), string Name = default(string), V1Money PriceMoney = default(V1Money), bool? OnByDefault = default(bool?), int? Ordinal = default(int?), string ModifierListId = default(string), string V2Id = default(string)) @@ -75,9 +76,9 @@ public partial class V1ModifierOption : IEquatable, IValidata [DataMember(Name="on_by_default", EmitDefaultValue=false)] public bool? OnByDefault { get; set; } /// - /// Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. + /// Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. /// - /// Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. + /// Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order. [DataMember(Name="ordinal", EmitDefaultValue=false)] public int? Ordinal { get; set; } /// diff --git a/src/Square.Connect/Model/V1Money.cs b/src/Square.Connect/Model/V1Money.cs index 0e0c1ff..9045bd8 100644 --- a/src/Square.Connect/Model/V1Money.cs +++ b/src/Square.Connect/Model/V1Money.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1Money : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1Page.cs b/src/Square.Connect/Model/V1Page.cs index d0f4f2b..5c0610f 100644 --- a/src/Square.Connect/Model/V1Page.cs +++ b/src/Square.Connect/Model/V1Page.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1Page /// [DataContract] + [Obsolete] public partial class V1Page : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1PageCell.cs b/src/Square.Connect/Model/V1PageCell.cs index 4fb1ac6..2edfc30 100644 --- a/src/Square.Connect/Model/V1PageCell.cs +++ b/src/Square.Connect/Model/V1PageCell.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1PageCell /// [DataContract] + [Obsolete] public partial class V1PageCell : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1PhoneNumber.cs b/src/Square.Connect/Model/V1PhoneNumber.cs index 26a7241..29b0d42 100644 --- a/src/Square.Connect/Model/V1PhoneNumber.cs +++ b/src/Square.Connect/Model/V1PhoneNumber.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// Represents a phone number. /// [DataContract] + [Obsolete] public partial class V1PhoneNumber : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1RemoveFeeRequest.cs b/src/Square.Connect/Model/V1RemoveFeeRequest.cs index c472dcb..bb1a329 100644 --- a/src/Square.Connect/Model/V1RemoveFeeRequest.cs +++ b/src/Square.Connect/Model/V1RemoveFeeRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1RemoveFeeRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1RemoveModifierListRequest.cs b/src/Square.Connect/Model/V1RemoveModifierListRequest.cs index 0144ae7..7f941c6 100644 --- a/src/Square.Connect/Model/V1RemoveModifierListRequest.cs +++ b/src/Square.Connect/Model/V1RemoveModifierListRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1RemoveModifierListRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1RetrieveBusinessRequest.cs b/src/Square.Connect/Model/V1RetrieveBusinessRequest.cs index 3bc2568..0d92582 100644 --- a/src/Square.Connect/Model/V1RetrieveBusinessRequest.cs +++ b/src/Square.Connect/Model/V1RetrieveBusinessRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1RetrieveBusinessRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1RetrieveItemRequest.cs b/src/Square.Connect/Model/V1RetrieveItemRequest.cs index 48028bb..2365519 100644 --- a/src/Square.Connect/Model/V1RetrieveItemRequest.cs +++ b/src/Square.Connect/Model/V1RetrieveItemRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1RetrieveItemRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1RetrieveModifierListRequest.cs b/src/Square.Connect/Model/V1RetrieveModifierListRequest.cs index 858da34..b94db2e 100644 --- a/src/Square.Connect/Model/V1RetrieveModifierListRequest.cs +++ b/src/Square.Connect/Model/V1RetrieveModifierListRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1RetrieveModifierListRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1Tender.cs b/src/Square.Connect/Model/V1Tender.cs index e0410de..b3c9041 100644 --- a/src/Square.Connect/Model/V1Tender.cs +++ b/src/Square.Connect/Model/V1Tender.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The `tender` field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url fields of the corresponding Tender objects. *A note on gift cards**: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A `Tender` object with a type of `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the associated payment. /// [DataContract] + [Obsolete] public partial class V1Tender : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1UpdateCategoryRequest.cs b/src/Square.Connect/Model/V1UpdateCategoryRequest.cs index d7cdf1b..f156590 100644 --- a/src/Square.Connect/Model/V1UpdateCategoryRequest.cs +++ b/src/Square.Connect/Model/V1UpdateCategoryRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1UpdateCategoryRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1UpdateDiscountRequest.cs b/src/Square.Connect/Model/V1UpdateDiscountRequest.cs index 86d55e9..1a48a69 100644 --- a/src/Square.Connect/Model/V1UpdateDiscountRequest.cs +++ b/src/Square.Connect/Model/V1UpdateDiscountRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1UpdateDiscountRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1UpdateFeeRequest.cs b/src/Square.Connect/Model/V1UpdateFeeRequest.cs index f372ae2..c3b39c3 100644 --- a/src/Square.Connect/Model/V1UpdateFeeRequest.cs +++ b/src/Square.Connect/Model/V1UpdateFeeRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1UpdateFeeRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1UpdateItemRequest.cs b/src/Square.Connect/Model/V1UpdateItemRequest.cs index 565f15a..ccbe76e 100644 --- a/src/Square.Connect/Model/V1UpdateItemRequest.cs +++ b/src/Square.Connect/Model/V1UpdateItemRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1UpdateItemRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1UpdateModifierListRequest.cs b/src/Square.Connect/Model/V1UpdateModifierListRequest.cs index 040d88c..510d6db 100644 --- a/src/Square.Connect/Model/V1UpdateModifierListRequest.cs +++ b/src/Square.Connect/Model/V1UpdateModifierListRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1UpdateModifierListRequest /// [DataContract] + [Obsolete] public partial class V1UpdateModifierListRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1UpdateModifierOptionRequest.cs b/src/Square.Connect/Model/V1UpdateModifierOptionRequest.cs index 6f420a2..ecd4cc5 100644 --- a/src/Square.Connect/Model/V1UpdateModifierOptionRequest.cs +++ b/src/Square.Connect/Model/V1UpdateModifierOptionRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1UpdateModifierOptionRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1UpdatePageCellRequest.cs b/src/Square.Connect/Model/V1UpdatePageCellRequest.cs index 3b46c72..7d63ce2 100644 --- a/src/Square.Connect/Model/V1UpdatePageCellRequest.cs +++ b/src/Square.Connect/Model/V1UpdatePageCellRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1UpdatePageCellRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1UpdatePageRequest.cs b/src/Square.Connect/Model/V1UpdatePageRequest.cs index a34d390..54be2e2 100644 --- a/src/Square.Connect/Model/V1UpdatePageRequest.cs +++ b/src/Square.Connect/Model/V1UpdatePageRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1UpdatePageRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1UpdateVariationRequest.cs b/src/Square.Connect/Model/V1UpdateVariationRequest.cs index a27b341..95f0b65 100644 --- a/src/Square.Connect/Model/V1UpdateVariationRequest.cs +++ b/src/Square.Connect/Model/V1UpdateVariationRequest.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// /// [DataContract] + [Obsolete] public partial class V1UpdateVariationRequest : IEquatable, IValidatableObject { /// diff --git a/src/Square.Connect/Model/V1Variation.cs b/src/Square.Connect/Model/V1Variation.cs index 3c72de5..9448a60 100644 --- a/src/Square.Connect/Model/V1Variation.cs +++ b/src/Square.Connect/Model/V1Variation.cs @@ -27,6 +27,7 @@ namespace Square.Connect.Model /// V1Variation /// [DataContract] + [Obsolete] public partial class V1Variation : IEquatable, IValidatableObject { /// @@ -35,7 +36,7 @@ public partial class V1Variation : IEquatable, IValidatableObject /// The item variation's unique ID.. /// The item variation's name.. /// The ID of the variation's associated item.. - /// Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order. + /// Indicates the variation's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order. /// Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values. /// The item variation's price, if any.. /// The item variation's SKU, if any.. @@ -79,9 +80,9 @@ public partial class V1Variation : IEquatable, IValidatableObject [DataMember(Name="item_id", EmitDefaultValue=false)] public string ItemId { get; set; } /// - /// Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order + /// Indicates the variation's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order /// - /// Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order + /// Indicates the variation's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order [DataMember(Name="ordinal", EmitDefaultValue=false)] public int? Ordinal { get; set; } /// diff --git a/src/Square.Connect/Model/VoidTransactionRequest.cs b/src/Square.Connect/Model/VoidTransactionRequest.cs index 1e1e91b..c84b8c6 100644 --- a/src/Square.Connect/Model/VoidTransactionRequest.cs +++ b/src/Square.Connect/Model/VoidTransactionRequest.cs @@ -24,7 +24,7 @@ namespace Square.Connect.Model { /// - /// Defines the request body for calls to the VoidTransaction endpoint. + /// /// [DataContract] [Obsolete] diff --git a/src/Square.Connect/Properties/AssemblyInfo.cs b/src/Square.Connect/Properties/AssemblyInfo.cs index 4b80210..b5898ec 100644 --- a/src/Square.Connect/Properties/AssemblyInfo.cs +++ b/src/Square.Connect/Properties/AssemblyInfo.cs @@ -28,6 +28,6 @@ // You can specify all the values or you can default the Build and Revision Numbers // by using the '*' as shown below: // [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("2.24.0")] -[assembly: AssemblyFileVersion("2.24.0")] -[assembly: AssemblyInformationalVersion("Square-Connect-CSharp/2.20191023.0")] +[assembly: AssemblyVersion("2.25.0")] +[assembly: AssemblyFileVersion("2.25.0")] +[assembly: AssemblyInformationalVersion("Square-Connect-CSharp/2.20191120.0")] diff --git a/src/Square.Connect/Square.Connect.nuspec b/src/Square.Connect/Square.Connect.nuspec index 270f2f3..b169afe 100644 --- a/src/Square.Connect/Square.Connect.nuspec +++ b/src/Square.Connect/Square.Connect.nuspec @@ -6,7 +6,7 @@ Square.Connect - 2.24.0 + 2.25.0 Square