@djangocfg/api 1.2.19 → 1.2.21

package/src/cfg/generated/cfg__rq__rq_monitoring/client.ts

@@ -0,0 +1,45 @@
+import * as Models from "./models";
+
+
+/**
+ * API endpoints for RQ Monitoring.
+ */
+export class CfgRqMonitoring {
+  private client: any;
+
+  constructor(client: any) {
+    this.client = client;
+  }
+
+  /**
+   * Get RQ configuration
+   * 
+   * Returns current RQ configuration from django-cfg.
+   */
+  async rqMonitorConfigRetrieve(): Promise<Models.RQConfig> {
+    const response = await this.client.request('GET', "/cfg/rq/monitor/config/");
+    return response;
+  }
+
+  /**
+   * Health check
+   * 
+   * Returns RQ cluster health status including worker count and queue
+   * status.
+   */
+  async rqMonitorHealthRetrieve(): Promise<Models.HealthCheck> {
+    const response = await this.client.request('GET', "/cfg/rq/monitor/health/");
+    return response;
+  }
+
+  /**
+   * Prometheus metrics
+   * 
+   * Returns Prometheus metrics for RQ queues and workers.
+   */
+  async rqMonitorMetricsRetrieve(): Promise<any> {
+    const response = await this.client.request('GET', "/cfg/rq/monitor/metrics/");
+    return response;
+  }
+
+}

package/src/cfg/generated/cfg__rq__rq_monitoring/models.ts

@@ -0,0 +1,39 @@
+/**
+ * RQ configuration serializer. Returns current RQ configuration from
+ * django-cfg.
+ * 
+ * Response model (includes read-only fields).
+ */
+export interface RQConfig {
+  /** RQ enabled status */
+  enabled: boolean;
+  /** Configured queues */
+  queues: Record<string, any>;
+  /** Async mode enabled */
+  async_mode?: boolean;
+  /** Show admin link */
+  show_admin_link?: boolean;
+  /** Prometheus metrics enabled */
+  prometheus_enabled?: boolean;
+  /** API token is configured */
+  api_token_configured?: boolean;
+  /** Scheduled tasks from django-cfg config */
+  schedules?: Array<string>;
+}
+
+/**
+ * Health check response.
+ * 
+ * Response model (includes read-only fields).
+ */
+export interface HealthCheck {
+  /** Health status: healthy or unhealthy */
+  status: string;
+  /** Configured wrapper URL */
+  wrapper_url: string;
+  /** Whether API key is configured */
+  has_api_key: boolean;
+  /** Current timestamp */
+  timestamp: string;
+}
+

package/src/cfg/generated/cfg__rq__rq_queues/client.ts

@@ -0,0 +1,78 @@
+import * as Models from "./models";
+
+
+/**
+ * API endpoints for RQ Queues.
+ */
+export class CfgRqQueues {
+  private client: any;
+
+  constructor(client: any) {
+    this.client = client;
+  }
+
+  async list(name?: string): Promise<any>;
+  async list(params?: { name?: string }): Promise<any>;
+
+  /**
+   * List all queues
+   * 
+   * Returns list of all configured RQ queues with statistics. Supports
+   * filtering by queue name.
+   */
+  async list(...args: any[]): Promise<any> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { name: args[0] };
+    }
+    const response = await this.client.request('GET', "/cfg/rq/queues/", { params });
+    return response;
+  }
+
+  /**
+   * Get queue details
+   * 
+   * Returns detailed information about a specific queue.
+   */
+  async retrieve(id: string): Promise<Models.QueueDetail> {
+    const response = await this.client.request('GET', `/cfg/rq/queues/${id}/`);
+    return response;
+  }
+
+  /**
+   * Empty queue
+   * 
+   * Removes all jobs from the specified queue.
+   */
+  async emptyCreate(id: string): Promise<any> {
+    const response = await this.client.request('POST', `/cfg/rq/queues/${id}/empty/`);
+    return response;
+  }
+
+  async jobsRetrieve(id: string, limit?: number, offset?: number): Promise<any>;
+  async jobsRetrieve(id: string, params?: { limit?: number; offset?: number }): Promise<any>;
+
+  /**
+   * Get queue jobs
+   * 
+   * Returns list of job IDs in the queue.
+   */
+  async jobsRetrieve(...args: any[]): Promise<any> {
+    const id = args[0];
+    const isParamsObject = args.length === 2 && typeof args[1] === 'object' && args[1] !== null && !Array.isArray(args[1]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[1];
+    } else {
+      params = { limit: args[1], offset: args[2] };
+    }
+    const response = await this.client.request('GET', `/cfg/rq/queues/${id}/jobs/`, { params });
+    return response;
+  }
+
+}

package/src/cfg/generated/cfg__rq__rq_queues/index.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * as Models from "./models";

package/src/cfg/generated/cfg__rq__rq_queues/models.ts

@@ -0,0 +1,33 @@
+/**
+ * Detailed queue information serializer. Provides comprehensive queue
+ * statistics and metadata.
+ * 
+ * Response model (includes read-only fields).
+ */
+export interface QueueDetail {
+  /** Queue name */
+  name: string;
+  /** Total jobs in queue */
+  count: number;
+  /** Jobs waiting to be processed */
+  queued_jobs?: number;
+  /** Jobs currently being processed */
+  started_jobs?: number;
+  /** Completed jobs */
+  finished_jobs?: number;
+  /** Failed jobs */
+  failed_jobs?: number;
+  /** Deferred jobs */
+  deferred_jobs?: number;
+  /** Scheduled jobs */
+  scheduled_jobs?: number;
+  /** Number of workers for this queue */
+  workers?: number;
+  /** Timestamp of oldest job in queue */
+  oldest_job_timestamp?: string | null;
+  /** Redis connection parameters */
+  connection_kwargs?: Record<string, any>;
+  /** Queue is in async mode */
+  is_async?: boolean;
+}
+

package/src/cfg/generated/cfg__rq__rq_registries/client.ts

@@ -0,0 +1,161 @@
+import * as Models from "./models";
+
+
+/**
+ * API endpoints for RQ Registries.
+ */
+export class CfgRqRegistries {
+  private client: any;
+
+  constructor(client: any) {
+    this.client = client;
+  }
+
+  async rqJobsRegistriesDeferredList(queue?: string): Promise<any>;
+  async rqJobsRegistriesDeferredList(params?: { queue?: string }): Promise<any>;
+
+  /**
+   * List deferred jobs
+   * 
+   * Returns list of all deferred jobs from deferred job registry.
+   */
+  async rqJobsRegistriesDeferredList(...args: any[]): Promise<any> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { queue: args[0] };
+    }
+    const response = await this.client.request('GET', "/cfg/rq/jobs/registries/deferred/", { params });
+    return response;
+  }
+
+  async rqJobsRegistriesFailedList(queue?: string): Promise<any>;
+  async rqJobsRegistriesFailedList(params?: { queue?: string }): Promise<any>;
+
+  /**
+   * List failed jobs
+   * 
+   * Returns list of all failed jobs from failed job registry.
+   */
+  async rqJobsRegistriesFailedList(...args: any[]): Promise<any> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { queue: args[0] };
+    }
+    const response = await this.client.request('GET', "/cfg/rq/jobs/registries/failed/", { params });
+    return response;
+  }
+
+  async rqJobsRegistriesFailedClearCreate(queue: string): Promise<Models.JobActionResponse>;
+  async rqJobsRegistriesFailedClearCreate(params: { queue: string }): Promise<Models.JobActionResponse>;
+
+  /**
+   * Clear failed jobs registry
+   * 
+   * Removes all jobs from the failed job registry.
+   */
+  async rqJobsRegistriesFailedClearCreate(...args: any[]): Promise<Models.JobActionResponse> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { queue: args[0] };
+    }
+    const response = await this.client.request('POST', "/cfg/rq/jobs/registries/failed/clear/", { params });
+    return response;
+  }
+
+  async rqJobsRegistriesFailedRequeueAllCreate(queue: string): Promise<Models.JobActionResponse>;
+  async rqJobsRegistriesFailedRequeueAllCreate(params: { queue: string }): Promise<Models.JobActionResponse>;
+
+  /**
+   * Requeue all failed jobs
+   * 
+   * Requeues all failed jobs in the failed job registry.
+   */
+  async rqJobsRegistriesFailedRequeueAllCreate(...args: any[]): Promise<Models.JobActionResponse> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { queue: args[0] };
+    }
+    const response = await this.client.request('POST', "/cfg/rq/jobs/registries/failed/requeue-all/", { params });
+    return response;
+  }
+
+  async rqJobsRegistriesFinishedList(queue?: string): Promise<any>;
+  async rqJobsRegistriesFinishedList(params?: { queue?: string }): Promise<any>;
+
+  /**
+   * List finished jobs
+   * 
+   * Returns list of all finished jobs from finished job registry.
+   */
+  async rqJobsRegistriesFinishedList(...args: any[]): Promise<any> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { queue: args[0] };
+    }
+    const response = await this.client.request('GET', "/cfg/rq/jobs/registries/finished/", { params });
+    return response;
+  }
+
+  async rqJobsRegistriesFinishedClearCreate(queue: string): Promise<Models.JobActionResponse>;
+  async rqJobsRegistriesFinishedClearCreate(params: { queue: string }): Promise<Models.JobActionResponse>;
+
+  /**
+   * Clear finished jobs registry
+   * 
+   * Removes all jobs from the finished job registry.
+   */
+  async rqJobsRegistriesFinishedClearCreate(...args: any[]): Promise<Models.JobActionResponse> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { queue: args[0] };
+    }
+    const response = await this.client.request('POST', "/cfg/rq/jobs/registries/finished/clear/", { params });
+    return response;
+  }
+
+  async rqJobsRegistriesStartedList(queue?: string): Promise<any>;
+  async rqJobsRegistriesStartedList(params?: { queue?: string }): Promise<any>;
+
+  /**
+   * List started jobs
+   * 
+   * Returns list of all currently running jobs from started job registry.
+   */
+  async rqJobsRegistriesStartedList(...args: any[]): Promise<any> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { queue: args[0] };
+    }
+    const response = await this.client.request('GET', "/cfg/rq/jobs/registries/started/", { params });
+    return response;
+  }
+
+}

package/src/cfg/generated/cfg__rq__rq_registries/index.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * as Models from "./models";

package/src/cfg/generated/cfg__rq__rq_registries/models.ts

@@ -0,0 +1,17 @@
+/**
+ * Job action response serializer. Used for job management actions (requeue,
+ * delete, etc.).
+ * 
+ * Response model (includes read-only fields).
+ */
+export interface JobActionResponse {
+  /** Action success status */
+  success: boolean;
+  /** Action result message */
+  message: string;
+  /** Job ID */
+  job_id: string;
+  /** Action performed (requeue/delete/cancel) */
+  action: string;
+}
+

package/src/cfg/generated/cfg__rq__rq_schedules/client.ts

@@ -0,0 +1,91 @@
+import * as Models from "./models";
+
+
+/**
+ * API endpoints for RQ Schedules.
+ */
+export class CfgRqSchedules {
+  private client: any;
+
+  constructor(client: any) {
+    this.client = client;
+  }
+
+  async list(queue?: string): Promise<any>;
+  async list(params?: { queue?: string }): Promise<any>;
+
+  /**
+   * List scheduled jobs
+   * 
+   * Returns list of all scheduled jobs across all queues.
+   */
+  async list(...args: any[]): Promise<any> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { queue: args[0] };
+    }
+    const response = await this.client.request('GET', "/cfg/rq/schedules/", { params });
+    return response;
+  }
+
+  /**
+   * Create scheduled job
+   * 
+   * Schedule a job to run at specific time, interval, or cron schedule.
+   */
+  async create(data: Models.ScheduleCreateRequest): Promise<Models.ScheduleActionResponse> {
+    const response = await this.client.request('POST', "/cfg/rq/schedules/", { body: data });
+    return response;
+  }
+
+  async retrieve(id: string, pk: string, queue?: string): Promise<Models.ScheduledJob>;
+  async retrieve(id: string, pk: string, params?: { queue?: string }): Promise<Models.ScheduledJob>;
+
+  /**
+   * Get scheduled job details
+   * 
+   * Returns detailed information about a specific scheduled job.
+   */
+  async retrieve(...args: any[]): Promise<Models.ScheduledJob> {
+    const id = args[0];
+    const pk = args[1];
+    const isParamsObject = args.length === 3 && typeof args[2] === 'object' && args[2] !== null && !Array.isArray(args[2]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[2];
+    } else {
+      params = { queue: args[2] };
+    }
+    const response = await this.client.request('GET', `/cfg/rq/schedules/${id}/`, { params });
+    return response;
+  }
+
+  async destroy(id: string, pk: string, queue?: string): Promise<Models.ScheduleActionResponse>;
+  async destroy(id: string, pk: string, params?: { queue?: string }): Promise<Models.ScheduleActionResponse>;
+
+  /**
+   * Cancel scheduled job
+   * 
+   * Cancel a scheduled job by ID.
+   */
+  async destroy(...args: any[]): Promise<Models.ScheduleActionResponse> {
+    const id = args[0];
+    const pk = args[1];
+    const isParamsObject = args.length === 3 && typeof args[2] === 'object' && args[2] !== null && !Array.isArray(args[2]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[2];
+    } else {
+      params = { queue: args[2] };
+    }
+    const response = await this.client.request('DELETE', `/cfg/rq/schedules/${id}/`, { params });
+    return response;
+  }
+
+}

package/src/cfg/generated/cfg__rq__rq_schedules/index.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * as Models from "./models";

package/src/cfg/generated/cfg__rq__rq_schedules/models.ts

@@ -0,0 +1,84 @@
+/**
+ * Serializer for creating a scheduled job. Supports three scheduling methods:
+ * 1. scheduled_time: Schedule job at specific time 2. interval: Schedule job
+ * to repeat at intervals 3. cron: Schedule job with cron expression
+ * 
+ * Request model (no read-only fields).
+ */
+export interface ScheduleCreateRequest {
+  /** Function path (e.g., 'myapp.tasks.my_task') */
+  func: string;
+  /** Function arguments */
+  args?: Array<string>;
+  /** Function keyword arguments */
+  kwargs?: Record<string, any>;
+  /** Queue name to schedule job in */
+  queue_name?: string;
+  /** Schedule job at specific time (ISO 8601) */
+  scheduled_time?: string | null;
+  /** Schedule job to repeat every N seconds */
+  interval?: number | null;
+  /** Cron expression (e.g., '0 0 * * *' for daily at midnight) */
+  cron?: string | null;
+  /** Job timeout in seconds */
+  timeout?: number | null;
+  /** Result TTL in seconds */
+  result_ttl?: number | null;
+  /** Number of times to repeat (None = infinite) */
+  repeat?: number | null;
+  /** Job description */
+  description?: string | null;
+}
+
+/**
+ * Response serializer for schedule actions (create/delete).
+ * 
+ * Response model (includes read-only fields).
+ */
+export interface ScheduleActionResponse {
+  /** Action success status */
+  success: boolean;
+  /** Action result message */
+  message: string;
+  /** Job ID (for create action) */
+  job_id?: string | null;
+  /** Action performed (create/delete/cancel) */
+  action: string;
+}
+
+/**
+ * Serializer for scheduled job information.
+ * 
+ * Response model (includes read-only fields).
+ */
+export interface ScheduledJob {
+  /** Job ID */
+  id: string;
+  /** Function path */
+  func: string;
+  /** Function arguments */
+  args?: Array<string>;
+  /** Function keyword arguments */
+  kwargs?: Record<string, any>;
+  /** Queue name */
+  queue_name: string;
+  /** Next scheduled time */
+  scheduled_time?: string | null;
+  /** Repeat interval in seconds */
+  interval?: number | null;
+  /** Cron expression */
+  cron?: string | null;
+  /** Job timeout in seconds */
+  timeout?: number | null;
+  /** Result TTL in seconds */
+  result_ttl?: number | null;
+  /** Times to repeat (None = infinite) */
+  repeat?: number | null;
+  /** Job description */
+  description?: string | null;
+  /** Job creation time */
+  created_at?: string | null;
+  /** Job metadata */
+  meta?: Record<string, any>;
+}
+

package/src/cfg/generated/cfg__rq__rq_testing/client.ts

@@ -0,0 +1,96 @@
+import * as Models from "./models";
+
+
+/**
+ * API endpoints for RQ Testing.
+ */
+export class CfgRqTesting {
+  private client: any;
+
+  constructor(client: any) {
+    this.client = client;
+  }
+
+  /**
+   * List test scenarios
+   * 
+   * Returns list of all available test scenarios with metadata.
+   */
+  async list(): Promise<any> {
+    const response = await this.client.request('GET', "/cfg/rq/testing/");
+    return response;
+  }
+
+  async cleanupDestroy(delete_demo_jobs_only?: boolean, queue?: string, registries?: string): Promise<Models.TestingActionResponse>;
+  async cleanupDestroy(params?: { delete_demo_jobs_only?: boolean; queue?: string; registries?: string }): Promise<Models.TestingActionResponse>;
+
+  /**
+   * Cleanup test jobs
+   * 
+   * Clean demo jobs from registries.
+   */
+  async cleanupDestroy(...args: any[]): Promise<Models.TestingActionResponse> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { delete_demo_jobs_only: args[0], queue: args[1], registries: args[2] };
+    }
+    const response = await this.client.request('DELETE', "/cfg/rq/testing/cleanup/", { params });
+    return response;
+  }
+
+  async resultsRetrieve(queue?: string, scenario?: string): Promise<any>;
+  async resultsRetrieve(params?: { queue?: string; scenario?: string }): Promise<any>;
+
+  /**
+   * Get test results
+   * 
+   * Get aggregated results of test jobs execution.
+   */
+  async resultsRetrieve(...args: any[]): Promise<any> {
+    const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
+    
+    let params;
+    if (isParamsObject) {
+      params = args[0];
+    } else {
+      params = { queue: args[0], scenario: args[1] };
+    }
+    const response = await this.client.request('GET', "/cfg/rq/testing/results/", { params });
+    return response;
+  }
+
+  /**
+   * Run demo task
+   * 
+   * Enqueue a single demo task for testing.
+   */
+  async runDemoCreate(data: Models.RunDemoRequestRequest): Promise<Models.TestingActionResponse> {
+    const response = await this.client.request('POST', "/cfg/rq/testing/run-demo/", { body: data });
+    return response;
+  }
+
+  /**
+   * Schedule demo tasks
+   * 
+   * Register demo scheduled tasks using rq-scheduler.
+   */
+  async scheduleDemoCreate(data: any): Promise<Models.TestingActionResponse> {
+    const response = await this.client.request('POST', "/cfg/rq/testing/schedule-demo/", { body: data });
+    return response;
+  }
+
+  /**
+   * Stress test
+   * 
+   * Generate N jobs for load testing and performance benchmarking.
+   */
+  async stressTestCreate(data: Models.StressTestRequestRequest): Promise<Models.TestingActionResponse> {
+    const response = await this.client.request('POST', "/cfg/rq/testing/stress-test/", { body: data });
+    return response;
+  }
+
+}

package/src/cfg/generated/cfg__rq__rq_testing/index.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * as Models from "./models";