ajeek_client

Ajeek api document

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

  • API version: 4.1.2-SNAPSHOT
  • Generator version: 7.4.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

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:
  ajeek_client:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

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

dependencies:
  ajeek_client:
    path: /path/to/ajeek_client

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:ajeek_client/api.dart';

// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ApplianceResourcesApi();
final applianceRequestDto = ApplianceRequestDto(); // ApplianceRequestDto | 

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ApplianceResourcesApi createAppliance POST /appliance/ User add appliance
ApplianceResourcesApi deleteAppliance DELETE /appliance/{id}
ApplianceResourcesApi getAppliance GET /appliance/{id} Get an appliance
ApplianceResourcesApi listAppliances GET /appliance/list Get user' all appliances
ApplianceResourcesApi listAppliances1 GET /appliance/list/{applianceType}
ApplianceResourcesApi updateAppliance PUT /appliance/
BaseResourcesApi deleteAccount DELETE /base/account Delete user accout
BaseResourcesApi getAvailabilities GET /base/availabilities Get availabilities, The Day is Asia/Riyadh time zone
BaseResourcesApi getBrands GET /base/brands Get all brands and models
BaseResourcesApi getCities GET /base/cities Get all cities(administrative district)
BaseResourcesApi getPreSignedUploadUrl GET /base/preSignedUploadUrl Get a pre-signed s3 upload url
BaseResourcesApi getPredefinedIssues GET /base/predefinedIssues Get all predefined issues
BaseResourcesApi refreshProfile POST /base/refreshProfile Refresh synchroteam customer form cognito
BaseResourcesApi registered POST /base/registered Send user registered notification
BaseResourcesApi saveEnergyEfficiency POST /base/energyEfficiency Save user energy efficiency calculation
HomeResourcesApi getHomeResource GET /home/ Get homepage resources, Appliances and bookings.
NotificationResourcesApi delete DELETE /notification/{id} Get user notification as read.
NotificationResourcesApi deleteAll DELETE /notification/ Delete all user's notifications
NotificationResourcesApi getNotifications GET /notification/ Get user notifications.
NotificationResourcesApi markAllAsRead POST /notification/markAllAsRead Mark all user's notifications ad read.
NotificationResourcesApi markAsRead POST /notification/markAsRead/{id} Get user notification as read.
OrderResourcesApi calculatePrepayment POST /order/calculatePrepayment Calculate the prepayment.
OrderResourcesApi cancelOrder DELETE /order/{id} Cancel an order.
OrderResourcesApi createOrder POST /order/ Create an order.
OrderResourcesApi deleteOrder DELETE /order/delete/{id} Delete an order.
OrderResourcesApi getOrder GET /order/{id} Get an order.
OrderResourcesApi listOrders GET /order/list
OrderResourcesApi refreshPayment GET /order/payment/refresh Refresh payment status.
OrderResourcesApi rescheduleOrder POST /order/reschedule/{id} reschedule an order.
RootIndexApi test GET /test Index test
RootIndexApi testIndex GET /index Index test
RootIndexApi testUser GET /user/test User authentication test
SynchroTeamCallbackApi synchroTeamCallback POST /callback/synchroteam SynchroTeam callback
URWayCallbackApi urwayCallback POST /callback/urway Urway callback

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: HTTP Bearer authentication

Author

aaron@ajeeknow.com

Libraries

api