on_the_go_sdk 2.1.0
on_the_go_sdk: ^2.1.0 copied to clipboard
OpenAPI Dart client for on-the-go
on_the_go_sdk (EXPERIMENTAL) #
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
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:
on_the_go_sdk: 1.0.0
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
on_the_go_sdk:
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:
on_the_go_sdk:
path: /path/to/on_the_go_sdk
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:on_the_go_sdk/on_the_go_sdk.dart';
final api = OnTheGoSdk().getAiApi();
final AiChatPostRequest aiChatPostRequest = ; // AiChatPostRequest |
try {
final response = await api.aiChatPost(aiChatPostRequest);
print(response);
} catch on DioException (e) {
print("Exception when calling AiApi->aiChatPost: $e\n");
}
Documentation for API Endpoints #
All URIs are relative to https://api.aztrix.me/webhook
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AiApi | aiChatPost | POST /ai/chat | |
| AiApi | aiConversationPost | POST /ai/conversation | |
| AiApi | aiMemoriesDelete | DELETE /ai/memories | |
| AiApi | aiMemoriesGet | GET /ai/memories | |
| AiApi | aiMemoriesPost | POST /ai/memories | |
| AiApi | aiSystemGet | GET /ai/system | |
| AnalyticsApi | analyticsGet | GET /analytics | |
| InboxApi | inboxItemChildrenGet | GET /inbox/item/children | |
| InboxApi | inboxItemGet | GET /inbox/item | |
| InboxApi | inboxPost | POST /inbox | |
| InboxApi | inboxReplyPost | POST /inbox/reply | |
| LocationsApi | categoriesGet | GET /categories | Get All or Several Categories |
| LocationsApi | locationGet | GET /location | Get a Location |
| LocationsApi | locationListingsGet | GET /location/listings | |
| LocationsApi | locationPatch | PATCH /location | Update a Location |
| LocationsApi | locationPhotoDelete | DELETE /location/photo | |
| LocationsApi | locationPhotoPost | POST /location/photo | |
| LocationsApi | locationsGet | GET /locations | Get Several Locations |
| NotificationsApi | notificationsConfigGet | GET /notifications/config | |
| NotificationsApi | notificationsConfigPost | POST /notifications/config | |
| NotificationsApi | notificationsRegisterPost | POST /notifications/register | |
| PublishApi | publishPostsGet | GET /publish/posts | |
| PublishApi | publishPostsPost | POST /publish/posts | |
| SitesApi | siteColorsGet | GET /site/colors | |
| SitesApi | siteColorsPatch | PATCH /site/colors | |
| SitesApi | siteColorsPut | PUT /site/colors | |
| UsersApi | userGet | GET /user | Get the current user |
| UsersApi | userLoginPost | POST /user/login | Provides an access_token for the user |
| UsersApi | userLogoutPost | POST /user/logout | |
| UsersApi | userOauthPost | POST /user/oauth | Finish OAuth flow |
| UsersApi | userPatch | PATCH /user | Update the current user |
| UsersApi | userResetPasswordPost | POST /user/reset-password | Resets the user's password |
| WhitelabelApi | whitelabelGet | GET /whitelabel |
Documentation For Models #
- AcceptedExtraFieldsResponseObject
- AcceptedExtraFieldsResponseWrapper
- AiChatPost200Response
- AiChatPostRequest
- AiConversationPost200Response
- AiConversationPost200ResponseMessagesInner
- AiConversationPostRequest
- AiConversationPostRequestUserLocation
- AiMemoriesGet200Response
- AiMemoriesGet200ResponseMemoriesInner
- AiMemoriesPostRequest
- AiSystemGet200Response
- 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
- CategoriesGet200Response
- CategoriesGet200ResponseResponse
- CategoriesGet200ResponseResponseResults
- CategoriesGet200ResponseResponseResultsOneOf
- 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
- DirectoryType
- EmailSettings
- EvConnector
- EvData
- EvDynamicDataObject
- EvDynamicDataWrapper
- EvSupplyEquipment
- Event
- EventResponseObject
- EventResponseWrapper
- EventSearchResponseObject
- EventSearchResponseWrapper
- ExternalEntitiesObject
- ExternalEntitiesWrapper
- FeaturesResponse
- FeaturesResponseWrapper
- FeedItem
- FeedItemWrapper
- FiltersResponse
- FiltersResponseWrapper
- GenericResponse
- GoogleServiceItem
- GoogleServicesResponseObject
- GoogleServicesResponseWrapper
- GoogleVenueDetailsObject
- GoogleVenueDetailsWrapper
- InboxItem
- InboxItemAuthor
- InboxItemMediaInner
- InboxItemMetrics
- InboxPost200Response
- InboxPostRequest
- InboxReplyPostRequest
- 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
- LocationPhotoPostRequest
- LocationPhotoResponse
- LocationPhotoResponseWrapper
- LocationPhotoType
- LocationResponse
- LocationResponseWrapper
- LocationSearchResponse
- LocationSearchResponseWrapper
- LocationStatisticsResponse
- LocationTask
- LocationTaskWrapper
- LocationTemporarilyClosed
- LocationTransactionLink
- LocationWrapper
- LodgingField
- LodgingFieldResponseObject
- LodgingFieldResponseWrapper
- LoginBody
- LoginResponse
- LogoutResponse
- LogoutResponseWrapper
- MenuItem
- MenuItemResponseObject
- MenuItemResponseWrapper
- MenuItemSearchResponseObject
- MenuItemSearchResponseWrapper
- MoreHoursObject
- MoreHoursResponse
- MoreHoursWrapper
- NextOpen
- NotificationsConfigGet200Response
- OpeningHours
- Person
- PersonResponseObject
- PersonResponseWrapper
- PersonSearchResponseObject
- PersonSearchResponseWrapper
- PhotoContainer
- PostcodesResponse
- PostcodesResponseWrapper
- PricePerCountry
- Product
- ProductPlan
- ProductPlanListResponseObject
- ProductPlanListResponseWrapper
- ProductPlanResponseObject
- ProductPlanResponseWrapper
- ProductSearchObject
- ProductSearchWrapper
- ProductWrapper
- ProfileCompleteness
- ProfileCompletenessWrapper
- ProvincesResponse
- ProvincesResponseWrapper
- ResetPassword
- ResponseBusiness
- ResponseLocation
- ResponseTemplate
- ResponseTemplateWrapper
- ResponseTemplatesWrapper
- ResponseUser
- ResponseUsersWrapper
- ResponseValue
- RuleResponse
- RuleResponseWrapper
- RulesResponseWrapper
- SalesPartner
- SalesPartnerListResponseObject
- SalesPartnerListResponseWrapper
- SalesPartnerWrapper
- SalesPartnerWrapperObject
- SdkImage
- SearchData
- SearchDataListObject
- SearchDataListWrapper
- SearchDataObject
- SearchDataWrapper
- ServiceArea
- ServiceItem
- ServiceItemSearchObject
- ServiceItemSearchWrapper
- ServiceItemWrapper
- SiteColorsPatchRequest
- 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
- UnsubscribeActionLinkObject
- UnsubscribeActionLinkWrapper
- UpdateResponseObject
- UpdateResponseWrapper
- User
- UserLeftObject
- UserLeftWrapper
- UserMissingConnectionWarnings
- UserMissingConnectionWarningsWrapper
- UserOauthPost200Response
- UserOauthPostRequest
- UserObject
- UserSearchObject
- UserSearchWrapper
- UserWrapper
- Video
- VisibilityIndex
- VisibilityIndexObject
- VisibilityIndexWrapper
- VisibilityIndexesObject
- VisibilityIndexesWrapper
- Webhook
- WebhookCommand
- WebhookListWrapper
- WebhookWrapper
- WhitelabelData
- WhitelabelInformation
- WhitelabelInformationWrapper
Documentation For Authorization #
Authentication schemes defined for the API:
authToken #
- Type: API key
- API key parameter name: authToken
- Location: HTTP header