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

Xompass Client for cloud-api

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

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

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

  public static findByIdData(id: any, fk: any, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/data/:fk'
    ].join('');
    const _routeParams = {
      id,
      fk
    };
    const _postBody = {};
    const _urlParams: any = {};
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static destroyByIdData(id: any, fk: any, retry = false): Promise<any> {
    const _method = 'DELETE';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/data/:fk'
    ].join('');
    const _routeParams = {
      id,
      fk
    };
    const _postBody = {};
    const _urlParams: any = {};
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static updateByIdData(
    id: any,
    fk: any,
    data: any = {},
    retry = false
  ): Promise<any> {
    const _method = 'PUT';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/data/:fk'
    ].join('');
    const _routeParams = {
      id,
      fk
    };
    const _postBody = data;
    const _urlParams: any = {};
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static findByIdTrackingLogs(id: any, fk: any, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/trackingLogs/:fk'
    ].join('');
    const _routeParams = {
      id,
      fk
    };
    const _postBody = {};
    const _urlParams: any = {};
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static getSensor(id: any, refresh: any = {}, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/sensor'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = {};
    const _urlParams: any = {};
    if (typeof refresh !== 'undefined' && refresh !== null) {
      _urlParams['refresh'] = refresh;
    }
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static getData(id: any, filter: LoopBackFilter = {}, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/data'
    ].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 createData(id: any, data: any = {}, retry = false): Promise<any> {
    const _method = 'POST';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/data'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = data;
    const _urlParams: any = {};
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static countData(id: any, where: any = {}, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/data/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 getTrackingLogs(id: any, filter: LoopBackFilter = {}, retry = false): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/: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(),
      '/Datasets/: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 download(
    id: any,
    file: any,
    datasourceName: any = {},
    req: any,
    res: any,
    retry = false
  ): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/download/:file'
    ].join('');
    const _routeParams = {
      id,
      file
    };
    const _postBody = {};
    const _urlParams: any = {};
    if (typeof datasourceName !== 'undefined' && datasourceName !== null) {
      _urlParams['datasourceName'] = datasourceName;
    }
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static getSignedUrl(
    id: any,
    file: any,
    datasourceName: any = {},
    req: any,
    res: any,
    retry = false
  ): Promise<any> {
    const _method = 'GET';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/signed-url/:file'
    ].join('');
    const _routeParams = {
      id,
      file
    };
    const _postBody = {};
    const _urlParams: any = {};
    if (typeof datasourceName !== 'undefined' && datasourceName !== null) {
      _urlParams['datasourceName'] = datasourceName;
    }
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static deepRemove(id: any, retry = false): Promise<any> {
    const _method = 'DELETE';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/deep'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = {};
    const _urlParams: any = {};
    return super.request(_method, _url, _routeParams, _urlParams, _postBody, retry);
  }
  public static assignOrUpdateSummary(id: any, minimalResponse: any = {}, retry = false): Promise<any> {
    const _method = 'POST';
    const _url = [
      XompassClient.getPath() + '/' + XompassClient.getApiVersion(),
      '/Datasets/:id/summary/assign'
    ].join('');
    const _routeParams = {
      id
    };
    const _postBody = {};
    const _urlParams: any = {};
    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. `Dataset`.
   */
  public static getModelName(): string {
    return 'Dataset';
  }
}