@narrative.io/data-collaboration-sdk-ts 0.0.44 → 0.0.45

package/build/forecast/index.d.ts

@@ -0,0 +1,52 @@
+import { BaseApi } from '../base-api';
+import { type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse } from './types';
+/**
+ * @module ForecastApi
+ * @description This module provides methods for generating forecasts from a subscription
+ * @extends BaseApi
+ */
+declare class ForecastApi extends BaseApi {
+    /**
+     * @function postForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a subscription given the subscription details
+     * @returns {Promise<ApiRecords<ForcastResponse>>} A promise that resolves to forecast response.
+     */
+    postForecast(): Promise<ForecastResponse>;
+    /**
+     * @function getForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a given forecast id
+     * @returns {Promise<ForcastResponse>} A promise that resolves to forecast response.
+     */
+    getForecast(forecastId: string): Promise<ForecastResponse>;
+    /**
+     * @function postCostForecast
+     * @memberof ForecastApi
+     * @description Gets a cost forecast for a subscription given the subscriptions details
+     * @returns {Promise<CostForcastResponse>} A promise that resolves to cost forecast response.
+     */
+    postCostForecast(): Promise<CostForecastResponse>;
+    /**
+     * @function getCostForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a given cost forecast id
+     * @returns {Promise<CostForcastResponse>} A promise that resolves to cost forecast response.
+     */
+    getCostForecast(costForecastId: string): Promise<CostForecastResponse>;
+    /**
+     * @function postPublicForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a subscription given the subscriptions details from the public endpoint
+     * @returns {Promise<ForcastResponse>} A promise that resolves to forecast response.
+     */
+    postPublicForecast(): Promise<ForecastResponse>;
+    /**
+     * @function getPublicForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a given forecast id from the public endpoint
+     * @returns {Promise<ForcastResponse>} A promise that resolves to forecast response.
+     */
+    getPublicForecast(forecastId: string): Promise<ForecastResponse>;
+}
+export { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse };

package/build/forecast/index.js

@@ -0,0 +1,64 @@
+import { BaseApi } from '../base-api';
+const resourceName = 'data-shops/subscriptions';
+/**
+ * @module ForecastApi
+ * @description This module provides methods for generating forecasts from a subscription
+ * @extends BaseApi
+ */
+class ForecastApi extends BaseApi {
+    /**
+     * @function postForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a subscription given the subscription details
+     * @returns {Promise<ApiRecords<ForcastResponse>>} A promise that resolves to forecast response.
+     */
+    async postForecast() {
+        return await this.post(`${resourceName}/forecasts`);
+    }
+    /**
+     * @function getForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a given forecast id
+     * @returns {Promise<ForcastResponse>} A promise that resolves to forecast response.
+     */
+    async getForecast(forecastId) {
+        return await this.get(`${resourceName}/forecasts/${forecastId}`);
+    }
+    /**
+     * @function postCostForecast
+     * @memberof ForecastApi
+     * @description Gets a cost forecast for a subscription given the subscriptions details
+     * @returns {Promise<CostForcastResponse>} A promise that resolves to cost forecast response.
+     */
+    async postCostForecast() {
+        return await this.post(`${resourceName}/cost-forecasts`);
+    }
+    /**
+     * @function getCostForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a given cost forecast id
+     * @returns {Promise<CostForcastResponse>} A promise that resolves to cost forecast response.
+     */
+    async getCostForecast(costForecastId) {
+        return await this.get(`${resourceName}/forecasts/${costForecastId}`);
+    }
+    /**
+     * @function postPublicForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a subscription given the subscriptions details from the public endpoint
+     * @returns {Promise<ForcastResponse>} A promise that resolves to forecast response.
+     */
+    async postPublicForecast() {
+        return await this.post(`${resourceName}/public/forecasts`);
+    }
+    /**
+     * @function getPublicForecast
+     * @memberof ForecastApi
+     * @description Gets a forecast for a given forecast id from the public endpoint
+     * @returns {Promise<ForcastResponse>} A promise that resolves to forecast response.
+     */
+    async getPublicForecast(forecastId) {
+        return await this.get(`${resourceName}/public/forecasts/${forecastId}`);
+    }
+}
+export { ForecastApi };

package/build/index.d.ts

@@ -18,8 +18,9 @@ import { CompanyInfoApi, type CompanyInfo } from './company-info';
 import { InstallationsApi, type Installation } from './installations';
 import { NqlApi, type NqlCompileResult, type NqlQuery, type NqlResult } from './nql';
 import { DataStreamsApi, type DataStream } from './data-streams';
+import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse } from './forecast';
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, type Resource, type UploadsResponse, type PingStatus, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type NqlQuery, type NqlResult, type NqlCompileResult, type DataStream };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, type Resource, type UploadsResponse, type PingStatus, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type NqlQuery, type NqlResult, type NqlCompileResult, type DataStream, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse };

package/build/index.js

@@ -12,7 +12,8 @@ import { CompanyInfoApi } from './company-info';
 import { InstallationsApi } from './installations';
 import { NqlApi } from './nql';
 import { DataStreamsApi } from './data-streams';
+import { ForecastApi } from './forecast';
 class NarrativeApi extends BaseApi {
 }
-applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.44",
+  "version": "0.0.45",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",