Giters

iwatakeshi / square-dart-sdk

The unofficial Square Dart SDK

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

openapi

Client library for accessing the Square Connect APIs

This Dart package is automatically generated by the OpenAPI Generator project:

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  square_dart_sdk:
    git: https://github.com/iwatakeshi/connect-dart-sdk.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  square_dart_sdk:
    path: /path/to/square_dart_sdk

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:square_dart_sdk/api.dart';

// TODO Configure OAuth2 access token for authorization: oauth2
//defaultApiClient.getAuthentication<OAuth>('oauth2').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ApplePayApi();
final body = RegisterDomainRequest(); // RegisterDomainRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    final result = api_instance.registerDomain(body);
    print(result);
} catch (e) {
    print('Exception when calling ApplePayApi->registerDomain: $e\n');
}

Documentation for API Endpoints

All URIs are relative to https://connect.squareup.com

Class Method HTTP request Description
ApplePayApi registerDomain POST /v2/apple-pay/domains RegisterDomain
BankAccountsApi getBankAccount GET /v2/bank-accounts/{bank_account_id} GetBankAccount
BankAccountsApi getBankAccountByV1Id GET /v2/bank-accounts/by-v1-id/{v1_bank_account_id} GetBankAccountByV1Id
BankAccountsApi listBankAccounts GET /v2/bank-accounts ListBankAccounts
BookingCustomAttributesApi bulkDeleteBookingCustomAttributes POST /v2/bookings/custom-attributes/bulk-delete BulkDeleteBookingCustomAttributes
BookingCustomAttributesApi bulkUpsertBookingCustomAttributes POST /v2/bookings/custom-attributes/bulk-upsert BulkUpsertBookingCustomAttributes
BookingCustomAttributesApi createBookingCustomAttributeDefinition POST /v2/bookings/custom-attribute-definitions CreateBookingCustomAttributeDefinition
BookingCustomAttributesApi deleteBookingCustomAttribute DELETE /v2/bookings/{booking_id}/custom-attributes/{key} DeleteBookingCustomAttribute
BookingCustomAttributesApi deleteBookingCustomAttributeDefinition DELETE /v2/bookings/custom-attribute-definitions/{key} DeleteBookingCustomAttributeDefinition
BookingCustomAttributesApi listBookingCustomAttributeDefinitions GET /v2/bookings/custom-attribute-definitions ListBookingCustomAttributeDefinitions
BookingCustomAttributesApi listBookingCustomAttributes GET /v2/bookings/{booking_id}/custom-attributes ListBookingCustomAttributes
BookingCustomAttributesApi retrieveBookingCustomAttribute GET /v2/bookings/{booking_id}/custom-attributes/{key} RetrieveBookingCustomAttribute
BookingCustomAttributesApi retrieveBookingCustomAttributeDefinition GET /v2/bookings/custom-attribute-definitions/{key} RetrieveBookingCustomAttributeDefinition
BookingCustomAttributesApi updateBookingCustomAttributeDefinition PUT /v2/bookings/custom-attribute-definitions/{key} UpdateBookingCustomAttributeDefinition
BookingCustomAttributesApi upsertBookingCustomAttribute PUT /v2/bookings/{booking_id}/custom-attributes/{key} UpsertBookingCustomAttribute
BookingsApi bulkRetrieveBookings POST /v2/bookings/bulk-retrieve BulkRetrieveBookings
BookingsApi bulkRetrieveTeamMemberBookingProfiles POST /v2/bookings/team-member-booking-profiles/bulk-retrieve BulkRetrieveTeamMemberBookingProfiles
BookingsApi cancelBooking POST /v2/bookings/{booking_id}/cancel CancelBooking
BookingsApi createBooking POST /v2/bookings CreateBooking
BookingsApi listBookings GET /v2/bookings ListBookings
BookingsApi listLocationBookingProfiles GET /v2/bookings/location-booking-profiles ListLocationBookingProfiles
BookingsApi listTeamMemberBookingProfiles GET /v2/bookings/team-member-booking-profiles ListTeamMemberBookingProfiles
BookingsApi retrieveBooking GET /v2/bookings/{booking_id} RetrieveBooking
BookingsApi retrieveBusinessBookingProfile GET /v2/bookings/business-booking-profile RetrieveBusinessBookingProfile
BookingsApi retrieveLocationBookingProfile GET /v2/bookings/location-booking-profiles/{location_id} RetrieveLocationBookingProfile
BookingsApi retrieveTeamMemberBookingProfile GET /v2/bookings/team-member-booking-profiles/{team_member_id} RetrieveTeamMemberBookingProfile
BookingsApi searchAvailability POST /v2/bookings/availability/search SearchAvailability
BookingsApi updateBooking PUT /v2/bookings/{booking_id} UpdateBooking
CardsApi createCard POST /v2/cards CreateCard
CardsApi disableCard POST /v2/cards/{card_id}/disable DisableCard
CardsApi listCards GET /v2/cards ListCards
CardsApi retrieveCard GET /v2/cards/{card_id} RetrieveCard
CashDrawersApi listCashDrawerShiftEvents GET /v2/cash-drawers/shifts/{shift_id}/events ListCashDrawerShiftEvents
CashDrawersApi listCashDrawerShifts GET /v2/cash-drawers/shifts ListCashDrawerShifts
CashDrawersApi retrieveCashDrawerShift GET /v2/cash-drawers/shifts/{shift_id} RetrieveCashDrawerShift
CatalogApi batchDeleteCatalogObjects POST /v2/catalog/batch-delete BatchDeleteCatalogObjects
CatalogApi batchRetrieveCatalogObjects POST /v2/catalog/batch-retrieve BatchRetrieveCatalogObjects
CatalogApi batchUpsertCatalogObjects POST /v2/catalog/batch-upsert BatchUpsertCatalogObjects
CatalogApi catalogInfo GET /v2/catalog/info CatalogInfo
CatalogApi deleteCatalogObject DELETE /v2/catalog/object/{object_id} DeleteCatalogObject
CatalogApi listCatalog GET /v2/catalog/list ListCatalog
CatalogApi retrieveCatalogObject GET /v2/catalog/object/{object_id} RetrieveCatalogObject
CatalogApi searchCatalogItems POST /v2/catalog/search-catalog-items SearchCatalogItems
CatalogApi searchCatalogObjects POST /v2/catalog/search SearchCatalogObjects
CatalogApi updateItemModifierLists POST /v2/catalog/update-item-modifier-lists UpdateItemModifierLists
CatalogApi updateItemTaxes POST /v2/catalog/update-item-taxes UpdateItemTaxes
CatalogApi upsertCatalogObject POST /v2/catalog/object UpsertCatalogObject
CheckoutApi createCheckout POST /v2/locations/{location_id}/checkouts CreateCheckout
CheckoutApi createPaymentLink POST /v2/online-checkout/payment-links CreatePaymentLink
CheckoutApi deletePaymentLink DELETE /v2/online-checkout/payment-links/{id} DeletePaymentLink
CheckoutApi listPaymentLinks GET /v2/online-checkout/payment-links ListPaymentLinks
CheckoutApi retrieveLocationSettings GET /v2/online-checkout/location-settings/{location_id} RetrieveLocationSettings
CheckoutApi retrieveMerchantSettings GET /v2/online-checkout/merchant-settings RetrieveMerchantSettings
CheckoutApi retrievePaymentLink GET /v2/online-checkout/payment-links/{id} RetrievePaymentLink
CheckoutApi updateLocationSettings PUT /v2/online-checkout/location-settings/{location_id} UpdateLocationSettings
CheckoutApi updateMerchantSettings PUT /v2/online-checkout/merchant-settings UpdateMerchantSettings
CheckoutApi updatePaymentLink PUT /v2/online-checkout/payment-links/{id} UpdatePaymentLink
CustomerCustomAttributesApi bulkUpsertCustomerCustomAttributes POST /v2/customers/custom-attributes/bulk-upsert BulkUpsertCustomerCustomAttributes
CustomerCustomAttributesApi createCustomerCustomAttributeDefinition POST /v2/customers/custom-attribute-definitions CreateCustomerCustomAttributeDefinition
CustomerCustomAttributesApi deleteCustomerCustomAttribute DELETE /v2/customers/{customer_id}/custom-attributes/{key} DeleteCustomerCustomAttribute
CustomerCustomAttributesApi deleteCustomerCustomAttributeDefinition DELETE /v2/customers/custom-attribute-definitions/{key} DeleteCustomerCustomAttributeDefinition
CustomerCustomAttributesApi listCustomerCustomAttributeDefinitions GET /v2/customers/custom-attribute-definitions ListCustomerCustomAttributeDefinitions
CustomerCustomAttributesApi listCustomerCustomAttributes GET /v2/customers/{customer_id}/custom-attributes ListCustomerCustomAttributes
CustomerCustomAttributesApi retrieveCustomerCustomAttribute GET /v2/customers/{customer_id}/custom-attributes/{key} RetrieveCustomerCustomAttribute
CustomerCustomAttributesApi retrieveCustomerCustomAttributeDefinition GET /v2/customers/custom-attribute-definitions/{key} RetrieveCustomerCustomAttributeDefinition
CustomerCustomAttributesApi updateCustomerCustomAttributeDefinition PUT /v2/customers/custom-attribute-definitions/{key} UpdateCustomerCustomAttributeDefinition
CustomerCustomAttributesApi upsertCustomerCustomAttribute POST /v2/customers/{customer_id}/custom-attributes/{key} UpsertCustomerCustomAttribute
CustomerGroupsApi createCustomerGroup POST /v2/customers/groups CreateCustomerGroup
CustomerGroupsApi deleteCustomerGroup DELETE /v2/customers/groups/{group_id} DeleteCustomerGroup
CustomerGroupsApi listCustomerGroups GET /v2/customers/groups ListCustomerGroups
CustomerGroupsApi retrieveCustomerGroup GET /v2/customers/groups/{group_id} RetrieveCustomerGroup
CustomerGroupsApi updateCustomerGroup PUT /v2/customers/groups/{group_id} UpdateCustomerGroup
CustomerSegmentsApi listCustomerSegments GET /v2/customers/segments ListCustomerSegments
CustomerSegmentsApi retrieveCustomerSegment GET /v2/customers/segments/{segment_id} RetrieveCustomerSegment
CustomersApi addGroupToCustomer PUT /v2/customers/{customer_id}/groups/{group_id} AddGroupToCustomer
CustomersApi createCustomer POST /v2/customers CreateCustomer
CustomersApi createCustomerCard POST /v2/customers/{customer_id}/cards CreateCustomerCard
CustomersApi deleteCustomer DELETE /v2/customers/{customer_id} DeleteCustomer
CustomersApi deleteCustomerCard DELETE /v2/customers/{customer_id}/cards/{card_id} DeleteCustomerCard
CustomersApi listCustomers GET /v2/customers ListCustomers
CustomersApi removeGroupFromCustomer DELETE /v2/customers/{customer_id}/groups/{group_id} RemoveGroupFromCustomer
CustomersApi retrieveCustomer GET /v2/customers/{customer_id} RetrieveCustomer
CustomersApi searchCustomers POST /v2/customers/search SearchCustomers
CustomersApi updateCustomer PUT /v2/customers/{customer_id} UpdateCustomer
DevicesApi createDeviceCode POST /v2/devices/codes CreateDeviceCode
DevicesApi getDevice GET /v2/devices/{device_id} GetDevice
DevicesApi getDeviceCode GET /v2/devices/codes/{id} GetDeviceCode
DevicesApi listDeviceCodes GET /v2/devices/codes ListDeviceCodes
DevicesApi listDevices GET /v2/devices ListDevices
DisputesApi acceptDispute POST /v2/disputes/{dispute_id}/accept AcceptDispute
DisputesApi createDisputeEvidenceText POST /v2/disputes/{dispute_id}/evidence-text CreateDisputeEvidenceText
DisputesApi deleteDisputeEvidence DELETE /v2/disputes/{dispute_id}/evidence/{evidence_id} DeleteDisputeEvidence
DisputesApi listDisputeEvidence GET /v2/disputes/{dispute_id}/evidence ListDisputeEvidence
DisputesApi listDisputes GET /v2/disputes ListDisputes
DisputesApi retrieveDispute GET /v2/disputes/{dispute_id} RetrieveDispute
DisputesApi retrieveDisputeEvidence GET /v2/disputes/{dispute_id}/evidence/{evidence_id} RetrieveDisputeEvidence
DisputesApi submitEvidence POST /v2/disputes/{dispute_id}/submit-evidence SubmitEvidence
EmployeesApi listEmployees GET /v2/employees ListEmployees
EmployeesApi retrieveEmployee GET /v2/employees/{id} RetrieveEmployee
GiftCardActivitiesApi createGiftCardActivity POST /v2/gift-cards/activities CreateGiftCardActivity
GiftCardActivitiesApi listGiftCardActivities GET /v2/gift-cards/activities ListGiftCardActivities
GiftCardsApi createGiftCard POST /v2/gift-cards CreateGiftCard
GiftCardsApi linkCustomerToGiftCard POST /v2/gift-cards/{gift_card_id}/link-customer LinkCustomerToGiftCard
GiftCardsApi listGiftCards GET /v2/gift-cards ListGiftCards
GiftCardsApi retrieveGiftCard GET /v2/gift-cards/{id} RetrieveGiftCard
GiftCardsApi retrieveGiftCardFromGAN POST /v2/gift-cards/from-gan RetrieveGiftCardFromGAN
GiftCardsApi retrieveGiftCardFromNonce POST /v2/gift-cards/from-nonce RetrieveGiftCardFromNonce
GiftCardsApi unlinkCustomerFromGiftCard POST /v2/gift-cards/{gift_card_id}/unlink-customer UnlinkCustomerFromGiftCard
InventoryApi batchChangeInventory POST /v2/inventory/changes/batch-create BatchChangeInventory
InventoryApi batchRetrieveInventoryChanges POST /v2/inventory/changes/batch-retrieve BatchRetrieveInventoryChanges
InventoryApi batchRetrieveInventoryCounts POST /v2/inventory/counts/batch-retrieve BatchRetrieveInventoryCounts
InventoryApi deprecatedBatchChangeInventory POST /v2/inventory/batch-change DeprecatedBatchChangeInventory
InventoryApi deprecatedBatchRetrieveInventoryChanges POST /v2/inventory/batch-retrieve-changes DeprecatedBatchRetrieveInventoryChanges
InventoryApi deprecatedBatchRetrieveInventoryCounts POST /v2/inventory/batch-retrieve-counts DeprecatedBatchRetrieveInventoryCounts
InventoryApi deprecatedRetrieveInventoryAdjustment GET /v2/inventory/adjustment/{adjustment_id} DeprecatedRetrieveInventoryAdjustment
InventoryApi deprecatedRetrieveInventoryPhysicalCount GET /v2/inventory/physical-count/{physical_count_id} DeprecatedRetrieveInventoryPhysicalCount
InventoryApi retrieveInventoryAdjustment GET /v2/inventory/adjustments/{adjustment_id} RetrieveInventoryAdjustment
InventoryApi retrieveInventoryChanges GET /v2/inventory/{catalog_object_id}/changes RetrieveInventoryChanges
InventoryApi retrieveInventoryCount GET /v2/inventory/{catalog_object_id} RetrieveInventoryCount
InventoryApi retrieveInventoryPhysicalCount GET /v2/inventory/physical-counts/{physical_count_id} RetrieveInventoryPhysicalCount
InventoryApi retrieveInventoryTransfer GET /v2/inventory/transfers/{transfer_id} RetrieveInventoryTransfer
InvoicesApi cancelInvoice POST /v2/invoices/{invoice_id}/cancel CancelInvoice
InvoicesApi createInvoice POST /v2/invoices CreateInvoice
InvoicesApi deleteInvoice DELETE /v2/invoices/{invoice_id} DeleteInvoice
InvoicesApi getInvoice GET /v2/invoices/{invoice_id} GetInvoice
InvoicesApi listInvoices GET /v2/invoices ListInvoices
InvoicesApi publishInvoice POST /v2/invoices/{invoice_id}/publish PublishInvoice
InvoicesApi searchInvoices POST /v2/invoices/search SearchInvoices
InvoicesApi updateInvoice PUT /v2/invoices/{invoice_id} UpdateInvoice
LaborApi createBreakType POST /v2/labor/break-types CreateBreakType
LaborApi createShift POST /v2/labor/shifts CreateShift
LaborApi deleteBreakType DELETE /v2/labor/break-types/{id} DeleteBreakType
LaborApi deleteShift DELETE /v2/labor/shifts/{id} DeleteShift
LaborApi getBreakType GET /v2/labor/break-types/{id} GetBreakType
LaborApi getEmployeeWage GET /v2/labor/employee-wages/{id} GetEmployeeWage
LaborApi getShift GET /v2/labor/shifts/{id} GetShift
LaborApi getTeamMemberWage GET /v2/labor/team-member-wages/{id} GetTeamMemberWage
LaborApi listBreakTypes GET /v2/labor/break-types ListBreakTypes
LaborApi listEmployeeWages GET /v2/labor/employee-wages ListEmployeeWages
LaborApi listTeamMemberWages GET /v2/labor/team-member-wages ListTeamMemberWages
LaborApi listWorkweekConfigs GET /v2/labor/workweek-configs ListWorkweekConfigs
LaborApi searchShifts POST /v2/labor/shifts/search SearchShifts
LaborApi updateBreakType PUT /v2/labor/break-types/{id} UpdateBreakType
LaborApi updateShift PUT /v2/labor/shifts/{id} UpdateShift
LaborApi updateWorkweekConfig PUT /v2/labor/workweek-configs/{id} UpdateWorkweekConfig
LocationCustomAttributesApi bulkDeleteLocationCustomAttributes POST /v2/locations/custom-attributes/bulk-delete BulkDeleteLocationCustomAttributes
LocationCustomAttributesApi bulkUpsertLocationCustomAttributes POST /v2/locations/custom-attributes/bulk-upsert BulkUpsertLocationCustomAttributes
LocationCustomAttributesApi createLocationCustomAttributeDefinition POST /v2/locations/custom-attribute-definitions CreateLocationCustomAttributeDefinition
LocationCustomAttributesApi deleteLocationCustomAttribute DELETE /v2/locations/{location_id}/custom-attributes/{key} DeleteLocationCustomAttribute
LocationCustomAttributesApi deleteLocationCustomAttributeDefinition DELETE /v2/locations/custom-attribute-definitions/{key} DeleteLocationCustomAttributeDefinition
LocationCustomAttributesApi listLocationCustomAttributeDefinitions GET /v2/locations/custom-attribute-definitions ListLocationCustomAttributeDefinitions
LocationCustomAttributesApi listLocationCustomAttributes GET /v2/locations/{location_id}/custom-attributes ListLocationCustomAttributes
LocationCustomAttributesApi retrieveLocationCustomAttribute GET /v2/locations/{location_id}/custom-attributes/{key} RetrieveLocationCustomAttribute
LocationCustomAttributesApi retrieveLocationCustomAttributeDefinition GET /v2/locations/custom-attribute-definitions/{key} RetrieveLocationCustomAttributeDefinition
LocationCustomAttributesApi updateLocationCustomAttributeDefinition PUT /v2/locations/custom-attribute-definitions/{key} UpdateLocationCustomAttributeDefinition
LocationCustomAttributesApi upsertLocationCustomAttribute POST /v2/locations/{location_id}/custom-attributes/{key} UpsertLocationCustomAttribute
LocationsApi createLocation POST /v2/locations CreateLocation
LocationsApi listLocations GET /v2/locations ListLocations
LocationsApi retrieveLocation GET /v2/locations/{location_id} RetrieveLocation
LocationsApi updateLocation PUT /v2/locations/{location_id} UpdateLocation
LoyaltyApi accumulateLoyaltyPoints POST /v2/loyalty/accounts/{account_id}/accumulate AccumulateLoyaltyPoints
LoyaltyApi adjustLoyaltyPoints POST /v2/loyalty/accounts/{account_id}/adjust AdjustLoyaltyPoints
LoyaltyApi calculateLoyaltyPoints POST /v2/loyalty/programs/{program_id}/calculate CalculateLoyaltyPoints
LoyaltyApi cancelLoyaltyPromotion POST /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel CancelLoyaltyPromotion
LoyaltyApi createLoyaltyAccount POST /v2/loyalty/accounts CreateLoyaltyAccount
LoyaltyApi createLoyaltyPromotion POST /v2/loyalty/programs/{program_id}/promotions CreateLoyaltyPromotion
LoyaltyApi createLoyaltyReward POST /v2/loyalty/rewards CreateLoyaltyReward
LoyaltyApi deleteLoyaltyReward DELETE /v2/loyalty/rewards/{reward_id} DeleteLoyaltyReward
LoyaltyApi listLoyaltyPrograms GET /v2/loyalty/programs ListLoyaltyPrograms
LoyaltyApi listLoyaltyPromotions GET /v2/loyalty/programs/{program_id}/promotions ListLoyaltyPromotions
LoyaltyApi redeemLoyaltyReward POST /v2/loyalty/rewards/{reward_id}/redeem RedeemLoyaltyReward
LoyaltyApi retrieveLoyaltyAccount GET /v2/loyalty/accounts/{account_id} RetrieveLoyaltyAccount
LoyaltyApi retrieveLoyaltyProgram GET /v2/loyalty/programs/{program_id} RetrieveLoyaltyProgram
LoyaltyApi retrieveLoyaltyPromotion GET /v2/loyalty/programs/{program_id}/promotions/{promotion_id} RetrieveLoyaltyPromotion
LoyaltyApi retrieveLoyaltyReward GET /v2/loyalty/rewards/{reward_id} RetrieveLoyaltyReward
LoyaltyApi searchLoyaltyAccounts POST /v2/loyalty/accounts/search SearchLoyaltyAccounts
LoyaltyApi searchLoyaltyEvents POST /v2/loyalty/events/search SearchLoyaltyEvents
LoyaltyApi searchLoyaltyRewards POST /v2/loyalty/rewards/search SearchLoyaltyRewards
MerchantCustomAttributesApi bulkDeleteMerchantCustomAttributes POST /v2/merchants/custom-attributes/bulk-delete BulkDeleteMerchantCustomAttributes
MerchantCustomAttributesApi bulkUpsertMerchantCustomAttributes POST /v2/merchants/custom-attributes/bulk-upsert BulkUpsertMerchantCustomAttributes
MerchantCustomAttributesApi createMerchantCustomAttributeDefinition POST /v2/merchants/custom-attribute-definitions CreateMerchantCustomAttributeDefinition
MerchantCustomAttributesApi deleteMerchantCustomAttribute DELETE /v2/merchants/{merchant_id}/custom-attributes/{key} DeleteMerchantCustomAttribute
MerchantCustomAttributesApi deleteMerchantCustomAttributeDefinition DELETE /v2/merchants/custom-attribute-definitions/{key} DeleteMerchantCustomAttributeDefinition
MerchantCustomAttributesApi listMerchantCustomAttributeDefinitions GET /v2/merchants/custom-attribute-definitions ListMerchantCustomAttributeDefinitions
MerchantCustomAttributesApi listMerchantCustomAttributes GET /v2/merchants/{merchant_id}/custom-attributes ListMerchantCustomAttributes
MerchantCustomAttributesApi retrieveMerchantCustomAttribute GET /v2/merchants/{merchant_id}/custom-attributes/{key} RetrieveMerchantCustomAttribute
MerchantCustomAttributesApi retrieveMerchantCustomAttributeDefinition GET /v2/merchants/custom-attribute-definitions/{key} RetrieveMerchantCustomAttributeDefinition
MerchantCustomAttributesApi updateMerchantCustomAttributeDefinition PUT /v2/merchants/custom-attribute-definitions/{key} UpdateMerchantCustomAttributeDefinition
MerchantCustomAttributesApi upsertMerchantCustomAttribute POST /v2/merchants/{merchant_id}/custom-attributes/{key} UpsertMerchantCustomAttribute
MerchantsApi listMerchants GET /v2/merchants ListMerchants
MerchantsApi retrieveMerchant GET /v2/merchants/{merchant_id} RetrieveMerchant
MobileAuthorizationApi createMobileAuthorizationCode POST /mobile/authorization-code CreateMobileAuthorizationCode
OAuthApi obtainToken POST /oauth2/token ObtainToken
OAuthApi renewToken POST /oauth2/clients/{client_id}/access-token/renew RenewToken
OAuthApi retrieveTokenStatus POST /oauth2/token/status RetrieveTokenStatus
OAuthApi revokeToken POST /oauth2/revoke RevokeToken
OrderCustomAttributesApi bulkDeleteOrderCustomAttributes POST /v2/orders/custom-attributes/bulk-delete BulkDeleteOrderCustomAttributes
OrderCustomAttributesApi bulkUpsertOrderCustomAttributes POST /v2/orders/custom-attributes/bulk-upsert BulkUpsertOrderCustomAttributes
OrderCustomAttributesApi createOrderCustomAttributeDefinition POST /v2/orders/custom-attribute-definitions CreateOrderCustomAttributeDefinition
OrderCustomAttributesApi deleteOrderCustomAttribute DELETE /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} DeleteOrderCustomAttribute
OrderCustomAttributesApi deleteOrderCustomAttributeDefinition DELETE /v2/orders/custom-attribute-definitions/{key} DeleteOrderCustomAttributeDefinition
OrderCustomAttributesApi listOrderCustomAttributeDefinitions GET /v2/orders/custom-attribute-definitions ListOrderCustomAttributeDefinitions
OrderCustomAttributesApi listOrderCustomAttributes GET /v2/orders/{order_id}/custom-attributes ListOrderCustomAttributes
OrderCustomAttributesApi retrieveOrderCustomAttribute GET /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} RetrieveOrderCustomAttribute
OrderCustomAttributesApi retrieveOrderCustomAttributeDefinition GET /v2/orders/custom-attribute-definitions/{key} RetrieveOrderCustomAttributeDefinition
OrderCustomAttributesApi updateOrderCustomAttributeDefinition PUT /v2/orders/custom-attribute-definitions/{key} UpdateOrderCustomAttributeDefinition
OrderCustomAttributesApi upsertOrderCustomAttribute POST /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} UpsertOrderCustomAttribute
OrdersApi batchRetrieveOrders POST /v2/orders/batch-retrieve BatchRetrieveOrders
OrdersApi calculateOrder POST /v2/orders/calculate CalculateOrder
OrdersApi cloneOrder POST /v2/orders/clone CloneOrder
OrdersApi createOrder POST /v2/orders CreateOrder
OrdersApi payOrder POST /v2/orders/{order_id}/pay PayOrder
OrdersApi retrieveOrder GET /v2/orders/{order_id} RetrieveOrder
OrdersApi searchOrders POST /v2/orders/search SearchOrders
OrdersApi updateOrder PUT /v2/orders/{order_id} UpdateOrder
PaymentsApi cancelPayment POST /v2/payments/{payment_id}/cancel CancelPayment
PaymentsApi cancelPaymentByIdempotencyKey POST /v2/payments/cancel CancelPaymentByIdempotencyKey
PaymentsApi completePayment POST /v2/payments/{payment_id}/complete CompletePayment
PaymentsApi createPayment POST /v2/payments CreatePayment
PaymentsApi getPayment GET /v2/payments/{payment_id} GetPayment
PaymentsApi listPayments GET /v2/payments ListPayments
PaymentsApi updatePayment PUT /v2/payments/{payment_id} UpdatePayment
PayoutsApi getPayout GET /v2/payouts/{payout_id} GetPayout
PayoutsApi listPayoutEntries GET /v2/payouts/{payout_id}/payout-entries ListPayoutEntries
PayoutsApi listPayouts GET /v2/payouts ListPayouts
RefundsApi getPaymentRefund GET /v2/refunds/{refund_id} GetPaymentRefund
RefundsApi listPaymentRefunds GET /v2/refunds ListPaymentRefunds
RefundsApi refundPayment POST /v2/refunds RefundPayment
SitesApi listSites GET /v2/sites ListSites
SnippetsApi deleteSnippet DELETE /v2/sites/{site_id}/snippet DeleteSnippet
SnippetsApi retrieveSnippet GET /v2/sites/{site_id}/snippet RetrieveSnippet
SnippetsApi upsertSnippet POST /v2/sites/{site_id}/snippet UpsertSnippet
SubscriptionsApi bulkSwapPlan POST /v2/subscriptions/bulk-swap-plan BulkSwapPlan
SubscriptionsApi cancelSubscription POST /v2/subscriptions/{subscription_id}/cancel CancelSubscription
SubscriptionsApi changeBillingAnchorDate POST /v2/subscriptions/{subscription_id}/billing-anchor ChangeBillingAnchorDate
SubscriptionsApi createSubscription POST /v2/subscriptions CreateSubscription
SubscriptionsApi deleteSubscriptionAction DELETE /v2/subscriptions/{subscription_id}/actions/{action_id} DeleteSubscriptionAction
SubscriptionsApi listSubscriptionEvents GET /v2/subscriptions/{subscription_id}/events ListSubscriptionEvents
SubscriptionsApi pauseSubscription POST /v2/subscriptions/{subscription_id}/pause PauseSubscription
SubscriptionsApi resumeSubscription POST /v2/subscriptions/{subscription_id}/resume ResumeSubscription
SubscriptionsApi retrieveSubscription GET /v2/subscriptions/{subscription_id} RetrieveSubscription
SubscriptionsApi searchSubscriptions POST /v2/subscriptions/search SearchSubscriptions
SubscriptionsApi swapPlan POST /v2/subscriptions/{subscription_id}/swap-plan SwapPlan
SubscriptionsApi updateSubscription PUT /v2/subscriptions/{subscription_id} UpdateSubscription
TeamApi bulkCreateTeamMembers POST /v2/team-members/bulk-create BulkCreateTeamMembers
TeamApi bulkUpdateTeamMembers POST /v2/team-members/bulk-update BulkUpdateTeamMembers
TeamApi createTeamMember POST /v2/team-members CreateTeamMember
TeamApi retrieveTeamMember GET /v2/team-members/{team_member_id} RetrieveTeamMember
TeamApi retrieveWageSetting GET /v2/team-members/{team_member_id}/wage-setting RetrieveWageSetting
TeamApi searchTeamMembers POST /v2/team-members/search SearchTeamMembers
TeamApi updateTeamMember PUT /v2/team-members/{team_member_id} UpdateTeamMember
TeamApi updateWageSetting PUT /v2/team-members/{team_member_id}/wage-setting UpdateWageSetting
TerminalApi cancelTerminalAction POST /v2/terminals/actions/{action_id}/cancel CancelTerminalAction
TerminalApi cancelTerminalCheckout POST /v2/terminals/checkouts/{checkout_id}/cancel CancelTerminalCheckout
TerminalApi cancelTerminalRefund POST /v2/terminals/refunds/{terminal_refund_id}/cancel CancelTerminalRefund
TerminalApi createTerminalAction POST /v2/terminals/actions CreateTerminalAction
TerminalApi createTerminalCheckout POST /v2/terminals/checkouts CreateTerminalCheckout
TerminalApi createTerminalRefund POST /v2/terminals/refunds CreateTerminalRefund
TerminalApi dismissTerminalAction POST /v2/terminals/actions/{action_id}/dismiss DismissTerminalAction
TerminalApi dismissTerminalCheckout POST /v2/terminals/checkouts/{checkout_id}/dismiss DismissTerminalCheckout
TerminalApi dismissTerminalRefund POST /v2/terminals/refunds/{terminal_refund_id}/dismiss DismissTerminalRefund
TerminalApi getTerminalAction GET /v2/terminals/actions/{action_id} GetTerminalAction
TerminalApi getTerminalCheckout GET /v2/terminals/checkouts/{checkout_id} GetTerminalCheckout
TerminalApi getTerminalRefund GET /v2/terminals/refunds/{terminal_refund_id} GetTerminalRefund
TerminalApi searchTerminalActions POST /v2/terminals/actions/search SearchTerminalActions
TerminalApi searchTerminalCheckouts POST /v2/terminals/checkouts/search SearchTerminalCheckouts
TerminalApi searchTerminalRefunds POST /v2/terminals/refunds/search SearchTerminalRefunds
TransactionsApi captureTransaction POST /v2/locations/{location_id}/transactions/{transaction_id}/capture CaptureTransaction
TransactionsApi listTransactions GET /v2/locations/{location_id}/transactions ListTransactions
TransactionsApi retrieveTransaction GET /v2/locations/{location_id}/transactions/{transaction_id} RetrieveTransaction
TransactionsApi voidTransaction POST /v2/locations/{location_id}/transactions/{transaction_id}/void VoidTransaction
V1TransactionsApi v1CreateRefund POST /v1/{location_id}/refunds V1CreateRefund
V1TransactionsApi v1ListOrders GET /v1/{location_id}/orders V1ListOrders
V1TransactionsApi v1ListPayments GET /v1/{location_id}/payments V1ListPayments
V1TransactionsApi v1ListRefunds GET /v1/{location_id}/refunds V1ListRefunds
V1TransactionsApi v1ListSettlements GET /v1/{location_id}/settlements V1ListSettlements
V1TransactionsApi v1RetrieveOrder GET /v1/{location_id}/orders/{order_id} V1RetrieveOrder
V1TransactionsApi v1RetrievePayment GET /v1/{location_id}/payments/{payment_id} V1RetrievePayment
V1TransactionsApi v1RetrieveSettlement GET /v1/{location_id}/settlements/{settlement_id} V1RetrieveSettlement
V1TransactionsApi v1UpdateOrder PUT /v1/{location_id}/orders/{order_id} V1UpdateOrder
VendorsApi bulkCreateVendors POST /v2/vendors/bulk-create BulkCreateVendors
VendorsApi bulkRetrieveVendors POST /v2/vendors/bulk-retrieve BulkRetrieveVendors
VendorsApi bulkUpdateVendors PUT /v2/vendors/bulk-update BulkUpdateVendors
VendorsApi createVendor POST /v2/vendors/create CreateVendor
VendorsApi retrieveVendor GET /v2/vendors/{vendor_id} RetrieveVendor
VendorsApi searchVendors POST /v2/vendors/search SearchVendors
VendorsApi updateVendor PUT /v2/vendors/{vendor_id} UpdateVendor
WebhookSubscriptionsApi createWebhookSubscription POST /v2/webhooks/subscriptions CreateWebhookSubscription
WebhookSubscriptionsApi deleteWebhookSubscription DELETE /v2/webhooks/subscriptions/{subscription_id} DeleteWebhookSubscription
WebhookSubscriptionsApi listWebhookEventTypes GET /v2/webhooks/event-types ListWebhookEventTypes
WebhookSubscriptionsApi listWebhookSubscriptions GET /v2/webhooks/subscriptions ListWebhookSubscriptions
WebhookSubscriptionsApi retrieveWebhookSubscription GET /v2/webhooks/subscriptions/{subscription_id} RetrieveWebhookSubscription
WebhookSubscriptionsApi testWebhookSubscription POST /v2/webhooks/subscriptions/{subscription_id}/test TestWebhookSubscription
WebhookSubscriptionsApi updateWebhookSubscription PUT /v2/webhooks/subscriptions/{subscription_id} UpdateWebhookSubscription
WebhookSubscriptionsApi updateWebhookSubscriptionSignatureKey POST /v2/webhooks/subscriptions/{subscription_id}/signature-key UpdateWebhookSubscriptionSignatureKey

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://connect.squareup.com/oauth2/authorize
  • Scopes:
  • BANK_ACCOUNTS_READ: HTTP Method: GET Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint.
  • CASH_DRAWER_READ: HTTP Method: GET Grants read access to cash drawer shift information. For example, to call the ListCashDrawerShifts endpoint.
  • CUSTOMERS_READ: HTTP Method: GET Grants read access to customer information. For example, to call the ListCustomers endpoint.
  • CUSTOMERS_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to customer information. For example, to create and update customer profiles.
  • DEVICE_CREDENTIAL_MANAGEMENT: HTTP Method: POST, GET Grants read/write access to device credentials information. For example, to call the CreateDeviceCode endpoint.
  • EMPLOYEES_READ: HTTP Method: GET Grants read access to employee profile information. For example, to call the Connect v1 Employees API.
  • EMPLOYEES_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to employee profile information. For example, to create and modify employee profiles.
  • INVENTORY_READ: HTTP Method: GET Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.
  • INVENTORY_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.
  • ITEMS_READ: HTTP Method: GET Grants read access to product catalog information. For example, to obtain objects in a product catalog.
  • ITEMS_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to product catalog information. For example, to modify or add to a product catalog.
  • LOYALTY_READ: HTTP Method: GET Grants read access to loyalty information. For example, to call the ListLoyaltyPrograms endpoint.
  • LOYALTY_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to loyalty information. For example, to call the CreateLoyaltyAccount endpoint.
  • 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 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 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.
  • APPOINTMENTS_READ: HTTP Method: GET, POST Grants read access to booking information. For example, to call the RetrieveBooking endpoint.
  • APPOINTMENTS_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to booking information. For example, to call the CreateBooking endpoint.
  • APPOINTMENTS_BUSINESS_SETTINGS_READ: HTTP Method: GET Grants read access to booking business settings. For example, to call the ListTeamMemberBookingProfiles endpoint.
  • INVOICES_READ: HTTP Method: GET, POST Grants read access to invoice information. For example, to call the ListInvoices endpoint.
  • INVOICES_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to invoice information. For example, to call the CreateInvoice endpoint.
  • SUBSCRIPTIONS_READ: HTTP Method: GET, POST Grants read access to subscription information. For example, to call the RetrieveSubscription endpoint.
  • SUBSCRIPTIONS_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to subscription information. For example, to call the CreateSubscription endpoint.
  • DISPUTES_READ: HTTP Method: GET Grants read access to dispute information. For example, to call the RetrieveDispute endpoint.
  • DISPUTES_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to dispute information. For example, to call the SubmitEvidence endpoint.
  • GIFTCARDS_READ: HTTP Method: GET, POST Grants read access to gift card information. For example, to call the RetrieveGiftCard endpoint.
  • GIFTCARDS_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to gift card information. For example, to call the CreateGiftCard endpoint.
  • ONLINE_STORE_SNIPPETS_WRITE: HTTP Method: POST, PUT, DELETE Write access to ECOM online store snippets on published websites.
  • ONLINE_STORE_SNIPPETS_READ: HTTP Method: GET, POST Read access to ECOM online store snippets on published websites.
  • ONLINE_STORE_SITE_READ: HTTP Method: GET, POST Read access to ECOM online store site details.
  • PAYMENTS_WRITE_SHARED_ONFILE: HTTP Method: POST, PUT, DELETE Allows the developer to process payments on behalf of a seller using a shared on file payment method.
  • APPOINTMENTS_ALL_READ: HTTP Method: GET, POST Grants read access to all of a seller's booking information, calendar, and business details. This permission must be accompanied by the APPOINTMENTS_READ permission.
  • APPOINTMENTS_ALL_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to all booking details, including double-booking a seller. This permission must be accompanied by the APPOINTMENTS_WRITE permission.
  • MERCHANT_PROFILE_WRITE: HTTP Method: POST, PUT Grants write access to business and location information. For example, to create a new location or update the business hours at an existing location.
  • VENDOR_READ: HTTP Method: GET, POST Grants read access to vendor information, for example, when calling the RetrieveVendor endpoint.
  • VENDOR_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to vendor information, for example, when calling the BulkUpdateVendors endpoint.
  • PAYOUTS_READ: HTTP Method: GET Grants read access to payouts and payout entries information. For example, to call the Connect v2 ListPayouts endpoint.
  • RESERVATIONS_READ: HTTP Method: GET Grants read access to reservation information, for example, when calling the RetrieveReservation endpoint.
  • RESERVATIONS_WRITE: HTTP Method: POST, PUT, DELETE Grants write access to reservation information, for example, when calling the CreateReservation endpoint.
  • RESTAURANT_CHECKS_READ: HTTP Method: GET Grants read access to check information, for example, when calling the RetrieveCheck endpoint.
  • DEVICES_READ: HTTP Method: GET Grants read access to device information. For example, to call the GetDevice and ListDevices endpoints.
  • CHANNELS_READ: HTTP Method: GET Grants read access to view channels, for example, when calling the RetrieveChannel endpoint.
  • CHANNELS_CREATE: HTTP Method: POST Grants write access to create channels, for example, when calling the CreateChannel endpoint.
  • CHANNELS_UPDATE: HTTP Method: PUT Grants write access to update channels, for example, when calling the UpdateChannel endpoint.

oauth2ClientSecret

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

developers@squareup.com

About

The unofficial Square Dart SDK

Languages

Language:Dart 100.0%Language:Shell 0.0%