SquareApiClient class abstract

Annotations
  • @RestApi()

Constructors

SquareApiClient({required String accessToken, String baseUrl = 'https://connect.squareup.com', String? apiVersion})
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

accumulateLoyaltyPoints({required AccumulateLoyaltyPointsRequest body, required String accountId}) → Future<AccumulateLoyaltyPointsResponse>
adjustLoyaltyPoints({required AdjustLoyaltyPointsRequest body, required String accountId}) → Future<AdjustLoyaltyPointsResponse>
batchRetrieveCatalogObjects({required BatchRetrieveCatalogObjectsRequest body}) → Future<BatchRetrieveCatalogObjectsResponse>
batchRetrieveOrders({required BatchRetrieveOrdersRequest body}) → Future<BatchRetrieveOrdersResponse>
Retrieves a set of orders by their IDs.
calculateLoyaltyPoints({required String programId, required CalculateLoyaltyPointsRequest body}) → Future<CalculateLoyaltyPointsResponse>
calculateOrder({required CalculateOrderRequest body}) → Future<CalculateOrderResponse>
Enables applications to preview order pricing without creating an order.
cancelInvoice({required String invoiceId, required CancelInvoiceRequest body}) → Future<CancelInvoiceResponse>
Cancels an invoice.
cancelSubscription({required String subscriptionId}) → Future<CancelSubscriptionResponse>
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.
cloneOrder({required CloneOrderRequest body}) → Future<CloneOrderResponse>
Creates a new order, in the DRAFT state, by duplicating an existing order.
createCard({required CreateCardRequest body}) → Future<CreateCardResponse>
createCheckout({required String locationId, required CreateCheckoutRequest body}) → Future<CreateCheckoutResponse>
createCustomer({required CreateCustomerRequest body}) → Future<CreateCustomerResponse>
createCustomerGroup({required CreateCustomerGroupRequest body}) → Future<CreateCustomerGroupRequest>
Creates a new customer group for a business. The request must include the name value of the group.
createGiftCard({required CreateGiftCardRequest body}) → Future<CreateGiftCardResponse>
Creates a digital gift card or registers a physical (plastic) gift card.
createGiftCardActivity({required CreateGiftCardActivityRequest body}) → Future<CreateGiftCardActivityResponse>
Creates a gift card activity to manage the balance or state of a gift card.
createInvoice({required CreateInvoiceRequest body}) → Future<CreateInvoiceResponse>
Creates a draft invoice for an order created using the Orders API.
createLocation({required CreateLocationRequest input}) → Future<CreateLocationResponse>
createLoyaltyAccount({required CreateLoyaltyAccountRequest body}) → Future<CreateLoyaltyAccountResponse>
createLoyaltyReward({required CreateLoyaltyRewardRequest body}) → Future<CreateLoyaltyRewardResponse>
createOrder({required CreateOrderRequest body}) → Future<CreateOrderResponse>
Creates a new order that can include information about products for purchase and settings to apply to the purchase.
createPayment({required CreatePaymentRequest body}) → Future<CreatePaymentResponse>
createSubscription({required CreateSubscriptionRequest body}) → Future<CreateSubscriptionResponse>
Creates a subscription to a subscription plan by a customer.
deleteCustomer({required String customerId}) → Future<DeleteCustomerResponse>
deleteCustomerGroup({required String groupId}) → Future<DeleteCustomerGroupResponse>
Deletes a customer group as identified by the group_id value.
deleteInvoice({required String invoiceId, int? version}) → Future<DeleteInvoiceResponse>
Deletes the specified invoice.
deleteLoyaltyReward({required String rewardId}) → Future<DeleteLoyaltyReward>
deleteSubscriptionAction({required String subscriptionId, required String actionId}) → Future<DeleteSubscriptionActionResponse>
Deletes a scheduled action for a subscription.
disableCard({required String cardId}) → Future<DisableCardResponse>
getInvoice({required String invoiceId}) → Future<GetInvoiceResponse>
Retrieves an invoice by invoice ID.
linkCustomerToGiftCard({required LinkCustomerToGiftCardRequest body, required String giftCardId}) → Future<LinkCustomerToGiftCardResponse>
Links a customer to a gift card, which is also referred to as adding a card on file.
listCards({String? cursor, String? customerId, bool? includeDisabled, String? referenceId, String? sortOrder}) → Future<ListCardsResponse>
listCatalog({String? cursor, String? types, int? catalogVersion}) → Future<ListCatalogResponse>
listCustomerGroups({String? cursor, int? limit}) → Future<ListCustomerGroupsResponse>
Retrieves the list of customer groups of a business.
listCustomers({String? cursor, int? limit, CustomerSortField? sortField, SortOrder? sortOrder}) → Future<ListCustomersResponse>
listCustomerSegments({String? cursor, int? limit}) → Future<ListCustomerSegmentsResponse>
Retrieves the list of customer segments of a business.
listGiftCardActivities({String? giftCardId, String? type, String? locationId, String? beginTime, String? endTime, int? limit, String? cursor, String? sortOrder}) → Future<ListGiftCardsResponse>
Lists gift card activities.
listGiftCards({String? type, String? state, int? limit, String? cursor, String? customerId}) → Future<ListGiftCardsResponse>
Lists all gift cards.
listInvoices({required String locationId, String? cursor, int? limit}) → Future<ListInvoicesResponse>
Returns a list of invoices for a given location.
listLocations() → Future<ListLocationsResponse>
listMerchants({int? cursor}) → Future<ListMerchantsResponse>
listSubscriptionEvents({required String subscriptionId, String? cursor, String? limit}) → Future<ListSubscriptionEventsResponse>
Lists all events for a specific subscription.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
obtainToken({required ObtainTokenRequest body}) → Future<ObtainTokenResponse>
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.
pauseSubscription({required String subscriptionId, required PauseSubscriptionRequest body}) → Future<PauseSubscriptionResponse>
Schedules a PAUSE action to pause an active subscription.
payOrder({required String orderId, required PayOrderRequest payOrderRequest}) → Future<PayOrderResponse>
Pay for an order using one or more approved payments or settle an order with a total of 0.
publishInvoice({required String invoiceId, required PublishInvoiceRequest body}) → Future<PublishInvoiceResponse>
Publishes the specified draft invoice.
redeemLoyaltyReward({required String rewardId, required RedeemLoyaltyRewardRequest body}) → Future<RedeemLoyaltyRewardResponse>
resumeSubscription({required String subscriptionId, required ResumeSubscriptionRequest body}) → Future<ResumeSubscriptionResponse>
Schedules a RESUME action to resume a paused or a deactivated subscription.
retrieveCard({required String cardId}) → Future<RetrieveCardResponse>
retrieveCatalogObject({required String objectId, bool? includeRelatedObjects, int? catalogVersion}) → Future<RetrieveCatalogObjectResponse>
retrieveCustomer({required String customerId}) → Future<RetrieveCustomerResponse>
retrieveCustomerGroup({required String groupId}) → Future<RetrieveCustomerGroupResponse>
Retrieves a specific customer group as identified by the group_id value.
retrieveCustomerSegment({required String segmentId}) → Future<RetrieveCustomerSegmentResponse>
Retrieves a specific customer segment as identified by the segment_id value.
retrieveGiftCard({required String id}) → Future<RetrieveGiftCardResponse>
Retrieves a gift card using the gift card ID.
retrieveGiftCardFromGAN({required RetrieveGiftCardFromGanRequest body}) → Future<RetrieveGiftCardFromGanResponse>
Retrieves a gift card using the gift card account number (GAN).
retrieveGiftCardFromNonce({required RetrieveGiftCardFromNonceRequest body}) → Future<RetrieveGiftCardFromNonceResponse>
Retrieves a gift card using a secure payment token that represents the gift card.
retrieveLocation({required String locationId}) → Future<RetrieveLocationResponse>
retrieveLoyaltyAccount({required String accountId}) → Future<RetrieveLoyaltyAccountResponse>
retrieveLoyaltyProgram({required String programId}) → Future<RetrieveLoyaltyProgramResponse>
retrieveLoyaltyReward({required String rewardId}) → Future<RetrieveLoyaltyRewardResponse>
retrieveMerchant({required String merchantId}) → Future<RetrieveMerchantResponse>
retrieveOrder({required String orderId}) → Future<RetrieveOrderResponse>
Retrieves an Order by ID.
retrieveSubscription({required String subscriptionId, String? include}) → Future<RetrieveSubscriptionResponse>
Retrieves a subscription.
retrieveTokenStatus() → Future<RetrieveTokenStatusResponse>
Returns information about an OAuth access token or an application’s personal access token.
revokeToken({required RevokeTokenRequest body, required String applicationSecret}) → Future<RevokeTokenResponse>
Revokes an access token generated with the OAuth flow.
searchCatalog({required SearchCatalogRequest body}) → Future<SearchCatalogResponse>
searchCustomers({required SearchCustomersRequest body}) → Future<SearchCustomersResponse>
searchInvoices({required SearchInvoicesRequest body}) → Future<SearchInvoicesResponse>
Searches for invoices from a location specified in the filter.
searchLoyaltyAccounts({required SearchLoyaltyAccountsRequest body}) → Future<SearchLoyaltyAccountsResponse>
searchLoyaltyEvents({required SearchLoyaltyEventsRequest body}) → Future<SearchLoyaltyEventsResponse>
searchOrders({required SearchOrdersRequest body}) → Future<SearchOrdersResponse>
Search all orders for one or more locations.
searchSubscriptions({required SearchSubscriptionsRequest body}) → Future<SearchSubscriptionsResponse>
Searches for subscriptions.
swapPlan({required String subscriptionId, required SwapPlanResponse body}) → Future<SwapPlanResponse>
Schedules a SWAP_PLAN action to swap a subscription plan in an existing subscription.
toString() → String
A string representation of this object.
inherited
unlinkCustomerFromGiftCard({required UnlinkCustomerFromGiftCardRequest body, required String giftCardId}) → Future<UnlinkCustomerFromGiftCardResponse>
Unlinks a customer from a gift card, which is also referred to as removing a card on file.
updateCustomer({required String customerId, required UpdateCustomerRequest body}) → Future<UpdateCustomerResponse>
updateCustomerGroup({required String groupId, required UpdateCustomerGroupRequest body}) → Future<UpdateCustomerGroupResponse>
Updates a customer group as identified by the group_id value.
updateInvoice({required String invoiceId, required UpdateInvoiceRequest body}) → Future<UpdateInvoiceResponse>
Updates an invoice by modifying fields, clearing fields, or both.
updateLocation({required String locationId, required UpdateLocationRequest body}) → Future<UpdateLocationResponse>
updateOrder({required String orderId, required UpdateOrderRequest body}) → Future<UpdateOrderResponse>
Updates an open order by adding, replacing, or deleting fields.
updateSubscription({required String subscriptionId, required UpdateSubscriptionRequest body}) → Future<UpdateSubscriptionResponse>
Updates a subscription.SquareApiClient

Operators

operator ==(Object other) → bool
The equality operator.
inherited