openapi

API stubs for Norton that are used with the web build of Vertex.

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

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

Information about the Dart generator can be found here.

Requirements

Dart 2.0 or later

Installation & Usage

Github

dependencies:
  openapi:
    git: https://github.com/VertexChat/norton-api-client

Local

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

dependencies:
  openapi:
    path: /path/to/openapi

Getting Started

Please follow the installation procedure and then run the following:

import 'package:openapi/api.dart';


var api_instance = AccountApi();
var inlineObject = InlineObject(); // InlineObject | 

try {
    api_instance.login(inlineObject);
} catch (e) {
    print("Exception when calling AccountApi->login: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

Class	Method	HTTP request	Description
AccountApi	login	POST /login	Log in
AccountApi	register	POST /register	Registers User
ChannelApi	addUserToChannel	POST /channels/{channelId}/members
ChannelApi	createChannel	POST /channels	Create a Channel
ChannelApi	createMessage	POST /channels/{channelId}/messages	Create a Message
ChannelApi	deleteChannel	DELETE /channels/{channelId}	Delete a Channel
ChannelApi	deleteMessage	DELETE /channels/{channelId}/messages/{messageId}	Delete a Message
ChannelApi	getChannel	GET /channels/{channelId}	Get a Channel
ChannelApi	getChannelMembers	GET /channels/{channelId}/members	List All members
ChannelApi	getChannels	GET /channels	List All channels
ChannelApi	getMessage	GET /channels/{channelId}/messages/{messageId}	Get a Message
ChannelApi	getMessages	GET /channels/{channelId}/messages	List All messages
ChannelApi	removeChannelMember	DELETE /channels/{channelId}/members/{userId}	Remove as User
ChannelApi	updateChannel	PUT /channels/{channelId}	Update a Channel
ChannelApi	updateMessage	PUT /channels/{channelId}/messages/{messageId}	Update a Message
UserApi	createUser	POST /users	Create a User
UserApi	deleteUser	DELETE /users/{userId}	Delete a User
UserApi	getUser	GET /users/{userId}	Get a User
UserApi	getUsers	GET /users	List All users
UserApi	updateUser	PUT /users/{userId}	Update a User

Documentation For Models

• Channel
• Error
• InlineObject
• Message
• User

Documentation For Authorization

LoginRequired

• Type: API key
• API key parameter name: session_id
• Location: header

Authors

• Cathal Butler
• Morgan Reilly
• David Neilan