Skip to content

Latest commit

 

History

History
411 lines (267 loc) · 12.5 KB

AppsApi.md

File metadata and controls

411 lines (267 loc) · 12.5 KB

SematextApiClientJavascript.AppsApi

All URIs are relative to /

Method HTTP request Description
deleteUsingDELETE DELETE /users-web/api/v3/apps/{anyStateAppId} delete
getAppTypesUsingGET GET /users-web/api/v3/apps/types Get all App types supported for the account identified with apiKey
getUsingGET GET /users-web/api/v3/apps/{anyStateAppId} Gets defails for one particular App
inviteAppGuestsUsingPOST1 POST /users-web/api/v3/apps/guests Invite guests to an app
listAppsUsersUsingGET1 GET /users-web/api/v3/apps/users Get all users of apps accessible to this account
listUsingGET GET /users-web/api/v3/apps Get all apps accessible by account identified with apiKey
updateDescriptionUsingPUT1 PUT /users-web/api/v3/apps/{anyStateAppId}/description Update description of the app
updateUsingPUT3 PUT /users-web/api/v3/apps/{anyStateAppId} Update app

deleteUsingDELETE

GenericMapBasedApiResponse deleteUsingDELETE(anyStateAppId)

delete

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.AppsApi();
let anyStateAppId = 789; // Number | anyStateAppId

apiInstance.deleteUsingDELETE(anyStateAppId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
anyStateAppId Number anyStateAppId

Return type

GenericMapBasedApiResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAppTypesUsingGET

AppTypesResponse getAppTypesUsingGET()

Get all App types supported for the account identified with apiKey

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.AppsApi();
apiInstance.getAppTypesUsingGET().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

AppTypesResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getUsingGET

AppResponse getUsingGET(anyStateAppId)

Gets defails for one particular App

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.AppsApi();
let anyStateAppId = 789; // Number | anyStateAppId

apiInstance.getUsingGET(anyStateAppId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
anyStateAppId Number anyStateAppId

Return type

AppResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

inviteAppGuestsUsingPOST1

GenericMapBasedApiResponse inviteAppGuestsUsingPOST1(body)

Invite guests to an app

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.AppsApi();
let body = new SematextApiClientJavascript.Invitation(); // Invitation | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values

apiInstance.inviteAppGuestsUsingPOST1(body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body Invitation For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values

Return type

GenericMapBasedApiResponse

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listAppsUsersUsingGET1

AppsResponse listAppsUsersUsingGET1()

Get all users of apps accessible to this account

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.AppsApi();
apiInstance.listAppsUsersUsingGET1().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

AppsResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listUsingGET

AppsResponse listUsingGET()

Get all apps accessible by account identified with apiKey

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.AppsApi();
apiInstance.listUsingGET().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

AppsResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateDescriptionUsingPUT1

AppResponse updateDescriptionUsingPUT1(anyStateAppId, opts)

Update description of the app

App can be in any state

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.AppsApi();
let anyStateAppId = 789; // Number | App Id
let opts = { 
  'body': new SematextApiClientJavascript.AppDescription() // AppDescription | Update Details
};
apiInstance.updateDescriptionUsingPUT1(anyStateAppId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
anyStateAppId Number App Id
body AppDescription Update Details [optional]

Return type

AppResponse

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateUsingPUT3

AppResponse updateUsingPUT3(body, anyStateAppId)

Update app

App can be in any state

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.AppsApi();
let body = new SematextApiClientJavascript.UpdateAppInfo(); // UpdateAppInfo | dto
let anyStateAppId = 789; // Number | App Id

apiInstance.updateUsingPUT3(body, anyStateAppId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body UpdateAppInfo dto
anyStateAppId Number App Id

Return type

AppResponse

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json