@narrative.io/data-collaboration-sdk-ts 0.0.102 → 0.0.104

package/build/datasets/index.d.ts

@@ -1,7 +1,7 @@
 import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
-import type { FilePerSnapshotResponse, Dataset, DatasetTableSummaryAPIResponse, ColumnStatistics } from './types';
-export { type FilePerSnapshotResponse, type Dataset, type DatasetTableSummaryAPIResponse, type ColumnStatistics };
+import type { FilePerSnapshotResponse, Dataset, DatasetTableSummaryAPIResponse, ColumnStatistics, RetentionPolicy } from './types';
+export { type FilePerSnapshotResponse, type Dataset, type RetentionPolicy, type DatasetTableSummaryAPIResponse, type ColumnStatistics };
 /**
  * @module DatasetApi
  * @description This module provides methods for fetching datasets.
@@ -81,4 +81,15 @@ export declare class DatasetApi extends BaseApi {
    * @public
    */
     getColumnStats(datasetId: number): Promise<ColumnStatistics>;
+    /**
+   * Updates the retention policy of a specific dataset.
+   *
+   * @param {number} datasetId - The ID of the dataset to update the retention policy for.
+   * @param {RetentionPolicy} policy - The new retention policy to be applied.
+   * @returns {Promise<Dataset>} A Promise that resolves with the updated dataset object.
+   * @throws {Error} If there is an issue with the request or the response.
+   * @memberof DatasetApi
+   * @public
+   */
+    updateRetentionPolicy(datasetId: number, policy: RetentionPolicy): Promise<Dataset>;
 }

package/build/datasets/index.js

@@ -100,4 +100,17 @@ export class DatasetApi extends BaseApi {
     async getColumnStats(datasetId) {
         return await this.get(`${resourceName}/${datasetId}/column-stats`);
     }
+    /**
+   * Updates the retention policy of a specific dataset.
+   *
+   * @param {number} datasetId - The ID of the dataset to update the retention policy for.
+   * @param {RetentionPolicy} policy - The new retention policy to be applied.
+   * @returns {Promise<Dataset>} A Promise that resolves with the updated dataset object.
+   * @throws {Error} If there is an issue with the request or the response.
+   * @memberof DatasetApi
+   * @public
+   */
+    async updateRetentionPolicy(datasetId, policy) {
+        return await this.put(`${resourceName}/${datasetId}/retention-policy`, policy);
+    }
 }

package/build/datasets/types.d.ts

@@ -1,3 +1,4 @@
+import type { Mapping } from '../mappings/types';
 export interface Dataset {
     id: number;
     company_id: number;
@@ -12,6 +13,7 @@ export interface Dataset {
     write_mode: DatasetWriteMode;
     last_snapshot_created_at?: string;
     active_dataset_stored_bytes?: number;
+    mappings?: Mapping[];
 }
 export interface DatasetColumnSummary {
     id: number;
@@ -51,11 +53,25 @@ type SchemaFileConfigType = 'flat' | 'json' | 'parquet';
 type SchemaPropertiesType = 'string' | 'boolean' | 'double' | 'long' | 'timestamptz' | 'object' | 'array';
 type DatasetStatus = 'active' | 'archived';
 type DatasetWriteMode = 'append' | 'overwrite';
-type RetentionPolicyType = 'retain_everything';
+type ExpressionlessRetentionPolicyType = 'retain_everything' | 'expire_everything';
+type ExpressionedRetentionPolicyType = 'retain_when' | 'expire_when';
 type SchemaType = 'object' | 'value';
-interface RetentionPolicy {
-    type: RetentionPolicyType;
-}
+export declare enum Operator {
+    GreaterThan = ">",
+    LessThan = "<",
+    GreaterThanOrEqualTo = ">=",
+    LessThanOrEqualTo = "<="
+}
+export type RetentionPolicy = {
+    type: ExpressionlessRetentionPolicyType;
+} | {
+    type: ExpressionedRetentionPolicyType;
+    expression?: {
+        type: 'snapshot_age';
+        operator: Operator;
+        period: string;
+    };
+};
 interface SchemaFileConfig {
     type: SchemaFileConfigType;
     delimiter?: string;

package/build/datasets/types.js

@@ -1 +1,7 @@
-export {};
+export var Operator;
+(function (Operator) {
+    Operator["GreaterThan"] = ">";
+    Operator["LessThan"] = "<";
+    Operator["GreaterThanOrEqualTo"] = ">=";
+    Operator["LessThanOrEqualTo"] = "<=";
+})(Operator || (Operator = {}));

package/build/index.d.ts

@@ -3,7 +3,7 @@ import { DatasetApi } from './datasets';
 import { HealthCheckApi } from './health';
 import { RosettaStoneApi } from './rosetta-stone';
 import { type Environment, type Config, type ApiRecords, type MonetaryAmount } from './types';
-import { type DatasetTableSummaryAPIResponse, type Dataset, type DatasetTableSummary, type FilePerSnapshotResponse } from './datasets/types';
+import type { DatasetTableSummaryAPIResponse, Dataset, DatasetTableSummary, FilePerSnapshotResponse, RetentionPolicy } from './datasets/types';
 import { type HealthCheckResult } from './health/types';
 import { type SampleRecords } from './rosetta-stone/types';
 import { AttributeApi } from './attributes';
@@ -31,4 +31,4 @@ declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, 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 Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, 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 Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, type RetentionPolicy };

package/build/nql/types.d.ts

@@ -245,7 +245,7 @@ export declare const NqlFilterBinaryExpressionObj: z.ZodObject<{
             table: string;
         };
     } | undefined);
-    operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+    operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
 }, {
     left: (string | number | boolean | {
         field: string;
@@ -273,7 +273,7 @@ export declare const NqlFilterBinaryExpressionObj: z.ZodObject<{
             table: string;
         };
     } | undefined);
-    operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+    operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
 }>;
 export declare const NqlFilterExpressionObj: z.ZodUnion<[z.ZodObject<{
     field: z.ZodObject<{
@@ -399,7 +399,7 @@ export declare const NqlFilterExpressionObj: z.ZodUnion<[z.ZodObject<{
             table: string;
         };
     } | undefined);
-    operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+    operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
 }, {
     left: (string | number | boolean | {
         field: string;
@@ -427,7 +427,7 @@ export declare const NqlFilterExpressionObj: z.ZodUnion<[z.ZodObject<{
             table: string;
         };
     } | undefined);
-    operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+    operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
 }>]>;
 export type NqlFilterExpression = z.infer<typeof NqlFilterExpressionObj>;
 export declare const NqlBooleanExpressionObj: z.ZodEnum<["AND", "OR"]>;
@@ -558,7 +558,7 @@ export declare const NqlWhereObj: z.ZodEffects<z.ZodObject<{
                 table: string;
             };
         } | undefined);
-        operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+        operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
     }, {
         left: (string | number | boolean | {
             field: string;
@@ -586,7 +586,7 @@ export declare const NqlWhereObj: z.ZodEffects<z.ZodObject<{
                 table: string;
             };
         } | undefined);
-        operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+        operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
     }>]>, "many">;
 }, "strip", z.ZodTypeAny, {
     booleanExpressions: ("AND" | "OR")[];
@@ -626,7 +626,7 @@ export declare const NqlWhereObj: z.ZodEffects<z.ZodObject<{
                 table: string;
             };
         } | undefined);
-        operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+        operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
     })[];
 }, {
     booleanExpressions: ("AND" | "OR")[];
@@ -666,7 +666,7 @@ export declare const NqlWhereObj: z.ZodEffects<z.ZodObject<{
                 table: string;
             };
         } | undefined);
-        operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+        operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
     })[];
 }>, {
     booleanExpressions: ("AND" | "OR")[];
@@ -706,7 +706,7 @@ export declare const NqlWhereObj: z.ZodEffects<z.ZodObject<{
                 table: string;
             };
         } | undefined);
-        operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+        operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
     })[];
 }, {
     booleanExpressions: ("AND" | "OR")[];
@@ -746,7 +746,7 @@ export declare const NqlWhereObj: z.ZodEffects<z.ZodObject<{
                 table: string;
             };
         } | undefined);
-        operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+        operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
     })[];
 }>;
 export type NqlWhere = z.infer<typeof NqlWhereObj>;
@@ -914,7 +914,7 @@ export declare const NqlObj: z.ZodObject<{
                     table: string;
                 };
             } | undefined);
-            operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+            operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
         }, {
             left: (string | number | boolean | {
                 field: string;
@@ -942,7 +942,7 @@ export declare const NqlObj: z.ZodObject<{
                     table: string;
                 };
             } | undefined);
-            operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+            operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
         }>]>, "many">;
     }, "strip", z.ZodTypeAny, {
         booleanExpressions: ("AND" | "OR")[];
@@ -982,7 +982,7 @@ export declare const NqlObj: z.ZodObject<{
                     table: string;
                 };
             } | undefined);
-            operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+            operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
         })[];
     }, {
         booleanExpressions: ("AND" | "OR")[];
@@ -1022,7 +1022,7 @@ export declare const NqlObj: z.ZodObject<{
                     table: string;
                 };
             } | undefined);
-            operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+            operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
         })[];
     }>, {
         booleanExpressions: ("AND" | "OR")[];
@@ -1062,7 +1062,7 @@ export declare const NqlObj: z.ZodObject<{
                     table: string;
                 };
             } | undefined);
-            operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+            operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
         })[];
     }, {
         booleanExpressions: ("AND" | "OR")[];
@@ -1102,7 +1102,7 @@ export declare const NqlObj: z.ZodObject<{
                     table: string;
                 };
             } | undefined);
-            operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+            operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
         })[];
     }>;
     limit: z.ZodObject<{
@@ -1173,7 +1173,7 @@ export declare const NqlObj: z.ZodObject<{
                     table: string;
                 };
             } | undefined);
-            operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+            operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
         })[];
     };
     limit: {
@@ -1237,7 +1237,7 @@ export declare const NqlObj: z.ZodObject<{
                     table: string;
                 };
             } | undefined);
-            operator: "=" | "!=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
+            operator: ">" | "<" | ">=" | "<=" | "=" | "!=" | "IN" | "NOT IN" | "LIKE" | "NOT LIKE";
         })[];
     };
     limit: {

package/package.json

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