@narrative.io/data-collaboration-sdk-ts 0.0.16 → 0.0.19

package/build/attributes/index.d.ts

@@ -5,7 +5,7 @@ import { type Attribute } from './types';
  * A class for accessing the Attribute API.
  * @extends BaseApi
  */
-export declare class AttributeApi extends BaseApi {
+declare class AttributeApi extends BaseApi {
     /**
      * Gets a list of attributes from the API.
      *
@@ -34,3 +34,4 @@ export declare class AttributeApi extends BaseApi {
      */
     createAttribute(data: Attribute): Promise<Attribute>;
 }
+export { AttributeApi, type Attribute };

package/build/attributes/index.js

@@ -10,7 +10,7 @@ const resourceName = 'attributes';
  * A class for accessing the Attribute API.
  * @extends BaseApi
  */
-export class AttributeApi extends BaseApi {
+class AttributeApi extends BaseApi {
     /**
      * Gets a list of attributes from the API.
      *
@@ -47,3 +47,4 @@ export class AttributeApi extends BaseApi {
         return await this.post(`${resourceName}`, data);
     }
 }
+export { AttributeApi };

package/build/attributes/types.d.ts

@@ -6,12 +6,14 @@ export interface Attribute {
     type: string;
     enum?: string[] | number[];
     validations?: string[];
+    is_join_key?: boolean;
     properties?: Record<string, {
         type: string;
         description?: string;
         validations?: string[];
         enum?: string[];
         items?: unknown;
+        is_join_key?: boolean;
     }>;
     required?: string[];
 }

package/build/base-api.d.ts

@@ -38,6 +38,14 @@ export declare abstract class BaseApi {
      * @protected
      */
     protected delete(endpoint: string): Promise<void>;
+    /**
+     * Makes a PUT request to the specified endpoint with the given data.
+     *
+     * @param endpoint - The endpoint to make the request to.
+     * @param data - The data to send in the request body.
+     * @returns A Promise that resolves to the data returned by the server.
+     */
+    protected put<I, T>(endpoint: string, data: I): Promise<T>;
     /**
       * Returns the base URL for the API based on the environment.
       *

package/build/base-api.js

@@ -50,6 +50,16 @@ export class BaseApi {
     async delete(endpoint) {
         await this.base_api.delete(endpoint);
     }
+    /**
+     * Makes a PUT request to the specified endpoint with the given data.
+     *
+     * @param endpoint - The endpoint to make the request to.
+     * @param data - The data to send in the request body.
+     * @returns A Promise that resolves to the data returned by the server.
+     */
+    async put(endpoint, data) {
+        return await this.base_api.put(endpoint, data);
+    }
     /**
       * Returns the base URL for the API based on the environment.
       *

package/build/company-info/index.d.ts

@@ -0,0 +1,18 @@
+import { BaseApi } from '../base-api';
+import { type CompanyInfo } from './types';
+/**
+ * A class for accessing the Contracts API.
+ * @extends BaseApi
+ */
+declare class CompanyInfoApi extends BaseApi {
+    private readonly companyId;
+    /**
+       * Get a customer contract based on the contract ID
+       *
+       * @param contractId - ID of the customer contract
+       * @returns Promise that resolves to the customer contract
+       *
+       */
+    getCompanyInfo(contractId: string): Promise<CompanyInfo>;
+}
+export { type CompanyInfo, CompanyInfoApi };

package/build/company-info/index.js

@@ -0,0 +1,29 @@
+import { BaseApi } from '../base-api';
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = 'company-info';
+/**
+ * A class for accessing the Contracts API.
+ * @extends BaseApi
+ */
+class CompanyInfoApi extends BaseApi {
+    companyId = async () => {
+        return await this.get(`${resourceName}/whoami`);
+    };
+    /**
+       * Get a customer contract based on the contract ID
+       *
+       * @param contractId - ID of the customer contract
+       * @returns Promise that resolves to the customer contract
+       *
+       */
+    async getCompanyInfo(contractId) {
+        const companyId = await this.companyId();
+        return await this.get(`${resourceName}/${companyId}`);
+    }
+}
+export { CompanyInfoApi };

package/build/company-info/types.d.ts

@@ -0,0 +1,13 @@
+export interface CompanyInfo {
+    id: number;
+    name: string;
+    short_description: string;
+    long_description: string;
+    company_type: string;
+    image_url: string;
+    location: string;
+    size: string;
+    website: string;
+    contact: string;
+    created_at: string;
+}

package/build/company-info/types.js

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

package/build/contracts/index.d.ts

@@ -0,0 +1,32 @@
+import { BaseApi } from '../base-api';
+import { type CustomerContract, type PaymentMethod } from './types';
+/**
+ * A class for accessing the Contracts API.
+ * @extends BaseApi
+ */
+declare class ContractsApi extends BaseApi {
+    /**
+   * Gets a list of contracts from the API.
+   *
+   * @returns {Promise<CustomerContract[]>} A promise that resolves with the list of contracts.
+   */
+    getContracts(): Promise<CustomerContract[]>;
+    /**
+       * Get a customer contract based on the contract ID
+       *
+       * @param contractId - ID of the customer contract
+       * @returns Promise that resolves to the customer contract
+       *
+       */
+    getContract(contractId: string): Promise<CustomerContract>;
+    /**
+     * Update a customer contract's payment method based on the contract ID
+     *
+     * @param contractId - ID of the customer contract
+     * @param paymentMethod - the updated payment method
+     * @returns Promise that resolves to the updated customer contract
+     *
+     */
+    updatePaymentMethod(contractId: string, paymentMethod: PaymentMethod): Promise<CustomerContract>;
+}
+export { ContractsApi, type CustomerContract, type PaymentMethod };

package/build/contracts/index.js

@@ -0,0 +1,44 @@
+import { BaseApi } from '../base-api';
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = 'contracts';
+/**
+ * A class for accessing the Contracts API.
+ * @extends BaseApi
+ */
+class ContractsApi extends BaseApi {
+    /**
+   * Gets a list of contracts from the API.
+   *
+   * @returns {Promise<CustomerContract[]>} A promise that resolves with the list of contracts.
+   */
+    async getContracts() {
+        return await this.get(resourceName);
+    }
+    /**
+       * Get a customer contract based on the contract ID
+       *
+       * @param contractId - ID of the customer contract
+       * @returns Promise that resolves to the customer contract
+       *
+       */
+    async getContract(contractId) {
+        return await this.get(`${resourceName}/${contractId}`);
+    }
+    /**
+     * Update a customer contract's payment method based on the contract ID
+     *
+     * @param contractId - ID of the customer contract
+     * @param paymentMethod - the updated payment method
+     * @returns Promise that resolves to the updated customer contract
+     *
+     */
+    async updatePaymentMethod(contractId, paymentMethod) {
+        return await this.put(`${resourceName}/${contractId}`, paymentMethod);
+    }
+}
+export { ContractsApi };

package/build/contracts/types.d.ts

@@ -0,0 +1,29 @@
+export interface CustomerContract {
+    id: CustomerContractId;
+    payableCompanyId: CompanyId;
+    paymentMethod: PaymentMethod;
+    internalNotes?: string;
+    revision: Revision;
+    revisionNotes?: string;
+    revisionStart: string;
+    revisionEnd?: string;
+    updatedBy: UserId;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CustomerContractId {
+    value: string;
+}
+interface Revision {
+    value: number;
+}
+export interface PaymentMethod {
+    type: 'credit_card' | 'invoice';
+}
+interface UserId {
+    value: string;
+}
+interface CompanyId {
+    value: string;
+}
+export {};

package/build/contracts/types.js

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

package/build/index.d.ts

@@ -2,14 +2,18 @@ import { BaseApi } from './base-api';
 import { DatasetApi } from './datasets';
 import { HealthCheckApi } from './health';
 import { RosettaStoneApi } from './rosetta-stone';
-import { type Environment, type Config, type ApiRecords } from './types';
+import { type Environment, type Config, type ApiRecords, type MonetaryAmount } from './types';
 import { type DatasetTableSummaryAPIResponse, type Dataset, type DatasetTableSummary } from './datasets/types';
 import { type HealthCheckResult } from './health/types';
 import { type SampleRecords } from './rosetta-stone/types';
 import { AttributeApi } from './attributes';
 import { type Attribute } from './attributes/types';
+import { PingApi } from './ping';
+import { type PingStatus } from './ping/types';
+import { type Product, ProductsApi } from './products';
+import { CompanyInfoApi, type CompanyInfo } from './company-info';
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, 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 };

package/build/index.js

@@ -4,7 +4,10 @@ import { HealthCheckApi } from './health';
 import { RosettaStoneApi } from './rosetta-stone';
 import { applyMixins } from './utils';
 import { AttributeApi } from './attributes';
+import { PingApi } from './ping';
+import { ProductsApi } from './products';
+import { CompanyInfoApi } from './company-info';
 class NarrativeApi extends BaseApi {
 }
-applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi };

package/build/ping/index.d.ts

@@ -0,0 +1,14 @@
+import { BaseApi } from '../base-api';
+import { type PingStatus } from './types';
+/**
+ * A class for accessing the Ping API.
+ * @extends BaseApi
+ */
+export declare class PingApi extends BaseApi {
+    /**
+     * Gets the result of a ping from the API.
+     *
+     * @returns {Promise<HealthCheckResult>} A promise that resolves with the result of the ping.
+     */
+    ping(): Promise<PingStatus>;
+}

package/build/ping/index.js

@@ -0,0 +1,22 @@
+import { BaseApi } from '../base-api';
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = 'ping';
+/**
+ * A class for accessing the Ping API.
+ * @extends BaseApi
+ */
+export class PingApi extends BaseApi {
+    /**
+     * Gets the result of a ping from the API.
+     *
+     * @returns {Promise<HealthCheckResult>} A promise that resolves with the result of the ping.
+     */
+    async ping() {
+        return await this.get(resourceName);
+    }
+}

package/build/ping/types.d.ts

@@ -0,0 +1 @@
+export type PingStatus = 'healthy' | unknown;

package/build/ping/types.js

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

package/build/products/index.d.ts

@@ -0,0 +1,15 @@
+import { BaseApi } from '../base-api';
+import { type Product } from './types';
+/**
+ * A class for accessing the Products API.
+ * @extends BaseApi
+ */
+declare class ProductsApi extends BaseApi {
+    /**
+       * Gets the result of a product from the API.
+       *
+       * @returns {Promise<Product[]>} A promise that resolves with the products.
+       */
+    getHealthCheck(): Promise<Product[]>;
+}
+export { ProductsApi, type Product };

package/build/products/index.js

@@ -0,0 +1,23 @@
+import { BaseApi } from '../base-api';
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = 'admin/products';
+/**
+ * A class for accessing the Products API.
+ * @extends BaseApi
+ */
+class ProductsApi extends BaseApi {
+    /**
+       * Gets the result of a product from the API.
+       *
+       * @returns {Promise<Product[]>} A promise that resolves with the products.
+       */
+    async getHealthCheck() {
+        return await this.get(resourceName);
+    }
+}
+export { ProductsApi };

package/build/products/types.d.ts

@@ -0,0 +1,34 @@
+type ProductId = string;
+type ProductSkuType = 'processing' | 'storage' | 'transfer';
+type ProductCloudType = 'aws' | 'gcp' | 'azure';
+type ProductUnitType = 'bytes' | 'average-bytes-per-month';
+type ProductStatus = 'active' | 'archived';
+interface ProductRate {
+    type: string;
+    unitPrice: {
+        type: string;
+        currency: string;
+        priceInMicroCents: number;
+    };
+}
+export interface ProductUnitPrice {
+    type: string;
+    currency: string;
+    priceInMicroCents: number;
+}
+export interface Product {
+    id: ProductId;
+    sku: string;
+    skuType: ProductSkuType;
+    payableCompanyId: number;
+    name: string;
+    description?: string | null;
+    cloud?: ProductCloudType | null;
+    region?: string | null;
+    unit: ProductUnitType;
+    defaultRate: ProductRate;
+    status: ProductStatus;
+    createdAt: string;
+    updatedAt: string;
+}
+export {};

package/build/products/types.js

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

package/build/types.d.ts

@@ -18,3 +18,14 @@ export interface Config {
 export interface ApiRecords<T> {
     records: T[];
 }
+export interface MonetaryAmount {
+    value: {
+        amount: number;
+        currency: {
+            code: CurrencyCode;
+        };
+    };
+    microCentsUsd: number;
+}
+type CurrencyCode = 'USD';
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.16",
+  "version": "0.0.19",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -9,7 +9,7 @@
   "scripts": {
     "build": "tsc",
     "lint": "npx eslint . --fix",
-    "prepare": "npm run build",
+    "prepare": "npx eslint . --fix && npm run build",
     "prepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
     "version": "npm run && git add -A src",