openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

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

Requirements

Dart 2.0 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    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:
  openapi:
    path: /path/to/openapi

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:openapi/api.dart';

// TODO Configure OAuth2 access token for authorization: oauth2
//defaultApiClient.getAuthentication<OAuth>('oauth2').accessToken = 'YOUR_ACCESS_TOKEN';

var api_instance = ActivemembersApi();
var limit = 56; // int | Number of results to return per page.
var offset = 56; // int | The initial index from which to return the results.
var ordering = ordering_example; // String | Which field to use when ordering the results.
var search = search_example; // String | A search term.

try {
    var result = api_instance.listMemberGroups(limit, offset, ordering, search);
    print(result);
} catch (e) {
    print("Exception when calling ActivemembersApi->listMemberGroups: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ActivemembersApi	listMemberGroups	GET /api/v1/activemembers/groups/
ActivemembersApi	retrieveRetrieveMemberGroup	GET /api/v1/activemembers/groups/{id}/
DevicesApi	createCreateDevice	POST /api/v1/devices/
DevicesApi	destroyDestroyDevice	DELETE /api/v1/devices/{id}/
DevicesApi	listDevices	GET /api/v1/devices/
DevicesApi	partialUpdatePartialUpdateDevice	PATCH /api/v1/devices/{id}/
DevicesApi	retrieveCategoriesDevice	GET /api/v1/devices/categories/
DevicesApi	retrieveRetrieveDevice	GET /api/v1/devices/{id}/
DevicesApi	updateUpdateDevice	PUT /api/v1/devices/{id}/
EventsApi	createRegistrationsEvent	POST /api/v1/events/{id}/registrations/
EventsApi	listEvents	GET /api/v1/events/
EventsApi	retrieveCalendarjsEvent	GET /api/v1/events/calendarjs/
EventsApi	retrieveRegistrationsEvent	GET /api/v1/events/{id}/registrations/
EventsApi	retrieveRetrieveEvent	GET /api/v1/events/{id}/
EventsApi	retrieveUnpublishedEvent	GET /api/v1/events/unpublished/
MembersApi	listMembers	GET /api/v1/members/
MembersApi	retrieveBirthdaysMember	GET /api/v1/members/birthdays/
MembersApi	retrieveRetrieveMember	GET /api/v1/members/{id}/
NotificationsApi	listMessages	GET /api/v1/notifications/
NotificationsApi	retrieveRetrieveMessage	GET /api/v1/notifications/{id}/
PartnersApi	listPartnerEvents	GET /api/v1/partners/events/
PartnersApi	listPartners	GET /api/v1/partners/
PartnersApi	retrieveCalendarjsPartner	GET /api/v1/partners/calendarjs/
PartnersApi	retrieveRetrievePartner	GET /api/v1/partners/{id}/
PartnersApi	retrieveRetrievePartnerEvent	GET /api/v1/partners/events/{id}/
PhotosApi	createCreateAlbum	POST /api/v1/photos/albums/
PhotosApi	createCreatePhoto	POST /api/v1/photos/images/
PhotosApi	destroyDestroyAlbum	DELETE /api/v1/photos/albums/{id}/
PhotosApi	listAlbums	GET /api/v1/photos/albums/
PhotosApi	partialUpdatePartialUpdateAlbum	PATCH /api/v1/photos/albums/{id}/
PhotosApi	partialUpdatePartialUpdatePhoto	PATCH /api/v1/photos/images/{id}/
PhotosApi	retrieveRetrieveAlbum	GET /api/v1/photos/albums/{id}/
PhotosApi	updateUpdateAlbum	PUT /api/v1/photos/albums/{id}/
PhotosApi	updateUpdatePhoto	PUT /api/v1/photos/images/{id}/
PizzasApi	createCreateOrder	POST /api/v1/pizzas/orders/
PizzasApi	destroyDestroyOrder	DELETE /api/v1/pizzas/orders/{id}/
PizzasApi	listOrders	GET /api/v1/pizzas/orders/
PizzasApi	listProducts	GET /api/v1/pizzas/
PizzasApi	partialUpdatePartialUpdateOrder	PATCH /api/v1/pizzas/orders/{id}/
PizzasApi	retrieveEventProduct	GET /api/v1/pizzas/event/
PizzasApi	retrieveRetrieveOrder	GET /api/v1/pizzas/orders/{id}/
PizzasApi	updateUpdateOrder	PUT /api/v1/pizzas/orders/{id}/
RegistrationsApi	destroyDestroyEventRegistration	DELETE /api/v1/registrations/{id}/
RegistrationsApi	partialUpdatePartialUpdateEventRegistration	PATCH /api/v1/registrations/{id}/
RegistrationsApi	retrieveRetrieveEventRegistration	GET /api/v1/registrations/{id}/
RegistrationsApi	updateUpdateEventRegistration	PUT /api/v1/registrations/{id}/
TokenAuthApi	createAuthToken	POST /api/v1/token-auth/

Documentation For Models

• Album
• AlbumList
• AlbumListCover
• AuthToken
• Device
• EventList
• EventRegistration
• EventRetrieve
• EventsCalenderJS
• InlineResponse200
• InlineResponse2001
• InlineResponse2002
• InlineResponse2003
• InlineResponse2004
• InlineResponse2005
• InlineResponse2006
• InlineResponse2007
• InlineResponse2008
• InlineResponse2009
• MemberGroup
• MemberList
• Message
• Order
• Partner
• PartnerEvent
• PhotoCreate
• Pizza
• ProfileRetrieve

Documentation For Authorization

oauth2

• Type: OAuth
• Flow: implicit
• Authorization URL: /user/oauth/authorize/
• Scopes:
• read: Authenticated read access to the website
• write: Authenticated write access to the website
• members:read: Read access to your member profile
• activemembers:read: Read access to committee, society and board groups

Author