| Package | Description |
|---|---|
| com.squareup.square | |
| com.squareup.square.api |
| Modifier and Type | Method and Description |
|---|---|
static void |
ApiHelper.populate(String json,
ApiException obj)
Populates an object of an ApiException subclass with the required properties.
|
| Modifier and Type | Method and Description |
|---|---|
HttpRequest |
AuthManager.apply(HttpRequest httpRequest)
Adds authentication to the given HttpRequest.
|
| Modifier and Type | Method and Description |
|---|---|
AcceptDisputeResponse |
DefaultDisputesApi.acceptDispute(String disputeId)
Accepts the loss on a dispute.
|
AcceptDisputeResponse |
DisputesApi.acceptDispute(String disputeId)
Accepts the loss on a dispute.
|
AccumulateLoyaltyPointsResponse |
LoyaltyApi.accumulateLoyaltyPoints(String accountId,
AccumulateLoyaltyPointsRequest body)
Adds points to a loyalty account.
|
AccumulateLoyaltyPointsResponse |
DefaultLoyaltyApi.accumulateLoyaltyPoints(String accountId,
AccumulateLoyaltyPointsRequest body)
Adds points to a loyalty account.
|
AddGroupToCustomerResponse |
DefaultCustomersApi.addGroupToCustomer(String customerId,
String groupId)
Adds a group membership to a customer.
|
AddGroupToCustomerResponse |
CustomersApi.addGroupToCustomer(String customerId,
String groupId)
Adds a group membership to a customer.
|
AdjustLoyaltyPointsResponse |
LoyaltyApi.adjustLoyaltyPoints(String accountId,
AdjustLoyaltyPointsRequest body)
Adds points to or subtracts points from a buyer's account.
|
AdjustLoyaltyPointsResponse |
DefaultLoyaltyApi.adjustLoyaltyPoints(String accountId,
AdjustLoyaltyPointsRequest body)
Adds points to or subtracts points from a buyer's account.
|
BatchChangeInventoryResponse |
DefaultInventoryApi.batchChangeInventory(BatchChangeInventoryRequest body)
Applies adjustments and counts to the provided item quantities.
|
BatchChangeInventoryResponse |
InventoryApi.batchChangeInventory(BatchChangeInventoryRequest body)
Applies adjustments and counts to the provided item quantities.
|
BatchDeleteCatalogObjectsResponse |
DefaultCatalogApi.batchDeleteCatalogObjects(BatchDeleteCatalogObjectsRequest body)
Deletes a set of [CatalogItem]($m/CatalogItem)s based on the provided list of target IDs and
returns a set of successfully deleted IDs in the response.
|
BatchDeleteCatalogObjectsResponse |
CatalogApi.batchDeleteCatalogObjects(BatchDeleteCatalogObjectsRequest body)
Deletes a set of [CatalogItem]($m/CatalogItem)s based on the provided list of target IDs and
returns a set of successfully deleted IDs in the response.
|
BatchRetrieveCatalogObjectsResponse |
DefaultCatalogApi.batchRetrieveCatalogObjects(BatchRetrieveCatalogObjectsRequest body)
Returns a set of objects based on the provided ID.
|
BatchRetrieveCatalogObjectsResponse |
CatalogApi.batchRetrieveCatalogObjects(BatchRetrieveCatalogObjectsRequest body)
Returns a set of objects based on the provided ID.
|
BatchRetrieveInventoryChangesResponse |
DefaultInventoryApi.batchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest body)
Returns historical physical counts and adjustments based on the provided filter criteria.
|
BatchRetrieveInventoryChangesResponse |
InventoryApi.batchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest body)
Returns historical physical counts and adjustments based on the provided filter criteria.
|
BatchRetrieveInventoryCountsResponse |
DefaultInventoryApi.batchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest body)
Returns current counts for the provided [CatalogObject]($m/CatalogObject)s at the requested
[Location]($m/Location)s.
|
BatchRetrieveInventoryCountsResponse |
InventoryApi.batchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest body)
Returns current counts for the provided [CatalogObject]($m/CatalogObject)s at the requested
[Location]($m/Location)s.
|
BatchRetrieveOrdersResponse |
OrdersApi.batchRetrieveOrders(BatchRetrieveOrdersRequest body)
Retrieves a set of [orders]($m/Order) by their IDs.
|
BatchRetrieveOrdersResponse |
DefaultOrdersApi.batchRetrieveOrders(BatchRetrieveOrdersRequest body)
Retrieves a set of [orders]($m/Order) by their IDs.
|
BatchUpsertCatalogObjectsResponse |
DefaultCatalogApi.batchUpsertCatalogObjects(BatchUpsertCatalogObjectsRequest body)
Creates or updates up to 10,000 target objects based on the provided list of objects.
|
BatchUpsertCatalogObjectsResponse |
CatalogApi.batchUpsertCatalogObjects(BatchUpsertCatalogObjectsRequest body)
Creates or updates up to 10,000 target objects based on the provided list of objects.
|
BulkCreateTeamMembersResponse |
DefaultTeamApi.bulkCreateTeamMembers(BulkCreateTeamMembersRequest body)
Creates multiple `TeamMember` objects.
|
BulkCreateTeamMembersResponse |
TeamApi.bulkCreateTeamMembers(BulkCreateTeamMembersRequest body)
Creates multiple `TeamMember` objects.
|
BulkCreateVendorsResponse |
VendorsApi.bulkCreateVendors(BulkCreateVendorsRequest body)
Creates one or more [Vendor]($m/Vendor) objects to represent suppliers to a seller.
|
BulkCreateVendorsResponse |
DefaultVendorsApi.bulkCreateVendors(BulkCreateVendorsRequest body)
Creates one or more [Vendor]($m/Vendor) objects to represent suppliers to a seller.
|
BulkRetrieveVendorsResponse |
VendorsApi.bulkRetrieveVendors(BulkRetrieveVendorsRequest body)
Retrieves one or more vendors of specified [Vendor]($m/Vendor) IDs.
|
BulkRetrieveVendorsResponse |
DefaultVendorsApi.bulkRetrieveVendors(BulkRetrieveVendorsRequest body)
Retrieves one or more vendors of specified [Vendor]($m/Vendor) IDs.
|
BulkUpdateTeamMembersResponse |
DefaultTeamApi.bulkUpdateTeamMembers(BulkUpdateTeamMembersRequest body)
Updates multiple `TeamMember` objects.
|
BulkUpdateTeamMembersResponse |
TeamApi.bulkUpdateTeamMembers(BulkUpdateTeamMembersRequest body)
Updates multiple `TeamMember` objects.
|
BulkUpdateVendorsResponse |
VendorsApi.bulkUpdateVendors(BulkUpdateVendorsRequest body)
Updates one or more of existing [Vendor]($m/Vendor) objects as suppliers to a seller.
|
BulkUpdateVendorsResponse |
DefaultVendorsApi.bulkUpdateVendors(BulkUpdateVendorsRequest body)
Updates one or more of existing [Vendor]($m/Vendor) objects as suppliers to a seller.
|
BulkUpsertCustomerCustomAttributesResponse |
DefaultCustomerCustomAttributesApi.bulkUpsertCustomerCustomAttributes(BulkUpsertCustomerCustomAttributesRequest body)
Creates or updates custom attributes for customer profiles as a bulk operation.
|
BulkUpsertCustomerCustomAttributesResponse |
CustomerCustomAttributesApi.bulkUpsertCustomerCustomAttributes(BulkUpsertCustomerCustomAttributesRequest body)
Creates or updates custom attributes for customer profiles as a bulk operation.
|
CalculateLoyaltyPointsResponse |
LoyaltyApi.calculateLoyaltyPoints(String programId,
CalculateLoyaltyPointsRequest body)
Calculates the points a purchase earns.
|
CalculateLoyaltyPointsResponse |
DefaultLoyaltyApi.calculateLoyaltyPoints(String programId,
CalculateLoyaltyPointsRequest body)
Calculates the points a purchase earns.
|
CalculateOrderResponse |
OrdersApi.calculateOrder(CalculateOrderRequest body)
Enables applications to preview order pricing without creating an order.
|
CalculateOrderResponse |
DefaultOrdersApi.calculateOrder(CalculateOrderRequest body)
Enables applications to preview order pricing without creating an order.
|
CancelBookingResponse |
DefaultBookingsApi.cancelBooking(String bookingId,
CancelBookingRequest body)
Cancels an existing booking.
|
CancelBookingResponse |
BookingsApi.cancelBooking(String bookingId,
CancelBookingRequest body)
Cancels an existing booking.
|
CancelInvoiceResponse |
DefaultInvoicesApi.cancelInvoice(String invoiceId,
CancelInvoiceRequest body)
Cancels an invoice.
|
CancelInvoiceResponse |
InvoicesApi.cancelInvoice(String invoiceId,
CancelInvoiceRequest body)
Cancels an invoice.
|
CancelPaymentResponse |
PaymentsApi.cancelPayment(String paymentId)
Cancels (voids) a payment.
|
CancelPaymentResponse |
DefaultPaymentsApi.cancelPayment(String paymentId)
Cancels (voids) a payment.
|
CancelPaymentByIdempotencyKeyResponse |
PaymentsApi.cancelPaymentByIdempotencyKey(CancelPaymentByIdempotencyKeyRequest body)
Cancels (voids) a payment identified by the idempotency key that is specified in the request.
|
CancelPaymentByIdempotencyKeyResponse |
DefaultPaymentsApi.cancelPaymentByIdempotencyKey(CancelPaymentByIdempotencyKeyRequest body)
Cancels (voids) a payment identified by the idempotency key that is specified in the request.
|
CancelSubscriptionResponse |
SubscriptionsApi.cancelSubscription(String subscriptionId)
Schedules a `CANCEL` action to cancel an active subscription by setting the `canceled_date`
field to the end of the active billing period and changing the subscription status from
ACTIVE to CANCELED after this date.
|
CancelSubscriptionResponse |
DefaultSubscriptionsApi.cancelSubscription(String subscriptionId)
Schedules a `CANCEL` action to cancel an active subscription by setting the `canceled_date`
field to the end of the active billing period and changing the subscription status from
ACTIVE to CANCELED after this date.
|
CancelTerminalActionResponse |
DefaultTerminalApi.cancelTerminalAction(String actionId)
Cancels a Terminal action request if the status of the request permits it.
|
CancelTerminalActionResponse |
TerminalApi.cancelTerminalAction(String actionId)
Cancels a Terminal action request if the status of the request permits it.
|
CancelTerminalCheckoutResponse |
DefaultTerminalApi.cancelTerminalCheckout(String checkoutId)
Cancels a Terminal checkout request if the status of the request permits it.
|
CancelTerminalCheckoutResponse |
TerminalApi.cancelTerminalCheckout(String checkoutId)
Cancels a Terminal checkout request if the status of the request permits it.
|
CancelTerminalRefundResponse |
DefaultTerminalApi.cancelTerminalRefund(String terminalRefundId)
Cancels an Interac Terminal refund request by refund request ID if the status of the request
permits it.
|
CancelTerminalRefundResponse |
TerminalApi.cancelTerminalRefund(String terminalRefundId)
Cancels an Interac Terminal refund request by refund request ID if the status of the request
permits it.
|
CaptureTransactionResponse |
DefaultTransactionsApi.captureTransaction(String locationId,
String transactionId)
Deprecated.
|
CaptureTransactionResponse |
TransactionsApi.captureTransaction(String locationId,
String transactionId)
Deprecated.
|
CatalogInfoResponse |
DefaultCatalogApi.catalogInfo()
Retrieves information about the Square Catalog API, such as batch size limits that can be
used by the `BatchUpsertCatalogObjects` endpoint.
|
CatalogInfoResponse |
CatalogApi.catalogInfo()
Retrieves information about the Square Catalog API, such as batch size limits that can be
used by the `BatchUpsertCatalogObjects` endpoint.
|
CloneOrderResponse |
OrdersApi.cloneOrder(CloneOrderRequest body)
Creates a new order, in the `DRAFT` state, by duplicating an existing order.
|
CloneOrderResponse |
DefaultOrdersApi.cloneOrder(CloneOrderRequest body)
Creates a new order, in the `DRAFT` state, by duplicating an existing order.
|
CompletePaymentResponse |
PaymentsApi.completePayment(String paymentId,
CompletePaymentRequest body)
Completes (captures) a payment.
|
CompletePaymentResponse |
DefaultPaymentsApi.completePayment(String paymentId,
CompletePaymentRequest body)
Completes (captures) a payment.
|
CreateBookingResponse |
DefaultBookingsApi.createBooking(CreateBookingRequest body)
Creates a booking.
|
CreateBookingResponse |
BookingsApi.createBooking(CreateBookingRequest body)
Creates a booking.
|
CreateBreakTypeResponse |
LaborApi.createBreakType(CreateBreakTypeRequest body)
Creates a new `BreakType`.
|
CreateBreakTypeResponse |
DefaultLaborApi.createBreakType(CreateBreakTypeRequest body)
Creates a new `BreakType`.
|
CreateCardResponse |
CardsApi.createCard(CreateCardRequest body)
Adds a card on file to an existing merchant.
|
CreateCardResponse |
DefaultCardsApi.createCard(CreateCardRequest body)
Adds a card on file to an existing merchant.
|
CreateCatalogImageResponse |
DefaultCatalogApi.createCatalogImage(CreateCatalogImageRequest request,
FileWrapper imageFile)
Uploads an image file to be represented by a [CatalogImage]($m/CatalogImage) object that can
be linked to an existing [CatalogObject]($m/CatalogObject) instance.
|
CreateCatalogImageResponse |
CatalogApi.createCatalogImage(CreateCatalogImageRequest request,
FileWrapper imageFile)
Uploads an image file to be represented by a [CatalogImage]($m/CatalogImage) object that can
be linked to an existing [CatalogObject]($m/CatalogObject) instance.
|
CreateCheckoutResponse |
CheckoutApi.createCheckout(String locationId,
CreateCheckoutRequest body)
Links a `checkoutId` to a `checkout_page_url` that customers are directed to in order to
provide their payment information using a payment processing workflow hosted on
connect.squareup.com.
|
CreateCheckoutResponse |
DefaultCheckoutApi.createCheckout(String locationId,
CreateCheckoutRequest body)
Links a `checkoutId` to a `checkout_page_url` that customers are directed to in order to
provide their payment information using a payment processing workflow hosted on
connect.squareup.com.
|
CreateCustomerResponse |
DefaultCustomersApi.createCustomer(CreateCustomerRequest body)
Creates a new customer for a business.
|
CreateCustomerResponse |
CustomersApi.createCustomer(CreateCustomerRequest body)
Creates a new customer for a business.
|
CreateCustomerCardResponse |
DefaultCustomersApi.createCustomerCard(String customerId,
CreateCustomerCardRequest body)
Deprecated.
|
CreateCustomerCardResponse |
CustomersApi.createCustomerCard(String customerId,
CreateCustomerCardRequest body)
Deprecated.
|
CreateCustomerCustomAttributeDefinitionResponse |
DefaultCustomerCustomAttributesApi.createCustomerCustomAttributeDefinition(CreateCustomerCustomAttributeDefinitionRequest body)
Creates a customer-related custom attribute definition for a Square seller account.
|
CreateCustomerCustomAttributeDefinitionResponse |
CustomerCustomAttributesApi.createCustomerCustomAttributeDefinition(CreateCustomerCustomAttributeDefinitionRequest body)
Creates a customer-related custom attribute definition for a Square seller account.
|
CreateCustomerGroupResponse |
DefaultCustomerGroupsApi.createCustomerGroup(CreateCustomerGroupRequest body)
Creates a new customer group for a business.
|
CreateCustomerGroupResponse |
CustomerGroupsApi.createCustomerGroup(CreateCustomerGroupRequest body)
Creates a new customer group for a business.
|
CreateDeviceCodeResponse |
DefaultDevicesApi.createDeviceCode(CreateDeviceCodeRequest body)
Creates a DeviceCode that can be used to login to a Square Terminal device to enter the
connected terminal mode.
|
CreateDeviceCodeResponse |
DevicesApi.createDeviceCode(CreateDeviceCodeRequest body)
Creates a DeviceCode that can be used to login to a Square Terminal device to enter the
connected terminal mode.
|
CreateDisputeEvidenceFileResponse |
DefaultDisputesApi.createDisputeEvidenceFile(String disputeId,
CreateDisputeEvidenceFileRequest request,
FileWrapper imageFile)
Uploads a file to use as evidence in a dispute challenge.
|
CreateDisputeEvidenceFileResponse |
DisputesApi.createDisputeEvidenceFile(String disputeId,
CreateDisputeEvidenceFileRequest request,
FileWrapper imageFile)
Uploads a file to use as evidence in a dispute challenge.
|
CreateDisputeEvidenceTextResponse |
DefaultDisputesApi.createDisputeEvidenceText(String disputeId,
CreateDisputeEvidenceTextRequest body)
Uploads text to use as evidence for a dispute challenge.
|
CreateDisputeEvidenceTextResponse |
DisputesApi.createDisputeEvidenceText(String disputeId,
CreateDisputeEvidenceTextRequest body)
Uploads text to use as evidence for a dispute challenge.
|
CreateGiftCardResponse |
GiftCardsApi.createGiftCard(CreateGiftCardRequest body)
Creates a digital gift card or registers a physical (plastic) gift card.
|
CreateGiftCardResponse |
DefaultGiftCardsApi.createGiftCard(CreateGiftCardRequest body)
Creates a digital gift card or registers a physical (plastic) gift card.
|
CreateGiftCardActivityResponse |
DefaultGiftCardActivitiesApi.createGiftCardActivity(CreateGiftCardActivityRequest body)
Creates a gift card activity to manage the balance or state of a [gift card]($m/GiftCard).
|
CreateGiftCardActivityResponse |
GiftCardActivitiesApi.createGiftCardActivity(CreateGiftCardActivityRequest body)
Creates a gift card activity to manage the balance or state of a [gift card]($m/GiftCard).
|
CreateInvoiceResponse |
DefaultInvoicesApi.createInvoice(CreateInvoiceRequest body)
Creates a draft [invoice]($m/Invoice) for an order created using the Orders API.
|
CreateInvoiceResponse |
InvoicesApi.createInvoice(CreateInvoiceRequest body)
Creates a draft [invoice]($m/Invoice) for an order created using the Orders API.
|
CreateLocationResponse |
LocationsApi.createLocation(CreateLocationRequest body)
Creates a [location](https://developer.squareup.com/docs/locations-api).
|
CreateLocationResponse |
DefaultLocationsApi.createLocation(CreateLocationRequest body)
Creates a [location](https://developer.squareup.com/docs/locations-api).
|
CreateLoyaltyAccountResponse |
LoyaltyApi.createLoyaltyAccount(CreateLoyaltyAccountRequest body)
Creates a loyalty account.
|
CreateLoyaltyAccountResponse |
DefaultLoyaltyApi.createLoyaltyAccount(CreateLoyaltyAccountRequest body)
Creates a loyalty account.
|
CreateLoyaltyRewardResponse |
LoyaltyApi.createLoyaltyReward(CreateLoyaltyRewardRequest body)
Creates a loyalty reward.
|
CreateLoyaltyRewardResponse |
DefaultLoyaltyApi.createLoyaltyReward(CreateLoyaltyRewardRequest body)
Creates a loyalty reward.
|
CreateMobileAuthorizationCodeResponse |
MobileAuthorizationApi.createMobileAuthorizationCode(CreateMobileAuthorizationCodeRequest body)
Generates code to authorize a mobile application to connect to a Square card reader.
|
CreateMobileAuthorizationCodeResponse |
DefaultMobileAuthorizationApi.createMobileAuthorizationCode(CreateMobileAuthorizationCodeRequest body)
Generates code to authorize a mobile application to connect to a Square card reader.
|
CreateOrderResponse |
OrdersApi.createOrder(CreateOrderRequest body)
Creates a new [order]($m/Order) that can include information about products for purchase and
settings to apply to the purchase.
|
CreateOrderResponse |
DefaultOrdersApi.createOrder(CreateOrderRequest body)
Creates a new [order]($m/Order) that can include information about products for purchase and
settings to apply to the purchase.
|
CreatePaymentResponse |
PaymentsApi.createPayment(CreatePaymentRequest body)
Creates a payment using the provided source.
|
CreatePaymentResponse |
DefaultPaymentsApi.createPayment(CreatePaymentRequest body)
Creates a payment using the provided source.
|
CreatePaymentLinkResponse |
CheckoutApi.createPaymentLink(CreatePaymentLinkRequest body)
Creates a Square-hosted checkout page.
|
CreatePaymentLinkResponse |
DefaultCheckoutApi.createPaymentLink(CreatePaymentLinkRequest body)
Creates a Square-hosted checkout page.
|
V1Refund |
DefaultV1TransactionsApi.createRefund(String locationId,
V1CreateRefundRequest body)
Deprecated.
|
V1Refund |
V1TransactionsApi.createRefund(String locationId,
V1CreateRefundRequest body)
Deprecated.
|
CreateShiftResponse |
LaborApi.createShift(CreateShiftRequest body)
Creates a new `Shift`.
|
CreateShiftResponse |
DefaultLaborApi.createShift(CreateShiftRequest body)
Creates a new `Shift`.
|
CreateSubscriptionResponse |
SubscriptionsApi.createSubscription(CreateSubscriptionRequest body)
Creates a subscription to a subscription plan by a customer.
|
CreateSubscriptionResponse |
DefaultSubscriptionsApi.createSubscription(CreateSubscriptionRequest body)
Creates a subscription to a subscription plan by a customer.
|
CreateTeamMemberResponse |
DefaultTeamApi.createTeamMember(CreateTeamMemberRequest body)
Creates a single `TeamMember` object.
|
CreateTeamMemberResponse |
TeamApi.createTeamMember(CreateTeamMemberRequest body)
Creates a single `TeamMember` object.
|
CreateTerminalActionResponse |
DefaultTerminalApi.createTerminalAction(CreateTerminalActionRequest body)
Creates a Terminal action request and sends it to the specified device to take a payment for
the requested amount.
|
CreateTerminalActionResponse |
TerminalApi.createTerminalAction(CreateTerminalActionRequest body)
Creates a Terminal action request and sends it to the specified device to take a payment for
the requested amount.
|
CreateTerminalCheckoutResponse |
DefaultTerminalApi.createTerminalCheckout(CreateTerminalCheckoutRequest body)
Creates a Terminal checkout request and sends it to the specified device to take a payment
for the requested amount.
|
CreateTerminalCheckoutResponse |
TerminalApi.createTerminalCheckout(CreateTerminalCheckoutRequest body)
Creates a Terminal checkout request and sends it to the specified device to take a payment
for the requested amount.
|
CreateTerminalRefundResponse |
DefaultTerminalApi.createTerminalRefund(CreateTerminalRefundRequest body)
Creates a request to refund an Interac payment completed on a Square Terminal.
|
CreateTerminalRefundResponse |
TerminalApi.createTerminalRefund(CreateTerminalRefundRequest body)
Creates a request to refund an Interac payment completed on a Square Terminal.
|
CreateVendorResponse |
VendorsApi.createVendor(CreateVendorRequest body)
Creates a single [Vendor]($m/Vendor) object to represent a supplier to a seller.
|
CreateVendorResponse |
DefaultVendorsApi.createVendor(CreateVendorRequest body)
Creates a single [Vendor]($m/Vendor) object to represent a supplier to a seller.
|
DeleteBreakTypeResponse |
LaborApi.deleteBreakType(String id)
Deletes an existing `BreakType`.
|
DeleteBreakTypeResponse |
DefaultLaborApi.deleteBreakType(String id)
Deletes an existing `BreakType`.
|
DeleteCatalogObjectResponse |
DefaultCatalogApi.deleteCatalogObject(String objectId)
Deletes a single [CatalogObject]($m/CatalogObject) based on the provided ID and returns the
set of successfully deleted IDs in the response.
|
DeleteCatalogObjectResponse |
CatalogApi.deleteCatalogObject(String objectId)
Deletes a single [CatalogObject]($m/CatalogObject) based on the provided ID and returns the
set of successfully deleted IDs in the response.
|
DeleteCustomerResponse |
DefaultCustomersApi.deleteCustomer(String customerId,
Long version)
Deletes a customer profile from a business.
|
DeleteCustomerResponse |
CustomersApi.deleteCustomer(String customerId,
Long version)
Deletes a customer profile from a business.
|
DeleteCustomerCardResponse |
DefaultCustomersApi.deleteCustomerCard(String customerId,
String cardId)
Deprecated.
|
DeleteCustomerCardResponse |
CustomersApi.deleteCustomerCard(String customerId,
String cardId)
Deprecated.
|
DeleteCustomerCustomAttributeResponse |
DefaultCustomerCustomAttributesApi.deleteCustomerCustomAttribute(String customerId,
String key)
Deletes a custom attribute associated with a customer profile.
|
DeleteCustomerCustomAttributeResponse |
CustomerCustomAttributesApi.deleteCustomerCustomAttribute(String customerId,
String key)
Deletes a custom attribute associated with a customer profile.
|
DeleteCustomerCustomAttributeDefinitionResponse |
DefaultCustomerCustomAttributesApi.deleteCustomerCustomAttributeDefinition(String key)
Deletes a customer-related custom attribute definition from a Square seller account.
|
DeleteCustomerCustomAttributeDefinitionResponse |
CustomerCustomAttributesApi.deleteCustomerCustomAttributeDefinition(String key)
Deletes a customer-related custom attribute definition from a Square seller account.
|
DeleteCustomerGroupResponse |
DefaultCustomerGroupsApi.deleteCustomerGroup(String groupId)
Deletes a customer group as identified by the `group_id` value.
|
DeleteCustomerGroupResponse |
CustomerGroupsApi.deleteCustomerGroup(String groupId)
Deletes a customer group as identified by the `group_id` value.
|
DeleteDisputeEvidenceResponse |
DefaultDisputesApi.deleteDisputeEvidence(String disputeId,
String evidenceId)
Removes specified evidence from a dispute.
|
DeleteDisputeEvidenceResponse |
DisputesApi.deleteDisputeEvidence(String disputeId,
String evidenceId)
Removes specified evidence from a dispute.
|
DeleteInvoiceResponse |
DefaultInvoicesApi.deleteInvoice(String invoiceId,
Integer version)
Deletes the specified invoice.
|
DeleteInvoiceResponse |
InvoicesApi.deleteInvoice(String invoiceId,
Integer version)
Deletes the specified invoice.
|
DeleteLoyaltyRewardResponse |
LoyaltyApi.deleteLoyaltyReward(String rewardId)
Deletes a loyalty reward by doing the following: - Returns the loyalty points back to the
loyalty account.
|
DeleteLoyaltyRewardResponse |
DefaultLoyaltyApi.deleteLoyaltyReward(String rewardId)
Deletes a loyalty reward by doing the following: - Returns the loyalty points back to the
loyalty account.
|
DeletePaymentLinkResponse |
CheckoutApi.deletePaymentLink(String id)
Deletes a payment link.
|
DeletePaymentLinkResponse |
DefaultCheckoutApi.deletePaymentLink(String id)
Deletes a payment link.
|
DeleteShiftResponse |
LaborApi.deleteShift(String id)
Deletes a `Shift`.
|
DeleteShiftResponse |
DefaultLaborApi.deleteShift(String id)
Deletes a `Shift`.
|
DeleteSnippetResponse |
DefaultSnippetsApi.deleteSnippet(String siteId)
Removes your snippet from a Square Online site.
|
DeleteSnippetResponse |
SnippetsApi.deleteSnippet(String siteId)
Removes your snippet from a Square Online site.
|
DeleteSubscriptionActionResponse |
SubscriptionsApi.deleteSubscriptionAction(String subscriptionId,
String actionId)
Deletes a scheduled action for a subscription.
|
DeleteSubscriptionActionResponse |
DefaultSubscriptionsApi.deleteSubscriptionAction(String subscriptionId,
String actionId)
Deletes a scheduled action for a subscription.
|
BatchChangeInventoryResponse |
DefaultInventoryApi.deprecatedBatchChangeInventory(BatchChangeInventoryRequest body)
Deprecated.
|
BatchChangeInventoryResponse |
InventoryApi.deprecatedBatchChangeInventory(BatchChangeInventoryRequest body)
Deprecated.
|
BatchRetrieveInventoryChangesResponse |
DefaultInventoryApi.deprecatedBatchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest body)
Deprecated.
|
BatchRetrieveInventoryChangesResponse |
InventoryApi.deprecatedBatchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest body)
Deprecated.
|
BatchRetrieveInventoryCountsResponse |
DefaultInventoryApi.deprecatedBatchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest body)
Deprecated.
|
BatchRetrieveInventoryCountsResponse |
InventoryApi.deprecatedBatchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest body)
Deprecated.
|
RetrieveInventoryAdjustmentResponse |
DefaultInventoryApi.deprecatedRetrieveInventoryAdjustment(String adjustmentId)
Deprecated.
|
RetrieveInventoryAdjustmentResponse |
InventoryApi.deprecatedRetrieveInventoryAdjustment(String adjustmentId)
Deprecated.
|
RetrieveInventoryPhysicalCountResponse |
DefaultInventoryApi.deprecatedRetrieveInventoryPhysicalCount(String physicalCountId)
Deprecated.
|
RetrieveInventoryPhysicalCountResponse |
InventoryApi.deprecatedRetrieveInventoryPhysicalCount(String physicalCountId)
Deprecated.
|
DisableCardResponse |
CardsApi.disableCard(String cardId)
Disables the card, preventing any further updates or charges.
|
DisableCardResponse |
DefaultCardsApi.disableCard(String cardId)
Disables the card, preventing any further updates or charges.
|
GetBankAccountResponse |
BankAccountsApi.getBankAccount(String bankAccountId)
Returns details of a [BankAccount]($m/BankAccount) linked to a Square account.
|
GetBankAccountResponse |
DefaultBankAccountsApi.getBankAccount(String bankAccountId)
Returns details of a [BankAccount]($m/BankAccount) linked to a Square account.
|
GetBankAccountByV1IdResponse |
BankAccountsApi.getBankAccountByV1Id(String v1BankAccountId)
Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank account ID.
|
GetBankAccountByV1IdResponse |
DefaultBankAccountsApi.getBankAccountByV1Id(String v1BankAccountId)
Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank account ID.
|
GetBreakTypeResponse |
LaborApi.getBreakType(String id)
Returns a single `BreakType` specified by `id`.
|
GetBreakTypeResponse |
DefaultLaborApi.getBreakType(String id)
Returns a single `BreakType` specified by `id`.
|
GetDeviceCodeResponse |
DefaultDevicesApi.getDeviceCode(String id)
Retrieves DeviceCode with the associated ID.
|
GetDeviceCodeResponse |
DevicesApi.getDeviceCode(String id)
Retrieves DeviceCode with the associated ID.
|
GetEmployeeWageResponse |
LaborApi.getEmployeeWage(String id)
Deprecated.
|
GetEmployeeWageResponse |
DefaultLaborApi.getEmployeeWage(String id)
Deprecated.
|
GetInvoiceResponse |
DefaultInvoicesApi.getInvoice(String invoiceId)
Retrieves an invoice by invoice ID.
|
GetInvoiceResponse |
InvoicesApi.getInvoice(String invoiceId)
Retrieves an invoice by invoice ID.
|
GetPaymentResponse |
PaymentsApi.getPayment(String paymentId)
Retrieves details for a specific payment.
|
GetPaymentResponse |
DefaultPaymentsApi.getPayment(String paymentId)
Retrieves details for a specific payment.
|
GetPaymentRefundResponse |
DefaultRefundsApi.getPaymentRefund(String refundId)
Retrieves a specific refund using the `refund_id`.
|
GetPaymentRefundResponse |
RefundsApi.getPaymentRefund(String refundId)
Retrieves a specific refund using the `refund_id`.
|
GetPayoutResponse |
PayoutsApi.getPayout(String payoutId)
Retrieves details of a specific payout identified by a payout ID.
|
GetPayoutResponse |
DefaultPayoutsApi.getPayout(String payoutId)
Retrieves details of a specific payout identified by a payout ID.
|
GetShiftResponse |
LaborApi.getShift(String id)
Returns a single `Shift` specified by `id`.
|
GetShiftResponse |
DefaultLaborApi.getShift(String id)
Returns a single `Shift` specified by `id`.
|
GetTeamMemberWageResponse |
LaborApi.getTeamMemberWage(String id)
Returns a single `TeamMemberWage` specified by `id `.
|
GetTeamMemberWageResponse |
DefaultLaborApi.getTeamMemberWage(String id)
Returns a single `TeamMemberWage` specified by `id `.
|
GetTerminalActionResponse |
DefaultTerminalApi.getTerminalAction(String actionId)
Retrieves a Terminal action request by `action_id`.
|
GetTerminalActionResponse |
TerminalApi.getTerminalAction(String actionId)
Retrieves a Terminal action request by `action_id`.
|
GetTerminalCheckoutResponse |
DefaultTerminalApi.getTerminalCheckout(String checkoutId)
Retrieves a Terminal checkout request by `checkout_id`.
|
GetTerminalCheckoutResponse |
TerminalApi.getTerminalCheckout(String checkoutId)
Retrieves a Terminal checkout request by `checkout_id`.
|
GetTerminalRefundResponse |
DefaultTerminalApi.getTerminalRefund(String terminalRefundId)
Retrieves an Interac Terminal refund object by ID.
|
GetTerminalRefundResponse |
TerminalApi.getTerminalRefund(String terminalRefundId)
Retrieves an Interac Terminal refund object by ID.
|
T |
BaseApi.ResponseHandler.handle(HttpContext context)
Handles the response for an endpoint.
|
LinkCustomerToGiftCardResponse |
GiftCardsApi.linkCustomerToGiftCard(String giftCardId,
LinkCustomerToGiftCardRequest body)
Links a customer to a gift card, which is also referred to as adding a card on file.
|
LinkCustomerToGiftCardResponse |
DefaultGiftCardsApi.linkCustomerToGiftCard(String giftCardId,
LinkCustomerToGiftCardRequest body)
Links a customer to a gift card, which is also referred to as adding a card on file.
|
ListBankAccountsResponse |
BankAccountsApi.listBankAccounts(String cursor,
Integer limit,
String locationId)
Returns a list of [BankAccount]($m/BankAccount) objects linked to a Square account.
|
ListBankAccountsResponse |
DefaultBankAccountsApi.listBankAccounts(String cursor,
Integer limit,
String locationId)
Returns a list of [BankAccount]($m/BankAccount) objects linked to a Square account.
|
ListBookingsResponse |
DefaultBookingsApi.listBookings(Integer limit,
String cursor,
String teamMemberId,
String locationId,
String startAtMin,
String startAtMax)
Retrieve a collection of bookings.
|
ListBookingsResponse |
BookingsApi.listBookings(Integer limit,
String cursor,
String teamMemberId,
String locationId,
String startAtMin,
String startAtMax)
Retrieve a collection of bookings.
|
ListBreakTypesResponse |
LaborApi.listBreakTypes(String locationId,
Integer limit,
String cursor)
Returns a paginated list of `BreakType` instances for a business.
|
ListBreakTypesResponse |
DefaultLaborApi.listBreakTypes(String locationId,
Integer limit,
String cursor)
Returns a paginated list of `BreakType` instances for a business.
|
ListCardsResponse |
CardsApi.listCards(String cursor,
String customerId,
Boolean includeDisabled,
String referenceId,
String sortOrder)
Retrieves a list of cards owned by the account making the request.
|
ListCardsResponse |
DefaultCardsApi.listCards(String cursor,
String customerId,
Boolean includeDisabled,
String referenceId,
String sortOrder)
Retrieves a list of cards owned by the account making the request.
|
ListCashDrawerShiftEventsResponse |
CashDrawersApi.listCashDrawerShiftEvents(String locationId,
String shiftId,
Integer limit,
String cursor)
Provides a paginated list of events for a single cash drawer shift.
|
ListCashDrawerShiftEventsResponse |
DefaultCashDrawersApi.listCashDrawerShiftEvents(String locationId,
String shiftId,
Integer limit,
String cursor)
Provides a paginated list of events for a single cash drawer shift.
|
ListCashDrawerShiftsResponse |
CashDrawersApi.listCashDrawerShifts(String locationId,
String sortOrder,
String beginTime,
String endTime,
Integer limit,
String cursor)
Provides the details for all of the cash drawer shifts for a location in a date range.
|
ListCashDrawerShiftsResponse |
DefaultCashDrawersApi.listCashDrawerShifts(String locationId,
String sortOrder,
String beginTime,
String endTime,
Integer limit,
String cursor)
Provides the details for all of the cash drawer shifts for a location in a date range.
|
ListCatalogResponse |
DefaultCatalogApi.listCatalog(String cursor,
String types,
Long catalogVersion)
Returns a list of all [CatalogObject]($m/CatalogObject)s of the specified types in the
catalog.
|
ListCatalogResponse |
CatalogApi.listCatalog(String cursor,
String types,
Long catalogVersion)
Returns a list of all [CatalogObject]($m/CatalogObject)s of the specified types in the
catalog.
|
ListCustomerCustomAttributeDefinitionsResponse |
DefaultCustomerCustomAttributesApi.listCustomerCustomAttributeDefinitions(Integer limit,
String cursor)
Lists the customer-related custom attribute definitions that belong to a Square seller
account.
|
ListCustomerCustomAttributeDefinitionsResponse |
CustomerCustomAttributesApi.listCustomerCustomAttributeDefinitions(Integer limit,
String cursor)
Lists the customer-related custom attribute definitions that belong to a Square seller
account.
|
ListCustomerCustomAttributesResponse |
DefaultCustomerCustomAttributesApi.listCustomerCustomAttributes(String customerId,
Integer limit,
String cursor,
Boolean withDefinitions)
Lists the custom attributes associated with a customer profile.
|
ListCustomerCustomAttributesResponse |
CustomerCustomAttributesApi.listCustomerCustomAttributes(String customerId,
Integer limit,
String cursor,
Boolean withDefinitions)
Lists the custom attributes associated with a customer profile.
|
ListCustomerGroupsResponse |
DefaultCustomerGroupsApi.listCustomerGroups(String cursor,
Integer limit)
Retrieves the list of customer groups of a business.
|
ListCustomerGroupsResponse |
CustomerGroupsApi.listCustomerGroups(String cursor,
Integer limit)
Retrieves the list of customer groups of a business.
|
ListCustomersResponse |
DefaultCustomersApi.listCustomers(String cursor,
Integer limit,
String sortField,
String sortOrder)
Lists customer profiles associated with a Square account.
|
ListCustomersResponse |
CustomersApi.listCustomers(String cursor,
Integer limit,
String sortField,
String sortOrder)
Lists customer profiles associated with a Square account.
|
ListCustomerSegmentsResponse |
CustomerSegmentsApi.listCustomerSegments(String cursor,
Integer limit)
Retrieves the list of customer segments of a business.
|
ListCustomerSegmentsResponse |
DefaultCustomerSegmentsApi.listCustomerSegments(String cursor,
Integer limit)
Retrieves the list of customer segments of a business.
|
ListDeviceCodesResponse |
DefaultDevicesApi.listDeviceCodes(String cursor,
String locationId,
String productType,
String status)
Lists all DeviceCodes associated with the merchant.
|
ListDeviceCodesResponse |
DevicesApi.listDeviceCodes(String cursor,
String locationId,
String productType,
String status)
Lists all DeviceCodes associated with the merchant.
|
ListDisputeEvidenceResponse |
DefaultDisputesApi.listDisputeEvidence(String disputeId,
String cursor)
Returns a list of evidence associated with a dispute.
|
ListDisputeEvidenceResponse |
DisputesApi.listDisputeEvidence(String disputeId,
String cursor)
Returns a list of evidence associated with a dispute.
|
ListDisputesResponse |
DefaultDisputesApi.listDisputes(String cursor,
String states,
String locationId)
Returns a list of disputes associated with a particular account.
|
ListDisputesResponse |
DisputesApi.listDisputes(String cursor,
String states,
String locationId)
Returns a list of disputes associated with a particular account.
|
ListEmployeesResponse |
DefaultEmployeesApi.listEmployees(String locationId,
String status,
Integer limit,
String cursor)
Deprecated.
|
ListEmployeesResponse |
EmployeesApi.listEmployees(String locationId,
String status,
Integer limit,
String cursor)
Deprecated.
|
ListEmployeeWagesResponse |
LaborApi.listEmployeeWages(String employeeId,
Integer limit,
String cursor)
Deprecated.
|
ListEmployeeWagesResponse |
DefaultLaborApi.listEmployeeWages(String employeeId,
Integer limit,
String cursor)
Deprecated.
|
ListGiftCardActivitiesResponse |
DefaultGiftCardActivitiesApi.listGiftCardActivities(String giftCardId,
String type,
String locationId,
String beginTime,
String endTime,
Integer limit,
String cursor,
String sortOrder)
Lists gift card activities.
|
ListGiftCardActivitiesResponse |
GiftCardActivitiesApi.listGiftCardActivities(String giftCardId,
String type,
String locationId,
String beginTime,
String endTime,
Integer limit,
String cursor,
String sortOrder)
Lists gift card activities.
|
ListGiftCardsResponse |
GiftCardsApi.listGiftCards(String type,
String state,
Integer limit,
String cursor,
String customerId)
Lists all gift cards.
|
ListGiftCardsResponse |
DefaultGiftCardsApi.listGiftCards(String type,
String state,
Integer limit,
String cursor,
String customerId)
Lists all gift cards.
|
ListInvoicesResponse |
DefaultInvoicesApi.listInvoices(String locationId,
String cursor,
Integer limit)
Returns a list of invoices for a given location.
|
ListInvoicesResponse |
InvoicesApi.listInvoices(String locationId,
String cursor,
Integer limit)
Returns a list of invoices for a given location.
|
ListLocationsResponse |
LocationsApi.listLocations()
Provides details about all of the seller's
[locations](https://developer.squareup.com/docs/locations-api), including those with an
inactive status.
|
ListLocationsResponse |
DefaultLocationsApi.listLocations()
Provides details about all of the seller's
[locations](https://developer.squareup.com/docs/locations-api), including those with an
inactive status.
|
ListLoyaltyProgramsResponse |
LoyaltyApi.listLoyaltyPrograms()
Deprecated.
|
ListLoyaltyProgramsResponse |
DefaultLoyaltyApi.listLoyaltyPrograms()
Deprecated.
|
ListMerchantsResponse |
MerchantsApi.listMerchants(Integer cursor)
Provides details about the merchant associated with a given access token.
|
ListMerchantsResponse |
DefaultMerchantsApi.listMerchants(Integer cursor)
Provides details about the merchant associated with a given access token.
|
List<V1Order> |
DefaultV1TransactionsApi.listOrders(String locationId,
String order,
Integer limit,
String batchToken)
Deprecated.
|
List<V1Order> |
V1TransactionsApi.listOrders(String locationId,
String order,
Integer limit,
String batchToken)
Deprecated.
|
ListPaymentLinksResponse |
CheckoutApi.listPaymentLinks(String cursor,
Integer limit)
Lists all payment links.
|
ListPaymentLinksResponse |
DefaultCheckoutApi.listPaymentLinks(String cursor,
Integer limit)
Lists all payment links.
|
ListPaymentRefundsResponse |
DefaultRefundsApi.listPaymentRefunds(String beginTime,
String endTime,
String sortOrder,
String cursor,
String locationId,
String status,
String sourceType,
Integer limit)
Retrieves a list of refunds for the account making the request.
|
ListPaymentRefundsResponse |
RefundsApi.listPaymentRefunds(String beginTime,
String endTime,
String sortOrder,
String cursor,
String locationId,
String status,
String sourceType,
Integer limit)
Retrieves a list of refunds for the account making the request.
|
List<V1Payment> |
DefaultV1TransactionsApi.listPayments(String locationId,
String order,
String beginTime,
String endTime,
Integer limit,
String batchToken,
Boolean includePartial)
Deprecated.
|
List<V1Payment> |
V1TransactionsApi.listPayments(String locationId,
String order,
String beginTime,
String endTime,
Integer limit,
String batchToken,
Boolean includePartial)
Deprecated.
|
ListPaymentsResponse |
PaymentsApi.listPayments(String beginTime,
String endTime,
String sortOrder,
String cursor,
String locationId,
Long total,
String last4,
String cardBrand,
Integer limit)
Retrieves a list of payments taken by the account making the request.
|
ListPaymentsResponse |
DefaultPaymentsApi.listPayments(String beginTime,
String endTime,
String sortOrder,
String cursor,
String locationId,
Long total,
String last4,
String cardBrand,
Integer limit)
Retrieves a list of payments taken by the account making the request.
|
ListPayoutEntriesResponse |
PayoutsApi.listPayoutEntries(String payoutId,
String sortOrder,
String cursor,
Integer limit)
Retrieves a list of all payout entries for a specific payout.
|
ListPayoutEntriesResponse |
DefaultPayoutsApi.listPayoutEntries(String payoutId,
String sortOrder,
String cursor,
Integer limit)
Retrieves a list of all payout entries for a specific payout.
|
ListPayoutsResponse |
PayoutsApi.listPayouts(String locationId,
String status,
String beginTime,
String endTime,
String sortOrder,
String cursor,
Integer limit)
Retrieves a list of all payouts for the default location.
|
ListPayoutsResponse |
DefaultPayoutsApi.listPayouts(String locationId,
String status,
String beginTime,
String endTime,
String sortOrder,
String cursor,
Integer limit)
Retrieves a list of all payouts for the default location.
|
List<V1Refund> |
DefaultV1TransactionsApi.listRefunds(String locationId,
String order,
String beginTime,
String endTime,
Integer limit,
String batchToken)
Deprecated.
|
List<V1Refund> |
V1TransactionsApi.listRefunds(String locationId,
String order,
String beginTime,
String endTime,
Integer limit,
String batchToken)
Deprecated.
|
List<V1Settlement> |
DefaultV1TransactionsApi.listSettlements(String locationId,
String order,
String beginTime,
String endTime,
Integer limit,
String status,
String batchToken)
Deprecated.
|
List<V1Settlement> |
V1TransactionsApi.listSettlements(String locationId,
String order,
String beginTime,
String endTime,
Integer limit,
String status,
String batchToken)
Deprecated.
|
ListSitesResponse |
DefaultSitesApi.listSites()
Lists the Square Online sites that belong to a seller.
|
ListSitesResponse |
SitesApi.listSites()
Lists the Square Online sites that belong to a seller.
|
ListSubscriptionEventsResponse |
SubscriptionsApi.listSubscriptionEvents(String subscriptionId,
String cursor,
Integer limit)
Lists all events for a specific subscription.
|
ListSubscriptionEventsResponse |
DefaultSubscriptionsApi.listSubscriptionEvents(String subscriptionId,
String cursor,
Integer limit)
Lists all events for a specific subscription.
|
ListTeamMemberBookingProfilesResponse |
DefaultBookingsApi.listTeamMemberBookingProfiles(Boolean bookableOnly,
Integer limit,
String cursor,
String locationId)
Lists booking profiles for team members.
|
ListTeamMemberBookingProfilesResponse |
BookingsApi.listTeamMemberBookingProfiles(Boolean bookableOnly,
Integer limit,
String cursor,
String locationId)
Lists booking profiles for team members.
|
ListTeamMemberWagesResponse |
LaborApi.listTeamMemberWages(String teamMemberId,
Integer limit,
String cursor)
Returns a paginated list of `TeamMemberWage` instances for a business.
|
ListTeamMemberWagesResponse |
DefaultLaborApi.listTeamMemberWages(String teamMemberId,
Integer limit,
String cursor)
Returns a paginated list of `TeamMemberWage` instances for a business.
|
ListTransactionsResponse |
DefaultTransactionsApi.listTransactions(String locationId,
String beginTime,
String endTime,
String sortOrder,
String cursor)
Deprecated.
|
ListTransactionsResponse |
TransactionsApi.listTransactions(String locationId,
String beginTime,
String endTime,
String sortOrder,
String cursor)
Deprecated.
|
ListWorkweekConfigsResponse |
LaborApi.listWorkweekConfigs(Integer limit,
String cursor)
Returns a list of `WorkweekConfig` instances for a business.
|
ListWorkweekConfigsResponse |
DefaultLaborApi.listWorkweekConfigs(Integer limit,
String cursor)
Returns a list of `WorkweekConfig` instances for a business.
|
ObtainTokenResponse |
DefaultOAuthApi.obtainToken(ObtainTokenRequest body)
Returns an OAuth access token and a refresh token unless the `short_lived` parameter is set
to `true`, in which case the endpoint returns only an access token.
|
ObtainTokenResponse |
OAuthApi.obtainToken(ObtainTokenRequest body)
Returns an OAuth access token and a refresh token unless the `short_lived` parameter is set
to `true`, in which case the endpoint returns only an access token.
|
PauseSubscriptionResponse |
SubscriptionsApi.pauseSubscription(String subscriptionId,
PauseSubscriptionRequest body)
Schedules a `PAUSE` action to pause an active subscription.
|
PauseSubscriptionResponse |
DefaultSubscriptionsApi.pauseSubscription(String subscriptionId,
PauseSubscriptionRequest body)
Schedules a `PAUSE` action to pause an active subscription.
|
PayOrderResponse |
OrdersApi.payOrder(String orderId,
PayOrderRequest body)
Pay for an [order]($m/Order) using one or more approved [payments]($m/Payment) or settle an
order with a total of `0`.
|
PayOrderResponse |
DefaultOrdersApi.payOrder(String orderId,
PayOrderRequest body)
Pay for an [order]($m/Order) using one or more approved [payments]($m/Payment) or settle an
order with a total of `0`.
|
PublishInvoiceResponse |
DefaultInvoicesApi.publishInvoice(String invoiceId,
PublishInvoiceRequest body)
Publishes the specified draft invoice.
|
PublishInvoiceResponse |
InvoicesApi.publishInvoice(String invoiceId,
PublishInvoiceRequest body)
Publishes the specified draft invoice.
|
RedeemLoyaltyRewardResponse |
LoyaltyApi.redeemLoyaltyReward(String rewardId,
RedeemLoyaltyRewardRequest body)
Redeems a loyalty reward.
|
RedeemLoyaltyRewardResponse |
DefaultLoyaltyApi.redeemLoyaltyReward(String rewardId,
RedeemLoyaltyRewardRequest body)
Redeems a loyalty reward.
|
RefundPaymentResponse |
DefaultRefundsApi.refundPayment(RefundPaymentRequest body)
Refunds a payment.
|
RefundPaymentResponse |
RefundsApi.refundPayment(RefundPaymentRequest body)
Refunds a payment.
|
RegisterDomainResponse |
ApplePayApi.registerDomain(RegisterDomainRequest body)
Activates a domain for use with Apple Pay on the Web and Square.
|
RegisterDomainResponse |
DefaultApplePayApi.registerDomain(RegisterDomainRequest body)
Activates a domain for use with Apple Pay on the Web and Square.
|
RemoveGroupFromCustomerResponse |
DefaultCustomersApi.removeGroupFromCustomer(String customerId,
String groupId)
Removes a group membership from a customer.
|
RemoveGroupFromCustomerResponse |
CustomersApi.removeGroupFromCustomer(String customerId,
String groupId)
Removes a group membership from a customer.
|
RenewTokenResponse |
DefaultOAuthApi.renewToken(String clientId,
RenewTokenRequest body,
String authorization)
Deprecated.
|
RenewTokenResponse |
OAuthApi.renewToken(String clientId,
RenewTokenRequest body,
String authorization)
Deprecated.
|
ResumeSubscriptionResponse |
SubscriptionsApi.resumeSubscription(String subscriptionId,
ResumeSubscriptionRequest body)
Schedules a `RESUME` action to resume a paused or a deactivated subscription.
|
ResumeSubscriptionResponse |
DefaultSubscriptionsApi.resumeSubscription(String subscriptionId,
ResumeSubscriptionRequest body)
Schedules a `RESUME` action to resume a paused or a deactivated subscription.
|
RetrieveBookingResponse |
DefaultBookingsApi.retrieveBooking(String bookingId)
Retrieves a booking.
|
RetrieveBookingResponse |
BookingsApi.retrieveBooking(String bookingId)
Retrieves a booking.
|
RetrieveBusinessBookingProfileResponse |
DefaultBookingsApi.retrieveBusinessBookingProfile()
Retrieves a seller's booking profile.
|
RetrieveBusinessBookingProfileResponse |
BookingsApi.retrieveBusinessBookingProfile()
Retrieves a seller's booking profile.
|
RetrieveCardResponse |
CardsApi.retrieveCard(String cardId)
Retrieves details for a specific Card.
|
RetrieveCardResponse |
DefaultCardsApi.retrieveCard(String cardId)
Retrieves details for a specific Card.
|
RetrieveCashDrawerShiftResponse |
CashDrawersApi.retrieveCashDrawerShift(String locationId,
String shiftId)
Provides the summary details for a single cash drawer shift.
|
RetrieveCashDrawerShiftResponse |
DefaultCashDrawersApi.retrieveCashDrawerShift(String locationId,
String shiftId)
Provides the summary details for a single cash drawer shift.
|
RetrieveCatalogObjectResponse |
DefaultCatalogApi.retrieveCatalogObject(String objectId,
Boolean includeRelatedObjects,
Long catalogVersion)
Returns a single [CatalogItem]($m/CatalogItem) as a [CatalogObject]($m/CatalogObject) based
on the provided ID.
|
RetrieveCatalogObjectResponse |
CatalogApi.retrieveCatalogObject(String objectId,
Boolean includeRelatedObjects,
Long catalogVersion)
Returns a single [CatalogItem]($m/CatalogItem) as a [CatalogObject]($m/CatalogObject) based
on the provided ID.
|
RetrieveCustomerResponse |
DefaultCustomersApi.retrieveCustomer(String customerId)
Returns details for a single customer.
|
RetrieveCustomerResponse |
CustomersApi.retrieveCustomer(String customerId)
Returns details for a single customer.
|
RetrieveCustomerCustomAttributeResponse |
DefaultCustomerCustomAttributesApi.retrieveCustomerCustomAttribute(String customerId,
String key,
Boolean withDefinition,
Integer version)
Retrieves a custom attribute associated with a customer profile.
|
RetrieveCustomerCustomAttributeResponse |
CustomerCustomAttributesApi.retrieveCustomerCustomAttribute(String customerId,
String key,
Boolean withDefinition,
Integer version)
Retrieves a custom attribute associated with a customer profile.
|
RetrieveCustomerCustomAttributeDefinitionResponse |
DefaultCustomerCustomAttributesApi.retrieveCustomerCustomAttributeDefinition(String key,
Integer version)
Retrieves a customer-related custom attribute definition from a Square seller account.
|
RetrieveCustomerCustomAttributeDefinitionResponse |
CustomerCustomAttributesApi.retrieveCustomerCustomAttributeDefinition(String key,
Integer version)
Retrieves a customer-related custom attribute definition from a Square seller account.
|
RetrieveCustomerGroupResponse |
DefaultCustomerGroupsApi.retrieveCustomerGroup(String groupId)
Retrieves a specific customer group as identified by the `group_id` value.
|
RetrieveCustomerGroupResponse |
CustomerGroupsApi.retrieveCustomerGroup(String groupId)
Retrieves a specific customer group as identified by the `group_id` value.
|
RetrieveCustomerSegmentResponse |
CustomerSegmentsApi.retrieveCustomerSegment(String segmentId)
Retrieves a specific customer segment as identified by the `segment_id` value.
|
RetrieveCustomerSegmentResponse |
DefaultCustomerSegmentsApi.retrieveCustomerSegment(String segmentId)
Retrieves a specific customer segment as identified by the `segment_id` value.
|
RetrieveDisputeResponse |
DefaultDisputesApi.retrieveDispute(String disputeId)
Returns details about a specific dispute.
|
RetrieveDisputeResponse |
DisputesApi.retrieveDispute(String disputeId)
Returns details about a specific dispute.
|
RetrieveDisputeEvidenceResponse |
DefaultDisputesApi.retrieveDisputeEvidence(String disputeId,
String evidenceId)
Returns the evidence metadata specified by the evidence ID in the request URL path You must
maintain a copy of the evidence you upload if you want to reference it later.
|
RetrieveDisputeEvidenceResponse |
DisputesApi.retrieveDisputeEvidence(String disputeId,
String evidenceId)
Returns the evidence metadata specified by the evidence ID in the request URL path You must
maintain a copy of the evidence you upload if you want to reference it later.
|
RetrieveEmployeeResponse |
DefaultEmployeesApi.retrieveEmployee(String id)
Deprecated.
|
RetrieveEmployeeResponse |
EmployeesApi.retrieveEmployee(String id)
Deprecated.
|
RetrieveGiftCardResponse |
GiftCardsApi.retrieveGiftCard(String id)
Retrieves a gift card using the gift card ID.
|
RetrieveGiftCardResponse |
DefaultGiftCardsApi.retrieveGiftCard(String id)
Retrieves a gift card using the gift card ID.
|
RetrieveGiftCardFromGANResponse |
GiftCardsApi.retrieveGiftCardFromGAN(RetrieveGiftCardFromGANRequest body)
Retrieves a gift card using the gift card account number (GAN).
|
RetrieveGiftCardFromGANResponse |
DefaultGiftCardsApi.retrieveGiftCardFromGAN(RetrieveGiftCardFromGANRequest body)
Retrieves a gift card using the gift card account number (GAN).
|
RetrieveGiftCardFromNonceResponse |
GiftCardsApi.retrieveGiftCardFromNonce(RetrieveGiftCardFromNonceRequest body)
Retrieves a gift card using a secure payment token that represents the gift card.
|
RetrieveGiftCardFromNonceResponse |
DefaultGiftCardsApi.retrieveGiftCardFromNonce(RetrieveGiftCardFromNonceRequest body)
Retrieves a gift card using a secure payment token that represents the gift card.
|
RetrieveInventoryAdjustmentResponse |
DefaultInventoryApi.retrieveInventoryAdjustment(String adjustmentId)
Returns the [InventoryAdjustment]($m/InventoryAdjustment) object with the provided
`adjustment_id`.
|
RetrieveInventoryAdjustmentResponse |
InventoryApi.retrieveInventoryAdjustment(String adjustmentId)
Returns the [InventoryAdjustment]($m/InventoryAdjustment) object with the provided
`adjustment_id`.
|
RetrieveInventoryChangesResponse |
DefaultInventoryApi.retrieveInventoryChanges(String catalogObjectId,
String locationIds,
String cursor)
Deprecated.
|
RetrieveInventoryChangesResponse |
InventoryApi.retrieveInventoryChanges(String catalogObjectId,
String locationIds,
String cursor)
Deprecated.
|
RetrieveInventoryCountResponse |
DefaultInventoryApi.retrieveInventoryCount(String catalogObjectId,
String locationIds,
String cursor)
Retrieves the current calculated stock count for a given [CatalogObject]($m/CatalogObject) at
a given set of [Location]($m/Location)s.
|
RetrieveInventoryCountResponse |
InventoryApi.retrieveInventoryCount(String catalogObjectId,
String locationIds,
String cursor)
Retrieves the current calculated stock count for a given [CatalogObject]($m/CatalogObject) at
a given set of [Location]($m/Location)s.
|
RetrieveInventoryPhysicalCountResponse |
DefaultInventoryApi.retrieveInventoryPhysicalCount(String physicalCountId)
Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount) object with the provided
`physical_count_id`.
|
RetrieveInventoryPhysicalCountResponse |
InventoryApi.retrieveInventoryPhysicalCount(String physicalCountId)
Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount) object with the provided
`physical_count_id`.
|
RetrieveInventoryTransferResponse |
DefaultInventoryApi.retrieveInventoryTransfer(String transferId)
Returns the [InventoryTransfer]($m/InventoryTransfer) object with the provided `transfer_id`.
|
RetrieveInventoryTransferResponse |
InventoryApi.retrieveInventoryTransfer(String transferId)
Returns the [InventoryTransfer]($m/InventoryTransfer) object with the provided `transfer_id`.
|
RetrieveLocationResponse |
LocationsApi.retrieveLocation(String locationId)
Retrieves details of a single location.
|
RetrieveLocationResponse |
DefaultLocationsApi.retrieveLocation(String locationId)
Retrieves details of a single location.
|
RetrieveLoyaltyAccountResponse |
LoyaltyApi.retrieveLoyaltyAccount(String accountId)
Retrieves a loyalty account.
|
RetrieveLoyaltyAccountResponse |
DefaultLoyaltyApi.retrieveLoyaltyAccount(String accountId)
Retrieves a loyalty account.
|
RetrieveLoyaltyProgramResponse |
LoyaltyApi.retrieveLoyaltyProgram(String programId)
Retrieves the loyalty program in a seller's account, specified by the program ID or the
keyword `main`.
|
RetrieveLoyaltyProgramResponse |
DefaultLoyaltyApi.retrieveLoyaltyProgram(String programId)
Retrieves the loyalty program in a seller's account, specified by the program ID or the
keyword `main`.
|
RetrieveLoyaltyRewardResponse |
LoyaltyApi.retrieveLoyaltyReward(String rewardId)
Retrieves a loyalty reward.
|
RetrieveLoyaltyRewardResponse |
DefaultLoyaltyApi.retrieveLoyaltyReward(String rewardId)
Retrieves a loyalty reward.
|
RetrieveMerchantResponse |
MerchantsApi.retrieveMerchant(String merchantId)
Retrieves the `Merchant` object for the given `merchant_id`.
|
RetrieveMerchantResponse |
DefaultMerchantsApi.retrieveMerchant(String merchantId)
Retrieves the `Merchant` object for the given `merchant_id`.
|
RetrieveOrderResponse |
OrdersApi.retrieveOrder(String orderId)
Retrieves an [Order]($m/Order) by ID.
|
RetrieveOrderResponse |
DefaultOrdersApi.retrieveOrder(String orderId)
Retrieves an [Order]($m/Order) by ID.
|
V1Order |
DefaultV1TransactionsApi.retrieveOrder(String locationId,
String orderId)
Deprecated.
|
V1Order |
V1TransactionsApi.retrieveOrder(String locationId,
String orderId)
Deprecated.
|
V1Payment |
DefaultV1TransactionsApi.retrievePayment(String locationId,
String paymentId)
Deprecated.
|
V1Payment |
V1TransactionsApi.retrievePayment(String locationId,
String paymentId)
Deprecated.
|
RetrievePaymentLinkResponse |
CheckoutApi.retrievePaymentLink(String id)
Retrieves a payment link.
|
RetrievePaymentLinkResponse |
DefaultCheckoutApi.retrievePaymentLink(String id)
Retrieves a payment link.
|
V1Settlement |
DefaultV1TransactionsApi.retrieveSettlement(String locationId,
String settlementId)
Deprecated.
|
V1Settlement |
V1TransactionsApi.retrieveSettlement(String locationId,
String settlementId)
Deprecated.
|
RetrieveSnippetResponse |
DefaultSnippetsApi.retrieveSnippet(String siteId)
Retrieves your snippet from a Square Online site.
|
RetrieveSnippetResponse |
SnippetsApi.retrieveSnippet(String siteId)
Retrieves your snippet from a Square Online site.
|
RetrieveSubscriptionResponse |
SubscriptionsApi.retrieveSubscription(String subscriptionId,
String include)
Retrieves a subscription.
|
RetrieveSubscriptionResponse |
DefaultSubscriptionsApi.retrieveSubscription(String subscriptionId,
String include)
Retrieves a subscription.
|
RetrieveTeamMemberResponse |
DefaultTeamApi.retrieveTeamMember(String teamMemberId)
Retrieves a `TeamMember` object for the given `TeamMember.id`.
|
RetrieveTeamMemberResponse |
TeamApi.retrieveTeamMember(String teamMemberId)
Retrieves a `TeamMember` object for the given `TeamMember.id`.
|
RetrieveTeamMemberBookingProfileResponse |
DefaultBookingsApi.retrieveTeamMemberBookingProfile(String teamMemberId)
Retrieves a team member's booking profile.
|
RetrieveTeamMemberBookingProfileResponse |
BookingsApi.retrieveTeamMemberBookingProfile(String teamMemberId)
Retrieves a team member's booking profile.
|
RetrieveTransactionResponse |
DefaultTransactionsApi.retrieveTransaction(String locationId,
String transactionId)
Deprecated.
|
RetrieveTransactionResponse |
TransactionsApi.retrieveTransaction(String locationId,
String transactionId)
Deprecated.
|
RetrieveVendorResponse |
VendorsApi.retrieveVendor(String vendorId)
Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.
|
RetrieveVendorResponse |
DefaultVendorsApi.retrieveVendor(String vendorId)
Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.
|
RetrieveWageSettingResponse |
DefaultTeamApi.retrieveWageSetting(String teamMemberId)
Retrieves a `WageSetting` object for a team member specified by `TeamMember.id`.
|
RetrieveWageSettingResponse |
TeamApi.retrieveWageSetting(String teamMemberId)
Retrieves a `WageSetting` object for a team member specified by `TeamMember.id`.
|
RevokeTokenResponse |
DefaultOAuthApi.revokeToken(RevokeTokenRequest body,
String authorization)
Revokes an access token generated with the OAuth flow.
|
RevokeTokenResponse |
OAuthApi.revokeToken(RevokeTokenRequest body,
String authorization)
Revokes an access token generated with the OAuth flow.
|
SearchAvailabilityResponse |
DefaultBookingsApi.searchAvailability(SearchAvailabilityRequest body)
Searches for availabilities for booking.
|
SearchAvailabilityResponse |
BookingsApi.searchAvailability(SearchAvailabilityRequest body)
Searches for availabilities for booking.
|
SearchCatalogItemsResponse |
DefaultCatalogApi.searchCatalogItems(SearchCatalogItemsRequest body)
Searches for catalog items or item variations by matching supported search attribute values,
including custom attribute values, against one or more of the specified query filters.
|
SearchCatalogItemsResponse |
CatalogApi.searchCatalogItems(SearchCatalogItemsRequest body)
Searches for catalog items or item variations by matching supported search attribute values,
including custom attribute values, against one or more of the specified query filters.
|
SearchCatalogObjectsResponse |
DefaultCatalogApi.searchCatalogObjects(SearchCatalogObjectsRequest body)
Searches for [CatalogObject]($m/CatalogObject) of any type by matching supported search
attribute values, excluding custom attribute values on items or item variations, against one
or more of the specified query filters.
|
SearchCatalogObjectsResponse |
CatalogApi.searchCatalogObjects(SearchCatalogObjectsRequest body)
Searches for [CatalogObject]($m/CatalogObject) of any type by matching supported search
attribute values, excluding custom attribute values on items or item variations, against one
or more of the specified query filters.
|
SearchCustomersResponse |
DefaultCustomersApi.searchCustomers(SearchCustomersRequest body)
Searches the customer profiles associated with a Square account using a supported query
filter.
|
SearchCustomersResponse |
CustomersApi.searchCustomers(SearchCustomersRequest body)
Searches the customer profiles associated with a Square account using a supported query
filter.
|
SearchInvoicesResponse |
DefaultInvoicesApi.searchInvoices(SearchInvoicesRequest body)
Searches for invoices from a location specified in the filter.
|
SearchInvoicesResponse |
InvoicesApi.searchInvoices(SearchInvoicesRequest body)
Searches for invoices from a location specified in the filter.
|
SearchLoyaltyAccountsResponse |
LoyaltyApi.searchLoyaltyAccounts(SearchLoyaltyAccountsRequest body)
Searches for loyalty accounts in a loyalty program.
|
SearchLoyaltyAccountsResponse |
DefaultLoyaltyApi.searchLoyaltyAccounts(SearchLoyaltyAccountsRequest body)
Searches for loyalty accounts in a loyalty program.
|
SearchLoyaltyEventsResponse |
LoyaltyApi.searchLoyaltyEvents(SearchLoyaltyEventsRequest body)
Searches for loyalty events.
|
SearchLoyaltyEventsResponse |
DefaultLoyaltyApi.searchLoyaltyEvents(SearchLoyaltyEventsRequest body)
Searches for loyalty events.
|
SearchLoyaltyRewardsResponse |
LoyaltyApi.searchLoyaltyRewards(SearchLoyaltyRewardsRequest body)
Searches for loyalty rewards.
|
SearchLoyaltyRewardsResponse |
DefaultLoyaltyApi.searchLoyaltyRewards(SearchLoyaltyRewardsRequest body)
Searches for loyalty rewards.
|
SearchOrdersResponse |
OrdersApi.searchOrders(SearchOrdersRequest body)
Search all orders for one or more locations.
|
SearchOrdersResponse |
DefaultOrdersApi.searchOrders(SearchOrdersRequest body)
Search all orders for one or more locations.
|
SearchShiftsResponse |
LaborApi.searchShifts(SearchShiftsRequest body)
Returns a paginated list of `Shift` records for a business.
|
SearchShiftsResponse |
DefaultLaborApi.searchShifts(SearchShiftsRequest body)
Returns a paginated list of `Shift` records for a business.
|
SearchSubscriptionsResponse |
SubscriptionsApi.searchSubscriptions(SearchSubscriptionsRequest body)
Searches for subscriptions.
|
SearchSubscriptionsResponse |
DefaultSubscriptionsApi.searchSubscriptions(SearchSubscriptionsRequest body)
Searches for subscriptions.
|
SearchTeamMembersResponse |
DefaultTeamApi.searchTeamMembers(SearchTeamMembersRequest body)
Returns a paginated list of `TeamMember` objects for a business.
|
SearchTeamMembersResponse |
TeamApi.searchTeamMembers(SearchTeamMembersRequest body)
Returns a paginated list of `TeamMember` objects for a business.
|
SearchTerminalActionsResponse |
DefaultTerminalApi.searchTerminalActions(SearchTerminalActionsRequest body)
Retrieves a filtered list of Terminal action requests created by the account making the
request.
|
SearchTerminalActionsResponse |
TerminalApi.searchTerminalActions(SearchTerminalActionsRequest body)
Retrieves a filtered list of Terminal action requests created by the account making the
request.
|
SearchTerminalCheckoutsResponse |
DefaultTerminalApi.searchTerminalCheckouts(SearchTerminalCheckoutsRequest body)
Returns a filtered list of Terminal checkout requests created by the application making the
request.
|
SearchTerminalCheckoutsResponse |
TerminalApi.searchTerminalCheckouts(SearchTerminalCheckoutsRequest body)
Returns a filtered list of Terminal checkout requests created by the application making the
request.
|
SearchTerminalRefundsResponse |
DefaultTerminalApi.searchTerminalRefunds(SearchTerminalRefundsRequest body)
Retrieves a filtered list of Interac Terminal refund requests created by the seller making
the request.
|
SearchTerminalRefundsResponse |
TerminalApi.searchTerminalRefunds(SearchTerminalRefundsRequest body)
Retrieves a filtered list of Interac Terminal refund requests created by the seller making
the request.
|
SearchVendorsResponse |
VendorsApi.searchVendors(SearchVendorsRequest body)
Searches for vendors using a filter against supported [Vendor]($m/Vendor) properties and a
supported sorter.
|
SearchVendorsResponse |
DefaultVendorsApi.searchVendors(SearchVendorsRequest body)
Searches for vendors using a filter against supported [Vendor]($m/Vendor) properties and a
supported sorter.
|
SubmitEvidenceResponse |
DefaultDisputesApi.submitEvidence(String disputeId)
Submits evidence to the cardholder's bank.
|
SubmitEvidenceResponse |
DisputesApi.submitEvidence(String disputeId)
Submits evidence to the cardholder's bank.
|
HttpRequest |
BaseApi.RequestSupplier.supply()
Supplies the HttpRequest object.
|
SwapPlanResponse |
SubscriptionsApi.swapPlan(String subscriptionId,
SwapPlanRequest body)
Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing subscription.
|
SwapPlanResponse |
DefaultSubscriptionsApi.swapPlan(String subscriptionId,
SwapPlanRequest body)
Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing subscription.
|
UnlinkCustomerFromGiftCardResponse |
GiftCardsApi.unlinkCustomerFromGiftCard(String giftCardId,
UnlinkCustomerFromGiftCardRequest body)
Unlinks a customer from a gift card, which is also referred to as removing a card on file.
|
UnlinkCustomerFromGiftCardResponse |
DefaultGiftCardsApi.unlinkCustomerFromGiftCard(String giftCardId,
UnlinkCustomerFromGiftCardRequest body)
Unlinks a customer from a gift card, which is also referred to as removing a card on file.
|
UpdateBookingResponse |
DefaultBookingsApi.updateBooking(String bookingId,
UpdateBookingRequest body)
Updates a booking.
|
UpdateBookingResponse |
BookingsApi.updateBooking(String bookingId,
UpdateBookingRequest body)
Updates a booking.
|
UpdateBreakTypeResponse |
LaborApi.updateBreakType(String id,
UpdateBreakTypeRequest body)
Updates an existing `BreakType`.
|
UpdateBreakTypeResponse |
DefaultLaborApi.updateBreakType(String id,
UpdateBreakTypeRequest body)
Updates an existing `BreakType`.
|
UpdateCatalogImageResponse |
DefaultCatalogApi.updateCatalogImage(String imageId,
UpdateCatalogImageRequest request,
FileWrapper imageFile)
Uploads a new image file to replace the existing one in the specified
[CatalogImage]($m/CatalogImage) object.
|
UpdateCatalogImageResponse |
CatalogApi.updateCatalogImage(String imageId,
UpdateCatalogImageRequest request,
FileWrapper imageFile)
Uploads a new image file to replace the existing one in the specified
[CatalogImage]($m/CatalogImage) object.
|
UpdateCustomerResponse |
DefaultCustomersApi.updateCustomer(String customerId,
UpdateCustomerRequest body)
Updates a customer profile.
|
UpdateCustomerResponse |
CustomersApi.updateCustomer(String customerId,
UpdateCustomerRequest body)
Updates a customer profile.
|
UpdateCustomerCustomAttributeDefinitionResponse |
DefaultCustomerCustomAttributesApi.updateCustomerCustomAttributeDefinition(String key,
UpdateCustomerCustomAttributeDefinitionRequest body)
Updates a customer-related custom attribute definition for a Square seller account.
|
UpdateCustomerCustomAttributeDefinitionResponse |
CustomerCustomAttributesApi.updateCustomerCustomAttributeDefinition(String key,
UpdateCustomerCustomAttributeDefinitionRequest body)
Updates a customer-related custom attribute definition for a Square seller account.
|
UpdateCustomerGroupResponse |
DefaultCustomerGroupsApi.updateCustomerGroup(String groupId,
UpdateCustomerGroupRequest body)
Updates a customer group as identified by the `group_id` value.
|
UpdateCustomerGroupResponse |
CustomerGroupsApi.updateCustomerGroup(String groupId,
UpdateCustomerGroupRequest body)
Updates a customer group as identified by the `group_id` value.
|
UpdateInvoiceResponse |
DefaultInvoicesApi.updateInvoice(String invoiceId,
UpdateInvoiceRequest body)
Updates an invoice by modifying fields, clearing fields, or both.
|
UpdateInvoiceResponse |
InvoicesApi.updateInvoice(String invoiceId,
UpdateInvoiceRequest body)
Updates an invoice by modifying fields, clearing fields, or both.
|
UpdateItemModifierListsResponse |
DefaultCatalogApi.updateItemModifierLists(UpdateItemModifierListsRequest body)
Updates the [CatalogModifierList]($m/CatalogModifierList) objects that apply to the targeted
[CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.
|
UpdateItemModifierListsResponse |
CatalogApi.updateItemModifierLists(UpdateItemModifierListsRequest body)
Updates the [CatalogModifierList]($m/CatalogModifierList) objects that apply to the targeted
[CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.
|
UpdateItemTaxesResponse |
DefaultCatalogApi.updateItemTaxes(UpdateItemTaxesRequest body)
Updates the [CatalogTax]($m/CatalogTax) objects that apply to the targeted
[CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.
|
UpdateItemTaxesResponse |
CatalogApi.updateItemTaxes(UpdateItemTaxesRequest body)
Updates the [CatalogTax]($m/CatalogTax) objects that apply to the targeted
[CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item.
|
UpdateLocationResponse |
LocationsApi.updateLocation(String locationId,
UpdateLocationRequest body)
Updates a [location](https://developer.squareup.com/docs/locations-api).
|
UpdateLocationResponse |
DefaultLocationsApi.updateLocation(String locationId,
UpdateLocationRequest body)
Updates a [location](https://developer.squareup.com/docs/locations-api).
|
V1Order |
DefaultV1TransactionsApi.updateOrder(String locationId,
String orderId,
V1UpdateOrderRequest body)
Deprecated.
|
V1Order |
V1TransactionsApi.updateOrder(String locationId,
String orderId,
V1UpdateOrderRequest body)
Deprecated.
|
UpdateOrderResponse |
OrdersApi.updateOrder(String orderId,
UpdateOrderRequest body)
Updates an open [order]($m/Order) by adding, replacing, or deleting fields.
|
UpdateOrderResponse |
DefaultOrdersApi.updateOrder(String orderId,
UpdateOrderRequest body)
Updates an open [order]($m/Order) by adding, replacing, or deleting fields.
|
UpdatePaymentResponse |
PaymentsApi.updatePayment(String paymentId,
UpdatePaymentRequest body)
Updates a payment with the APPROVED status.
|
UpdatePaymentResponse |
DefaultPaymentsApi.updatePayment(String paymentId,
UpdatePaymentRequest body)
Updates a payment with the APPROVED status.
|
UpdatePaymentLinkResponse |
CheckoutApi.updatePaymentLink(String id,
UpdatePaymentLinkRequest body)
Updates a payment link.
|
UpdatePaymentLinkResponse |
DefaultCheckoutApi.updatePaymentLink(String id,
UpdatePaymentLinkRequest body)
Updates a payment link.
|
UpdateShiftResponse |
LaborApi.updateShift(String id,
UpdateShiftRequest body)
Updates an existing `Shift`.
|
UpdateShiftResponse |
DefaultLaborApi.updateShift(String id,
UpdateShiftRequest body)
Updates an existing `Shift`.
|
UpdateSubscriptionResponse |
SubscriptionsApi.updateSubscription(String subscriptionId,
UpdateSubscriptionRequest body)
Updates a subscription.
|
UpdateSubscriptionResponse |
DefaultSubscriptionsApi.updateSubscription(String subscriptionId,
UpdateSubscriptionRequest body)
Updates a subscription.
|
UpdateTeamMemberResponse |
DefaultTeamApi.updateTeamMember(String teamMemberId,
UpdateTeamMemberRequest body)
Updates a single `TeamMember` object.
|
UpdateTeamMemberResponse |
TeamApi.updateTeamMember(String teamMemberId,
UpdateTeamMemberRequest body)
Updates a single `TeamMember` object.
|
UpdateVendorResponse |
VendorsApi.updateVendor(UpdateVendorRequest body,
String vendorId)
Updates an existing [Vendor]($m/Vendor) object as a supplier to a seller.
|
UpdateVendorResponse |
DefaultVendorsApi.updateVendor(UpdateVendorRequest body,
String vendorId)
Updates an existing [Vendor]($m/Vendor) object as a supplier to a seller.
|
UpdateWageSettingResponse |
DefaultTeamApi.updateWageSetting(String teamMemberId,
UpdateWageSettingRequest body)
Creates or updates a `WageSetting` object.
|
UpdateWageSettingResponse |
TeamApi.updateWageSetting(String teamMemberId,
UpdateWageSettingRequest body)
Creates or updates a `WageSetting` object.
|
UpdateWorkweekConfigResponse |
LaborApi.updateWorkweekConfig(String id,
UpdateWorkweekConfigRequest body)
Updates a `WorkweekConfig`.
|
UpdateWorkweekConfigResponse |
DefaultLaborApi.updateWorkweekConfig(String id,
UpdateWorkweekConfigRequest body)
Updates a `WorkweekConfig`.
|
UpsertCatalogObjectResponse |
DefaultCatalogApi.upsertCatalogObject(UpsertCatalogObjectRequest body)
Creates or updates the target [CatalogObject]($m/CatalogObject).
|
UpsertCatalogObjectResponse |
CatalogApi.upsertCatalogObject(UpsertCatalogObjectRequest body)
Creates or updates the target [CatalogObject]($m/CatalogObject).
|
UpsertCustomerCustomAttributeResponse |
DefaultCustomerCustomAttributesApi.upsertCustomerCustomAttribute(String customerId,
String key,
UpsertCustomerCustomAttributeRequest body)
Creates or updates a custom attribute for a customer profile.
|
UpsertCustomerCustomAttributeResponse |
CustomerCustomAttributesApi.upsertCustomerCustomAttribute(String customerId,
String key,
UpsertCustomerCustomAttributeRequest body)
Creates or updates a custom attribute for a customer profile.
|
UpsertSnippetResponse |
DefaultSnippetsApi.upsertSnippet(String siteId,
UpsertSnippetRequest body)
Adds a snippet to a Square Online site or updates the existing snippet on the site.
|
UpsertSnippetResponse |
SnippetsApi.upsertSnippet(String siteId,
UpsertSnippetRequest body)
Adds a snippet to a Square Online site or updates the existing snippet on the site.
|
protected void |
BaseApi.validateResponse(HttpResponse response,
HttpContext context)
Validates the response against HTTP errors defined at the API level.
|
VoidTransactionResponse |
DefaultTransactionsApi.voidTransaction(String locationId,
String transactionId)
Deprecated.
|
VoidTransactionResponse |
TransactionsApi.voidTransaction(String locationId,
String transactionId)
Deprecated.
|
Copyright © 2022. All rights reserved.