on_the_go_sdk 3.0.0-dev.20
on_the_go_sdk: ^3.0.0-dev.20 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 categories |
| LocationsApi | locationGet | GET /location | Get a Location |
| LocationsApi | locationListingConnectGet | GET /location/listing/connect | |
| 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 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 #
- Address
- AiChatPost200Response
- AiChatPostRequest
- AiConversationPost200Response
- AiConversationPost200ResponseMessagesInner
- AiConversationPostRequest
- AiConversationPostRequestUserLocation
- AiMemoriesGet200Response
- AiMemoriesGet200ResponseMemoriesInner
- AiMemoriesPostRequest
- AiSystemGet200Response
- BrandDataPoint
- Category
- DataPoint
- DirectoryType
- InboxItem
- InboxItemAuthor
- InboxItemMediaInner
- InboxItemMetrics
- InboxPost200Response
- InboxPostRequest
- InboxReplyPostRequest
- Insights
- InsightsMetricsInner
- InsightsMetricsInnerDataInner
- Listing
- Location
- LocationListingConnectGet200Response
- LocationListingsGet200Response
- LocationPhoto
- LocationPhotoPostRequest
- LocationPhotoType
- LocationsGet200Response
- LoginBody
- LoginResponse
- NotificationsConfigGet200Response
- OpeningHour
- OpeningHourInterval
- ResetPassword
- SiteColorsPatchRequest
- SocialPost
- SpecialOpeningHour
- User
- UserOauthPost200Response
- UserOauthPostRequest
- WhitelabelData
Documentation For Authorization #
Authentication schemes defined for the API:
authToken #
- Type: API key
- API key parameter name: authToken
- Location: HTTP header