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

package/build/forecast/index.d.ts

@@ -12,7 +12,7 @@ declare class ForecastApi extends BaseApi {
      * @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>;
+    postForecast(payload: ForecastRequest): Promise<ForecastResponse>;
     /**
      * @function getForecast
      * @memberof ForecastApi
@@ -26,7 +26,7 @@ declare class ForecastApi extends BaseApi {
      * @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>;
+    postCostForecast(payload: CostForecastRequest): Promise<CostForecastResponse>;
     /**
      * @function getCostForecast
      * @memberof ForecastApi
@@ -40,7 +40,7 @@ declare class ForecastApi extends BaseApi {
      * @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>;
+    postPublicForecast(payload: ForecastRequest): Promise<ForecastResponse>;
     /**
      * @function getPublicForecast
      * @memberof ForecastApi

package/build/forecast/index.js

@@ -12,8 +12,8 @@ class ForecastApi extends BaseApi {
      * @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`);
+    async postForecast(payload) {
+        return await this.post(`${resourceName}/forecasts`, payload);
     }
     /**
      * @function getForecast
@@ -30,8 +30,8 @@ class ForecastApi extends BaseApi {
      * @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`);
+    async postCostForecast(payload) {
+        return await this.post(`${resourceName}/cost-forecasts`, payload);
     }
     /**
      * @function getCostForecast
@@ -48,8 +48,8 @@ class ForecastApi extends BaseApi {
      * @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`);
+    async postPublicForecast(payload) {
+        return await this.post(`${resourceName}/public/forecasts`, payload);
     }
     /**
      * @function getPublicForecast

package/build/forecast/types.d.ts

@@ -0,0 +1,106 @@
+import { type DataRules } from '../data-streams/types';
+export interface CostForecastRequest {
+    asOf?: Date;
+    details: ForecastDetails;
+}
+export interface ForecastRequest extends CostForecastRequest {
+    fingerprint?: string;
+    skipCache?: boolean;
+}
+export type ForecastType = 'marketplace' | 'data_stream';
+export interface ForecastDetails {
+    type: ForecastType;
+}
+export interface MarketplaceForecastDetails extends ForecastDetails {
+    type: 'marketplace';
+    company_constraint?: CompanyConstraint;
+    dataset_constraint?: DatasetConstraint;
+    data_rules: DataRules;
+    pricing: ForecastPricing;
+}
+export interface DataStreamPurchaseDetails {
+    type: 'data_stream';
+    data_stream_id: number;
+    offer_id: number;
+    data_shop_id?: number;
+}
+export type CompanyConstraintType = 'inclusion' | 'exclusion';
+export interface CompanyConstraint {
+    type: CompanyConstraintType;
+    company_ids: number[];
+}
+export type DatasetConstraintType = 'inclusion' | 'exclusion' | 'all';
+export interface DatasetConstraint {
+    type: DatasetConstraintType;
+    dataset_ids: number[];
+}
+export interface ForecastPricing {
+    micro_cents_usd: number;
+}
+export interface ForecastGenericResponse {
+    id: string;
+    companyId: number;
+    completedAt?: Date;
+    createdAt: Date;
+    failures: JobFailure[];
+    idempotencyKey: string;
+    input: ForecastInput;
+    requestSource: RequestSource;
+    state: JobState;
+    updatedAt: Date;
+}
+export interface ForecastResponse extends ForecastGenericResponse {
+    result?: ForecastResult;
+}
+export interface CostForecastResponse extends ForecastGenericResponse {
+    result?: CostForecastResult;
+}
+export interface CostForecastInput {
+    details: ForecastDetails;
+}
+export interface ForecastInput {
+    asOf?: Date;
+    dimensions: ForecastDimensions;
+    fingerprint?: string;
+}
+export interface RequestSource {
+    company_id: number;
+    type: string;
+    user_id: number;
+}
+export interface ForecastDimensions {
+    distinctCounts: string[];
+    groupBy?: string;
+}
+export type JobState = 'pending' | 'running' | 'completed' | 'cancelled' | 'failed';
+export interface ForecastResult {
+    cost: number;
+    datasets: DatasetForecastResponse[];
+    rows: number;
+    scanCost: ScanCostEstimate;
+}
+export interface CostForecastResult {
+    cost: ScanCostEstimate;
+}
+export interface DatasetForecastResponse {
+    companyId: number;
+    datasetId: number;
+    group?: string;
+    cost: number;
+    rows: number;
+}
+export interface ScanCostEstimate {
+    rows: number;
+    size: number;
+    sources: DataSourceCost[];
+}
+export interface DataSourceCost {
+    source: string | number;
+    rows: number;
+    size: number;
+}
+export interface JobFailure {
+    message: string;
+    timestamp: Date;
+    value: string;
+}

package/build/forecast/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

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