keyclic_sdk_api

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This Dart package is automatically generated by the Swagger Codegen project:

  • API version: 1.28.0
  • Build package: io.swagger.codegen.languages.DartClientCodegen For more information, please visit http://keyclic.com

Requirements

Dart 1.20.0 or later OR Flutter 0.0.20 or later

Installation & Usage

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

name: keyclic_sdk_api
version: 1.28.6
description: Dart client for Keyclic API
dependencies:
  keyclic_sdk_api:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      version: 'any'

Local

To use the package in your local drive, please include the following in pubspec.yaml

dependencies:
  keyclic_sdk_api:
    path: /path/to/keyclic_sdk_api

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:keyclic_sdk_api/api.dart';

// TODO Configure API key authorization: bearer
//keyclic_sdk_api.api.Configuration.apiKey{'Authorization'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//keyclic_sdk_api.api.Configuration.apiKeyPrefix{'Authorization'} = "Bearer";

var api_instance = new AnalyticApi();
var xKeyclicApp = xKeyclicApp_example; // String | 
var organization = ; // String | The identifier of the resource formatted as GUID string.
var acceptLanguage = acceptLanguage_example; // String | 
var xKeyclicAppVersion = xKeyclicAppVersion_example; // String | 
var place = ; // String | The identifier of the resource formatted as GUID string.
var category = ; // String | The identifier of the resource formatted as GUID string.
var state = state_example; // String | 
var before = 2013-10-20T19:20:30+01:00; // DateTime | 
var after = 2013-10-20T19:20:30+01:00; // DateTime | 
var options[property] = options[property]_example; // String | 
var options[sort] = options[sort]_example; // String | 

try {
    var result = api_instance.getAnalyticByOrganization(xKeyclicApp, organization, acceptLanguage, xKeyclicAppVersion, place, category, state, before, after, options[property], options[sort]);
    print(result);
} catch (e) {
    print("Exception when calling AnalyticApi->getAnalyticByOrganization: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://api.keyclic.com

ClassMethodHTTP requestDescription
AnalyticApigetAnalyticByOrganizationGET /organizations/{organization}/analyticsRetrieve one Analytic resource.
ApplicationApigetApplicationByTokenGET /applications/{token}Retrieve one Application resource.
AssignApipostAssignByOperationPOST /operations/{operation}/assignCreate one Assign resource.
BusinessActivityApicgetBusinessActivitiesGET /businessactivitiesRetrieve all BusinessActivity resources.
BusinessActivityApigetBusinessActivityGET /businessactivities/{businessActivity}Retrieve one BusinessActivity resource.
CategoryApicgetCategoriesGET /categoriesRetrieve all Category resources.
CategoryApicgetCategoriesByOrganizationGET /organizations/{organization}/categoriesRetrieve all Category resources.
CategoryApigetCategoryGET /categories/{category}Retrieve one Category resource.
CategoryApipatchCategoryPATCH /categories/{category}Edit one Category resource.
CategoryApipostCategoryByOrganizationPOST /organizations/{organization}/categoriesCreate one Category resource.
ChangeApipostChangeByTokenPOST /security/password/change/{token}Create one Change resource.
CommentApicgetCommentsByFeedbackGET /feedbacks/{feedback}/commentsRetrieve all Comment resources.
CommentApicgetCommentsByOperationGET /operations/{operation}/commentsRetrieve all Comment resources.
CommentApipostCommentByFeedbackPOST /feedbacks/{feedback}/commentsCreate one Comment resource.
CommentApipostCommentByOperationPOST /operations/{operation}/commentsCreate one Comment resource.
ContributionApicgetContributionsByFeedbackGET /feedbacks/{feedback}/contributionsRetrieve all Contribution resources.
ContributionApipostContributionByFeedbackPOST /feedbacks/{feedback}/contributionsCreate one Contribution resource.
DelegateApipostDelegateByOrganizationPOST /organizations/{organization}/delegatesCreate one Delegate resource.
DeviceApideleteDeviceByPersonAndDeviceDELETE /people/{person}/devices/{device}Remove one Device resource.
DeviceApipostDeviceByPersonPOST /people/{person}/devicesCreate one Device resource.
ExportApicpostExportByOrganizationPOST /organizations/{organization}/reports/exportsRetrieve all Export resources.
FacebookApipostFacebookPOST /security/connect/facebookCreate one Facebook resource.
FeedbackApicgetFeedbackGET /feedbacksRetrieve all Feedback resources.
FeedbackApicgetFeedbackByPersonGET /people/{person}/feedbacksRetrieve all Feedback resources.
FeedbackApigetFeedbackGET /feedbacks/{feedback}Retrieve one Feedback resource.
ImageApideleteImageByOperationAndImageDELETE /operations/{operation}/images/{image}Remove one Image resource.
ImageApigetImageByFeedbackAndImageAndWidthAndHeightGET /feedbacks/{feedback}/images/{image}/{width}/{height}Retrieve one Image resource.
ImageApigetImageByOperationAndImageAndWidthAndHeightGET /operations/{operation}/images/{image}/{width}/{height}Retrieve one Image resource.
ImageApigetImageByPersonAndWidthAndHeightGET /people/{person}/image/{width}/{height}Retrieve one Image resource.
ImageApipostImageByFeedbackPOST /feedbacks/{feedback}/imagesCreate one Image resource.
ImageApipostImageByOperationPOST /operations/{operation}/imagesCreate one Image resource.
IssueApipostIssuePOST /feedbacks/issuesCreate one Issue resource.
LogApicgetLogsByOperationGET /operations/{operation}/logsRetrieve all Log resources.
LoginApipostLoginPOST /security/loginCreate one Login resource.
LogoApigetLogoByOrganizationAndWidthAndHeightGET /organizations/{organization}/logo/{width}/{height}Retrieve one Logo resource.
MemberApicgetMembersByOrganizationGET /organizations/{organization}/membersRetrieve all Member resources.
MemberApideleteMemberByOrganizationAndMemberDELETE /organizations/{organization}/members/{member}Remove one Member resource.
MemberApigetMemberByOrganizationAndMemberGET /organizations/{organization}/members/{member}Retrieve one Member resource.
MemberApipatchMemberByOrganizationAndMemberPATCH /organizations/{organization}/members/{member}Edit one Member resource.
MemberApipostMemberByOrganizationPOST /organizations/{organization}/membersCreate one Member resource.
MembershipApicgetMembershipsByPersonGET /people/{person}/membershipsRetrieve all Membership resources.
OperationApicgetOperationsByOrganizationGET /organizations/{organization}/operationsRetrieve all Operation resources.
OperationApicgetOperationsByPersonGET /people/{person}/operationsRetrieve all Operation resources.
OperationApicgetOperationsByReportGET /reports/{report}/operationsRetrieve all Operation resources.
OperationApideleteOperationDELETE /operations/{operation}Remove one Operation resource.
OperationApigetOperationGET /operations/{operation}Retrieve one Operation resource.
OperationApipatchOperationPATCH /operations/{operation}Edit one Operation resource.
OperationApipostOperationPOST /operationsCreate one Operation resource.
OrganizationApicgetOrganizationsGET /organizationsRetrieve all Organization resources.
OrganizationApigetOrganizationGET /organizations/{organization}Retrieve one Organization resource.
OrganizationApipatchOrganizationPATCH /organizations/{organization}Edit one Organization resource.
OrganizationApipostOrganizationPOST /organizationsCreate one Organization resource.
PersonApicgetPeopleGET /peopleRetrieve all Person resources.
PersonApigetPersonGET /people/{person}Retrieve one Person resource.
PersonApipatchPersonPATCH /people/{person}Edit one Person resource.
PlaceApicgetPlacesGET /placesRetrieve all Place resources.
PlaceApicgetPlacesByOrganizationGET /organizations/{organization}/placesRetrieve all Place resources.
PlaceApigetPlaceGET /places/{place}Retrieve one Place resource.
PlaceApipatchPlacePATCH /places/{place}Edit one Place resource.
PlaceApipostPlaceByOrganizationPOST /organizations/{organization}/placesCreate one Place resource.
RegisterApipostRegisterPOST /security/registerCreate one Register resource.
RelationshipApicgetRelationshipsByOrganizationGET /organizations/{organization}/relationshipsRetrieve all Relationship resources.
RelationshipApideleteRelationshipByOrganizationAndRelationshipDELETE /organizations/{organization}/relationships/{relationship}Remove one Relationship resource.
RelationshipApipostRelationshipByOrganizationPOST /organizations/{organization}/relationshipsCreate one Relationship resource.
ReportApicgetReportsByOrganizationGET /organizations/{organization}/reportsRetrieve all Report resources.
ReportApigetReportGET /reports/{report}Retrieve one Report resource.
ReportApipatchReportPATCH /reports/{report}Edit one Report resource.
RequestApicgetRequestsByPersonGET /people/{person}/review-requestsRetrieve all Request resources.
ResetApipostResetPOST /security/password/change-requestCreate one Reset resource.
ReviewApicgetReviewsByFeedbackGET /feedbacks/{feedback}/reviewsRetrieve all Review resources.
ReviewApigetReviewGET /reviews/{review}Retrieve one Review resource.
ReviewApipostReviewByReviewRequestPOST /review-requests/{reviewRequest}/reviewsCreate one Review resource.
ReviewRequestApigetReviewRequestGET /review-requests/{reviewRequest}Retrieve one ReviewRequest resource.
ServiceApicgetServicesByOrganizationGET /organizations/{organization}/servicesRetrieve all Service resources.
StateApipatchStateByFeedbackPATCH /feedbacks/{feedback}/stateEdit one State resource.
StateApipatchStateByOperationPATCH /operations/{operation}/stateEdit one State resource.
StateApipatchStateByReportPATCH /reports/{report}/stateEdit one State resource.
TrackingApigetTrackingByFeedbackGET /feedbacks/{feedback}/trackingRetrieve one Tracking resource.
TrackingApigetTrackingByOperationGET /operations/{operation}/trackingRetrieve one Tracking resource.
TrackingApigetTrackingByReportGET /reports/{report}/trackingRetrieve one Tracking resource.
TransitionApipostTransitionByFeedbackPOST /feedbacks/{feedback}/workflow/transitionCreate one Transition resource.
TransitionApipostTransitionByOperationPOST /operations/{operation}/workflow/transitionCreate one Transition resource.
TransitionApipostTransitionByReportPOST /reports/{report}/workflow/transitionCreate one Transition resource.
WebhookApicgetWebhooksByOrganizationGET /organizations/{organization}/webhooksRetrieve all Webhook resources.
WebhookApigetWebhookGET /webhooks/{webhook}Retrieve one Webhook resource.
WebhookApipatchWebhookPATCH /webhooks/{webhook}Edit one Webhook resource.

Documentation For Models

Documentation For Authorization

bearer

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

Author

techies@keyclic.com

Libraries

keyclic_sdk_api.api