ugc-guard-api

v1.0.0

Published

6 months ago

OpenAPI client for UGC Guard.

0High
0Medium
0Low

ugc_guard_javascript_api

UgcGuardJavascriptApi - JavaScript client for ugc_guard_javascript_api API for UGC Guard. A tool to help you manage reports on user generated content. This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.1.0
Package version: 1.0.0
Generator version: 7.13.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install ugc_guard_javascript_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your ugc_guard_javascript_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

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

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var UgcGuardJavascriptApi = require('ugc_guard_javascript_api');


var api = new UgcGuardJavascriptApi.ActionsApi()
var action = new UgcGuardJavascriptApi.Action(); // {Action} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAction(action, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- UgcGuardJavascriptApi.ActionsApi | createAction | POST /actions/ | Create Action UgcGuardJavascriptApi.ActionsApi | deleteAction | DELETE /actions/{action_id} | Delete Action UgcGuardJavascriptApi.ActionsApi | getActionById | GET /actions/{action_id} | Get Action By Id UgcGuardJavascriptApi.ActionsApi | getAllActionsOfType | GET /actions/ | Get All Actions Of Type UgcGuardJavascriptApi.ActionsApi | getUserTypeActionById | GET /actions/user_type/{module_id} | Get User Type Action By Id UgcGuardJavascriptApi.ActionsApi | performAction | GET /actions/{action_id}/perform | Perform Action UgcGuardJavascriptApi.ActionsApi | updateAction | PUT /actions/ | Update Action UgcGuardJavascriptApi.AiApi | getAllAiModels | GET /ai/models | Get All Ai Models UgcGuardJavascriptApi.AiApi | getAllAiUsageForOrganization | GET /ai/usage/{organization_id}/all | Get All Ai Usage For Organization UgcGuardJavascriptApi.AiApi | getAllMonthlyAiUsageForOrganization | GET /ai/usage/{organization_id} | Get All Monthly Ai Usage For Organization UgcGuardJavascriptApi.AiApi | getMonthlyAiUsageForOrganizationModel | GET /ai/usage/{organization_id}/{ai_model} | Get Monthly Ai Usage For Organization And Model UgcGuardJavascriptApi.ContentApi | createContent | POST /content/ | Create Content UgcGuardJavascriptApi.ContentApi | deleteContent | DELETE /content/{content_id} | Delete Content UgcGuardJavascriptApi.ContentApi | getAllContentOfReport | GET /content/{report_id} | Get All Content Of Report UgcGuardJavascriptApi.ContentApi | getContentById | GET /content/content/{content_id} | Get Content By Id UgcGuardJavascriptApi.DefaultApi | statusGet | GET / | Status UgcGuardJavascriptApi.FilesApi | deleteFile | DELETE /files/{file_id} | Delete File UgcGuardJavascriptApi.FilesApi | downloadFile | GET /files/download/{file_id} | Download File UgcGuardJavascriptApi.FilesApi | getFileById | GET /files/{file_id} | Get File By Id UgcGuardJavascriptApi.FilesApi | updateFile | PUT /files/{file_id}/{secret} | Update File UgcGuardJavascriptApi.FilesApi | uploadFile | POST /files/upload | Upload File UgcGuardJavascriptApi.MailTemplatesApi | createMailTemplate | POST /mail_templates/ | Create Mail Template UgcGuardJavascriptApi.MailTemplatesApi | deleteMailTemplate | DELETE /mail_templates/{template_id} | Delete Mail Template UgcGuardJavascriptApi.MailTemplatesApi | getAllMailTemplatesForModuleWithDefaults | GET /mail_templates/modules/{module_id}/with_defaults | Get All Mail Templates For Module And All Defaults UgcGuardJavascriptApi.MailTemplatesApi | getMailTemplateById | GET /mail_templates/{template_id} | Get Mail Template By Id UgcGuardJavascriptApi.MailTemplatesApi | getMailTemplateByType | GET /mail_templates/type/{template_type} | Get Mail Template By Type UgcGuardJavascriptApi.MailTemplatesApi | getMailTemplatesForModule | GET /mail_templates/modules/{module_id} | Get Mail Templates For Module UgcGuardJavascriptApi.MailTemplatesApi | updateMailTemplate | PUT /mail_templates/{template_id} | Update Mail Template UgcGuardJavascriptApi.ModulesApi | createModule | POST /modules/ | Create Module UgcGuardJavascriptApi.ModulesApi | deleteModule | DELETE /modules/{module_id} | Delete Module UgcGuardJavascriptApi.ModulesApi | getAllModules | GET /modules/all | Get All Modules UgcGuardJavascriptApi.ModulesApi | getChannelsOfModule | GET /modules/{module_id}/channels | Get Channels Of Module UgcGuardJavascriptApi.ModulesApi | getMailSettingsOfModule | GET /modules/{module_id}/mail | Get Mail Settings Of Module UgcGuardJavascriptApi.ModulesApi | getModuleById | GET /modules/{module_id} | Get Module By Id UgcGuardJavascriptApi.ModulesApi | getModuleSecret | GET /modules/secret/{module_id} | Get Module Secret UgcGuardJavascriptApi.ModulesApi | getMyModules | GET /modules/myModules/{organization_id} | Get My Modules UgcGuardJavascriptApi.ModulesApi | updateMailSettingsOfModule | POST /modules/{module_id}/mail | Update Mail Settings Of Module UgcGuardJavascriptApi.ModulesApi | updateModule | PUT /modules/{module_id} | Update Module UgcGuardJavascriptApi.OrganizationsApi | acceptInvitationToOrganization | POST /organizations/accept/{organization_id} | Accept Invitation To Organization UgcGuardJavascriptApi.OrganizationsApi | changeMembershipState | POST /organizations/membership/{organization_id} | Change Membership State UgcGuardJavascriptApi.OrganizationsApi | createOrganization | POST /organizations/ | Create Organization UgcGuardJavascriptApi.OrganizationsApi | deleteOrganization | DELETE /organizations/{organization_id} | Delete Organization UgcGuardJavascriptApi.OrganizationsApi | denyInvitationToOrganization | DELETE /organizations/invite/deny/{organization_id} | Deny Invitation To Organization UgcGuardJavascriptApi.OrganizationsApi | getMembershipState | GET /organizations/membership/{organization_id} | Get Membership State UgcGuardJavascriptApi.OrganizationsApi | getMyOrganizations | GET /organizations/ | Get All Organizations UgcGuardJavascriptApi.OrganizationsApi | getMyOrganizationsGrouped | GET /organizations/grouped | Get All Of Your Organizations Grouped By Membership State UgcGuardJavascriptApi.OrganizationsApi | getOrganization | GET /organizations/{organization_id} | Get Organization UgcGuardJavascriptApi.OrganizationsApi | getOrganizationMembers | GET /organizations/{organization_id}/members | Get Organization Members UgcGuardJavascriptApi.OrganizationsApi | inviteUserToOrganization | POST /organizations/invite/by_id/{user_id} | Invite User To Organization UgcGuardJavascriptApi.OrganizationsApi | inviteUserToOrganizationByEmail | POST /organizations/invite/by_email | Invite User To Organization By Email UgcGuardJavascriptApi.OrganizationsApi | leaveOrganization | DELETE /organizations/leave/{organization_id} | Leave Organization UgcGuardJavascriptApi.OrganizationsApi | revokeUserFromOrganization | DELETE /organizations/revoke/{organization_id}/{user_id} | Revoke User From Organization UgcGuardJavascriptApi.OrganizationsApi | updateOrganization | PUT /organizations/{organization_id} | Update Organization UgcGuardJavascriptApi.PersonsApi | createPerson | POST /persons/ | Create Person UgcGuardJavascriptApi.PersonsApi | deletePerson | DELETE /persons/{person_id} | Delete Person UgcGuardJavascriptApi.PersonsApi | getPersonById | GET /persons/{person_id} | Get Person By Id UgcGuardJavascriptApi.PersonsApi | getPersonByUpiId | GET /persons/by_upid/{upi_id} | Get Person By Upi Id UgcGuardJavascriptApi.PersonsApi | updatePerson | PUT /persons/ | Update Person UgcGuardJavascriptApi.ReportsApi | createMagicReport | POST /reports/magic | Create Magic Report UgcGuardJavascriptApi.ReportsApi | createReport | POST /reports/ | Create Report UgcGuardJavascriptApi.ReportsApi | escalateReport | GET /reports/{report_id}/escalate | Escalate Report UgcGuardJavascriptApi.ReportsApi | getAllReports | GET /reports/all | Get All Reports UgcGuardJavascriptApi.ReportsApi | getContentOfReport | GET /reports/{report_id}/content | Get Content Of Report UgcGuardJavascriptApi.ReportsApi | getEnrichedEvaluationsOfReport | GET /reports/{report_id}/enriched_evaluations | Get Enriched Evaluations Of Report UgcGuardJavascriptApi.ReportsApi | getEvaluationsOfReport | GET /reports/{report_id}/evaluations | Get Evaluations Of Report UgcGuardJavascriptApi.ReportsApi | getMyReports | GET /reports/my/{module_id} | Get My Reports UgcGuardJavascriptApi.ReportsApi | getReportById | GET /reports/{report_id} | Get Report By Id UgcGuardJavascriptApi.ReportsApi | getReportersOfReport | GET /reports/{report_id}/reporters | Get Reporters Of Report UgcGuardJavascriptApi.ReportsApi | rejectReport | GET /reports/{report_id}/reject | Reject Report UgcGuardJavascriptApi.ReportsApi | updateReport | PUT /reports/ | Update Report UgcGuardJavascriptApi.ReportsApi | validateReport | GET /reports/{report_id}/validate | Validate Report UgcGuardJavascriptApi.StatsApi | getComparedModuleStats | GET /stats/module/{module_id}/compared | Get Module Stats Compared To Prior Date UgcGuardJavascriptApi.StatsApi | getModuleStats | GET /stats/module/{module_id} | Get Module Stats UgcGuardJavascriptApi.StatsApi | getOrganizationStats | GET /stats/org/{org_id} | Get Organization Stats UgcGuardJavascriptApi.TypesApi | createType | POST /types/ | Create Type UgcGuardJavascriptApi.TypesApi | deleteType | DELETE /types/{type_id} | Delete Type UgcGuardJavascriptApi.TypesApi | getTypeActionSecret | GET /types/{type_id}/action_secret | Get Type Action Secret UgcGuardJavascriptApi.TypesApi | getTypeById | GET /types/{type_id} | Get Type By Id UgcGuardJavascriptApi.TypesApi | getTypesForModule | GET /types/ | Get Types For Module UgcGuardJavascriptApi.TypesApi | updateType | PUT /types/ | Update Type UgcGuardJavascriptApi.UsersApi | createChannel | POST /users/channels | Create Channel UgcGuardJavascriptApi.UsersApi | deleteChannel | DELETE /users/channels/{channel_id} | Delete Channel UgcGuardJavascriptApi.UsersApi | getChannelById | GET /users/channels/by_id/{channel_id} | Get Channel By Id UgcGuardJavascriptApi.UsersApi | getChannelByIdOrName | GET /users/channels/by_id_or_name/{id_or_name} | Get Channel By Id Or Name UgcGuardJavascriptApi.UsersApi | getChannelsOfCurrentUser | GET /users/my/channels | Get Channels Of Current User UgcGuardJavascriptApi.UsersApi | getChannelsOfUser | GET /users/{user_id}/channels | Get Channels Of User UgcGuardJavascriptApi.UsersApi | getChannelsOfUserUsersChannelsOfUserIdGet | GET /users/channels/of/{user_id} | Get Channels Of User UgcGuardJavascriptApi.UsersApi | getCurrentUser | GET /users/myself | Get Current User UgcGuardJavascriptApi.UsersApi | getUserById | GET /users/{user_id} | Get User By Id UgcGuardJavascriptApi.UsersApi | getUsersOfChannel | GET /users/channels/{channel_id}/users | Get Users Of Channel UgcGuardJavascriptApi.UsersApi | joinChannel | POST /users/channels/{channel_id}/join | Join Channel UgcGuardJavascriptApi.UsersApi | joinChannelByEmail | POST /users/channels/{channel_id}/join_by_email | Join Channel By Email UgcGuardJavascriptApi.UsersApi | leaveChannel | POST /users/channels/{channel_id}/leave | Leave Channel UgcGuardJavascriptApi.UsersApi | updateChannel | PUT /users/channels/{channel_id} | Update Channel

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme