@narrative.io/data-collaboration-sdk-ts 0.0.156 → 0.0.157

package/build/connections/index.d.ts

@@ -0,0 +1,43 @@
+import { BaseApi } from "src/base-api";
+import type { Connection } from "./types";
+import { type ApiRecords } from "src/types";
+/**
+ * Class representing the API for connections.
+ *
+ * @module ConnectionsApi
+ * @extends BaseApi
+ * @description This class provides methods for fetching and managing connection records.
+ */
+declare class ConnectionsApi extends BaseApi {
+    /**
+     * Retrieves a specific connection by its ID.
+     *
+     * @public
+     * @async
+     * @param {string} [connectionId] - The ID of the connection to retrieve.
+     * @returns {Promise<Connection>} A promise that resolves to the connection object.
+     * @throws Will throw an error if the API call fails.
+     */
+    getConnection(connectionId?: string): Promise<Connection>;
+    /**
+     * Retrieves all connections associated with a specific dataset.
+     *
+     * @public
+     * @async
+     * @param {number} datasetId - The ID of the dataset to retrieve connections for.
+     * @returns {Promise<ApiRecords<Connection>>} A promise that resolves to an array of connection objects.
+     * @throws Will throw an error if the API call fails.
+     */
+    getDatasetConnections(datasetId: number): Promise<ApiRecords<Connection>>;
+    /**
+     * Creates a new connection.
+     *
+     * @public
+     * @async
+     * @param {Omit<Connection, "id">} newConnection - The connection data to create, excluding the ID.
+     * @returns {Promise<Connection>} A promise that resolves to the newly created connection object.
+     * @throws Will throw an error if the API call fails.
+     */
+    createConnection(newConnection: Omit<Connection, "id">): Promise<Connection>;
+}
+export { type Connection, ConnectionsApi };

package/build/connections/index.js

@@ -0,0 +1,56 @@
+import { BaseApi } from "src/base-api";
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = "connections";
+/**
+ * Class representing the API for connections.
+ *
+ * @module ConnectionsApi
+ * @extends BaseApi
+ * @description This class provides methods for fetching and managing connection records.
+ */
+class ConnectionsApi extends BaseApi {
+    /**
+     * Retrieves a specific connection by its ID.
+     *
+     * @public
+     * @async
+     * @param {string} [connectionId] - The ID of the connection to retrieve.
+     * @returns {Promise<Connection>} A promise that resolves to the connection object.
+     * @throws Will throw an error if the API call fails.
+     */
+    async getConnection(connectionId) {
+        const url = `${resourceName}/${connectionId}`;
+        return await this.get(url);
+    }
+    /**
+     * Retrieves all connections associated with a specific dataset.
+     *
+     * @public
+     * @async
+     * @param {number} datasetId - The ID of the dataset to retrieve connections for.
+     * @returns {Promise<ApiRecords<Connection>>} A promise that resolves to an array of connection objects.
+     * @throws Will throw an error if the API call fails.
+     */
+    async getDatasetConnections(datasetId) {
+        const url = `${resourceName}?dataset_id=${datasetId}`;
+        return await this.get(url);
+    }
+    /**
+     * Creates a new connection.
+     *
+     * @public
+     * @async
+     * @param {Omit<Connection, "id">} newConnection - The connection data to create, excluding the ID.
+     * @returns {Promise<Connection>} A promise that resolves to the newly created connection object.
+     * @throws Will throw an error if the API call fails.
+     */
+    async createConnection(newConnection) {
+        return await this.post(resourceName, newConnection);
+    }
+}
+export { ConnectionsApi };

package/build/connections/types.d.ts

@@ -0,0 +1,6 @@
+export interface Connection {
+    id: string;
+    dataset_id: number;
+    profile_id: string;
+    quick_settings: Record<string, unknown>;
+}

package/build/connections/types.js

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

package/build/index.d.ts

@@ -16,7 +16,7 @@ import { type UploadsResponse } from "./uploads/types";
 import { type PingStatus } from "./ping/types";
 import { type Product, ProductsApi } from "./products";
 import { CompanyInfoApi, type CompanyInfo } from "./company-info";
-import { InstallationsApi, type Installation } from "./installations";
+import { InstallationsApi, type Installation, type Profile } from "./installations";
 import { NqlApi, type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, compileStatement, parseStatement } from "./nql";
 import { DataStreamsApi, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet } from "./data-streams";
 import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState } from "./forecast";
@@ -32,8 +32,9 @@ import { type AccessRule, AccessRulesApi } from "./access-rules/";
 import { type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, SubscriptionsApi } from "./subscriptions";
 import { type Job, JobsApi } from "./jobs";
 import { WhoAmIApi } from "./whoami";
+import { ConnectionsApi, type Connection } from "./connections";
 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, SubscriptionsApi, JobsApi, WhoAmIApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, WhoAmIApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, WhoAmIApi, 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 UpdateDatasetRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaProperty, type SchemaPrimitiveProperty, type SchemaObjectProperty, type SchemaArrayProperty, type SchemaArrayItems, type SchemaArrayItemsPrimitive, type SchemaArrayItemsObject, type SchemaArrayItemsArray, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type ColumnStatistics, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type CreateDatasetRequest, type IngestDatasetFileRequest, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, 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, type Job, type User, type Mapping, type MappingTestResult, compileStatement, parseStatement, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, WhoAmIApi, 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 Connection, 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 UpdateDatasetRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaProperty, type SchemaPrimitiveProperty, type SchemaObjectProperty, type SchemaArrayProperty, type SchemaArrayItems, type SchemaArrayItemsPrimitive, type SchemaArrayItemsObject, type SchemaArrayItemsArray, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type ColumnStatistics, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type CreateDatasetRequest, type IngestDatasetFileRequest, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type Profile, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, 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, type Job, type User, type Mapping, type MappingTestResult, compileStatement, parseStatement, };

package/build/index.js

@@ -9,7 +9,7 @@ import { PingApi } from "./ping";
 import { UploadsApi } from "./uploads";
 import { ProductsApi } from "./products";
 import { CompanyInfoApi } from "./company-info";
-import { InstallationsApi } from "./installations";
+import { InstallationsApi, } from "./installations";
 import { NqlApi, compileStatement, parseStatement, } from "./nql";
 import { DataStreamsApi, } from "./data-streams";
 import { ForecastApi, } from "./forecast";
@@ -24,6 +24,7 @@ import { AccessRulesApi } from "./access-rules/";
 import { SubscriptionsApi, } from "./subscriptions";
 import { JobsApi } from "./jobs";
 import { WhoAmIApi } from "./whoami";
+import { ConnectionsApi } from "./connections";
 class NarrativeApi extends BaseApi {
 }
 applyMixins(NarrativeApi, [
@@ -35,6 +36,7 @@ applyMixins(NarrativeApi, [
     PingApi,
     CompanyInfoApi,
     InstallationsApi,
+    ConnectionsApi,
     UploadsApi,
     ResourceApi,
     NqlApi,
@@ -49,4 +51,4 @@ applyMixins(NarrativeApi, [
     JobsApi,
     WhoAmIApi,
 ]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, compileStatement, parseStatement, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, compileStatement, parseStatement, };

package/build/installations/index.d.ts

@@ -1,6 +1,6 @@
 import { type ApiRecords } from "../types";
 import { BaseApi } from "../base-api";
-import { type Installation } from "./types";
+import type { Profile, Installation } from "./types";
 /**
  * @module InstallationsApi
  * @description This module provides methods for fetching installation records.
@@ -13,5 +13,6 @@ declare class InstallationsApi extends BaseApi {
      * @returns {Promise<ApiRecords<Installation>>} - Promise resolving with the list of installations.
      */
     getInstallations(appCategory?: string): Promise<ApiRecords<Installation>>;
+    getInstallationProfiles(installationId: number): Promise<ApiRecords<Profile>>;
 }
-export { type Installation, InstallationsApi };
+export { type Installation, type Profile, InstallationsApi };

package/build/installations/index.js

@@ -16,5 +16,9 @@ class InstallationsApi extends BaseApi {
         const url = `${resourceName}${appCategoryQuery}`;
         return await this.get(url);
     }
+    async getInstallationProfiles(installationId) {
+        const url = `${resourceName}/${installationId}/profiles`;
+        return await this.get(url);
+    }
 }
 export { InstallationsApi };

package/build/installations/types.d.ts

@@ -11,4 +11,11 @@ export interface Permission {
     resource: string;
 }
 type Access = "read" | "write" | "admin" | "create" | "revise";
+export type ProfileStatus = "enabled" | "disabled" | "archived";
+export interface Profile {
+    id: string;
+    name: string;
+    description: string;
+    status: ProfileStatus;
+}
 export {};

package/package.json

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