@narrative.io/data-collaboration-sdk-ts 0.0.62 → 0.0.64

package/build/apps/index.d.ts

@@ -0,0 +1,17 @@
+import { type ApiRecords } from '../types';
+import { BaseApi } from '../base-api';
+import { type App } from './types';
+/**
+ * @module AppsApi
+ * @description This module provides methods for fetching app records.
+ * @extends BaseApi
+ */
+declare class AppsApi extends BaseApi {
+    /**
+     * Get all installations for the current user
+     * @param {number} appCategory - An optional filter for app categories.
+     * @returns {Promise<ApiRecords<Installation>>} - Promise resolving with the list of installations.
+     */
+    getApps(appCategory?: string): Promise<ApiRecords<App>>;
+}
+export { type App, AppsApi };

package/build/apps/index.js

@@ -0,0 +1,20 @@
+import { BaseApi } from '../base-api';
+const resourceName = 'apps';
+/**
+ * @module AppsApi
+ * @description This module provides methods for fetching app records.
+ * @extends BaseApi
+ */
+class AppsApi extends BaseApi {
+    /**
+     * Get all installations for the current user
+     * @param {number} appCategory - An optional filter for app categories.
+     * @returns {Promise<ApiRecords<Installation>>} - Promise resolving with the list of installations.
+     */
+    async getApps(appCategory) {
+        const appCategoryQuery = appCategory !== undefined ? `?app_category=${appCategory}` : '';
+        const url = `${resourceName}${appCategoryQuery}`;
+        return await this.get(url);
+    }
+}
+export { AppsApi };

package/build/apps/types.d.ts

@@ -0,0 +1,89 @@
+export interface App {
+    id: number;
+    manifest: {
+        name: string;
+        headline_image: Image;
+        background_color: string;
+        short_description: string;
+        long_description: string;
+        merchandising_sections: MerchandisingSection[];
+        icons: Image[];
+        version: string;
+        release_notes: string;
+        base_url: string;
+        categories: string[];
+        status: string;
+        developer_information: DeveloperInformation;
+        pages: Page[];
+        tiers: Tier[];
+        app_token_scopes: Scope[];
+    };
+}
+interface Image {
+    name: string;
+    image: string;
+    image_type: string;
+    alt_text: string;
+    width?: number;
+    height?: number;
+}
+interface MerchandisingSection {
+    title: string;
+    subtitle: string;
+    order: number;
+    image: Image;
+}
+interface DeveloperInformation {
+    name: string;
+    website: string;
+    support_email: string;
+    privacy_policy: string;
+}
+interface Navigation {
+    title: string;
+    icon: string;
+    tiers: TierNavigation[];
+}
+interface Page {
+    eligible_path: string;
+    navigation: Navigation;
+}
+interface TierNavigation {
+    tier_id: string;
+    rule: string;
+}
+interface PriceSpecification {
+    type: string;
+}
+interface Cta {
+    text: string;
+    action: string;
+    url: string;
+}
+interface Scope {
+    access: string;
+    resource: string;
+}
+interface QuickSetting {
+    id: string;
+    display_name: string;
+    schema: Schema;
+    description: string;
+}
+interface Schema {
+    type: string;
+    pattern: string;
+}
+interface Tier {
+    id: string;
+    name: string;
+    short_description: string;
+    long_description: string;
+    price_specifications: PriceSpecification[];
+    status: string;
+    cta: Cta;
+    required_scopes: Scope[];
+    services: string[];
+    quick_settings: QuickSetting[];
+}
+export {};

package/build/apps/types.js

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

package/build/index.d.ts

@@ -22,8 +22,9 @@ import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostFore
 import { ContractsApi, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView } from './contracts';
 import { getNqlObject, buildNql } from './nql/NQLParser';
 import { AuthenticationApi, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken } from './authentication';
+import { AppsApi, type App } from './apps';
 declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, 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 Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, 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, getNqlObject, buildNql };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, type App, 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 Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, 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, getNqlObject, buildNql };

package/build/index.js

@@ -16,7 +16,8 @@ import { ForecastApi } from './forecast';
 import { ContractsApi } from './contracts';
 import { getNqlObject, buildNql } from './nql/NQLParser';
 import { AuthenticationApi } from './authentication';
+import { AppsApi } from './apps';
 class NarrativeApi extends BaseApi {
 }
 applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, getNqlObject, buildNql };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, getNqlObject, buildNql };