uberall_api 1.36.0
uberall_api: ^1.36.0 copied to clipboard
OpenAPI Dart client for Uberall
uberall_api (EXPERIMENTAL) #
Enhance your application with Uberall's comprehensive API documentation
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 20250204
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen For more information, please visit https://uberall.com
Requirements #
- Dart 2.15.0+ or Flutter 2.8.0+
- Dio 5.0.0+ (https://pub.dev/packages/dio)
Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
uberall_api: 1.0.0
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
uberall_api:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
uberall_api:
path: /path/to/uberall_api
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:uberall_api/uberall_api.dart';
final api = UberallApi().getAutoResponseApi();
final String id = id_example; // String | id of Auto Response Rule
try {
final response = await api.deleteAutoResponseRulesId(id);
print(response);
} catch on DioException (e) {
print("Exception when calling AutoResponseApi->deleteAutoResponseRulesId: $e\n");
}
Documentation for API Endpoints #
All URIs are relative to https://uberall.com/api
Class | Method | HTTP request | Description |
---|---|---|---|
AutoResponseApi | deleteAutoResponseRulesId | DELETE /auto-response/rules/{id} | Delete an Auto Response Rule |
AutoResponseApi | getAutoResponseRules | GET /auto-response/rules | List Auto Response Rules with filters |
AutoResponseApi | getAutoResponseRulesId | GET /auto-response/rules/{id} | Get an Auto Response Rule |
AutoResponseApi | patchAutoResponseRulesId | PATCH /auto-response/rules/{id} | Edit an Auto Response Rule |
AutoResponseApi | postAutoResponseRules | POST /auto-response/rules | Create an Auto Response Rule |
AutoResponseApi | postAutoResponseRulesCheckConflict | POST /auto-response/rules/check-conflict | Check for Auto Response Rule conflicts |
BatchOperationApi | getBatch | GET /batch | Get all Location Imports |
BatchOperationApi | getBatchIdErrorReport | GET /batch/{id}/error-report | Get Excel document with Location errors |
BrandDataPointsApi | deleteBrandDataPointsIdLike | DELETE /brand-data-points/{id}/like | Unlike a Brand Data Point |
BrandDataPointsApi | deleteBrandDataPointsIdReplyReplyIdApproval | DELETE /brand-data-points/{id}/reply/{replyId}/approval | Reject a reply to a Brand Data Point |
BrandDataPointsApi | patchBrandDataPointsIdReply | PATCH /brand-data-points/{id}/reply | Reply to a Brand Data Point |
BrandDataPointsApi | postBrandDataPointsIdLike | POST /brand-data-points/{id}/like | Like a Brand Data Point |
BrandDataPointsApi | postBrandDataPointsIdReplyReplyIdApproval | POST /brand-data-points/{id}/reply/{replyId}/approval | Approve reply to a Brand Data Point |
BrandDataPointsApi | putBrandDataPointsIdReplyReplyIdApproval | PUT /brand-data-points/{id}/reply/{replyId}/approval | Edit reply to a Brand Data Point |
BusinessConnectionsApi | getBusinessConnectionsDirectoryTypeSalesPartnerSalesPartnerIdCount | GET /business-connections/{directoryType}/sales-partner/{salesPartnerId}/count | Count of connections |
BusinessConnectionsApi | getBusinessConnectionsDirectoryTypeSalesPartnerSalesPartnerIdList | GET /business-connections/{directoryType}/sales-partner/{salesPartnerId}/list | List of business connections |
BusinessConnectionsApi | getBusinessConnectionsDirectoryTypeSalesPartnerSalesPartnerIdPages | GET /business-connections/{directoryType}/sales-partner/{salesPartnerId}/pages | List of external entities |
BusinessConnectionsApi | postBusinessConnectionsDirectoryTypeConnectBusinessId | POST /business-connections/{directoryType}/connect/{businessId} | Connect a business |
BusinessConnectionsApi | putBusinessConnectionsDirectoryTypeDisconnectBusinessId | PUT /business-connections/{directoryType}/disconnect/{businessId} | Disconnect a business |
BusinessesApi | deleteBusinessesId | DELETE /businesses/{id} | Delete a Business |
BusinessesApi | getBusinesses | GET /businesses | Get a List of Businesses |
BusinessesApi | getBusinessesId | GET /businesses/{id} | Get a Business |
BusinessesApi | getBusinessesIdBusinessConnectFacebookFacebookAccountIdBrandPageList | GET /businesses/{id}/business-connect/facebook/{facebookAccountId}/brand-page-list | Returns only the Facebook brand pages for the given Facebook account |
BusinessesApi | getBusinessesProductPlans | GET /businesses/product-plans | Get the product plans for businesses |
BusinessesApi | getBusinessesStatistics | GET /businesses/statistics | Get Businesses'' Statistics |
BusinessesApi | patchBusinessesId | PATCH /businesses/{id} | Update a Business |
BusinessesApi | postBusinesses | POST /businesses | Create a Business |
BusinessesApi | postBusinessesBusinessIdLocationsSync | POST /businesses/{businessId}/locations/sync | Sync All Business'' Locations |
BusinessesApi | postBusinessesIdMigrate | POST /businesses/{id}/migrate | Migrate the Business to a new SalesPartner |
CategoriesApi | getCategories | GET /categories | Get All or Several Categories |
CategoriesApi | getCategoriesIdAttributeRecommendations | GET /categories/{id}/attribute-recommendations | Get the recommended attributes for a Category |
CategoriesApi | getCategoriesIdAttributes | GET /categories/{id}/attributes | Get Attributes for a specific Category |
CategoriesApi | getCategoriesIdAvailablePhotoTypes | GET /categories/{id}/available-photo-types | Get available Photo types for a specific Category |
CategoriesApi | getCategoriesIdGoogleServices | GET /categories/{id}/google-services | Get available Google Structured Services for a specific Category |
CategoriesApi | getCategoriesIdMoreHoursTypes | GET /categories/{id}/more-hours-types | Get the supported More Hours types for a specific Category |
CollectionManagementApi | deleteCollectionsId | DELETE /collections/{id} | Delete a Collection |
CollectionManagementApi | getCollections | GET /collections | Get all collections |
CollectionManagementApi | getCollectionsId | GET /collections/{id} | Get a Collection |
CollectionManagementApi | patchCollectionsId | PATCH /collections/{id} | Update a Collection |
CollectionManagementApi | postCollections | POST /collections | Create a collection |
ConfigurationApi | getDirectoriesDirectoriesDetailsCountries | GET /directories/directories-details/countries | Get All Directories details by country |
ConfigurationApi | getDirectoryBrandSalesPartnerSalesPartnerIdUserAccountAccountIdDirectoryType | GET /directory-brand/sales-partner/{salesPartnerId}/user-account/{accountId}/{directoryType} | Get All Directory Brands |
ConfigurationApi | getFeatures | GET /features | Get available and potential features per location (business) |
ConfigurationApi | postDirectoryBrandSalesPartnerSalesPartnerIdUserAccountAccountIdDirectoryType | POST /directory-brand/sales-partner/{salesPartnerId}/user-account/{accountId}/{directoryType} | Create Directory Brand |
ContentListApi | deleteContentListsId | DELETE /content-lists/{id} | Delete a Content List |
ContentListApi | getContentLists | GET /content-lists | Get All Content Lists |
ContentListApi | getContentListsId | GET /content-lists/{id} | Get a Content List |
ContentListApi | patchContentListsId | PATCH /content-lists/{id} | Update a Content List |
ContentListApi | postContentLists | POST /content-lists | Create a Content List |
CustomItemsApi | deleteCustomItems | DELETE /custom-items | Delete a Custom Item using identifier |
CustomItemsApi | deleteCustomItemsId | DELETE /custom-items/{id} | Delete a Custom Item |
CustomItemsApi | getCustomItems | GET /custom-items | Get all Custom Items |
CustomItemsApi | getCustomItemsId | GET /custom-items/{id} | Get a Custom Item |
CustomItemsApi | patchCustomItemsId | PATCH /custom-items/{id} | Update a Custom Item |
CustomItemsApi | postCustomItems | POST /custom-items | Create a Custom Item |
DashboardApi | getDashboardCustomerFeedback | GET /dashboard/customer-feedback | Get Customer Feedback |
DashboardApi | getDashboardCustomerFeedbackByPeriod | GET /dashboard/customer-feedback-by-period | Get Customer Feedback by Period |
DashboardApi | getDashboardCustomerFeedbackKeywords | GET /dashboard/customer-feedback-keywords | Get Customer Feedback Keywords. |
DashboardApi | getDashboardExportInsightsData | GET /dashboard/export-insights-data | Get Insights Export Data |
DashboardApi | getDashboardExportInsightsDataWithThreshold | GET /dashboard/export-insights-data-with-threshold | Get Insights Export Data with threshold |
DashboardApi | getDashboardFeed | GET /dashboard/feed | Get Feed |
DashboardApi | getDashboardInsightsData | GET /dashboard/insights-data | Get Insights Data |
DashboardApi | getDashboardInsightsDataWarnings | GET /dashboard/insights-data/warnings | Get Insights Warnings |
DashboardApi | getDashboardListingHealthId | GET /dashboard/listing-health/{id} | Get Listing Health |
DashboardApi | getDashboardManagersCountId | GET /dashboard/managers-count/{id} | Get Managers Count |
DashboardApi | getDashboardNextBestActionsId | GET /dashboard/next-best-actions/{id} | Get Next Best Actions |
DashboardApi | getDashboardProfileCompleteness | GET /dashboard/profile-completeness | Get Profile Completeness |
DashboardApi | getDashboardSuppressedDuplicates | GET /dashboard/suppressed-duplicates | Get Suppressed Duplicates |
DashboardApi | getDashboardVisibilityIndexId | GET /dashboard/visibility-index/{id} | Get Visibility Index |
DashboardExportsApi | getDashboardExports | GET /dashboard-exports | Get a list of dashboard exports |
DashboardExportsApi | getDashboardExportsId | GET /dashboard-exports/{id} | Get details of a dashboard export by ID |
DashboardExportsApi | getDashboardExportsIdDownload | GET /dashboard-exports/{id}/download | Download the result of a dashboard export (a PDF file) |
DashboardExportsApi | postDashboardExports | POST /dashboard-exports | Invoke a creation of a dashboard export |
DataPointFiltersApi | deleteDataPointsFiltersId | DELETE /data-points/filters/{id} | Delete a saved datapoint''s filter |
DataPointFiltersApi | deleteDataPointsFiltersIdSubscription | DELETE /data-points/filters/{id}/subscription | Unsubscribe from a saved datapoint''s filter |
DataPointFiltersApi | getDataPointsFilters | GET /data-points/filters | Get available filters for filtering data points |
DataPointFiltersApi | getDataPointsFiltersId | GET /data-points/filters/{id} | Get a saved datapoint''s filter |
DataPointFiltersApi | getDataPointsFiltersList | GET /data-points/filters/list | List all saved datapoint''s filters the user has access |
DataPointFiltersApi | patchDataPointsFiltersId | PATCH /data-points/filters/{id} | Update a saved datapoint''s filter |
DataPointFiltersApi | postDataPointsFilters | POST /data-points/filters | Create a new saved datapoint''s filter |
DataPointFiltersApi | postDataPointsFiltersIdSubscription | POST /data-points/filters/{id}/subscription | Subscribe to a saved datapoint''s filter |
DataPointsApi | deleteDataPointsIdLike | DELETE /data-points/{id}/like | Unlike a Data Point |
DataPointsApi | deleteDataPointsIdReplyReplyIdApproval | DELETE /data-points/{id}/reply/{replyId}/approval | Reject a reply to a Data Point |
DataPointsApi | deleteDataPointsRead | DELETE /data-points/read | Mark as Unread |
DataPointsApi | getDataPoints | GET /data-points | Get All Data Points |
DataPointsApi | getDataPointsId | GET /data-points/{id} | Get a Data Point |
DataPointsApi | getDataPointsStatistics | GET /data-points/statistics | Get Data Points'' Statistics |
DataPointsApi | getDataPointsTimeseries | GET /data-points/timeseries | Get Data Points' time series |
DataPointsApi | patchDataPointsIdReply | PATCH /data-points/{id}/reply | Reply to a Data Point |
DataPointsApi | postDataPointsIdFlag | POST /data-points/{id}/flag | Report a Data Point |
DataPointsApi | postDataPointsIdLike | POST /data-points/{id}/like | Like a Data Point |
DataPointsApi | postDataPointsIdModerate | POST /data-points/{id}/moderate | Moderate a Data Point |
DataPointsApi | postDataPointsIdReplyReplyIdApproval | POST /data-points/{id}/reply/{replyId}/approval | Approve reply to a Data Point |
DataPointsApi | postDataPointsRead | POST /data-points/read | Mark as Read |
DataPointsApi | putDataPointsIdReplyReplyIdApproval | PUT /data-points/{id}/reply/{replyId}/approval | Edit reply to a Data Point |
DigitalAssetManagementApi | patchSocialTemplatesId | PATCH /social-templates/{id} | Edit an existing social template |
DigitalAssetManagementApi | postSocialTemplates | POST /social-templates | Create a new social template as a digital asset |
EventsApi | deleteEvents | DELETE /events | Delete an Event using identifier |
EventsApi | deleteEventsId | DELETE /events/{id} | Delete an Event |
EventsApi | getEvents | GET /events | Get All Events |
EventsApi | getEventsId | GET /events/{id} | Get an Event |
EventsApi | patchEvents | PATCH /events | Update an Event using identifier |
EventsApi | patchEventsId | PATCH /events/{id} | Update an Event |
EventsApi | postEvents | POST /events | Create an Event |
FeedApi | feedIdChildrenGet | GET /feed/{id}/children | |
FeedApi | feedIdGet | GET /feed/{id} | |
FeedApi | feedPost | POST /feed | |
LabelsApi | getLabels | GET /labels | Get All Labels |
ListingsApi | deleteLocationsIdFacebookPage | DELETE /locations/{id}/facebook/page | Disconnect Location''s Facebook Page |
ListingsApi | deleteLocationsIdGooglePage | DELETE /locations/{id}/google/page | Disconnect Google Page |
ListingsApi | deleteLocationsIdInstagramPage | DELETE /locations/{id}/instagram/page | Disconnect Instagram Page |
ListingsApi | getLocationsIdFacebookPage | GET /locations/{id}/facebook/page | Get Location''s Facebook Page |
ListingsApi | getLocationsIdGooglePage | GET /locations/{id}/google/page | Get information about the connected Google Page of the specified location |
ListingsApi | getLocationsIdListingsDetailsList | GET /locations/{id}/listings-details/list | Get all Listings for a specific Location |
ListingsApi | patchListingsId | PATCH /listings/{id} | Edit Listing |
ListingsApi | postLocationsIdFacebookPage | POST /locations/{id}/facebook/page | DEPRECATED - Connect Facebook Page |
ListingsApi | putListingsIdFlag | PUT /listings/{id}/flag | Flag a Listing |
LocationGroupsApi | deleteLocationGroupsId | DELETE /location-groups/{id} | Delete a single LocationGroup |
LocationGroupsApi | getLocationGroups | GET /location-groups | Search through all LocationGroups |
LocationGroupsApi | getLocationGroupsId | GET /location-groups/{id} | Get a single LocationGroup |
LocationGroupsApi | patchLocationGroupsId | PATCH /location-groups/{id} | Update a single LocationGroup |
LocationGroupsApi | postLocationGroups | POST /location-groups | Create a new LocationGroup |
LocationsDataApi | deleteLocations | DELETE /locations | Delete Several Locations |
LocationsDataApi | getLocations | GET /locations | Get Several Locations |
LocationsDataApi | getLocationsAvailableLodgingFields | GET /locations/available-lodging-fields | Get the available amenities (Google Lodging) fields for a location |
LocationsDataApi | getLocationsCities | GET /locations/cities | Get the city for locations |
LocationsDataApi | getLocationsCountries | GET /locations/countries | Get the country for locations |
LocationsDataApi | getLocationsDirectories | GET /locations/directories | Get the directories for locations |
LocationsDataApi | getLocationsId | GET /locations/{id} | Get a Location |
LocationsDataApi | getLocationsIdDashboard | GET /locations/{id}/dashboard | Get a Location''s Dashboard |
LocationsDataApi | getLocationsIdDatapoints | GET /locations/{id}/datapoints | DEPRECATED - Get Location''s Data Points |
LocationsDataApi | getLocationsIdDatapointsStatistics | GET /locations/{id}/datapoints/statistics | DEPRECATED - Get Location''s Data Point Statistics |
LocationsDataApi | getLocationsIdVisibilityIndexes | GET /locations/{id}/visibility-indexes | Get Location''s Visibility Index |
LocationsDataApi | getLocationsIdVisibilityIndexesInteresting | GET /locations/{id}/visibility-indexes/interesting | Get Historical Visibility Index |
LocationsDataApi | getLocationsKeywords | GET /locations/keywords | Get the keywords for locations |
LocationsDataApi | getLocationsLabels | GET /locations/labels | Get the labels for locations |
LocationsDataApi | getLocationsPostcodes | GET /locations/postcodes | Get the post / zip code for locations |
LocationsDataApi | getLocationsProvinces | GET /locations/provinces | Get the province/state for locations |
LocationsDataApi | getLocationsStatistics | GET /locations/statistics | Get Locations'' Statistics |
LocationsDataApi | patchLocations | PATCH /locations | Update Several Locations |
LocationsDataApi | patchLocationsId | PATCH /locations/{id} | Update a Location |
LocationsDataApi | patchLocationsIdEvDataUid | PATCH /locations/{id}/ev-data/{uid} | Update EV Dynamic Data |
LocationsDataApi | postLocations | POST /locations | Create a Location |
LocationsDataApi | postLocationsIdSync | POST /locations/{id}/sync | Sync a Location |
LocationsDataApi | postLocationsSync | POST /locations/sync | Sync Several Locations |
LocationsPhotosApi | deletePhotosId | DELETE /photos/{id} | Delete a Photo |
LocationsPhotosApi | getPhotosId | GET /photos/{id} | Get a Photo |
LocationsPhotosApi | patchPhotosId | PATCH /photos/{id} | Update a Photo |
LocationsPhotosApi | postPhotos | POST /photos | Upload a Photo |
MenuItemsApi | deleteMenuItems | DELETE /menu-items | Delete a Menu Item using identifier |
MenuItemsApi | deleteMenuItemsId | DELETE /menu-items/{id} | Delete a Menu Item |
MenuItemsApi | getMenuItems | GET /menu-items | Get All Menu Items |
MenuItemsApi | getMenuItemsAcceptedExtraFields | GET /menu-items/accepted-extra-fields | Get accepted values for dietary restrictions and allergens |
MenuItemsApi | getMenuItemsId | GET /menu-items/{id} | Get a Menu Item |
MenuItemsApi | patchMenuItems | PATCH /menu-items | Update a Menu Item using identifier |
MenuItemsApi | patchMenuItemsId | PATCH /menu-items/{id} | Update a Menu Item |
MenuItemsApi | postMenuItems | POST /menu-items | Create a Menu Item |
PersonsApi | deletePersons | DELETE /persons | Delete a Person using identifier |
PersonsApi | deletePersonsId | DELETE /persons/{id} | Delete a Person |
PersonsApi | getPersons | GET /persons | Get All Persons |
PersonsApi | getPersonsId | GET /persons/{id} | Get a Person |
PersonsApi | patchPersons | PATCH /persons | Update a Person using identifier |
PersonsApi | patchPersonsId | PATCH /persons/{id} | Update a Person |
PersonsApi | postPersons | POST /persons | Create a Person |
ProductPlansApi | getProductPlans | GET /product-plans | Get All Product Plans |
ProductPlansApi | patchProductPlansId | PATCH /product-plans/{id} | Update a Product Plan |
ProductPlansApi | postProductPlans | POST /product-plans | Create a Product Plan |
ProductsApi | deleteProducts | DELETE /products | Delete a Product using identifier |
ProductsApi | deleteProductsId | DELETE /products/{id} | Delete a Product |
ProductsApi | getProducts | GET /products | Get All Products |
ProductsApi | getProductsId | GET /products/{id} | Get a Product |
ProductsApi | patchProducts | PATCH /products | Update a Product using identifier |
ProductsApi | patchProductsId | PATCH /products/{id} | Update a Product |
ProductsApi | postProducts | POST /products | Create a Product |
SalesPartnersApi | getSalesPartners | GET /sales-partners | Search among child SalesPartners |
SalesPartnersApi | getSalesPartnersId | GET /sales-partners/{id} | Get a single SalesPartner |
SalesPartnersApi | getSalesPartnersSubscribableEventTypes | GET /sales-partners/subscribable-event-types | Get all possible webhooks types |
SalesPartnersApi | patchSalesPartnersIdSsoSettings | PATCH /sales-partners/{id}/sso-settings | Update SSO Settings of a SalesPartner |
SalesPartnersApi | postSalesPartners | POST /sales-partners | Create child SalesPartner |
SalesPartnersApi | postSalesPartnersIdUserAccountsAccountIdDirectoryType | POST /sales-partners/{id}/user-accounts/{accountId}/{directoryType} | Disconnect Directory User Account |
SalesPartnersApi | putSalesPartnersId | PUT /sales-partners/{id} | Update a single SalesPartner |
ServiceItemsApi | deleteServiceItemsId | DELETE /service-items/{id} | Delete a Service Item |
ServiceItemsApi | getServiceItems | GET /service-items | Get All Service Items |
ServiceItemsApi | getServiceItemsId | GET /service-items/{id} | Get a Service Item |
ServiceItemsApi | patchServiceItemsId | PATCH /service-items/{id} | Update a Service Item |
ServiceItemsApi | postServiceItems | POST /service-items | Create a Service Item |
SocialPostingApi | deleteSocialPostsId | DELETE /social-posts/{id} | Delete a Social Post |
SocialPostingApi | getSocialPosts | GET /social-posts | Get several Social Posts |
SocialPostingApi | getSocialPostsDirectories | GET /social-posts/directories | Directories |
SocialPostingApi | getSocialPostsDirectoryPages | GET /social-posts/directory-pages | Get a list of Directory Pages |
SocialPostingApi | getSocialPostsId | GET /social-posts/{id} | Get a Social Post |
SocialPostingApi | patchSocialPostsId | PATCH /social-posts/{id} | Update a Social Post |
SocialPostingApi | postSocialPosts | POST /social-posts | Create a Social Post |
SocialPostingApi | postSocialPostsValidateAppleCta | POST /social-posts/validate-apple-cta | Validate the Apple CTA |
SocialPostingTemplatesApi | deleteSocialPostsTemplatesId | DELETE /social-posts/templates/{id} | Delete a Social Post Template |
SocialPostingTemplatesApi | getSocialPostsTemplates | GET /social-posts/templates | Get a Social Post Template |
SocialPostingTemplatesApi | getSocialPostsTemplatesId | GET /social-posts/templates/{id} | Get all or several Social Post Templates |
SocialPostingTemplatesApi | patchSocialPostsTemplatesId | PATCH /social-posts/templates/{id} | Update a Social Post Template |
SocialPostingTemplatesApi | postSocialPostsTemplates | POST /social-posts/templates | Create a Social Post Template |
StatusCheckApi | getSearch | GET /search | Returns a list of the last searches |
StatusCheckApi | getSearchId | GET /search/{id} | Search in a Directory |
StatusCheckApi | postSearch | POST /search | Initiate a Search |
StoreFinderApi | getStoreFindersStoreKeyFilters | GET /store-finders/{storeKey}/filters | Get all possible filter values |
StoreFinderApi | getStoreFindersStoreKeyLocations | GET /store-finders/{storeKey}/locations | Search among the locations |
StoreFinderApi | getStoreFindersStoreKeyLocationsAll | GET /store-finders/{storeKey}/locations/all | Get all locations |
StoreFinderApi | getStoreFindersStoreKeyLocationsId | GET /store-finders/{storeKey}/locations/{id}** | Get location details |
SuggestionsApi | getLocationsIdSuggestions | GET /locations/{id}/suggestions | Get suggestions |
SuggestionsApi | getLocationsSuggestions | GET /locations/suggestions | Get Location Suggestions |
SuggestionsApi | putLocationsIdSuggestions | PUT /locations/{id}/suggestions | Update suggestions |
TemplatesApi | deleteTemplatesId | DELETE /templates/{id} | Delete a Template |
TemplatesApi | getTemplates | GET /templates | Get All Templates |
TemplatesApi | getTemplatesAuthors | GET /templates/authors | Returns a list of Authors |
TemplatesApi | getTemplatesId | GET /templates/{id} | Get a Template |
TemplatesApi | getTemplatesTags | GET /templates/tags | Returns a list of Tags |
TemplatesApi | patchTemplatesId | PATCH /templates/{id} | Update a Template |
TemplatesApi | postTemplates | POST /templates | Creates a Template |
TemplatesApi | postTemplatesIdIncrementUsage | POST /templates/{id}/increment-usage | Increment the count of times a Template has been used |
UsersApi | deleteUsersId | DELETE /users/{id} | Delete a User |
UsersApi | deleteUsersIdAllSessions | DELETE /users/{id}/all-sessions | Invalidate all active user sessions |
UsersApi | getUserMe | GET /users/me | Get the current user |
UsersApi | getUsers | GET /users | Get All Users |
UsersApi | getUsersEmailUnsubscribeLink | GET /users/email-unsubscribe-link | Unsubscribe email link |
UsersApi | getUsersId | GET /users/{id} | Get a User |
UsersApi | getUsersWhitelabelInformation | GET /users/whitelabel-information | Get whitelabel information |
UsersApi | patchUserMe | PATCH /users/me | Update the current user |
UsersApi | patchUsersId | PATCH /users/{id} | Update a User |
UsersApi | postUsers | POST /users | Create a User |
UsersApi | postUsersLogin | POST /users/login | Provide an access_token for the user |
UsersApi | postUsersLogout | POST /users/logout | Log out the current user |
WebhooksApi | deleteSalesPartnersWebhooksId | DELETE /sales-partners/webhooks/{id} | Delete a Webhook |
WebhooksApi | getSalesPartnersWebhooks | GET /sales-partners/webhooks | Get all webhooks that are currently set |
WebhooksApi | getSalesPartnersWebhooksId | GET /sales-partners/webhooks/{id} | Get a Webhook |
WebhooksApi | patchSalesPartnersWebhooksId | PATCH /sales-partners/webhooks/{id} | Update a Webhook |
WebhooksApi | postSalesPartnersWebhooks | POST /sales-partners/webhooks | Create a Webhook |
Documentation For Models #
- AcceptedExtraFieldsResponseObject
- AcceptedExtraFieldsResponseWrapper
- AssetInfo
- AttributeRecommendationsObject
- AttributeRecommendationsWrapper
- AttributeWrapper
- AttributesResponseObject
- AttributesResponseWrapper
- Attribution
- AvailablePhotoTypesResponseObject
- AvailablePhotoTypesResponseWrapper
- BasicListing
- BasicListingResultObject
- BasicListingResultWrapper
- BrandDataPoint
- BrandDataPointResponseObject
- BrandDataPointResponseWrapper
- BrandPagesResponseObject
- BrandPagesResponseWrapper
- Business
- BusinessConnectionRequest
- BusinessFiltersResponse
- BusinessPageResponseWrapper
- BusinessResponseWrapper
- BusinessStatistics
- BusinessStatisticsWrapper
- CallTrackingNumber
- Category
- CheckConflictRequest
- CitiesResponse
- CitiesResponseWrapper
- ConflictingRuleResponse
- ConflictingRulesResponseWrapper
- ConnectFlowUserDetails
- ContentCollection
- ContentList
- ContentListResponseObject
- ContentListResponseWrapper
- ContentListsObject
- ContentListsWrapper
- CountriesResponse
- CountriesResponseWrapper
- CreateDirectoryBrandRequest
- CreateTemplateRequest
- CreateUserRequest
- CurrentPreviousValue
- CustomItem
- CustomItemResponseObject
- CustomItemResponseWrapper
- CustomItemSearchResponseObject
- CustomItemSearchResponseWrapper
- CustomerFeedback
- CustomerFeedbackByPeriod
- CustomerFeedbackByPeriodWrapper
- CustomerFeedbackKeyword
- CustomerFeedbackKeywords
- CustomerFeedbackKeywordsWrapper
- CustomerFeedbackWrapper
- DashboardExportData
- DashboardExportDataListObject
- DashboardExportDataListWrapper
- DashboardExportDataWrapper
- DashboardExportInsightsDataResponse
- DashboardExportInsightsDataResponseWrapper
- DashboardLocation
- DataPoint
- DataPointFilter
- DataPointFilterResponseObject
- DataPointFilterResponseWrapper
- DataPointFiltersResponseObject
- DataPointFiltersResponseWrapper
- DataPointResponseObject
- DataPointResponseWrapper
- DataPointTimeSeriesResponse
- DataPointTimeSeriesResponseWrapper
- DataPointTimeSeriesValue
- DatapointStatisticsResponse
- DatapointStatisticsResponseWrapper
- DeleteResponseObject
- DeleteResponseWrapper
- DirectoriesDetailsCountriesResponseObject
- DirectoriesDetailsCountriesResponseWrapper
- DirectoriesDetailsCountry
- DirectoriesResponse
- DirectoriesResponseWrapper
- DirectoryBrand
- DirectoryBrandPageResponse
- DirectoryBrandPageResponseWrapper
- DirectoryBrandWrapper
- DirectoryCategory
- DirectoryConnectInfo
- DirectoryContactDetails
- DirectoryDetails
- DirectoryExternalBusinessResponse
- DirectoryExternalBusinessResponsePhotos
- DirectoryPage
- DirectoryPageResponse
- DirectoryPageResponseObject
- DirectoryPageResponseWrapper
- EmailSettings
- EvConnector
- EvData
- EvDynamicDataObject
- EvDynamicDataWrapper
- EvSupplyEquipment
- Event
- EventResponseObject
- EventResponseWrapper
- EventSearchResponseObject
- EventSearchResponseWrapper
- ExternalEntitiesObject
- ExternalEntitiesWrapper
- FeaturesResponse
- FeaturesResponseWrapper
- FeedDataItem
- FeedDataItemAuthor
- FeedDataItemMediaInner
- FeedDataItemMetrics
- FeedItem
- FeedItemWrapper
- FeedPost200Response
- FeedPostRequest
- FeedPostRequestPaginationOptions
- FiltersResponse
- FiltersResponseWrapper
- GetCategories200Response
- GetCategories200ResponseResponse
- GetCategories200ResponseResponseResults
- GetCategories200ResponseResponseResultsOneOf
- GetTemplatesAuthorsRequest
- GoogleServiceItem
- GoogleServicesResponseObject
- GoogleServicesResponseWrapper
- GoogleVenueDetailsObject
- GoogleVenueDetailsWrapper
- Image
- InboxResponse
- InboxResponseObject
- InboxResponseWrapper
- Insights
- InsightsMetricsInner
- InsightsMetricsInnerDataInner
- InsightsWrapper
- KeywordsObject
- KeywordsWrapper
- Label
- LabelListObject
- LabelListWrapper
- LabelsResponse
- LabelsResponseWrapper
- ListDirectoryPagesResponse
- ListDirectoryPagesResponseWrapper
- Listing
- ListingDetails
- ListingHealth
- ListingHealthWrapper
- ListingsDetailsResponse
- ListingsDetailsResponseWrapper
- Location
- LocationDashboardResponse
- LocationDashboardResponseObject
- LocationDashboardResponseWrapper
- LocationDashboardStatistics
- LocationFeatureResponse
- LocationGroupListResponseWrapper
- LocationGroupParams
- LocationGroupWrapper
- LocationImportListObject
- LocationImportListWrapper
- LocationManagersCount
- LocationManagersCountWrapper
- LocationObject
- LocationPhoto
- LocationPhotoResponse
- LocationPhotoResponseWrapper
- LocationPhotoResponseWrapperResponse
- LocationPhotoTypeEnum
- LocationResponse
- LocationResponseWrapper
- LocationSearchResponse
- LocationSearchResponseWrapper
- LocationStatisticsResponse
- LocationTask
- LocationTaskWrapper
- LocationTemporarilyClosed
- LocationTransactionLink
- LocationWrapper
- LodgingField
- LodgingFieldResponseObject
- LodgingFieldResponseWrapper
- LoginCommand
- LoginResponse
- LoginResponseWrapper
- LogoutResponse
- LogoutResponseWrapper
- MenuItem
- MenuItemResponseObject
- MenuItemResponseWrapper
- MenuItemSearchResponseObject
- MenuItemSearchResponseWrapper
- MoreHoursObject
- MoreHoursResponse
- MoreHoursWrapper
- NextOpen
- OpeningHours
- Person
- PersonResponseObject
- PersonResponseWrapper
- PersonSearchResponseObject
- PersonSearchResponseWrapper
- PhotoContainer
- PostAutoResponseRulesRequest
- PostPhotosRequest
- PostSocialTemplatesRequest
- PostcodesResponse
- PostcodesResponseWrapper
- PricePerCountry
- Product
- ProductPlan
- ProductPlanListResponseObject
- ProductPlanListResponseWrapper
- ProductPlanResponseObject
- ProductPlanResponseWrapper
- ProductSearchObject
- ProductSearchWrapper
- ProductWrapper
- ProfileCompleteness
- ProfileCompletenessWrapper
- ProvincesResponse
- ProvincesResponseWrapper
- ResponseBusiness
- ResponseLocation
- ResponseTemplate
- ResponseTemplateWrapper
- ResponseTemplatesWrapper
- ResponseUser
- ResponseUsersWrapper
- ResponseValue
- RuleResponse
- RuleResponseWrapper
- RulesResponseWrapper
- SalesPartner
- SalesPartnerListResponseObject
- SalesPartnerListResponseWrapper
- SalesPartnerWrapper
- SalesPartnerWrapperObject
- SearchData
- SearchDataListObject
- SearchDataListWrapper
- SearchDataObject
- SearchDataWrapper
- ServiceArea
- ServiceItem
- ServiceItemSearchObject
- ServiceItemSearchWrapper
- ServiceItemWrapper
- SocialPost
- SocialPostCallToAction
- SocialPostDirectoriesResponse
- SocialPostDirectoriesResponseWrapper
- SocialPostResponseObject
- SocialPostResponseWrapper
- SocialPostTemplate
- SocialPostTemplateCallToAction
- SocialPostTemplateResponseObject
- SocialPostTemplateResponseWrapper
- SocialPostTemplatesResponseObject
- SocialPostTemplatesResponseWrapper
- SocialPostWrapper
- SocialPostsResponseObject
- SocialPostsResponseWrapper
- SocialProfile
- SpecialOpeningHours
- Statistic
- StoreFinderFilters
- StoreFinderFiltersFilter
- StoreFinderFiltersObject
- StoreFinderFiltersWrapper
- StoreFinderResponse
- StoreFinderResponseListObject
- StoreFinderResponseListWrapper
- StoreFinderResponseWrapper
- StringListResponseWrapper
- SubscribableEventTypesObject
- SubscribableEventTypesWrapper
- SuccessResponseObject
- SuccessResponseWrapper
- Suggestion
- SuggestionListWrapper
- SuggestionResponse
- SuggestionResponseWrapper
- SuggestionSearchResponseObject
- SuggestionSearchResponseWrapper
- SuppressedDuplicates
- SuppressedDuplicatesWrapper
- TimeSeriesSegment
- UTM
- UberallResponse
- UnsubscribeActionLinkObject
- UnsubscribeActionLinkWrapper
- UpdateResponseObject
- UpdateResponseWrapper
- User
- UserLeftObject
- UserLeftWrapper
- UserMissingConnectionWarnings
- UserMissingConnectionWarningsWrapper
- UserObject
- UserSearchObject
- UserSearchWrapper
- UserWrapper
- Video
- VisibilityIndex
- VisibilityIndexObject
- VisibilityIndexWrapper
- VisibilityIndexesObject
- VisibilityIndexesWrapper
- Webhook
- WebhookCommand
- WebhookListWrapper
- WebhookWrapper
- WhitelabelInformation
- WhitelabelInformationWrapper
Documentation For Authorization #
Authentication schemes defined for the API:
privateKey #
- Type: API key
- API key parameter name: privateKey
- Location: HTTP header
accessToken #
- Type: API key
- API key parameter name: accessToken
- Location: HTTP header
publicKey #
- Type: API key
- API key parameter name: publicKey
- Location: HTTP header