sweep_api

API definitions for the Sweep server/dashboard.

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

  • API version: 1.0.0-oas3
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

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: sweep_api
version: 1.0.0
description: OpenAPI API client
dependencies:
  sweep_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:
  sweep_api:
    path: /path/to/sweep_api

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:sweep_api/api.dart';

// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';

var api_instance = new EventApi();
var eventRequestBody = new EventRequestBody(); // EventRequestBody | 
var apiKey = apiKey_example; // String | 

try {
    api_instance.addEvent(eventRequestBody, apiKey);
} catch (e) {
    print("Exception when calling EventApi->addEvent: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://app.sweephq.com/1.0.0

ClassMethodHTTP requestDescription
EventApiaddEventPOST /eventsRaise an event
EventApigetEventByIdGET /events/{eventId}Find raised event by ID
EventApilistEventsGET /eventsList all received events
ListenerApiaddListenerPOST /listenersCreate a new Listener
ListenerApiaddListenerTemplatePOST /listeners/{listenerId}/templates/{templateId}Associates a Template to a Listener
ListenerApideleteListenerDELETE /listeners/{listenerId}Deletes a Listener
ListenerApideleteListenerTemplateDELETE /listeners/{listenerId}/templates/{templateId}Disassociates a Template from a Listener
ListenerApigetListenerGET /listeners/{listenerId}Get a listener by ID
ListenerApilistListenerTemplatesGET /listeners/{listenerId}/templatesList Templates for Listener
ListenerApilistListenersGET /listenersList all Listeners
ListenerApilistMessagesForActionGET /actions/{listenerActionId}/messagesList all messages
ListenerApiupdateListenerPUT /listeners/{listenerId}Updates a Listener
MessageApigetMessageByIdGET /messages/{messageId}Find message by ID
MessageApilistMessagesGET /messagesList all messages
OrganizationApigetOrganizationInfoGET /organizationGet organization info for the currently authenticated context
TemplateApiaddTemplatePOST /templatesCreate a new Template
TemplateApideleteTemplateDELETE /templates/{templateId}Deletes a Template
TemplateApigetTemplateByIdGET /templates/{templateId}Find Template by ID
TemplateApilistTemplateGET /templatesList all Templates
TemplateApirenderTemplatePOST /templates/{templateId}/renderRenders a template using the provided event parameters
TemplateApiupdateTemplatePUT /templates/{templateId}Update an existing Template
UserApideleteUserDELETE /userDelete user
UserApigetUserInfoGET /userGet user info for the currently authenticated user
UserApiloginUserGET /user/loginLogs user into the system
UserApilogoutUserGET /user/logoutLogs out current logged in user session
UserApiupdateUserPUT /userUpdated user

Documentation For Models

Documentation For Authorization

GitHub

Google

api_key

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

Author

contact@avinium.com

Libraries

sweep_api.api