@abyss-project/tools 1.0.1 → 1.0.5

package/src/types/interface/api/requests/rcb.request.ts

@@ -1,267 +1,267 @@
-// ──────────────────────────────────────────────
-// RCB API requests.
-// ──────────────────────────────────────────────
-
-import {
-  RcbExtractionMode,
-  RcbFeedbackIssueType,
-  RcbFeedbackStatus,
-  RcbProcessingMode,
-  IRcbBankHint,
-} from '../../models/rcb.dto';
-
-// ─── EXTRACT ─────────────────────────────────
-
-export interface IExtractRcbBody {
-  /** Inline PDF buffer — multipart upload only. SDK helpers wrap this. */
-  pdf?: Buffer | Uint8Array;
-  storage_file_id?: string;
-  mode: RcbExtractionMode;
-  hint?: IRcbBankHint;
-  template_id?: string;
-  template?: Record<string, unknown>;
-  pdf_filename?: string;
-  user_external_id?: string;
-  user_metadata?: Record<string, unknown>;
-  archive?: boolean;
-  force?: boolean;
-  processing?: RcbProcessingMode;
-}
-
-export interface IExtractBulkRcbBody {
-  items: Array<{
-    storage_file_id?: string;
-    pdf_base64?: string;
-    mode: RcbExtractionMode;
-    hint?: IRcbBankHint;
-    template_id?: string;
-    template?: Record<string, unknown>;
-    pdf_filename?: string;
-    user_external_id?: string;
-    user_metadata?: Record<string, unknown>;
-    archive?: boolean;
-    force?: boolean;
-  }>;
-}
-
-// ─── DETECT ──────────────────────────────────
-
-export interface IDetectBulkRcbBody {
-  items: Array<{ pdf_base64: string; pdf_filename?: string }>;
-}
-
-// ─── FILES ───────────────────────────────────
-
-export interface IListFilesRcbQuery {
-  hash?: string;
-  external_id?: string;
-  application_file_id?: string;
-  bank?: string;
-  from?: string;
-  to?: string;
-  limit?: number;
-  offset?: number;
-}
-
-export interface IGetFileRcbParams {
-  fileId: string;
-}
-
-export interface IPatchFileRcbBody {
-  user_external_id?: string | null;
-  user_metadata?: Record<string, unknown> | null;
-}
-
-// ─── EXTRACTIONS ─────────────────────────────
-
-export interface IGetExtractionRcbParams {
-  extractionId: string;
-}
-
-export interface IPatchExtractionRcbBody {
-  tags?: string[] | null;
-  note?: string | null;
-}
-
-export interface ISearchExtractionRecordsRcbQuery {
-  q?: string;
-  amount_min?: number;
-  amount_max?: number;
-  sign?: 'debit' | 'credit';
-  date_from?: string;
-  date_to?: string;
-  sort?: 'date' | 'amount' | 'description';
-  sort_dir?: 'asc' | 'desc';
-  limit?: number;
-  offset?: number;
-}
-
-export interface IExportExtractionRcbQuery {
-  format: 'csv' | 'json';
-  delimiter?: ',' | ';' | '\t';
-}
-
-export interface IAsyncExportExtractionRcbBody {
-  format: 'csv' | 'json';
-  delimiter?: ',' | ';' | '\t';
-}
-
-// ─── TEMPLATES ───────────────────────────────
-
-export interface ICreateTemplateRcbBody {
-  name: string;
-  description?: string;
-  template_json: Record<string, unknown>;
-  comment?: string;
-}
-
-export interface IUpdateTemplateRcbBody {
-  template_json: Record<string, unknown>;
-  comment?: string;
-}
-
-export interface IPatchTemplateMetaRcbBody {
-  name?: string;
-  description?: string | null;
-  is_active?: boolean;
-}
-
-// ─── FEEDBACK ────────────────────────────────
-
-export interface ICreateFeedbackRcbBody {
-  extraction_id: string;
-  issue_type: RcbFeedbackIssueType;
-  description?: string;
-}
-
-export interface IPatchFeedbackRcbBody {
-  status: RcbFeedbackStatus;
-}
-
-export interface IListFeedbackRcbQuery {
-  extraction_id?: string;
-  status?: RcbFeedbackStatus;
-  issue_type?: RcbFeedbackIssueType;
-  limit?: number;
-  offset?: number;
-}
-
-// ─── USAGE ───────────────────────────────────
-
-export interface IListUsageRcbQuery {
-  application_id?: string;
-  event_type?: string;
-  from?: string;
-  to?: string;
-  limit?: number;
-  offset?: number;
-}
-
-export interface ISummaryUsageRcbQuery {
-  from?: string;
-  to?: string;
-}
-
-// ─── WEBHOOK DELIVERIES ─────────────────────
-
-export interface IListWebhookDeliveriesRcbQuery {
-  job_id?: string;
-  event?: string;
-  delivered?: boolean;
-  from?: string;
-  to?: string;
-  limit?: number;
-  offset?: number;
-}
-
-export interface IReplayWebhookDeliveryRcbBody {
-  url?: string;
-  secret?: string;
-}
-
-// ─── SHARE ───────────────────────────────────
-
-export interface IMintShareExtractionRcbBody {
-  expires_in_days?: number;
-}
-
-// ─── ADMIN: CATALOGUE ────────────────────────
-
-export interface IUpsertBankVersionAdminRcbBody {
-  bank: string;
-  version: string;
-  valid_from?: string | null;
-  valid_to?: string | null;
-  detector_json: Record<string, unknown>;
-  parser_kind: string;
-  config_json: Record<string, unknown>;
-  is_active?: boolean;
-}
-
-export interface IToggleBankVersionActiveAdminRcbBody {
-  is_active: boolean;
-}
-
-export interface IUpsertQuotaAdminRcbBody {
-  tier?: string;
-  monthly_extract_cap?: number | null;
-  monthly_extracted_cap?: number | null;
-  monthly_bytes_cap?: number | null;
-  queue_only_above_count?: number | null;
-}
-
-export interface IDetectorReplayAdminRcbBody {
-  detected_bank?: string;
-  from?: string;
-  to?: string;
-  limit?: number;
-}
-
-export interface IListRequestLogAdminRcbQuery {
-  since_ms?: number;
-  status_min?: number;
-  status_max?: number;
-  user_id?: string;
-  path_prefix?: string;
-  limit?: number;
-}
-
-// ─── WEBHOOK SUBSCRIPTIONS ──────────────────
-
-import type { RcbWebhookEvent } from '../../models/rcb.dto';
-
-export interface IRcbWebhookScopeQuery {
-  organization_id?: string;
-  project_id?: string;
-}
-
-export interface IPaginateRcbWebhookQuery extends IRcbWebhookScopeQuery {
-  name?: string;
-  event?: RcbWebhookEvent;
-  isEnabled?: boolean;
-  page?: number;
-  limit?: number;
-}
-
-export interface ICreateRcbWebhookBody {
-  webhookUrl: string;
-  name?: string;
-  description?: string;
-  isEnabled?: boolean;
-  scopes: RcbWebhookEvent[];
-}
-
-export interface IUpdateRcbWebhookBody {
-  webhookUrl?: string;
-  name?: string;
-  description?: string;
-  isEnabled?: boolean;
-  scopes?: RcbWebhookEvent[];
-}
-
-// ─── SHARED FILES (content_share-backed) ────
-
-export interface IListSharedFilesRcbQuery extends IRcbWebhookScopeQuery {
-  limit?: number;
-  offset?: number;
-}
+// ──────────────────────────────────────────────
+// RCB API requests.
+// ──────────────────────────────────────────────
+
+import {
+  RcbExtractionMode,
+  RcbFeedbackIssueType,
+  RcbFeedbackStatus,
+  RcbProcessingMode,
+  IRcbBankHint,
+} from '../../models/rcb.dto';
+
+// ─── EXTRACT ─────────────────────────────────
+
+export interface IExtractRcbBody {
+  /** Inline PDF buffer — multipart upload only. SDK helpers wrap this. */
+  pdf?: Buffer | Uint8Array;
+  storage_file_id?: string;
+  mode: RcbExtractionMode;
+  hint?: IRcbBankHint;
+  template_id?: string;
+  template?: Record<string, unknown>;
+  pdf_filename?: string;
+  user_external_id?: string;
+  user_metadata?: Record<string, unknown>;
+  archive?: boolean;
+  force?: boolean;
+  processing?: RcbProcessingMode;
+}
+
+export interface IExtractBulkRcbBody {
+  items: Array<{
+    storage_file_id?: string;
+    pdf_base64?: string;
+    mode: RcbExtractionMode;
+    hint?: IRcbBankHint;
+    template_id?: string;
+    template?: Record<string, unknown>;
+    pdf_filename?: string;
+    user_external_id?: string;
+    user_metadata?: Record<string, unknown>;
+    archive?: boolean;
+    force?: boolean;
+  }>;
+}
+
+// ─── DETECT ──────────────────────────────────
+
+export interface IDetectBulkRcbBody {
+  items: Array<{ pdf_base64: string; pdf_filename?: string }>;
+}
+
+// ─── FILES ───────────────────────────────────
+
+export interface IListFilesRcbQuery {
+  hash?: string;
+  external_id?: string;
+  application_file_id?: string;
+  bank?: string;
+  from?: string;
+  to?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface IGetFileRcbParams {
+  fileId: string;
+}
+
+export interface IPatchFileRcbBody {
+  user_external_id?: string | null;
+  user_metadata?: Record<string, unknown> | null;
+}
+
+// ─── EXTRACTIONS ─────────────────────────────
+
+export interface IGetExtractionRcbParams {
+  extractionId: string;
+}
+
+export interface IPatchExtractionRcbBody {
+  tags?: string[] | null;
+  note?: string | null;
+}
+
+export interface ISearchExtractionRecordsRcbQuery {
+  q?: string;
+  amount_min?: number;
+  amount_max?: number;
+  sign?: 'debit' | 'credit';
+  date_from?: string;
+  date_to?: string;
+  sort?: 'date' | 'amount' | 'description';
+  sort_dir?: 'asc' | 'desc';
+  limit?: number;
+  offset?: number;
+}
+
+export interface IExportExtractionRcbQuery {
+  format: 'csv' | 'json';
+  delimiter?: ',' | ';' | '\t';
+}
+
+export interface IAsyncExportExtractionRcbBody {
+  format: 'csv' | 'json';
+  delimiter?: ',' | ';' | '\t';
+}
+
+// ─── TEMPLATES ───────────────────────────────
+
+export interface ICreateTemplateRcbBody {
+  name: string;
+  description?: string;
+  template_json: Record<string, unknown>;
+  comment?: string;
+}
+
+export interface IUpdateTemplateRcbBody {
+  template_json: Record<string, unknown>;
+  comment?: string;
+}
+
+export interface IPatchTemplateMetaRcbBody {
+  name?: string;
+  description?: string | null;
+  is_active?: boolean;
+}
+
+// ─── FEEDBACK ────────────────────────────────
+
+export interface ICreateFeedbackRcbBody {
+  extraction_id: string;
+  issue_type: RcbFeedbackIssueType;
+  description?: string;
+}
+
+export interface IPatchFeedbackRcbBody {
+  status: RcbFeedbackStatus;
+}
+
+export interface IListFeedbackRcbQuery {
+  extraction_id?: string;
+  status?: RcbFeedbackStatus;
+  issue_type?: RcbFeedbackIssueType;
+  limit?: number;
+  offset?: number;
+}
+
+// ─── USAGE ───────────────────────────────────
+
+export interface IListUsageRcbQuery {
+  application_id?: string;
+  event_type?: string;
+  from?: string;
+  to?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface ISummaryUsageRcbQuery {
+  from?: string;
+  to?: string;
+}
+
+// ─── WEBHOOK DELIVERIES ─────────────────────
+
+export interface IListWebhookDeliveriesRcbQuery {
+  job_id?: string;
+  event?: string;
+  delivered?: boolean;
+  from?: string;
+  to?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface IReplayWebhookDeliveryRcbBody {
+  url?: string;
+  secret?: string;
+}
+
+// ─── SHARE ───────────────────────────────────
+
+export interface IMintShareExtractionRcbBody {
+  expires_in_days?: number;
+}
+
+// ─── ADMIN: CATALOGUE ────────────────────────
+
+export interface IUpsertBankVersionAdminRcbBody {
+  bank: string;
+  version: string;
+  valid_from?: string | null;
+  valid_to?: string | null;
+  detector_json: Record<string, unknown>;
+  parser_kind: string;
+  config_json: Record<string, unknown>;
+  is_active?: boolean;
+}
+
+export interface IToggleBankVersionActiveAdminRcbBody {
+  is_active: boolean;
+}
+
+export interface IUpsertQuotaAdminRcbBody {
+  tier?: string;
+  monthly_extract_cap?: number | null;
+  monthly_extracted_cap?: number | null;
+  monthly_bytes_cap?: number | null;
+  queue_only_above_count?: number | null;
+}
+
+export interface IDetectorReplayAdminRcbBody {
+  detected_bank?: string;
+  from?: string;
+  to?: string;
+  limit?: number;
+}
+
+export interface IListRequestLogAdminRcbQuery {
+  since_ms?: number;
+  status_min?: number;
+  status_max?: number;
+  user_id?: string;
+  path_prefix?: string;
+  limit?: number;
+}
+
+// ─── WEBHOOK SUBSCRIPTIONS ──────────────────
+
+import type { RcbWebhookEvent } from '../../models/rcb.dto';
+
+export interface IRcbWebhookScopeQuery {
+  organization_id?: string;
+  project_id?: string;
+}
+
+export interface IPaginateRcbWebhookQuery extends IRcbWebhookScopeQuery {
+  name?: string;
+  event?: RcbWebhookEvent;
+  isEnabled?: boolean;
+  page?: number;
+  limit?: number;
+}
+
+export interface ICreateRcbWebhookBody {
+  webhookUrl: string;
+  name?: string;
+  description?: string;
+  isEnabled?: boolean;
+  scopes: RcbWebhookEvent[];
+}
+
+export interface IUpdateRcbWebhookBody {
+  webhookUrl?: string;
+  name?: string;
+  description?: string;
+  isEnabled?: boolean;
+  scopes?: RcbWebhookEvent[];
+}
+
+// ─── SHARED FILES (content_share-backed) ────
+
+export interface IListSharedFilesRcbQuery extends IRcbWebhookScopeQuery {
+  limit?: number;
+  offset?: number;
+}

package/src/types/interface/api/responses/index.ts

@@ -29,3 +29,4 @@ export * from './count.response';
 export * from './recent.response';
 export * from './transfer.response';
 export * from './rcb.response';
+export * from './monitor.response';

package/src/types/interface/api/responses/monitor.response.ts

@@ -0,0 +1,8 @@
+import { IResponse } from '../type-message/response';
+
+export interface IUpMonitorData {
+  upTime: number;
+  processId: string;
+  requestId: string;
+}
+export type IUpMonitorResponse = IResponse<IUpMonitorData>;