@narrative.io/data-collaboration-sdk-ts 0.0.49 → 0.0.51

package/build/contracts/index.d.ts

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

package/build/contracts/index.js

@@ -40,5 +40,14 @@ class ContractsApi extends BaseApi {
     async updatePaymentMethod(contractId, paymentMethod) {
         return await this.put(`${resourceName}/${contractId}`, paymentMethod);
     }
+    /**
+       * Get the active contract for a company
+       *
+       * @returns Promise that resolves to the customer contract
+       *
+       */
+    async getActiveContract() {
+        return await this.get(`${resourceName}/active`);
+    }
 }
 export { ContractsApi };

package/build/contracts/types.d.ts

@@ -1,29 +1,48 @@
-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;
+export interface ContractDetails {
+    contract?: CustomerContract;
+    rates?: ContractRateView[];
 }
-interface Revision {
-    value: number;
+export interface CustomerContract {
+    id: string;
+    company_id: number;
+    payment_method: PaymentMethod;
+    internal_notes?: string;
+    revision: number;
+    revision_notes?: string;
+    revision_start: string;
+    revision_end?: string;
+    updated_by: number;
+    created_at: string;
+    updated_at: string;
 }
 export interface PaymentMethod {
     type: 'credit_card' | 'invoice';
 }
-interface UserId {
-    value: string;
+export interface ContractRateView {
+    rate?: Rate;
+    product?: ProductView;
+    start_at?: Date;
+    end_at?: Date;
+    created_at?: Date;
+    updated_at?: Date;
+}
+export interface Rate {
+    type: RateType;
+    unit_price: UnitPrice;
+}
+export type RateType = 'per_unit' | 'percent_of_gmv';
+export interface UnitPrice {
+    value: number;
+    expressed_in: string;
+    currency?: string;
 }
-interface CompanyId {
-    value: string;
+export interface ProductView {
+    id?: string;
+    sku?: string;
+    sku_type?: string;
+    payable_company_id?: number;
+    name?: string;
+    unit?: string;
+    status?: ProductStatus;
 }
-export {};
+export type ProductStatus = 'active' | 'archived';

package/build/index.d.ts

@@ -19,8 +19,9 @@ import { InstallationsApi, type Installation } from './installations';
 import { NqlApi, type NqlCompileResult, type NqlQuery, type NqlResult } from './nql';
 import { DataStreamsApi, type DataStream } from './data-streams';
 import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState } from './forecast';
+import { ContractsApi, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView } from './contracts';
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, 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 NqlQuery, type NqlResult, type NqlCompileResult, type DataStream, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, 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 NqlQuery, type NqlResult, type NqlCompileResult, type DataStream, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView };

package/build/index.js

@@ -13,7 +13,8 @@ import { InstallationsApi } from './installations';
 import { NqlApi } from './nql';
 import { DataStreamsApi } from './data-streams';
 import { ForecastApi } from './forecast';
+import { ContractsApi } from './contracts';
 class NarrativeApi extends BaseApi {
 }
-applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi };

package/package.json

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