Skip to content

SubscriptionsApi.md

Latest commit

 

History

History
526 lines (345 loc) · 16.6 KB

SubscriptionsApi.md

File metadata and controls

526 lines (345 loc) · 16.6 KB
Raw

SematextApiClientJavascript.SubscriptionsApi

All URIs are relative to /

Method HTTP request Description
createForAppUsingPOST POST /users-web/api/v3/apps/{appId}/subscription Create App subscription
createForDashUsingPOST POST /users-web/api/v3/dashboards/{dashId}/subscription Create dashboard subscription
deleteUsingDELETE3 DELETE /users-web/api/v3/subscriptions/{updateableSubscriptionId} Delete subscription
listUsingGET3 GET /users-web/api/v3/apps/{appId}/subscriptions Get subscriptions for an App
listUsingGET5 GET /users-web/api/v3/subscriptions Get current account's subscriptions
sendAppReportUsingPOST1 POST /users-web/api/v3/apps/{appId}/report/send Email an App report
sendDashReportUsingPOST POST /users-web/api/v3/dashboards/{dashId}/report/send Email a dashboard report
toggleEnabledUsingPUT PUT /users-web/api/v3/subscriptions/{updateableSubscriptionId} Toggle subscription status
updateForAppUsingPUT PUT /users-web/api/v3/apps/{appId}/subscription Update App subscription
updateForDashUsingPUT1 PUT /users-web/api/v3/dashboards/{dashId}/subscription Update dashboard subscription

createForAppUsingPOST

SubscriptionResponse createForAppUsingPOST(body, appId)

Create App subscription

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.SubscriptionsApi();
let body = new SematextApiClientJavascript.SubscriptionDto(); // SubscriptionDto | subscription
let appId = 789; // Number | appId

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

Parameters

Name Type Description Notes
body SubscriptionDto subscription
appId Number appId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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

createForDashUsingPOST

SubscriptionResponse createForDashUsingPOST(body, dashId)

Create dashboard subscription

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.SubscriptionsApi();
let body = new SematextApiClientJavascript.SubscriptionDashboardDto(); // SubscriptionDashboardDto | subscription
let dashId = 789; // Number | dashId

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

Parameters

Name Type Description Notes
body SubscriptionDashboardDto subscription
dashId Number dashId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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

deleteUsingDELETE3

GenericMapBasedApiResponse deleteUsingDELETE3(updateableSubscriptionId)

Delete subscription

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.SubscriptionsApi();
let updateableSubscriptionId = 789; // Number | updateableSubscriptionId

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

Parameters

Name Type Description Notes
updateableSubscriptionId Number updateableSubscriptionId

Return type

GenericMapBasedApiResponse

Authorization

api_key

HTTP request headers

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

listUsingGET3

SubscriptionsResponse listUsingGET3(appId)

Get subscriptions for 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.SubscriptionsApi();
let appId = 789; // Number | appId

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

Parameters

Name Type Description Notes
appId Number appId

Return type

SubscriptionsResponse

Authorization

api_key

HTTP request headers

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

listUsingGET5

SubscriptionsResponse listUsingGET5()

Get current account's subscriptions

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.SubscriptionsApi();
apiInstance.listUsingGET5().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

SubscriptionsResponse

Authorization

api_key

HTTP request headers

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

sendAppReportUsingPOST1

MailReportResponse sendAppReportUsingPOST1(body, appId)

Email an App report

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.SubscriptionsApi();
let body = new SematextApiClientJavascript.ReportInfo(); // ReportInfo | emailDto
let appId = 789; // Number | appId

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

Parameters

Name Type Description Notes
body ReportInfo emailDto
appId Number appId

Return type

MailReportResponse

Authorization

api_key

HTTP request headers

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

sendDashReportUsingPOST

MailReportResponse sendDashReportUsingPOST(body, dashId)

Email a dashboard report

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.SubscriptionsApi();
let body = new SematextApiClientJavascript.ReportInfo(); // ReportInfo | emailDto
let dashId = 789; // Number | dashId

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

Parameters

Name Type Description Notes
body ReportInfo emailDto
dashId Number dashId

Return type

MailReportResponse

Authorization

api_key

HTTP request headers

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

toggleEnabledUsingPUT

SubscriptionResponse toggleEnabledUsingPUT(body, updateableSubscriptionId)

Toggle subscription status

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.SubscriptionsApi();
let body = new SematextApiClientJavascript.UpdateSubscriptionDto(); // UpdateSubscriptionDto | dto
let updateableSubscriptionId = 789; // Number | updateableSubscriptionId

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

Parameters

Name Type Description Notes
body UpdateSubscriptionDto dto
updateableSubscriptionId Number updateableSubscriptionId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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

updateForAppUsingPUT

SubscriptionResponse updateForAppUsingPUT(body, appId)

Update App subscription

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.SubscriptionsApi();
let body = new SematextApiClientJavascript.SubscriptionDto(); // SubscriptionDto | subscription
let appId = 789; // Number | appId

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

Parameters

Name Type Description Notes
body SubscriptionDto subscription
appId Number appId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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

updateForDashUsingPUT1

SubscriptionResponse updateForDashUsingPUT1(body, dashId)

Update dashboard subscription

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.SubscriptionsApi();
let body = new SematextApiClientJavascript.SubscriptionDashboardDto(); // SubscriptionDashboardDto | subscription
let dashId = 789; // Number | dashId

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

Parameters

Name Type Description Notes
body SubscriptionDashboardDto subscription
dashId Number dashId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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