@ecodrix/erix-api 1.2.9 → 1.3.1

package/dist/ts/cjs/index.d.cts

@@ -2782,6 +2782,231 @@ declare class WhatsApp extends APIResource {
     }>;
 }
 
+declare class Agency extends APIResource {
+    /**
+     * List all available blueprints.
+     */
+    listBlueprints<T = any>(): Promise<T>;
+    /**
+     * Create a new blueprint configuration ("Gold Standard").
+     */
+    createBlueprint<T = any>(payload: any): Promise<T>;
+    /**
+     * Deploy a blueprint to a specific tenant client code.
+     */
+    deployBlueprint<T = any>(payload: {
+        clientCode: string;
+        blueprintId: string;
+    }): Promise<T>;
+    /**
+     * Get aggregate portfolio statistics for an agency.
+     */
+    getPortfolioStats<T = any>(agencyCode: string): Promise<T>;
+    /**
+     * Get proactive health report for an agency portfolio.
+     */
+    getPortfolioHealth<T = any>(agencyCode: string): Promise<T>;
+    /**
+     * View consumption usage for a specific client code.
+     */
+    getUsage<T = any>(clientCode: string): Promise<T>;
+    /**
+     * List staff members under a specific agency code.
+     */
+    listStaff<T = any>(agencyCode: string): Promise<T>;
+    /**
+     * Create a new staff member for an agency.
+     */
+    createStaff<T = any>(payload: any): Promise<T>;
+}
+
+declare class Clients extends APIResource {
+    /**
+     * List all clients in the ecosystem.
+     */
+    list<T = any>(): Promise<T>;
+    /**
+     * Get client count and auto-generate a unique code.
+     */
+    getCountAndGenerateCode<T = any>(): Promise<T>;
+    /**
+     * Retrieve a single client by client code.
+     */
+    retrieve<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Get API Key for a specific client (Admin Only).
+     */
+    getApiKey<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Generate or rotate API Key for a specific client (Admin Only).
+     */
+    rotateApiKey<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Create a new client identity and provision initial resources.
+     */
+    create<T = any>(payload: {
+        name: string;
+        clientCode: string;
+        business?: any;
+        plan?: any;
+    }): Promise<T>;
+    /**
+     * Get active service configuration for a specific client.
+     */
+    getConfig<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Update active service configuration for a specific client.
+     */
+    updateConfig<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Get decrypted secrets for a specific client.
+     */
+    getSecrets<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Set secrets for a specific client.
+     */
+    updateSecrets<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Completely replace secrets for a specific client.
+     */
+    replaceSecrets<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Partially update secrets for a specific client.
+     */
+    patchSecrets<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Retrieve Data Source connection metadata.
+     */
+    getDataSource<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Configure Data Source metadata.
+     */
+    manageDataSource<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Update Client Identity and perform cascading updates if required.
+     */
+    updateIdentity<T = any>(id: string, payload: any): Promise<T>;
+    /**
+     * Initiate Google Re-authentication for OAuth tokens.
+     */
+    googleReauth<T = any>(clientCode: string, payload?: {
+        authCode?: string;
+    }): Promise<T>;
+    /**
+     * Delete a client and perform cascading cleanup.
+     */
+    delete<T = any>(id: string): Promise<T>;
+}
+declare class Blogs extends APIResource {
+    /**
+     * Retrieve public corporate blogs/news.
+     */
+    list<T = any>(): Promise<T>;
+}
+declare class GlobalLeads extends APIResource {
+    /**
+     * Add a corporate lead capture entry.
+     */
+    add<T = any>(payload: any): Promise<T>;
+}
+declare class Services extends APIResource {
+    clients: Clients;
+    blogs: Blogs;
+    globalLeads: GlobalLeads;
+    constructor(client: any);
+}
+
+declare class EmailConfig extends APIResource {
+    /**
+     * Retrieve current email provider configuration and domain verification statuses.
+     */
+    getConfig<T = any>(): Promise<T>;
+    /**
+     * Switch the active email provider.
+     */
+    switchProvider<T = any>(provider: string): Promise<T>;
+    /**
+     * Provide explicit SMTP credentials and connection preferences.
+     */
+    saveSmtp<T = any>(payload: any): Promise<T>;
+    /**
+     * Initialize a new domain for SES identity verification.
+     */
+    initDomainVerification<T = any>(domain: string): Promise<T>;
+    /**
+     * Confirm "From" details and finalize configuration payload.
+     */
+    saveEmailConfig<T = any>(payload: {
+        fromName: string;
+        fromEmail: string;
+        replyTo?: string;
+    }): Promise<T>;
+    /**
+     * Check status of AWS SES domain validation DNS records.
+     */
+    checkSesVerification<T = any>(): Promise<T>;
+    /**
+     * Remove a verified SES domain identity and clean up local secrets.
+     */
+    removeSesIdentity<T = any>(): Promise<T>;
+    /**
+     * Send a test email to verify infrastructure is correctly bound.
+     */
+    sendTest<T = any>(toEmail: string): Promise<T>;
+    /**
+     * Define customized global email footers, limits, and specific campaign policies.
+     */
+    saveAdvancedConfig<T = any>(payload: any): Promise<T>;
+    /**
+     * Retrieve email configuration health properties including bounce limits metrics.
+     */
+    getHealth<T = any>(): Promise<T>;
+    /**
+     * Upgrade configurations dynamically to add DMARC enforcement records.
+     */
+    fixDmarc<T = any>(): Promise<T>;
+    /**
+     * Discover internally available providers constants metadata.
+     */
+    listProviders<T = any>(): Promise<T>;
+}
+declare class Settings extends APIResource {
+    email: EmailConfig;
+    constructor(client: any);
+}
+
+interface CorsOriginCreatePayload {
+    url: string;
+    name?: string;
+    allowedHeaders?: string[];
+    allowedMethods?: string[];
+}
+interface CorsOriginUpdatePayload {
+    url?: string;
+    name?: string;
+    allowedHeaders?: string[];
+    allowedMethods?: string[];
+    isActive?: boolean;
+}
+declare class Cors extends APIResource {
+    /**
+     * List all dynamic cross-origin policies.
+     */
+    list<T = any>(): Promise<T>;
+    /**
+     * Register a new cross-origin client for the SaaS API network dynamically.
+     */
+    create<T = any>(payload: CorsOriginCreatePayload): Promise<T>;
+    /**
+     * Adjust active states or configurations for an existing origin policy.
+     */
+    update<T = any>(id: string, payload: CorsOriginUpdatePayload): Promise<T>;
+    /**
+     * Irreversibly drop support for a cross-origin client URL policy permanently.
+     */
+    delete<T = any>(id: string): Promise<T>;
+}
+
 /**
  * Configuration options for the Ecodrix client.
  *
@@ -2801,6 +3026,11 @@ interface EcodrixOptions {
      * @example "ERIX_CLNT_JHBJHF"
      */
     clientCode?: string;
+    /**
+     * Optional Core API Key for deep system-level bypasses.
+     * Only used by elevated internal SaaS modules like Nirvisham.
+     */
+    coreApiKey?: string;
     /**
      * @internal Override Socket.io URL for testing/staging.
      * Not documented — internal use only.
@@ -2872,6 +3102,14 @@ declare class Ecodrix {
     readonly health: Health;
     /** Background job queue management. */
     readonly queue: Queue;
+    /** White-Label Agency administration. */
+    readonly agency: Agency;
+    /** Multi-tenant Identity & Lifecycle services. */
+    readonly services: Services;
+    /** Tenant environment and provider settings. */
+    readonly settings: Settings;
+    /** Dynamic Cross-Origin Resource Sharing network policies. */
+    readonly cors: Cors;
     constructor(options: EcodrixOptions);
     /**
      * Join a specific real-time room (e.g., a conversation or a lead).
@@ -2953,4 +3191,4 @@ declare class Ecodrix {
     request<T = any>(method: Method, path: string, data?: any, params?: any): Promise<T>;
 }
 
-export { APIError, Activities, Analytics, type AnalyticsParams, type AnalyticsRange, type AssignEventPayload, AuthenticationError, AutomationDashboard, type AutomationRulePayload, Automations, Broadcasts, CRM, type CallbackLog, type CampaignResult, Campaigns, type ChatMediaMeta, type ClientHealth, Conversations, type CreateBroadcastParams, type CreateLeadParams, type CreateMeetingParams, type CreatePipelineParams, type CreateTemplateDTO, Ecodrix, EcodrixError, type EcodrixOptions, Email, EmailResource, type EmailTemplate, Emails, type EventDefinition, type EventLog, EventsResource, type FieldManifest, type FieldType, Files, Folders, Health, type JobStats, type JobStatus, type LeadSource, type LeadStatus, Leads, type ListLeadsParams, type ListParams, type LogActivityParams, type LogCallParams, type LogFilter, type LogPaginationQuery, type LogResponse, Logs, Marketing, Media, MediaResource, Meetings, Messages, Notes, Notifications, Payments, type PipelineStageParams, Pipelines, Queue, RateLimitError, type ResourceManifest, Scoring, type ScoringConfig, type SendCampaignParams, type SendCampaignPayload, type SendMessageParams, type SendTemplateParams, type SendTemplatePayload, Sequences, Storage, type SystemHealth, type TemplateMapping, type TemplatePreviewResponse, Templates, type TriggerPayload, type TriggerResponse, type UpdateMeetingParams, type UploadOptions, type UpsertLeadParams, WebhookSignatureError, Webhooks, WhatsApp, WhatsAppMarketing, Ecodrix as default };
+export { APIError, Activities, Agency, Analytics, type AnalyticsParams, type AnalyticsRange, type AssignEventPayload, AuthenticationError, AutomationDashboard, type AutomationRulePayload, Automations, Blogs, Broadcasts, CRM, type CallbackLog, type CampaignResult, Campaigns, type ChatMediaMeta, type ClientHealth, Clients, Conversations, Cors, type CorsOriginCreatePayload, type CorsOriginUpdatePayload, type CreateBroadcastParams, type CreateLeadParams, type CreateMeetingParams, type CreatePipelineParams, type CreateTemplateDTO, Ecodrix, EcodrixError, type EcodrixOptions, Email, EmailConfig, EmailResource, type EmailTemplate, Emails, type EventDefinition, type EventLog, EventsResource, type FieldManifest, type FieldType, Files, Folders, GlobalLeads, Health, type JobStats, type JobStatus, type LeadSource, type LeadStatus, Leads, type ListLeadsParams, type ListParams, type LogActivityParams, type LogCallParams, type LogFilter, type LogPaginationQuery, type LogResponse, Logs, Marketing, Media, MediaResource, Meetings, Messages, Notes, Notifications, Payments, type PipelineStageParams, Pipelines, Queue, RateLimitError, type ResourceManifest, Scoring, type ScoringConfig, type SendCampaignParams, type SendCampaignPayload, type SendMessageParams, type SendTemplateParams, type SendTemplatePayload, Sequences, Services, Settings, Storage, type SystemHealth, type TemplateMapping, type TemplatePreviewResponse, Templates, type TriggerPayload, type TriggerResponse, type UpdateMeetingParams, type UploadOptions, type UpsertLeadParams, WebhookSignatureError, Webhooks, WhatsApp, WhatsAppMarketing, Ecodrix as default };

package/dist/ts/esm/index.d.ts

@@ -2782,6 +2782,231 @@ declare class WhatsApp extends APIResource {
     }>;
 }
 
+declare class Agency extends APIResource {
+    /**
+     * List all available blueprints.
+     */
+    listBlueprints<T = any>(): Promise<T>;
+    /**
+     * Create a new blueprint configuration ("Gold Standard").
+     */
+    createBlueprint<T = any>(payload: any): Promise<T>;
+    /**
+     * Deploy a blueprint to a specific tenant client code.
+     */
+    deployBlueprint<T = any>(payload: {
+        clientCode: string;
+        blueprintId: string;
+    }): Promise<T>;
+    /**
+     * Get aggregate portfolio statistics for an agency.
+     */
+    getPortfolioStats<T = any>(agencyCode: string): Promise<T>;
+    /**
+     * Get proactive health report for an agency portfolio.
+     */
+    getPortfolioHealth<T = any>(agencyCode: string): Promise<T>;
+    /**
+     * View consumption usage for a specific client code.
+     */
+    getUsage<T = any>(clientCode: string): Promise<T>;
+    /**
+     * List staff members under a specific agency code.
+     */
+    listStaff<T = any>(agencyCode: string): Promise<T>;
+    /**
+     * Create a new staff member for an agency.
+     */
+    createStaff<T = any>(payload: any): Promise<T>;
+}
+
+declare class Clients extends APIResource {
+    /**
+     * List all clients in the ecosystem.
+     */
+    list<T = any>(): Promise<T>;
+    /**
+     * Get client count and auto-generate a unique code.
+     */
+    getCountAndGenerateCode<T = any>(): Promise<T>;
+    /**
+     * Retrieve a single client by client code.
+     */
+    retrieve<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Get API Key for a specific client (Admin Only).
+     */
+    getApiKey<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Generate or rotate API Key for a specific client (Admin Only).
+     */
+    rotateApiKey<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Create a new client identity and provision initial resources.
+     */
+    create<T = any>(payload: {
+        name: string;
+        clientCode: string;
+        business?: any;
+        plan?: any;
+    }): Promise<T>;
+    /**
+     * Get active service configuration for a specific client.
+     */
+    getConfig<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Update active service configuration for a specific client.
+     */
+    updateConfig<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Get decrypted secrets for a specific client.
+     */
+    getSecrets<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Set secrets for a specific client.
+     */
+    updateSecrets<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Completely replace secrets for a specific client.
+     */
+    replaceSecrets<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Partially update secrets for a specific client.
+     */
+    patchSecrets<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Retrieve Data Source connection metadata.
+     */
+    getDataSource<T = any>(clientCode: string): Promise<T>;
+    /**
+     * Configure Data Source metadata.
+     */
+    manageDataSource<T = any>(clientCode: string, payload: any): Promise<T>;
+    /**
+     * Update Client Identity and perform cascading updates if required.
+     */
+    updateIdentity<T = any>(id: string, payload: any): Promise<T>;
+    /**
+     * Initiate Google Re-authentication for OAuth tokens.
+     */
+    googleReauth<T = any>(clientCode: string, payload?: {
+        authCode?: string;
+    }): Promise<T>;
+    /**
+     * Delete a client and perform cascading cleanup.
+     */
+    delete<T = any>(id: string): Promise<T>;
+}
+declare class Blogs extends APIResource {
+    /**
+     * Retrieve public corporate blogs/news.
+     */
+    list<T = any>(): Promise<T>;
+}
+declare class GlobalLeads extends APIResource {
+    /**
+     * Add a corporate lead capture entry.
+     */
+    add<T = any>(payload: any): Promise<T>;
+}
+declare class Services extends APIResource {
+    clients: Clients;
+    blogs: Blogs;
+    globalLeads: GlobalLeads;
+    constructor(client: any);
+}
+
+declare class EmailConfig extends APIResource {
+    /**
+     * Retrieve current email provider configuration and domain verification statuses.
+     */
+    getConfig<T = any>(): Promise<T>;
+    /**
+     * Switch the active email provider.
+     */
+    switchProvider<T = any>(provider: string): Promise<T>;
+    /**
+     * Provide explicit SMTP credentials and connection preferences.
+     */
+    saveSmtp<T = any>(payload: any): Promise<T>;
+    /**
+     * Initialize a new domain for SES identity verification.
+     */
+    initDomainVerification<T = any>(domain: string): Promise<T>;
+    /**
+     * Confirm "From" details and finalize configuration payload.
+     */
+    saveEmailConfig<T = any>(payload: {
+        fromName: string;
+        fromEmail: string;
+        replyTo?: string;
+    }): Promise<T>;
+    /**
+     * Check status of AWS SES domain validation DNS records.
+     */
+    checkSesVerification<T = any>(): Promise<T>;
+    /**
+     * Remove a verified SES domain identity and clean up local secrets.
+     */
+    removeSesIdentity<T = any>(): Promise<T>;
+    /**
+     * Send a test email to verify infrastructure is correctly bound.
+     */
+    sendTest<T = any>(toEmail: string): Promise<T>;
+    /**
+     * Define customized global email footers, limits, and specific campaign policies.
+     */
+    saveAdvancedConfig<T = any>(payload: any): Promise<T>;
+    /**
+     * Retrieve email configuration health properties including bounce limits metrics.
+     */
+    getHealth<T = any>(): Promise<T>;
+    /**
+     * Upgrade configurations dynamically to add DMARC enforcement records.
+     */
+    fixDmarc<T = any>(): Promise<T>;
+    /**
+     * Discover internally available providers constants metadata.
+     */
+    listProviders<T = any>(): Promise<T>;
+}
+declare class Settings extends APIResource {
+    email: EmailConfig;
+    constructor(client: any);
+}
+
+interface CorsOriginCreatePayload {
+    url: string;
+    name?: string;
+    allowedHeaders?: string[];
+    allowedMethods?: string[];
+}
+interface CorsOriginUpdatePayload {
+    url?: string;
+    name?: string;
+    allowedHeaders?: string[];
+    allowedMethods?: string[];
+    isActive?: boolean;
+}
+declare class Cors extends APIResource {
+    /**
+     * List all dynamic cross-origin policies.
+     */
+    list<T = any>(): Promise<T>;
+    /**
+     * Register a new cross-origin client for the SaaS API network dynamically.
+     */
+    create<T = any>(payload: CorsOriginCreatePayload): Promise<T>;
+    /**
+     * Adjust active states or configurations for an existing origin policy.
+     */
+    update<T = any>(id: string, payload: CorsOriginUpdatePayload): Promise<T>;
+    /**
+     * Irreversibly drop support for a cross-origin client URL policy permanently.
+     */
+    delete<T = any>(id: string): Promise<T>;
+}
+
 /**
  * Configuration options for the Ecodrix client.
  *
@@ -2801,6 +3026,11 @@ interface EcodrixOptions {
      * @example "ERIX_CLNT_JHBJHF"
      */
     clientCode?: string;
+    /**
+     * Optional Core API Key for deep system-level bypasses.
+     * Only used by elevated internal SaaS modules like Nirvisham.
+     */
+    coreApiKey?: string;
     /**
      * @internal Override Socket.io URL for testing/staging.
      * Not documented — internal use only.
@@ -2872,6 +3102,14 @@ declare class Ecodrix {
     readonly health: Health;
     /** Background job queue management. */
     readonly queue: Queue;
+    /** White-Label Agency administration. */
+    readonly agency: Agency;
+    /** Multi-tenant Identity & Lifecycle services. */
+    readonly services: Services;
+    /** Tenant environment and provider settings. */
+    readonly settings: Settings;
+    /** Dynamic Cross-Origin Resource Sharing network policies. */
+    readonly cors: Cors;
     constructor(options: EcodrixOptions);
     /**
      * Join a specific real-time room (e.g., a conversation or a lead).
@@ -2953,4 +3191,4 @@ declare class Ecodrix {
     request<T = any>(method: Method, path: string, data?: any, params?: any): Promise<T>;
 }
 
-export { APIError, Activities, Analytics, type AnalyticsParams, type AnalyticsRange, type AssignEventPayload, AuthenticationError, AutomationDashboard, type AutomationRulePayload, Automations, Broadcasts, CRM, type CallbackLog, type CampaignResult, Campaigns, type ChatMediaMeta, type ClientHealth, Conversations, type CreateBroadcastParams, type CreateLeadParams, type CreateMeetingParams, type CreatePipelineParams, type CreateTemplateDTO, Ecodrix, EcodrixError, type EcodrixOptions, Email, EmailResource, type EmailTemplate, Emails, type EventDefinition, type EventLog, EventsResource, type FieldManifest, type FieldType, Files, Folders, Health, type JobStats, type JobStatus, type LeadSource, type LeadStatus, Leads, type ListLeadsParams, type ListParams, type LogActivityParams, type LogCallParams, type LogFilter, type LogPaginationQuery, type LogResponse, Logs, Marketing, Media, MediaResource, Meetings, Messages, Notes, Notifications, Payments, type PipelineStageParams, Pipelines, Queue, RateLimitError, type ResourceManifest, Scoring, type ScoringConfig, type SendCampaignParams, type SendCampaignPayload, type SendMessageParams, type SendTemplateParams, type SendTemplatePayload, Sequences, Storage, type SystemHealth, type TemplateMapping, type TemplatePreviewResponse, Templates, type TriggerPayload, type TriggerResponse, type UpdateMeetingParams, type UploadOptions, type UpsertLeadParams, WebhookSignatureError, Webhooks, WhatsApp, WhatsAppMarketing, Ecodrix as default };
+export { APIError, Activities, Agency, Analytics, type AnalyticsParams, type AnalyticsRange, type AssignEventPayload, AuthenticationError, AutomationDashboard, type AutomationRulePayload, Automations, Blogs, Broadcasts, CRM, type CallbackLog, type CampaignResult, Campaigns, type ChatMediaMeta, type ClientHealth, Clients, Conversations, Cors, type CorsOriginCreatePayload, type CorsOriginUpdatePayload, type CreateBroadcastParams, type CreateLeadParams, type CreateMeetingParams, type CreatePipelineParams, type CreateTemplateDTO, Ecodrix, EcodrixError, type EcodrixOptions, Email, EmailConfig, EmailResource, type EmailTemplate, Emails, type EventDefinition, type EventLog, EventsResource, type FieldManifest, type FieldType, Files, Folders, GlobalLeads, Health, type JobStats, type JobStatus, type LeadSource, type LeadStatus, Leads, type ListLeadsParams, type ListParams, type LogActivityParams, type LogCallParams, type LogFilter, type LogPaginationQuery, type LogResponse, Logs, Marketing, Media, MediaResource, Meetings, Messages, Notes, Notifications, Payments, type PipelineStageParams, Pipelines, Queue, RateLimitError, type ResourceManifest, Scoring, type ScoringConfig, type SendCampaignParams, type SendCampaignPayload, type SendMessageParams, type SendTemplateParams, type SendTemplatePayload, Sequences, Services, Settings, Storage, type SystemHealth, type TemplateMapping, type TemplatePreviewResponse, Templates, type TriggerPayload, type TriggerResponse, type UpdateMeetingParams, type UploadOptions, type UpsertLeadParams, WebhookSignatureError, Webhooks, WhatsApp, WhatsAppMarketing, Ecodrix as default };