@scell/sdk 1.2.0 → 1.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scell/sdk",
-  "version": "1.2.0",
+  "version": "1.5.0",
   "description": "Official TypeScript SDK for Scell.io - Electronic invoicing (Factur-X) and signatures (eIDAS) API",
   "author": "Scell.io <contact@scell.io>",
   "license": "MIT",

package/src/client.ts

@@ -14,7 +14,7 @@ import { withRetry, type RetryOptions } from './utils/retry.js';
 /**
  * Authentication mode
  */
-export type AuthMode = 'bearer' | 'api-key';
+export type AuthMode = 'bearer' | 'api-key' | 'tenant-key';
 
 /**
  * Client configuration options
@@ -116,6 +116,8 @@ export class HttpClient {
 
     if (this.authMode === 'bearer') {
       headers['Authorization'] = `Bearer ${this.authToken}`;
+    } else if (this.authMode === 'tenant-key') {
+      headers['X-Tenant-Key'] = this.authToken;
     } else {
       headers['X-API-Key'] = this.authToken;
     }

package/src/index.ts

@@ -5,7 +5,7 @@
  *
  * @example
  * ```typescript
- * import { ScellClient, ScellApiClient, ScellAuth, ScellWebhooks } from '@scell/sdk';
+ * import { ScellClient, ScellApiClient, ScellTenantClient, ScellAuth, ScellWebhooks } from '@scell/sdk';
  *
  * // Dashboard client (Bearer token)
  * const auth = await ScellAuth.login({ email, password });
@@ -14,9 +14,15 @@
  * // API client (X-API-Key)
  * const apiClient = new ScellApiClient('your-api-key');
  *
+ * // Tenant client (X-Tenant-Key) - for multi-tenant operations
+ * const tenantClient = new ScellTenantClient('your-tenant-key');
+ *
  * // Create invoice
  * const invoice = await apiClient.invoices.create({...});
  *
+ * // Create direct invoice (tenant)
+ * const directInvoice = await tenantClient.directInvoices.create({...});
+ *
  * // Verify webhook
  * const isValid = await ScellWebhooks.verifySignature(payload, signature, secret);
  * ```
@@ -25,13 +31,23 @@
 // Client
 import { HttpClient, type ClientConfig } from './client.js';
 
+// Tenant Client
+import { ScellTenantClient } from './tenant-client.js';
+
 // Resources
 import { ApiKeysResource } from './resources/api-keys.js';
 import { AuthResource, ScellAuth } from './resources/auth.js';
 import { BalanceResource } from './resources/balance.js';
+import { BillingResource } from './resources/billing.js';
 import { CompaniesResource } from './resources/companies.js';
+import { FiscalResource } from './resources/fiscal.js';
 import { InvoicesResource } from './resources/invoices.js';
 import { SignaturesResource } from './resources/signatures.js';
+import { StatsResource } from './resources/stats.js';
+import { SubTenantsResource } from './resources/sub-tenants.js';
+import { TenantCreditNotesResource } from './resources/tenant-credit-notes.js';
+import { TenantDirectInvoicesResource } from './resources/tenant-direct-invoices.js';
+import { TenantIncomingInvoicesResource } from './resources/tenant-incoming-invoices.js';
 import { WebhooksResource } from './resources/webhooks.js';
 
 // Utilities
@@ -143,11 +159,25 @@ export class ScellApiClient {
   public readonly invoices: InvoicesResource;
   /** Signature operations (create, download, remind, cancel) */
   public readonly signatures: SignaturesResource;
+  /** Sub-tenant management (provision, update, list) */
+  public readonly subTenants: SubTenantsResource;
+  /** NF525 fiscal compliance (closings, FEC, attestation) */
+  public readonly fiscal: FiscalResource;
+  /** Platform statistics */
+  public readonly stats: StatsResource;
+  /** Platform billing (usage, top-up, transactions) */
+  public readonly billing: BillingResource;
+  /** Credit notes operations (create, send, download) */
+  public readonly creditNotes: TenantCreditNotesResource;
+  /** Tenant invoice operations (create, submit, update, delete) */
+  public readonly tenantInvoices: TenantDirectInvoicesResource;
+  /** Incoming invoice operations (list, accept, reject) */
+  public readonly incomingInvoices: TenantIncomingInvoicesResource;
 
   /**
    * Create a new Scell API Client
    *
-   * @param apiKey - Your API key (from dashboard)
+   * @param apiKey - Your API key (sk_live_xxx or sk_test_xxx)
    * @param config - Client configuration
    *
    * @example
@@ -166,12 +196,22 @@ export class ScellApiClient {
 
     this.invoices = new InvoicesResource(this.http);
     this.signatures = new SignaturesResource(this.http);
+    this.subTenants = new SubTenantsResource(this.http);
+    this.fiscal = new FiscalResource(this.http);
+    this.stats = new StatsResource(this.http);
+    this.billing = new BillingResource(this.http);
+    this.creditNotes = new TenantCreditNotesResource(this.http);
+    this.tenantInvoices = new TenantDirectInvoicesResource(this.http);
+    this.incomingInvoices = new TenantIncomingInvoicesResource(this.http);
   }
 }
 
 // Re-export utilities
 export { ScellAuth, ScellWebhooks, withRetry, createRetryWrapper };
 
+// Re-export tenant client
+export { ScellTenantClient };
+
 // Re-export types
 export type { ClientConfig } from './client.js';
 export type { RetryOptions } from './utils/retry.js';

package/src/resources/billing.ts

@@ -0,0 +1,49 @@
+/**
+ * Billing Resource
+ * @packageDocumentation
+ */
+
+import type { HttpClient, RequestOptions } from '../client.js';
+import type { MessageResponse, PaginatedResponse, SingleResponse } from '../types/common.js';
+import type {
+  BillingInvoice,
+  BillingInvoiceListOptions,
+  BillingTopUpConfirmInput,
+  BillingTopUpInput,
+  BillingTransaction,
+  BillingTransactionListOptions,
+  BillingUsage,
+  BillingUsageOptions,
+} from '../types/billing.js';
+
+export class BillingResource {
+  constructor(private readonly http: HttpClient) {}
+
+  async invoices(options: BillingInvoiceListOptions = {}, requestOptions?: RequestOptions): Promise<PaginatedResponse<BillingInvoice>> {
+    return this.http.get<PaginatedResponse<BillingInvoice>>('/tenant/billing/invoices', options as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async showInvoice(invoiceId: string, requestOptions?: RequestOptions): Promise<SingleResponse<BillingInvoice>> {
+    return this.http.get<SingleResponse<BillingInvoice>>(`/tenant/billing/invoices/${invoiceId}`, undefined, requestOptions);
+  }
+
+  async downloadInvoice(invoiceId: string, requestOptions?: RequestOptions): Promise<ArrayBuffer> {
+    return this.http.getRaw(`/tenant/billing/invoices/${invoiceId}/download`, undefined, requestOptions);
+  }
+
+  async usage(options: BillingUsageOptions = {}, requestOptions?: RequestOptions): Promise<SingleResponse<BillingUsage>> {
+    return this.http.get<SingleResponse<BillingUsage>>('/tenant/billing/usage', options as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async topUp(input: BillingTopUpInput, requestOptions?: RequestOptions): Promise<MessageResponse> {
+    return this.http.post<MessageResponse>('/tenant/billing/top-up', input, requestOptions);
+  }
+
+  async confirmTopUp(input: BillingTopUpConfirmInput, requestOptions?: RequestOptions): Promise<MessageResponse> {
+    return this.http.post<MessageResponse>('/tenant/billing/top-up/confirm', input, requestOptions);
+  }
+
+  async transactions(options: BillingTransactionListOptions = {}, requestOptions?: RequestOptions): Promise<PaginatedResponse<BillingTransaction>> {
+    return this.http.get<PaginatedResponse<BillingTransaction>>('/tenant/billing/transactions', options as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+}

package/src/resources/fiscal.ts

@@ -0,0 +1,128 @@
+/**
+ * Fiscal Compliance Resource
+ * @packageDocumentation
+ */
+
+import type { HttpClient, RequestOptions } from '../client.js';
+import type { MessageResponse, PaginatedResponse, SingleResponse } from '../types/common.js';
+import type {
+  FiscalAnchor,
+  FiscalAnchorsOptions,
+  FiscalAttestation,
+  FiscalClosing,
+  FiscalClosingsOptions,
+  FiscalComplianceData,
+  FiscalCreateRuleInput,
+  FiscalDailyClosingInput,
+  FiscalEntriesOptions,
+  FiscalEntry,
+  FiscalExportRulesOptions,
+  FiscalFecExportOptions,
+  FiscalFecExportResult,
+  FiscalForensicExportOptions,
+  FiscalIntegrityHistoryOptions,
+  FiscalIntegrityOptions,
+  FiscalIntegrityReport,
+  FiscalKillSwitchActivateInput,
+  FiscalKillSwitchStatus,
+  FiscalReplayRulesInput,
+  FiscalRule,
+  FiscalRulesOptions,
+  FiscalUpdateRuleInput,
+} from '../types/fiscal.js';
+
+export class FiscalResource {
+  constructor(private readonly http: HttpClient) {}
+
+  async compliance(requestOptions?: RequestOptions): Promise<SingleResponse<FiscalComplianceData>> {
+    return this.http.get<SingleResponse<FiscalComplianceData>>('/tenant/fiscal/compliance', undefined, requestOptions);
+  }
+
+  async integrity(options: FiscalIntegrityOptions = {}, requestOptions?: RequestOptions): Promise<SingleResponse<FiscalIntegrityReport>> {
+    return this.http.get<SingleResponse<FiscalIntegrityReport>>('/tenant/fiscal/integrity', options as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async integrityHistory(options: FiscalIntegrityHistoryOptions = {}, requestOptions?: RequestOptions): Promise<PaginatedResponse<FiscalIntegrityReport>> {
+    return this.http.get<PaginatedResponse<FiscalIntegrityReport>>('/tenant/fiscal/integrity/history', options as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async integrityForDate(date: string, requestOptions?: RequestOptions): Promise<SingleResponse<FiscalIntegrityReport>> {
+    return this.http.get<SingleResponse<FiscalIntegrityReport>>(`/tenant/fiscal/integrity/${date}`, undefined, requestOptions);
+  }
+
+  async closings(options: FiscalClosingsOptions = {}, requestOptions?: RequestOptions): Promise<PaginatedResponse<FiscalClosing>> {
+    return this.http.get<PaginatedResponse<FiscalClosing>>('/tenant/fiscal/closings', options as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async performDailyClosing(input: FiscalDailyClosingInput = {}, requestOptions?: RequestOptions): Promise<MessageResponse> {
+    return this.http.post<MessageResponse>('/tenant/fiscal/closings/daily', input, requestOptions);
+  }
+
+  async fecExport(options: FiscalFecExportOptions, requestOptions?: RequestOptions): Promise<SingleResponse<FiscalFecExportResult>> {
+    return this.http.get<SingleResponse<FiscalFecExportResult>>('/tenant/fiscal/fec', options as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async fecDownload(options: FiscalFecExportOptions, requestOptions?: RequestOptions): Promise<ArrayBuffer> {
+    return this.http.getRaw('/tenant/fiscal/fec', { ...options, download: true } as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async attestation(year: number, requestOptions?: RequestOptions): Promise<SingleResponse<FiscalAttestation>> {
+    return this.http.get<SingleResponse<FiscalAttestation>>(`/tenant/fiscal/attestation/${year}`, undefined, requestOptions);
+  }
+
+  async attestationDownload(year: number, requestOptions?: RequestOptions): Promise<ArrayBuffer> {
+    return this.http.getRaw(`/tenant/fiscal/attestation/${year}/download`, undefined, requestOptions);
+  }
+
+  async entries(options: FiscalEntriesOptions = {}, requestOptions?: RequestOptions): Promise<PaginatedResponse<FiscalEntry>> {
+    return this.http.get<PaginatedResponse<FiscalEntry>>('/tenant/fiscal/entries', options as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async killSwitchStatus(requestOptions?: RequestOptions): Promise<SingleResponse<FiscalKillSwitchStatus>> {
+    return this.http.get<SingleResponse<FiscalKillSwitchStatus>>('/tenant/fiscal/kill-switch/status', undefined, requestOptions);
+  }
+
+  async killSwitchActivate(input: FiscalKillSwitchActivateInput, requestOptions?: RequestOptions): Promise<MessageResponse> {
+    return this.http.post<MessageResponse>('/tenant/fiscal/kill-switch/activate', input, requestOptions);
+  }
+
+  async killSwitchDeactivate(requestOptions?: RequestOptions): Promise<MessageResponse> {
+    return this.http.post<MessageResponse>('/tenant/fiscal/kill-switch/deactivate', undefined, requestOptions);
+  }
+
+  async anchors(options: FiscalAnchorsOptions = {}, requestOptions?: RequestOptions): Promise<PaginatedResponse<FiscalAnchor>> {
+    return this.http.get<PaginatedResponse<FiscalAnchor>>('/tenant/fiscal/anchors', options as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async rules(options: FiscalRulesOptions = {}, requestOptions?: RequestOptions): Promise<PaginatedResponse<FiscalRule>> {
+    return this.http.get<PaginatedResponse<FiscalRule>>('/tenant/fiscal/rules', options as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async ruleDetail(key: string, requestOptions?: RequestOptions): Promise<SingleResponse<FiscalRule>> {
+    return this.http.get<SingleResponse<FiscalRule>>(`/tenant/fiscal/rules/${key}`, undefined, requestOptions);
+  }
+
+  async ruleHistory(key: string, requestOptions?: RequestOptions): Promise<PaginatedResponse<FiscalRule>> {
+    return this.http.get<PaginatedResponse<FiscalRule>>(`/tenant/fiscal/rules/${key}/history`, undefined, requestOptions);
+  }
+
+  async createRule(input: FiscalCreateRuleInput, requestOptions?: RequestOptions): Promise<SingleResponse<FiscalRule>> {
+    return this.http.post<SingleResponse<FiscalRule>>('/tenant/fiscal/rules', input, requestOptions);
+  }
+
+  async updateRule(id: string, input: FiscalUpdateRuleInput, requestOptions?: RequestOptions): Promise<SingleResponse<FiscalRule>> {
+    return this.http.post<SingleResponse<FiscalRule>>(`/tenant/fiscal/rules/${id}`, input, requestOptions);
+  }
+
+  async exportRules(options: FiscalExportRulesOptions, requestOptions?: RequestOptions): Promise<SingleResponse<Record<string, unknown>>> {
+    return this.http.get<SingleResponse<Record<string, unknown>>>('/tenant/fiscal/rules/export', options as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async replayRules(input: FiscalReplayRulesInput, requestOptions?: RequestOptions): Promise<MessageResponse> {
+    return this.http.post<MessageResponse>('/tenant/fiscal/rules/replay', input, requestOptions);
+  }
+
+  async forensicExport(options: FiscalForensicExportOptions, requestOptions?: RequestOptions): Promise<SingleResponse<Record<string, unknown>>> {
+    return this.http.get<SingleResponse<Record<string, unknown>>>('/tenant/fiscal/forensic-export', options as unknown as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+}

package/src/resources/signatures.ts

@@ -11,6 +11,7 @@ import type {
   PaginatedResponse,
   SingleResponse,
 } from '../types/common.js';
+import type { AuditTrailResponse } from '../types/invoices.js';
 import type {
   CreateSignatureInput,
   Signature,
@@ -242,4 +243,36 @@ export class SignaturesResource {
       requestOptions
     );
   }
+
+  /**
+   * Get signature audit trail (JSON)
+   *
+   * Returns the complete history of actions on the signature:
+   * creation, delivery, opening, signing, refusal, etc.
+   *
+   * @param id - Signature UUID
+   * @param requestOptions - Request options
+   * @returns Audit trail entries with integrity validation
+   *
+   * @example
+   * ```typescript
+   * const { data: entries, integrity_valid } = await client.signatures.auditTrail(
+   *   'signature-uuid'
+   * );
+   *
+   * if (integrity_valid) {
+   *   entries.forEach(e => console.log(e.action, e.created_at));
+   * }
+   * ```
+   */
+  async auditTrail(
+    id: string,
+    requestOptions?: RequestOptions
+  ): Promise<AuditTrailResponse> {
+    return this.http.get<AuditTrailResponse>(
+      `/signatures/${id}/audit-trail`,
+      undefined,
+      requestOptions
+    );
+  }
 }

package/src/resources/stats.ts

@@ -0,0 +1,29 @@
+/**
+ * Stats Resource
+ * @packageDocumentation
+ */
+
+import type { HttpClient, RequestOptions } from '../client.js';
+import type { SingleResponse } from '../types/common.js';
+import type {
+  StatsMonthly,
+  StatsMonthlyOptions,
+  StatsOverview,
+  StatsOverviewOptions,
+} from '../types/stats.js';
+
+export class StatsResource {
+  constructor(private readonly http: HttpClient) {}
+
+  async overview(options: StatsOverviewOptions = {}, requestOptions?: RequestOptions): Promise<SingleResponse<StatsOverview>> {
+    return this.http.get<SingleResponse<StatsOverview>>('/tenant/stats/overview', options as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async monthly(options: StatsMonthlyOptions = {}, requestOptions?: RequestOptions): Promise<SingleResponse<StatsMonthly[]>> {
+    return this.http.get<SingleResponse<StatsMonthly[]>>('/tenant/stats/monthly', options as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async subTenantOverview(subTenantId: string, options: StatsOverviewOptions = {}, requestOptions?: RequestOptions): Promise<SingleResponse<StatsOverview>> {
+    return this.http.get<SingleResponse<StatsOverview>>(`/tenant/sub-tenants/${subTenantId}/stats/overview`, options as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+}

package/src/resources/sub-tenants.ts

@@ -0,0 +1,41 @@
+/**
+ * Sub-Tenants Resource
+ * @packageDocumentation
+ */
+
+import type { HttpClient, RequestOptions } from '../client.js';
+import type { MessageResponse, PaginatedResponse, SingleResponse } from '../types/common.js';
+import type {
+  CreateSubTenantInput,
+  SubTenant,
+  SubTenantListOptions,
+  UpdateSubTenantInput,
+} from '../types/sub-tenants.js';
+
+export class SubTenantsResource {
+  constructor(private readonly http: HttpClient) {}
+
+  async list(options: SubTenantListOptions = {}, requestOptions?: RequestOptions): Promise<PaginatedResponse<SubTenant>> {
+    return this.http.get<PaginatedResponse<SubTenant>>('/tenant/sub-tenants', options as Record<string, string | number | boolean | undefined>, requestOptions);
+  }
+
+  async create(input: CreateSubTenantInput, requestOptions?: RequestOptions): Promise<SingleResponse<SubTenant>> {
+    return this.http.post<SingleResponse<SubTenant>>('/tenant/sub-tenants', input, requestOptions);
+  }
+
+  async get(id: string, requestOptions?: RequestOptions): Promise<SingleResponse<SubTenant>> {
+    return this.http.get<SingleResponse<SubTenant>>(`/tenant/sub-tenants/${id}`, undefined, requestOptions);
+  }
+
+  async update(id: string, input: UpdateSubTenantInput, requestOptions?: RequestOptions): Promise<SingleResponse<SubTenant>> {
+    return this.http.patch<SingleResponse<SubTenant>>(`/tenant/sub-tenants/${id}`, input, requestOptions);
+  }
+
+  async delete(id: string, requestOptions?: RequestOptions): Promise<MessageResponse> {
+    return this.http.delete<MessageResponse>(`/tenant/sub-tenants/${id}`, requestOptions);
+  }
+
+  async findByExternalId(externalId: string, requestOptions?: RequestOptions): Promise<SingleResponse<SubTenant>> {
+    return this.http.get<SingleResponse<SubTenant>>(`/tenant/sub-tenants/by-external-id/${externalId}`, undefined, requestOptions);
+  }
+}