0.1.0 • Published 8 years ago

dotvision-motion-api-v2-js-client v0.1.0

Weekly downloads
3
License
-
Repository
-
Last release
8 years ago

dot-vision-motion-api-v2

DotVisionMotionApiV2 - JavaScript client for dot-vision-motion-api-v2

Version: v2

Automatically generated by the JavaScript Swagger Codegen project:

  • Build date: 2016-03-18T10:35:06.799+01:00
  • Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

Use in Node.js

The generated client is valid npm package, you can publish it as described in Publishing npm packages.

After that, you can install it into your project via:

npm install dot-vision-motion-api-v2 --save

You can also host the generated client as a git repository on github, e.g. https://github.com/YOUR_USERNAME/dot-vision-motion-api-v2

Then you can install it via:

npm install YOUR_USERNAME/dot-vision-motion-api-v2 --save

Use in browser with browserify

The client also works in browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, you can do this in your project (assuming main.js is your entry file):

browserify main.js > bundle.js

The generated bundle.js can now be included in your HTML pages.

Getting Started

var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var defaultClient = DotVisionMotionApiV2.ApiClient.default;
defaultClient.timeout = 10 * 1000;
defaultClient.defaultHeaders['Test-Header'] = 'test_value';

// Assuming there's a `PetApi` containing a `getPetById` method
// which returns a model object:
var api = new DotVisionMotionApiV2.PetApi();
api.getPetById(2, function(err, pet, resp) {
  console.log('HTTP status code: ' + resp.status);
  console.log('Response Content-Type: ' + resp.get('Content-Type'));
  if (err) {
    console.error(err);
  } else {
    console.log(pet);
  }
});

Documentation for API Endpoints

All URIs are relative to http://dotvision-motion-webapi.azurewebsites.net

ClassMethodHTTP requestDescription
DotVisionMotionApiV2.BackOfficeApibackOfficeSendContactEmailPOST /api/backoffice/email/contactSends an email formatted in HTML to contact@dotvision.com
DotVisionMotionApiV2.BackOfficeApibackOfficeSendEmailPOST /api/backoffice/emailSends an email with a raw text.
DotVisionMotionApiV2.CategoriesApicategoriesCategoriesCountGET /api/categories/countGet categories count
DotVisionMotionApiV2.CategoriesApicategoriesCreateCategoryPOST /api/categoriesCreate a category
DotVisionMotionApiV2.CategoriesApicategoriesDeleteCategoryDELETE /api/categories/{id}Delete a category
DotVisionMotionApiV2.CategoriesApicategoriesGetAllCategoriesGET /api/categoriesGet categories collection
DotVisionMotionApiV2.CategoriesApicategoriesGetCategoryGET /api/categories/{id}Get a category
DotVisionMotionApiV2.CategoriesApicategoriesUpdateCategoryPUT /api/categoriesUpdate a category
DotVisionMotionApiV2.EventsApieventsCreateEventPOST /api/eventsCreate an event
DotVisionMotionApiV2.EventsApieventsDeleteEventDELETE /api/events/{id}Delete an event
DotVisionMotionApiV2.EventsApieventsDeleteUniqueNameForEventDELETE /api/events/{id}/uniqueNameDelete unique name for event
DotVisionMotionApiV2.EventsApieventsEventAddAdminPOST /api/events/{id}/adminsAdd an admin for an event
DotVisionMotionApiV2.EventsApieventsEventAddOrganisationPOST /api/events/{id}/organisationLink an organisation to an event
DotVisionMotionApiV2.EventsApieventsEventAddParticipantPOST /api/events/{id}/participantsAdd a participant on an event
DotVisionMotionApiV2.EventsApieventsEventAddStagePOST /api/events/{id}/stagesAdd a stage to an event
DotVisionMotionApiV2.EventsApieventsEventAdminsCountGET /api/events/{id}/admins/countGet event administrators count
DotVisionMotionApiV2.EventsApieventsEventAdminsGetAllGET /api/events/{id}/adminsGet event administrators collection
DotVisionMotionApiV2.EventsApieventsEventDeleteAdminDELETE /api/events/{id}/adminsDelete an administrator of an event
DotVisionMotionApiV2.EventsApieventsEventDeleteOrganisationDELETE /api/events/{id}/organisationUnlink the organisation of an event
DotVisionMotionApiV2.EventsApieventsEventDeleteParticipantDELETE /api/events/{id}/participantsDelete a participants of an event
DotVisionMotionApiV2.EventsApieventsEventDeleteStageDELETE /api/events/{id}/stages/{stageId}Delete the stage of an event
DotVisionMotionApiV2.EventsApieventsEventParticipantsCountGET /api/events/{id}/participants/countGet event participants count
DotVisionMotionApiV2.EventsApieventsEventParticipantsGetAllGET /api/events/{id}/participantsGet event participants collection
DotVisionMotionApiV2.EventsApieventsEventRegistrationsCountGET /api/events/{id}/registrations/countGet registrations count for an event
DotVisionMotionApiV2.EventsApieventsEventStagesCountGET /api/events/{id}/stages/countGet event stages count
DotVisionMotionApiV2.EventsApieventsEventUpdateAdminPUT /api/events/{id}/adminsUpdate an administrator for an event
DotVisionMotionApiV2.EventsApieventsEventUpdateParticipantPUT /api/events/{id}/participantsUpdate a participant for an event
DotVisionMotionApiV2.EventsApieventsEventUpdateStagePUT /api/events/{id}/stagesUpdate a stage for an event
DotVisionMotionApiV2.EventsApieventsGetAllCategoriesGET /api/events/{id}/categoriesGet all categories for an event
DotVisionMotionApiV2.EventsApieventsGetAllEventStagesGET /api/events/{id}/stagesGet all event stages
DotVisionMotionApiV2.EventsApieventsGetAllEventsGET /api/eventsGet events collection
DotVisionMotionApiV2.EventsApieventsGetEventGET /api/events/{id}Get an individual event
DotVisionMotionApiV2.EventsApieventsGetEventCategoriesCountGET /api/events/{id}/categories/countGet number of categories for an event
DotVisionMotionApiV2.EventsApieventsGetEventOrganisationGET /api/events/{id}/organisationGet event organisation
DotVisionMotionApiV2.EventsApieventsGetEventParticipantRegistrationGET /api/events/{id}/participants/{participantId}/registrationGet registration for a participants of an event
DotVisionMotionApiV2.EventsApieventsGetEventRegistrationsGET /api/events/{id}/registrationsGet registrations list for an event
DotVisionMotionApiV2.EventsApieventsGetUniqueNameForEventGET /api/events/{id}/uniqueNameGet unique name attributed to the event
DotVisionMotionApiV2.EventsApieventsLinkCategoryPOST /api/events/{id}/categoriesLink a category to an event
DotVisionMotionApiV2.EventsApieventsPublicEventsCountGET /api/events/countGet public events count
DotVisionMotionApiV2.EventsApieventsSearchEventsGET /api/events/searchSearch for an event by name
DotVisionMotionApiV2.EventsApieventsSetUniqueNameForEventPOST /api/events/{id}/uniqueNameSet unique name for event
DotVisionMotionApiV2.EventsApieventsUnlinkCategoryDELETE /api/events/{id}/categoriesUnlink a category from an event
DotVisionMotionApiV2.EventsApieventsUpdateEventPUT /api/eventsUpdate an event
DotVisionMotionApiV2.EventsApieventsUpdateUniqueNameForEventPUT /api/events/{id}/uniqueNameUpdate unique name for event
DotVisionMotionApiV2.OrganisationsApiorganisationsCreateOrganisationPOST /api/organisationsCreate an organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsDeleteOrganisationDELETE /api/organisations/{id}Delete an organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsDeleteUniqueNameForOrganisationDELETE /api/organisations/{id}/uniqueNameDelete unique name for organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsGetAllOrganisationsGET /api/organisationsGet organisations collection
DotVisionMotionApiV2.OrganisationsApiorganisationsGetOrganisationGET /api/organisations/{id}Get an organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsGetUniqueNameForOrganisationGET /api/organisations/{id}/uniqueNameGet unique name attributed to the organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsOrganisationAdminsCountGET /api/organisations/{id}/admins/countGet organisation administrators count
DotVisionMotionApiV2.OrganisationsApiorganisationsOrganisationAdminsGetAllGET /api/organisations/{id}/adminsGet organisation administrators collection
DotVisionMotionApiV2.OrganisationsApiorganisationsOrganisationEventsGetAllGET /api/organisations/{id}/eventsGet organisation events collection
DotVisionMotionApiV2.OrganisationsApiorganisationsOrganisationLinkAdminPOST /api/organisations/{id}/adminsLink an administrator to an organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsOrganisationUnlinkAdminDELETE /api/organisations/{id}/adminsUnlink an administrator of an organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsOrganisationUpdateLinkAdminPUT /api/organisations/{id}/adminsUpdate an administrator link for an organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsOrganisationsCountGET /api/organisations/countGet organisations count
DotVisionMotionApiV2.OrganisationsApiorganisationsOrganisationsEventsCountGET /api/organisations/{id}/events/countGet organisation events count
DotVisionMotionApiV2.OrganisationsApiorganisationsSearchOrganisationsGET /api/organisations/searchSearch for an organisation by name
DotVisionMotionApiV2.OrganisationsApiorganisationsSetUniqueNameForOrganisationPOST /api/organisations/{id}/uniqueNameSet unique name for organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsUpdateOrganisationPUT /api/organisationsUpdate an organisation
DotVisionMotionApiV2.OrganisationsApiorganisationsUpdateUniqueNameForOrganisationPUT /api/organisations/{id}/uniqueNameUpdate unique name for organisation
DotVisionMotionApiV2.ParticipantsApiparticipantsAddTeammateToTeamPOST /api/participants/{id}/teammatesAdd a teammate to a team
DotVisionMotionApiV2.ParticipantsApiparticipantsCountTeammatesGET /api/participants/{id}/teammates/countGet teammates count for a team
DotVisionMotionApiV2.ParticipantsApiparticipantsGetAllActivitiesGET /api/participants/{id}/activitiesGet all activities for a participant
DotVisionMotionApiV2.ParticipantsApiparticipantsGetAllCategoriesGET /api/participants/{id}/categoriesGet all categories for a participant
DotVisionMotionApiV2.ParticipantsApiparticipantsGetAllTeammatesGET /api/participants/{id}/teammatesGet all teammates for a team
DotVisionMotionApiV2.ParticipantsApiparticipantsGetAssociatedUserGET /api/participants/{id}/associatedUserGet the user associated with participant
DotVisionMotionApiV2.ParticipantsApiparticipantsGetCategoriesCountForParticipantGET /api/participants/{id}/categories/countGet number of categories for a participant
DotVisionMotionApiV2.ParticipantsApiparticipantsGetParticipantGET /api/participants/{id}Get a participant
DotVisionMotionApiV2.ParticipantsApiparticipantsGetRoleForTeammateGET /api/participants/{id}/teammates/{participantId}/teamRoleGet role for a teammate
DotVisionMotionApiV2.ParticipantsApiparticipantsGetTeammateGET /api/participants/{id}/teammates/{participantId}Get a teammate of a team
DotVisionMotionApiV2.ParticipantsApiparticipantsLinkCategoryPOST /api/participants/{id}/categoriesLink a category to a participant
DotVisionMotionApiV2.ParticipantsApiparticipantsRemoveTeammateFromTeamDELETE /api/participants/{id}/teammates/{participantId}Delete a teammate
DotVisionMotionApiV2.ParticipantsApiparticipantsUnlinkCategoryDELETE /api/participants/{id}/categoriesUnlink a category from a participant
DotVisionMotionApiV2.ParticipantsApiparticipantsUpdateTeammatePUT /api/participants/{id}/teammatesUpdate a teammate
DotVisionMotionApiV2.RegistrationsApiregistrationsCreateRegistrationPOST /api/registrationsCreate a registration
DotVisionMotionApiV2.RegistrationsApiregistrationsDeleteRegistrationDELETE /api/registrationsDelete a registration
DotVisionMotionApiV2.RegistrationsApiregistrationsGetRegistrationGET /api/registrations/{id}Get an individual registration
DotVisionMotionApiV2.RegistrationsApiregistrationsGetRegistrationsForEmailGET /api/registrationsGet registrations collection for an email
DotVisionMotionApiV2.RegistrationsApiregistrationsPublicRegistrationsCountGET /api/registrations/countGet registrations count
DotVisionMotionApiV2.RegistrationsApiregistrationsUpdateRegistrationPUT /api/registrationsUpdate a registration
DotVisionMotionApiV2.RolesApirolesCreateRolePOST /api/rolesCreate a role
DotVisionMotionApiV2.RolesApirolesDeleteRoleDELETE /api/roles/{id}Delete a role
DotVisionMotionApiV2.RolesApirolesGetAllRolesGET /api/rolesGet roles collection
DotVisionMotionApiV2.RolesApirolesGetRoleGET /api/roles/{id}Get a role
DotVisionMotionApiV2.RolesApirolesRolesCountGET /api/roles/countGet roles count
DotVisionMotionApiV2.RolesApirolesUpdateRolePUT /api/rolesUpdate a role
DotVisionMotionApiV2.StagesApistagesCreateActivityPOST /api/stages/{id}/activitiesCreate activity for a stage
DotVisionMotionApiV2.StagesApistagesCreateStageStatusPOST /api/stages/{id}/stageStatusCreate a status for a stage
DotVisionMotionApiV2.StagesApistagesDeleteActivityDELETE /api/stages/{id}/activitiesDelete activity of a stage
DotVisionMotionApiV2.StagesApistagesDeleteStageStatusDELETE /api/stages/{id}/stageStatusDelete a stage status
DotVisionMotionApiV2.StagesApistagesGetAllActivitiesGET /api/stages/{id}/activitiesGet all activities for a stage
DotVisionMotionApiV2.StagesApistagesGetAllCategoriesGET /api/stages/{id}/categoriesGet all categories for a stage
DotVisionMotionApiV2.StagesApistagesGetAllCategoriesForActivityGET /api/stages/{id}/activities/{activityId}/categoriesGet all categories for an activity
DotVisionMotionApiV2.StagesApistagesGetCategoriesCountForActivityGET /api/stages/{id}/activities/{activityId}/categories/countGet number of categories for an activity
DotVisionMotionApiV2.StagesApistagesGetLastStageStatusGET /api/stages/{id}/lastStageStatusGet last status of a stage
DotVisionMotionApiV2.StagesApistagesGetParticipantGET /api/stages/{id}/activities/{activityId}/participantGet participant associated to the activity of a stage
DotVisionMotionApiV2.StagesApistagesGetStageGET /api/stages/{id}Get a stage
DotVisionMotionApiV2.StagesApistagesGetStageCategoriesCountGET /api/stages/{id}/categories/countGet number of categories for a stage
DotVisionMotionApiV2.StagesApistagesGetStageStatusGET /api/stages/{id}/stageStatusGet status of a stage
DotVisionMotionApiV2.StagesApistagesLinkCategoryPOST /api/stages/{id}/activities/{activityId}/categoriesLink a category to an activity
DotVisionMotionApiV2.StagesApistagesLinkCategory_0POST /api/stages/{id}/categoriesLink a category to a stage
DotVisionMotionApiV2.StagesApistagesUnlinkCategoryDELETE /api/stages/{id}/activities/{activityId}/categoriesUnlink a category from an activity
DotVisionMotionApiV2.StagesApistagesUnlinkCategory_0DELETE /api/stages/{id}/categoriesUnlink a category from a stage
DotVisionMotionApiV2.StagesApistagesUpdateActivityPUT /api/stages/{id}/activitiesUpdate activity of a stage
DotVisionMotionApiV2.TeamRolesApiteamRolesCreateTeamRolePOST /api/teamrolesCreate a team role
DotVisionMotionApiV2.TeamRolesApiteamRolesDeleteTeamRoleDELETE /api/teamroles/{id}Delete a role
DotVisionMotionApiV2.TeamRolesApiteamRolesGetAllTeamRolesGET /api/teamrolesGet team roles collection
DotVisionMotionApiV2.TeamRolesApiteamRolesGetTeamRoleGET /api/teamroles/{id}Get a team role
DotVisionMotionApiV2.TeamRolesApiteamRolesTeamRolesCountGET /api/teamroles/countGet team roles count
DotVisionMotionApiV2.TeamRolesApiteamRolesUpdateTeamRolePUT /api/teamrolesUpdate a team role
DotVisionMotionApiV2.UniqueNamesApiuniqueNamesGetObjectForUniqueNameGET /api/uniqueNames/{uniqueName}Get object refered by unique name
DotVisionMotionApiV2.UniqueNamesApiuniqueNamesGetUniqueNameGET /api/uniqueNames/{id}Get unique name attributed to the object id
DotVisionMotionApiV2.UsersApiusersAcceptRegistrationForUserPUT /api/users/{id}/registrations/{registrationId}/acceptAccept a user registration
DotVisionMotionApiV2.UsersApiusersDeclineRegistrationForUserPUT /api/users/{id}/registrations/{registrationId}/declineDecline a user registration
DotVisionMotionApiV2.UsersApiusersDeleteUniqueNameForUserDELETE /api/users/{id}/uniqueNameDelete unique name for user
DotVisionMotionApiV2.UsersApiusersGetEventsAsAdminGET /api/users/{id}/eventsAsAdminGet list of events in witch user is involved as an administrator
DotVisionMotionApiV2.UsersApiusersGetEventsAsAdminCountGET /api/users/{id}/eventsAsAdmin/countGet number of events in witch user is involved as an administrator
DotVisionMotionApiV2.UsersApiusersGetEventsAsParticipantGET /api/users/{id}/eventsAsParticipantGet list of events in witch user is involved as a participant
DotVisionMotionApiV2.UsersApiusersGetEventsAsParticipantCountGET /api/users/{id}/eventsAsParticipant/countGet number of events in witch user is involved as a participant
DotVisionMotionApiV2.UsersApiusersGetMeGET /api/users/meGet current claims of connected user
DotVisionMotionApiV2.UsersApiusersGetOrganisationsAsAdminGET /api/users/{id}/organisationsAsAdminGet list of organisations in witch user is involved as an administrator
DotVisionMotionApiV2.UsersApiusersGetOrganisationsAsAdminCountGET /api/users/{id}/organisationsAsAdmin/countGet number of organisations in witch user is involved as an administrator
DotVisionMotionApiV2.UsersApiusersGetRegistrationsForUserGET /api/users/{id}/registrationsGet list of registrations attributed to the user
DotVisionMotionApiV2.UsersApiusersGetUniqueNameForUserGET /api/users/{id}/uniqueNameGet unique name attributed to the user
DotVisionMotionApiV2.UsersApiusersGetUserGET /api/users/{id}Get a user
DotVisionMotionApiV2.UsersApiusersGetUserCountGET /api/users/countGet users count
DotVisionMotionApiV2.UsersApiusersIdentityGET /api/users/identityGet current claims of connected user
DotVisionMotionApiV2.UsersApiusersSearchUsersGET /api/users/searchSearch for a user by name
DotVisionMotionApiV2.UsersApiusersSetUniqueNameForUserPOST /api/users/{id}/uniqueNameSet unique name for user
DotVisionMotionApiV2.UsersApiusersStandByRegistrationForUserPUT /api/users/{id}/registrations/{registrationId}/standbyAnswer \"Perhaps\" for a user registration
DotVisionMotionApiV2.UsersApiusersUpdateUniqueNameForUserPUT /api/users/{id}/uniqueNameUpdate unique name for user
DotVisionMotionApiV2.UsersApiusersUpdateUserPUT /api/usersUpdate a user
DotVisionMotionApiV2.UsersApiusersUserNameExistGET /api/users/exist
DotVisionMotionApiV2.UsersApiusersUserRegistrationsCountGET /api/users/{id}/registrations/countGet registrations count for a user

Documentation for Models

Documentation for Authorization

apiKey

  • Type: API key
  • API key parameter name: api_key
  • Location: HTTP header
superagent
@everything-registry/sub-chunk-1504@zalastax/nolb-dot
0.1.0

8 years ago