@narrative.io/data-collaboration-sdk-ts 0.0.115 → 0.0.117

package/build/datasets/types.d.ts

@@ -14,6 +14,7 @@ export interface Dataset {
     last_snapshot_created_at?: string;
     active_dataset_stored_bytes?: number;
     mappings?: Mapping[];
+    subscription_id?: string;
 }
 export interface RecalculationInfo {
     recalculation_id: string;

package/build/index.d.ts

@@ -28,9 +28,9 @@ import type { ForecastBody } from "./nql/types";
 import { type ConversationMessageRole, isConversationMessageRole, type ConversationMessageName, isConversationMessageName, type ConversationUserMessage, isConversationUserMessage, type ConversationAssistantMessage, isConversationAssistantMessage, type ConversationSystemMessage, isConversationSystemMessage, type ConversationFunctionMessage, isConversationFunctionMessage, type ConversationMessage, isConversationMessage, type ConversationIOMessage, isConversationInputMessage, type ConversationMessages, isConversationMessages, isType, type RosettaRequestMessage, isRosettaRequestMessage, type ConversationMessageFunctionCall, isConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, isConversationAssistantMessageWithoutFunctionCall } from "./rosetta/types";
 import { MappingsApi } from "./mappings";
 import { type AccessRule, AccessRulesApi } from "./access-rules/";
-import { type InstallAppRequest, CompaniesApi } from "./companies";
+import { type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, SubscriptionsApi } from "./subscriptions";
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, CompaniesApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, CompaniesApi, 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, type AccessRule, type InstallAppRequest, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, 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, type AccessRule, type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, };

package/build/index.js

@@ -21,7 +21,7 @@ import { AppsApi } from "./apps";
 import { isConversationMessageRole, isConversationMessageName, isConversationUserMessage, isConversationAssistantMessage, isConversationSystemMessage, isConversationFunctionMessage, isConversationMessage, isConversationInputMessage, isConversationMessages, isType, isRosettaRequestMessage, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithoutFunctionCall, } from "./rosetta/types";
 import { MappingsApi } from "./mappings";
 import { AccessRulesApi } from "./access-rules/";
-import { CompaniesApi } from "./companies";
+import { SubscriptionsApi, } from "./subscriptions";
 class NarrativeApi extends BaseApi {
 }
 applyMixins(NarrativeApi, [
@@ -43,6 +43,6 @@ applyMixins(NarrativeApi, [
     MappingsApi,
     AppsApi,
     AccessRulesApi,
-    CompaniesApi,
+    SubscriptionsApi,
 ]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, CompaniesApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, };

package/build/subscriptions/index.d.ts

@@ -0,0 +1,16 @@
+import { type ApiRecords } from "../types";
+import { BaseApi } from "../base-api";
+import { type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget } from "./types";
+/**
+ * @module SubscriptionsApi
+ * @description This module provides methods for interacing with subscriptions
+ * @extends SubscriptionsApi
+ */
+declare class SubscriptionsApi extends BaseApi {
+    /**
+     * Get a list of all subscriptions
+     * @returns {Promise<ApiRecords<Subscription>>} - Promise resolving to an array of datasets
+     */
+    getSubscriptions(): Promise<ApiRecords<Subscription>>;
+}
+export { type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, SubscriptionsApi, };

package/build/subscriptions/index.js

@@ -0,0 +1,17 @@
+import { BaseApi } from "../base-api";
+const resourceName = "data-shops/subscriptions";
+/**
+ * @module SubscriptionsApi
+ * @description This module provides methods for interacing with subscriptions
+ * @extends SubscriptionsApi
+ */
+class SubscriptionsApi extends BaseApi {
+    /**
+     * Get a list of all subscriptions
+     * @returns {Promise<ApiRecords<Subscription>>} - Promise resolving to an array of datasets
+     */
+    async getSubscriptions() {
+        return await this.get(`${resourceName}`);
+    }
+}
+export { SubscriptionsApi, };

package/build/subscriptions/types.d.ts

@@ -0,0 +1,59 @@
+import { type Offer, type DataRules, type CompanyConstraint } from "src/data-streams/types";
+import { type DatasetConstraint } from "src/forecast/types";
+export interface Subscription {
+    id: string;
+    budget: SubscriptionBudget;
+    cancelled_at?: string;
+    company_id: number;
+    created_at: string;
+    description?: string;
+    details?: SubscriptionDetails;
+    name: string;
+    output?: SubscriptionOutput;
+    cadence?: SubscriptionCadence;
+    status: SubscriptionStatus;
+    update_at: string;
+}
+export interface SubscriptionBudget {
+    amount: {
+        currency: string;
+        value: number;
+    };
+    period: {
+        type: SubscriptionBudgetPeriod;
+    };
+}
+export type SubscriptionBudgetPeriod = "calendar_daily" | "calendar_monthly";
+export interface SubscriptionDetails {
+    type: SubscriptionType;
+    data_rules: DataRules;
+}
+export type DataStreamSubscriptionDetails = SubscriptionDetails & {
+    type: "data_stream";
+    data_shop_id: string;
+    data_stream_company_id: number;
+    data_stream_content: DataStreamContent;
+    data_stream_id: string;
+    data_stream_name: string;
+    data_stream_slug: string;
+    offer?: Offer;
+};
+export type MarketplaceSubscriptionDetails = SubscriptionDetails & {
+    type: "marketplace";
+    company_contraint?: CompanyConstraint;
+    dataset_constraint?: DatasetConstraint;
+    pricing: {
+        micro_cents_usd: number;
+    };
+};
+export interface DataStreamContent {
+    description: string;
+    icon?: string;
+    sections?: object[];
+}
+export type SubscriptionType = "data_stream" | "marketplace";
+export interface SubscriptionOutput {
+    dataset_id: number;
+}
+export type SubscriptionCadence = "once" | "hourly" | "daily" | "weekly" | "monthly";
+export type SubscriptionStatus = "active" | "cancelled" | "pending" | "archived" | "kickoff" | "completed";

package/package.json

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

package/build/companies/index.d.ts

@@ -1,20 +0,0 @@
-import { BaseApi } from "../base-api";
-import { type InstallAppRequest } from "./types";
-import { type Installation } from "../installations/types";
-/**
- * @module CompaniesApi
- * @description This module provides methods for intracting with the company api endpoints.
- * @extends BaseApi
- */
-declare class CompaniesApi extends BaseApi {
-    /**
-     * Installs an app based on the provided request parameters.
-     *
-     * @async
-     * @public
-     * @param {InstallAppRequest} request - The request parameters for app installation.
-     * @returns {Promise<Installation>} Returns a promise that resolves to the Installation object after successful installation.
-     */
-    installApp(request: InstallAppRequest): Promise<Installation>;
-}
-export { type InstallAppRequest, CompaniesApi };

package/build/companies/index.js

@@ -1,22 +0,0 @@
-import { BaseApi } from "../base-api";
-const resourceName = "companies";
-/**
- * @module CompaniesApi
- * @description This module provides methods for intracting with the company api endpoints.
- * @extends BaseApi
- */
-class CompaniesApi extends BaseApi {
-    /**
-     * Installs an app based on the provided request parameters.
-     *
-     * @async
-     * @public
-     * @param {InstallAppRequest} request - The request parameters for app installation.
-     * @returns {Promise<Installation>} Returns a promise that resolves to the Installation object after successful installation.
-     */
-    async installApp(request) {
-        const url = `${resourceName}/${request.company_id}/installations?app_id=${request.app_id}&tier_id=${request.tier_id}`;
-        return await this.post(url);
-    }
-}
-export { CompaniesApi };

package/build/companies/types.d.ts

@@ -1,5 +0,0 @@
-export interface InstallAppRequest {
-    company_id: number;
-    app_id: number;
-    tier_id: string;
-}