keyclic_sdk_api 2.7.8

Dart native js
Flutter Android iOS web

The keyclic_sdk_api package is an implementation of the Keyclic API.

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: 2.7.8
  • 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: 2.7.8
description: The keyclic_sdk_api package is an implementation of the 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';


var api_instance = ApplicationApi();
var xKeyclicApp = xKeyclicApp_example; // String | 
var application = ; // String | The identifier of the resource.
var acceptLanguage = acceptLanguage_example; // String | 
var xDateTime = 2013-10-20T19:20:30+01:00; // DateTime | 
var xKeyclicAppPlatform = xKeyclicAppPlatform_example; // String | 
var xKeyclicAppVersion = xKeyclicAppVersion_example; // String | 

try {
    var result = api_instance.getApplication(xKeyclicApp, application, acceptLanguage, xDateTime, xKeyclicAppPlatform, xKeyclicAppVersion);
    print(result);
} catch (e) {
    print("Exception when calling ApplicationApi->getApplication: $e\n");
}

Documentation for API Endpoints #

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

ClassMethodHTTP requestDescription
ApplicationApigetApplicationGET /applications/{application}Retrieve one Application resource.
ArticleApigetArticleGET /articles/{article}Retrieve one Article resource.
BookmarkApideleteBookmarkDELETE /bookmarks/{bookmark}Remove one Bookmark resource.
BookmarkApigetBookmarkGET /bookmarks/{bookmark}Retrieve one Bookmark resource.
BookmarkApipostBookmarkPOST /bookmarksCreate one Bookmark resource.
BusinessActivityApicgetBusinessActivitiesGET /business-activitiesRetrieve all BusinessActivity resources.
BusinessActivityApigetBusinessActivityGET /business-activities/{businessActivity}Retrieve one BusinessActivity resource.
BusinessActivityApigetSchemaByBusinessActivityGET /businessactivities/{businessActivity}/schemaRetrieve one Schema resource.
CategoryApicgetCategoriesGET /categoriesRetrieve all Category resources.
CategoryApideleteCategoryDELETE /categories/{category}Remove one Category resource.
CategoryApigetCategoryGET /categories/{category}Retrieve one Category resource.
CategoryApipatchCategoryPATCH /categories/{category}Edit one Category resource.
CategoryApipostCategoryPOST /categoriesCreate one Category resource.
ConfigurationApigetConfigurationGET /configurations/{configuration}Retrieve one Configuration resource.
ContributionApicgetContributionsGET /contributionsRetrieve all Contribution resources.
ContributionApigetContributionGET /contributions/{contribution}Retrieve one Contribution resource.
ContributionApipostContributionPOST /contributionsCreate one Contribution resource.
DelegationApigetDelegationGET /delegations/{delegation}Retrieve one Delegation resource.
DelegationApipostDelegationPOST /delegationsCreate one Delegation resource.
DelegationApipostWorkflowByDelegationPOST /delegations/{delegation}/workflowCreate one Workflow resource.
DeviceApideleteDeviceDELETE /devices/{device}Remove one Device resource.
DeviceApigetDeviceGET /devices/{device}Retrieve one Device resource.
DeviceApipostDevicePOST /devicesCreate one Device resource.
DispatcherApicgetRulesByDispatcherGET /dispatchers/{dispatcher}/rulesRetrieve all Rule resources.
DispatcherApigetDispatcherGET /dispatchers/{dispatcher}Retrieve one Dispatcher resource.
DocumentApideleteDocumentDELETE /documents/{document}Remove one Document resource.
DocumentApigetDocumentGET /documents/{document}Retrieve one Document resource.
DocumentApipatchDocumentPATCH /documents/{document}Edit one Document resource.
ExternalServiceApideleteExternalServiceDELETE /external-services/{externalService}Remove one ExternalService resource.
ExternalServiceApigetExternalServiceGET /external-services/{externalService}Retrieve one ExternalService resource.
ExternalServiceApipatchExternalServicePATCH /external-services/{externalService}Edit one ExternalService resource.
ExternalServiceApipostExternalServicePOST /external-servicesCreate one ExternalService resource.
FeedApicgetFeedsGET /feedsRetrieve all Feed resources.
FeedApicgetFeedsByFeedGET /feeds/{feed}Retrieve all Feed resources.
FeedApicgetFollowingsByFeedGET /feeds/{feed}/followingRetrieve all Following resources.
FeedApipostFollowByFeedPOST /feeds/{feed}/followCreate one Follow resource.
FeedApipostReadByFeedAndGroupPOST /feeds/{feed}/read/{group}Create one Read resource.
FeedApipostUnfollowByFeedPOST /feeds/{feed}/unfollowCreate one Unfollow resource.
FeedbackApicgetCommentsByFeedbackGET /feedbacks/{feedback}/commentsRetrieve all Comment resources.
FeedbackApicgetFeedbackGET /feedbacksRetrieve all Feedback resources.
FeedbackApicgetReviewsByFeedbackGET /feedbacks/{feedback}/reviewsRetrieve all Review resources.
FeedbackApigetFeedbackGET /feedbacks/{feedback}Retrieve one Feedback resource.
FeedbackApigetTrackingByFeedbackGET /feedbacks/{feedback}/trackingRetrieve one Tracking resource.
FeedbackApipostCommentByFeedbackPOST /feedbacks/{feedback}/commentsCreate one Comment resource.
FeedbackApipostImageByFeedbackPOST /feedbacks/{feedback}/imagesCreate one Image resource.
FeedbackApipostIssuePOST /feedbacks/issuesCreate one Issue resource.
FeedbackApipostWorkflowByFeedbackPOST /feedbacks/{feedback}/workflowCreate one Workflow resource.
InternalServiceApicgetMembersByInternalServiceGET /internal-services/{internalService}/membersRetrieve all Member resources.
InternalServiceApideleteInternalServiceDELETE /internal-services/{internalService}Remove one InternalService resource.
InternalServiceApideleteMemberByInternalServiceAndMemberDELETE /internal-services/{internalService}/members/{member}Remove one Member resource.
InternalServiceApigetInternalServiceGET /internal-services/{internalService}Retrieve one InternalService resource.
InternalServiceApipatchInternalServicePATCH /internal-services/{internalService}Edit one InternalService resource.
InternalServiceApipostInternalServicePOST /internal-servicesCreate one InternalService resource.
InternalServiceApipostMemberByInternalServicePOST /internal-services/{internalService}/membersCreate one Member resource.
InvitationApideleteInvitationDELETE /invitations/{invitation}Remove one Invitation resource.
InvitationApigetInvitationGET /invitations/{invitation}Retrieve one Invitation resource.
InvitationApipostInvitationPOST /invitationsCreate one Invitation resource.
KnowledgeBaseApicgetArticlesByKnowledgeBaseGET /knowledge-bases/{knowledgeBase}/articlesRetrieve all Article resources.
KnowledgeBaseApicgetSectionsByKnowledgeBaseGET /knowledge-bases/{knowledgeBase}/sectionsRetrieve all Section resources.
KnowledgeBaseApigetKnowledgeBaseGET /knowledge-bases/{knowledgeBase}Retrieve one KnowledgeBase resource.
MarkerApideleteMarkerDELETE /markers/{marker}Remove one Marker resource.
MarkerApigetMarkerGET /markers/{marker}Retrieve one Marker resource.
MarkerApipostMarkerPOST /markersCreate one Marker resource.
MemberApicgetBookmarksByMemberGET /members/{member}/bookmarksRetrieve all Bookmark resources.
MemberApideleteMemberDELETE /members/{member}Remove one Member resource.
MemberApigetMemberGET /members/{member}Retrieve one Member resource.
MemberApipatchMemberPATCH /members/{member}Edit one Member resource.
MemberApipostMemberPOST /membersCreate one Member resource.
OccupantApideleteOccupantDELETE /occupants/{occupant}Remove one Occupant resource.
OccupantApigetOccupantGET /occupants/{occupant}Retrieve one Occupant resource.
OccupantApipostOccupantPOST /occupantsCreate one Occupant resource.
OperationApicgetCommentsByOperationGET /operations/{operation}/commentsRetrieve all Comment resources.
OperationApideleteImageByOperationAndImageDELETE /operations/{operation}/images/{image}Remove one Image resource.
OperationApideleteOperationDELETE /operations/{operation}Remove one Operation resource.
OperationApigetOperationGET /operations/{operation}Retrieve one Operation resource.
OperationApigetTrackingByOperationGET /operations/{operation}/trackingRetrieve one Tracking resource.
OperationApipatchOperationPATCH /operations/{operation}Edit one Operation resource.
OperationApipostAssignByOperationPOST /operations/{operation}/assignCreate one Assign resource.
OperationApipostCommentByOperationPOST /operations/{operation}/commentsCreate one Comment resource.
OperationApipostImageByOperationPOST /operations/{operation}/imagesCreate one Image resource.
OperationApipostOperationPOST /operationsCreate one Operation resource.
OperationApipostSignByOperationPOST /operations/{operation}/signCreate one Sign resource.
OperationApipostWorkflowByOperationPOST /operations/{operation}/workflowCreate one Workflow resource.
OrganizationApicgetCategoriesByOrganizationGET /organizations/{organization}/categoriesRetrieve all Category resources.
OrganizationApicgetDelegationsByOrganizationGET /organizations/{organization}/delegationsRetrieve all Delegation resources.
OrganizationApicgetExternalServicesByOrganizationGET /organizations/{organization}/external-servicesRetrieve all ExternalService resources.
OrganizationApicgetInternalServicesByOrganizationGET /organizations/{organization}/internal-servicesRetrieve all InternalService resources.
OrganizationApicgetMembersByOrganizationGET /organizations/{organization}/membersRetrieve all Member resources.
OrganizationApicgetOperationsByOrganizationGET /organizations/{organization}/operationsRetrieve all Operation resources.
OrganizationApicgetOrganizationsGET /organizationsRetrieve all Organization resources.
OrganizationApicgetPlacesByOrganizationGET /organizations/{organization}/placesRetrieve all Place resources.
OrganizationApicgetPublicationsByOrganizationGET /organizations/{organization}/publicationsRetrieve all Publication resources.
OrganizationApicgetReportsByOrganizationGET /organizations/{organization}/reportsRetrieve all Report resources.
OrganizationApicgetServicesByOrganizationGET /organizations/{organization}/servicesRetrieve all Service resources.
OrganizationApicgetWebhooksByOrganizationGET /organizations/{organization}/webhooksRetrieve all Webhook resources.
OrganizationApicpostExportByOrganizationPOST /organizations/{organization}/exportsRetrieve all Export resources.
OrganizationApigetAnalyticByOrganizationGET /organizations/{organization}/analyticsRetrieve one Analytic resource.
OrganizationApigetConfigurationByOrganizationGET /organizations/{organization}/configurationRetrieve one Configuration resource.
OrganizationApigetFormByOrganizationGET /organizations/{organization}/formRetrieve one Form resource.
OrganizationApigetOrganizationGET /organizations/{organization}Retrieve one Organization resource.
OrganizationApipatchOrganizationPATCH /organizations/{organization}Edit one Organization resource.
PersonApicgetFeedbackByPersonGET /people/{person}/feedbacksRetrieve all Feedback resources.
PersonApicgetMembershipsByPersonGET /people/{person}/membershipsRetrieve all Membership resources.
PersonApicgetOccupantsByPersonGET /people/{person}/occupantsRetrieve all Occupant resources.
PersonApicgetOperationsByPersonGET /people/{person}/operationsRetrieve all Operation resources.
PersonApicgetPeopleGET /peopleRetrieve all Person resources.
PersonApicgetReportsByPersonGET /people/{person}/reportsRetrieve all Report resources.
PersonApicgetReviewRequestsByPersonGET /people/{person}/review-requestsRetrieve all ReviewRequest resources.
PersonApigetPersonGET /people/{person}Retrieve one Person resource.
PersonApipatchPersonPATCH /people/{person}Edit one Person resource.
PlaceApicgetOccupantsByPlaceGET /places/{place}/occupantsRetrieve all Occupant resources.
PlaceApicgetPlacesGET /placesRetrieve all Place resources.
PlaceApicgetPlansByPlaceGET /places/{place}/plansRetrieve all Plan resources.
PlaceApigetPlaceGET /places/{place}Retrieve one Place resource.
PlaceApipatchPlacePATCH /places/{place}Edit one Place resource.
PlaceApipostPlacePOST /placesCreate one Place resource.
PlanApideletePlanDELETE /plans/{plan}Remove one Plan resource.
PlanApigetPlanGET /plans/{plan}Retrieve one Plan resource.
PlanApipatchPlanPATCH /plans/{plan}Edit one Plan resource.
PlanApipostPlanPOST /plansCreate one Plan resource.
PublicationApideletePublicationDELETE /publications/{publication}Remove one Publication resource.
PublicationApigetPublicationGET /publications/{publication}Retrieve one Publication resource.
PublicationApipostPublicationPOST /publicationsCreate one Publication resource.
ReportApicgetDelegationsByReportGET /reports/{report}/delegationsRetrieve all Delegation resources.
ReportApicgetDocumentsByReportGET /reports/{report}/documentsRetrieve all Document resources.
ReportApicgetOperationsByReportGET /reports/{report}/operationsRetrieve all Operation resources.
ReportApigetReportGET /reports/{report}Retrieve one Report resource.
ReportApigetTrackingByReportGET /reports/{report}/trackingRetrieve one Tracking resource.
ReportApipatchReportPATCH /reports/{report}Edit one Report resource.
ReportApipostDocumentByReportPOST /reports/{report}/documentsCreate one Document resource.
ReportApipostWorkflowByReportPOST /reports/{report}/workflowCreate one Workflow resource.
ReviewApigetReviewGET /reviews/{review}Retrieve one Review resource.
ReviewApipostReviewPOST /reviewsCreate one Review resource.
ReviewRequestApigetReviewRequestGET /review-requests/{reviewRequest}Retrieve one ReviewRequest resource.
RoleApigetRoleGET /roles/{role}Retrieve one Role resource.
RuleApideleteRuleDELETE /rules/{rule}Remove one Rule resource.
RuleApigetRuleGET /rules/{rule}Retrieve one Rule resource.
RuleApipatchRulePATCH /rules/{rule}Edit one Rule resource.
RuleApipostRulePOST /rulesCreate one Rule resource.
SectionApigetSectionGET /sections/{section}Retrieve one Section resource.
SecurityApipostLoginPOST /security/loginCreate one Login resource.
SecurityApipostPasswordChangeByTokenPOST /security/password/change/{token}Create one PasswordChange resource.
SecurityApipostPasswordResetPOST /security/password/change-requestCreate one PasswordReset resource.
SecurityApipostRegisterPOST /security/registerCreate one Register resource.
ServiceApigetServiceGET /services/{service}Retrieve one Service resource.
WebhookApideleteWebhookDELETE /webhooks/{webhook}Remove one Webhook resource.
WebhookApigetWebhookGET /webhooks/{webhook}Retrieve one Webhook resource.
WebhookApipatchWebhookPATCH /webhooks/{webhook}Edit one Webhook resource.
WebhookApipostWebhookPOST /webhooksCreate one Webhook resource.
WorkflowApigetWorkflowGET /workflows/{workflow}Retrieve one Workflow resource.

Documentation For Models #

Documentation For Authorization #

bearer #

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

Author #

techies@keyclic.com

0
likes
80
pub points
55%
popularity

The keyclic_sdk_api package is an implementation of the Keyclic API.

Homepage

Documentation

API reference

Uploaders

kevin.lot@keyclic.com
gdoury@keyclic.com
marin.virlogeux@gmail.com

License

MIT (LICENSE)

Dependencies

collection, http, logging

More

Packages that depend on keyclic_sdk_api