@narrative.io/data-collaboration-sdk-ts 0.0.48 → 0.0.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/forecast/index.d.ts +2 -2
- package/build/forecast/types.d.ts +14 -14
- package/build/index.d.ts +2 -2
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BaseApi } from '../base-api';
|
|
2
|
-
import { type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse } from './types';
|
|
2
|
+
import { type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState } from './types';
|
|
3
3
|
/**
|
|
4
4
|
* @module ForecastApi
|
|
5
5
|
* @description This module provides methods for generating forecasts from a subscription
|
|
@@ -49,4 +49,4 @@ declare class ForecastApi extends BaseApi {
|
|
|
49
49
|
*/
|
|
50
50
|
getPublicForecast(forecastId: string): Promise<ForecastResponse>;
|
|
51
51
|
}
|
|
52
|
-
export { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse };
|
|
52
|
+
export { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState };
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { type DataRules } from '../data-streams/types';
|
|
2
2
|
export interface CostForecastRequest {
|
|
3
|
-
|
|
3
|
+
as_of?: Date;
|
|
4
4
|
details: ForecastDetails;
|
|
5
5
|
}
|
|
6
6
|
export interface ForecastRequest extends CostForecastRequest {
|
|
7
7
|
fingerprint?: string;
|
|
8
|
-
|
|
8
|
+
skip_cache?: boolean;
|
|
9
9
|
}
|
|
10
10
|
export type ForecastType = 'marketplace' | 'data_stream';
|
|
11
11
|
export interface ForecastDetails {
|
|
@@ -39,15 +39,15 @@ export interface ForecastPricing {
|
|
|
39
39
|
}
|
|
40
40
|
export interface ForecastGenericResponse {
|
|
41
41
|
id: string;
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
42
|
+
company_id: number;
|
|
43
|
+
completed_at?: Date;
|
|
44
|
+
created_at: Date;
|
|
45
45
|
failures: JobFailure[];
|
|
46
|
-
|
|
46
|
+
idempotency_key: string;
|
|
47
47
|
input: ForecastInput;
|
|
48
|
-
|
|
48
|
+
request_source: RequestSource;
|
|
49
49
|
state: JobState;
|
|
50
|
-
|
|
50
|
+
updated_at: Date;
|
|
51
51
|
}
|
|
52
52
|
export interface ForecastResponse extends ForecastGenericResponse {
|
|
53
53
|
result?: ForecastResult;
|
|
@@ -59,7 +59,7 @@ export interface CostForecastInput {
|
|
|
59
59
|
details: ForecastDetails;
|
|
60
60
|
}
|
|
61
61
|
export interface ForecastInput {
|
|
62
|
-
|
|
62
|
+
as_of?: Date;
|
|
63
63
|
dimensions: ForecastDimensions;
|
|
64
64
|
fingerprint?: string;
|
|
65
65
|
}
|
|
@@ -69,22 +69,22 @@ export interface RequestSource {
|
|
|
69
69
|
user_id: number;
|
|
70
70
|
}
|
|
71
71
|
export interface ForecastDimensions {
|
|
72
|
-
|
|
73
|
-
|
|
72
|
+
distinct_counts: string[];
|
|
73
|
+
group_by?: string;
|
|
74
74
|
}
|
|
75
75
|
export type JobState = 'pending' | 'running' | 'completed' | 'cancelled' | 'failed';
|
|
76
76
|
export interface ForecastResult {
|
|
77
77
|
cost: number;
|
|
78
78
|
datasets: DatasetForecastResponse[];
|
|
79
79
|
rows: number;
|
|
80
|
-
|
|
80
|
+
scan_cost: ScanCostEstimate;
|
|
81
81
|
}
|
|
82
82
|
export interface CostForecastResult {
|
|
83
83
|
cost: ScanCostEstimate;
|
|
84
84
|
}
|
|
85
85
|
export interface DatasetForecastResponse {
|
|
86
|
-
|
|
87
|
-
|
|
86
|
+
company_id: number;
|
|
87
|
+
dataset_id: number;
|
|
88
88
|
group?: string;
|
|
89
89
|
cost: number;
|
|
90
90
|
rows: number;
|
package/build/index.d.ts
CHANGED
|
@@ -18,9 +18,9 @@ import { CompanyInfoApi, type CompanyInfo } from './company-info';
|
|
|
18
18
|
import { InstallationsApi, type Installation } from './installations';
|
|
19
19
|
import { NqlApi, type NqlCompileResult, type NqlQuery, type NqlResult } from './nql';
|
|
20
20
|
import { DataStreamsApi, type DataStream } from './data-streams';
|
|
21
|
-
import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse } from './forecast';
|
|
21
|
+
import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState } from './forecast';
|
|
22
22
|
declare class NarrativeApi extends BaseApi {
|
|
23
23
|
}
|
|
24
24
|
interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi {
|
|
25
25
|
}
|
|
26
|
-
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 };
|
|
26
|
+
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, type JobState };
|