@xompass/sdk-cloud-api/services/custom/Summary.ts

Xompass Client for cloud-api

import { SDKModels } from './SDKModels';
import { XompassBaseApi, XompassAuth } from '../core';
import { XompassClient } from '../../XompassClient';
import { LoopBackFilter } from '../../models';
import { Summary } from '../../models';
import { 
  Log,
  Asset,
  Sensor,
  Dataset,
  SummaryForAsset
 } from '../../models';

/**
 * Api services for the `Summary` model.
 */

export abstract class SummaryApi extends XompassBaseApi {
  public static model = SDKModels.get('Summary');

  public static findByIdTrackingLogs(id: any, fk: any, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Summaries/:id/trackingLogs/:fk'
    ].join('');
    const _routeParams = {
      id,
      fk
    };
    const _postBody = {};
    const _urlParams: any = {};
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static findByIdDatasets(id: any, fk: any, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Summaries/:id/datasets/:fk'
    ].join('');
    const _routeParams = {
      id,
      fk
    };
    const _postBody = {};
    const _urlParams: any = {};
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static getTrackingLogs(id: any, filter: LoopBackFilter = {}, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Summaries/:id/trackingLogs'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = {};
    const _urlParams: any = {};
    if (typeof filter !== 'undefined' && filter !== null) {
      _urlParams['filter'] = filter;
    }
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static countTrackingLogs(id: any, where: any = {}, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Summaries/:id/trackingLogs/count'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = {};
    const _urlParams: any = {};
    if (typeof where !== 'undefined' && where !== null) {
      _urlParams['where'] = where;
    }
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static getDatasets(id: any, filter: LoopBackFilter = {}, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Summaries/:id/datasets'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = {};
    const _urlParams: any = {};
    if (typeof filter !== 'undefined' && filter !== null) {
      _urlParams['filter'] = filter;
    }
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static deleteDatasets(id: any, retry = false): Promise<any> {
    const _method = 'DELETE';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Summaries/:id/datasets'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = {};
    const _urlParams: any = {};
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static countDatasets(id: any, where: any = {}, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Summaries/:id/datasets/count'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = {};
    const _urlParams: any = {};
    if (typeof where !== 'undefined' && where !== null) {
      _urlParams['where'] = where;
    }
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static generateSummary(
    id: any,
    force: any = {},
    minimalResponse: any = {},
    retry = false
  ): Promise<any> {
    const _method = 'POST';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Summaries/:id/generate'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = {};
    const _urlParams: any = {};
    if (typeof force !== 'undefined' && force !== null) {
      _urlParams['force'] = force;
    }
    if (typeof minimalResponse !== 'undefined' && minimalResponse !== null) {
      _urlParams['minimal_response'] = minimalResponse;
    }
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }

  /**
   * The name of the model represented by this $resource,
   * i.e. `Summary`.
   */
  public static getModelName(): string {
    return 'Summary';
  }
}