@narrative.io/data-collaboration-sdk-ts 0.0.111 → 0.0.113
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.
|
@@ -118,4 +118,12 @@ export declare class DatasetApi extends BaseApi {
|
|
|
118
118
|
* @returns {Promise<RecalculationInfo>} A promise that resolves when the operation is complete.
|
|
119
119
|
*/
|
|
120
120
|
recalculateDatasetColumnStatistics(datasetId: number): Promise<RecalculationInfo>;
|
|
121
|
+
/**
|
|
122
|
+
* Deletes a specific dataset from the system.
|
|
123
|
+
* This method sends a DELETE request to the specified endpoint to remove the dataset.
|
|
124
|
+
*
|
|
125
|
+
* @param {number} datasetId - The ID of the dataset to be deleted.
|
|
126
|
+
* @returns {Promise<void>} A promise that resolves when the dataset has been successfully deleted.
|
|
127
|
+
*/
|
|
128
|
+
deleteDataset(datasetId: number): Promise<void>;
|
|
121
129
|
}
|
package/build/datasets/index.js
CHANGED
|
@@ -145,4 +145,14 @@ export class DatasetApi extends BaseApi {
|
|
|
145
145
|
async recalculateDatasetColumnStatistics(datasetId) {
|
|
146
146
|
return await this.post(`${resourceName}/${datasetId}/column-stats/recalculate`, {});
|
|
147
147
|
}
|
|
148
|
+
/**
|
|
149
|
+
* Deletes a specific dataset from the system.
|
|
150
|
+
* This method sends a DELETE request to the specified endpoint to remove the dataset.
|
|
151
|
+
*
|
|
152
|
+
* @param {number} datasetId - The ID of the dataset to be deleted.
|
|
153
|
+
* @returns {Promise<void>} A promise that resolves when the dataset has been successfully deleted.
|
|
154
|
+
*/
|
|
155
|
+
async deleteDataset(datasetId) {
|
|
156
|
+
await this.delete(`${resourceName}/${datasetId}`);
|
|
157
|
+
}
|
|
148
158
|
}
|
package/build/index.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ import { type UploadsResponse } from "./uploads/types";
|
|
|
15
15
|
import { type PingStatus } from "./ping/types";
|
|
16
16
|
import { type Product, ProductsApi } from "./products";
|
|
17
17
|
import { CompanyInfoApi, type CompanyInfo } from "./company-info";
|
|
18
|
-
import { InstallationsApi, type Installation } from "./installations";
|
|
18
|
+
import { InstallationsApi, type Installation, type InstallAppRequest } from "./installations";
|
|
19
19
|
import { NqlApi, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression } from "./nql";
|
|
20
20
|
import { DataStreamsApi, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet } from "./data-streams";
|
|
21
21
|
import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState } from "./forecast";
|
|
@@ -32,4 +32,4 @@ declare class NarrativeApi extends BaseApi {
|
|
|
32
32
|
}
|
|
33
33
|
interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi {
|
|
34
34
|
}
|
|
35
|
-
export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, 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, };
|
|
35
|
+
export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, 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 InstallAppRequest, 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, };
|
package/build/index.js
CHANGED
|
@@ -9,7 +9,7 @@ import { PingApi } from "./ping";
|
|
|
9
9
|
import { UploadsApi } from "./uploads";
|
|
10
10
|
import { ProductsApi } from "./products";
|
|
11
11
|
import { CompanyInfoApi } from "./company-info";
|
|
12
|
-
import { InstallationsApi } from "./installations";
|
|
12
|
+
import { InstallationsApi, } from "./installations";
|
|
13
13
|
import { NqlApi, } from "./nql";
|
|
14
14
|
import { DataStreamsApi, } from "./data-streams";
|
|
15
15
|
import { ForecastApi, } from "./forecast";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type ApiRecords } from "../types";
|
|
2
2
|
import { BaseApi } from "../base-api";
|
|
3
|
-
import { type Installation } from "./types";
|
|
3
|
+
import { type Installation, type InstallAppRequest } from "./types";
|
|
4
4
|
/**
|
|
5
5
|
* @module InstallationsApi
|
|
6
6
|
* @description This module provides methods for fetching installation records.
|
|
@@ -13,5 +13,6 @@ declare class InstallationsApi extends BaseApi {
|
|
|
13
13
|
* @returns {Promise<ApiRecords<Installation>>} - Promise resolving with the list of installations.
|
|
14
14
|
*/
|
|
15
15
|
getInstallations(appCategory?: string): Promise<ApiRecords<Installation>>;
|
|
16
|
+
installApp(request: InstallAppRequest): Promise<ApiRecords<Installation>>;
|
|
16
17
|
}
|
|
17
|
-
export { type Installation, InstallationsApi };
|
|
18
|
+
export { type Installation, type InstallAppRequest, InstallationsApi };
|
|
@@ -16,5 +16,9 @@ class InstallationsApi extends BaseApi {
|
|
|
16
16
|
const url = `${resourceName}${appCategoryQuery}`;
|
|
17
17
|
return await this.get(url);
|
|
18
18
|
}
|
|
19
|
+
async installApp(request) {
|
|
20
|
+
const url = `${resourceName}?app_id=${request.app_id}&tier_id=${request.tier_id}`;
|
|
21
|
+
return await this.post(url);
|
|
22
|
+
}
|
|
19
23
|
}
|
|
20
24
|
export { InstallationsApi };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@narrative.io/data-collaboration-sdk-ts",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.113",
|
|
4
4
|
"main": "build/index.js",
|
|
5
5
|
"repository": "github:narrative-io/data-collaboration-sdk-ts",
|
|
6
6
|
"source": "src/index.ts",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"@types/jest": "^29.5.0",
|
|
29
29
|
"babel-jest": "^29.4.3",
|
|
30
30
|
"eslint-config-prettier": "^9.0.0",
|
|
31
|
-
"eslint-config-standard-with-typescript": "^
|
|
31
|
+
"eslint-config-standard-with-typescript": "^38.0.0",
|
|
32
32
|
"eslint-plugin-prettier": "^5.0.0",
|
|
33
33
|
"husky": "^8.0.0",
|
|
34
34
|
"jest": "^29.4.3",
|