@cdot65/prisma-airs-sdk 0.11.0 → 0.12.0

package/dist/index.js

@@ -29,7 +29,7 @@ var MAX_NUMBER_OF_BATCH_SCAN_OBJECTS = 5;
 var MAX_CONNECTION_POOL_SIZE = 100;
 var MAX_NUMBER_OF_RETRIES = 5;
 var HTTP_FORCE_RETRY_STATUS_CODES = [500, 502, 503, 504];
-var SDK_VERSION = "0.11.0";
+var SDK_VERSION = "0.12.0";
 var USER_AGENT = `PAN-AIRS/${SDK_VERSION}-typescript-sdk`;
 var DEFAULT_MGMT_ENDPOINT = "https://api.sase.paloaltonetworks.com/aisec";
 var DEFAULT_TOKEN_ENDPOINT = "https://auth.apps.paloaltonetworks.com/oauth2/access_token";
@@ -58,6 +58,7 @@ var MGMT_OAUTH_INVALIDATE_PATH = "/v1/mgmt/oauth/invalidateToken";
 var MGMT_OAUTH_TOKEN_PATH = "/v1/mgmt/oauth/client_credential/accesstoken";
 var MGMT_DASHBOARD_APPLICATION_PATH = "/v1/mgmt/dashboard/v2/apps/application";
 var MGMT_DASHBOARD_APPLICATION_VIOLATION_BREAKDOWN_PATH = "/v1/mgmt/dashboard/v2/apps/applicationviolationbreakdown";
+var MGMT_DASHBOARD_APPLICATIONS_OVERVIEW_PATH = "/v1/mgmt/dashboard/v2/apps/applicationsoverview";
 var DEFAULT_DLP_ENDPOINT = "https://api.dlp.paloaltonetworks.com";
 var DLP_DATA_FILTERING_PROFILES_PATH = "/v2/api/data-filtering-profiles";
 var DLP_DATA_PATTERNS_PATH = "/v2/api/data-patterns";
@@ -1510,6 +1511,31 @@ var DashboardApplicationViolationBreakdownSchema = z21.object({
   detection_type_violation_breakdown: z21.array(DetectorViolationBreakdownEntrySchema).optional(),
   total_violating: z21.number().optional()
 }).passthrough();
+var DashboardApplicationSessionsBucketSchema = z21.object({
+  bucket_number: z21.number().optional(),
+  date: z21.string().nullable().optional(),
+  total: z21.number().optional(),
+  violated: z21.number().optional()
+}).passthrough();
+var DashboardApplicationsOverviewItemSchema = z21.object({
+  id: z21.string().nullable().optional(),
+  name: z21.string().nullable().optional(),
+  cloud: z21.string().nullable().optional(),
+  source: z21.string().nullable().optional(),
+  created_at: z21.string().nullable().optional(),
+  sessions: z21.array(DashboardApplicationSessionsBucketSchema).nullable().optional(),
+  sessions_total: z21.number().nullable().optional(),
+  sessions_violated: z21.number().nullable().optional()
+}).passthrough();
+var DashboardPaginationSchema = z21.object({
+  limit: z21.number().optional(),
+  skip: z21.number().optional(),
+  total_items: z21.number().optional()
+}).passthrough();
+var DashboardApplicationsOverviewSchema = z21.object({
+  items: z21.array(DashboardApplicationsOverviewItemSchema).optional(),
+  pagination: DashboardPaginationSchema.optional()
+}).passthrough();
 
 // src/models/mgmt-deployment-profile.ts
 import { z as z22 } from "zod";
@@ -4855,6 +4881,53 @@ var DashboardClient = class {
       numRetries: this.numRetries
     });
   }
+  /**
+   * Enumerate all dashboard application buckets the tenant has data for.
+   *
+   * This is the canonical apps-list source for the dashboard. The customer-apps endpoint
+   * (`mgmt.customerApps.list`) lists registered customer applications, but each registered
+   * customer-app can have **multiple dashboard buckets** when its API key is used to send scan
+   * requests carrying different `metadata.app_name` values - one bucket per distinct
+   * scan-payload name. This endpoint returns every bucket, so it is what you want for
+   * per-app token-consumption reporting and dashboard inventory.
+   *
+   * The `id` field on each item is the registered `customer_appId` UUID; the `name` field is
+   * the scan-payload value. Pass that `(id, name)` pair to {@link application} or
+   * {@link applicationViolationBreakdown} to retrieve drill-down data for a specific bucket.
+   *
+   * @param query - Time window and pagination.
+   * @returns Paginated bucket list plus pagination metadata.
+   * @example
+   * ```ts
+   * import { ManagementClient } from '@cdot65/prisma-airs-sdk';
+   * const mgmt = new ManagementClient();
+   *
+   * const { items } = await mgmt.dashboard.applicationsOverview();
+   * for (const item of items ?? []) {
+   *   const overview = await mgmt.dashboard.application({
+   *     appId: item.id ?? '',
+   *     appName: item.name ?? '',
+   *   });
+   *   console.log(item.name, overview.token_stats?.monthly_total_tokens);
+   * }
+   * ```
+   */
+  async applicationsOverview(query) {
+    return request({
+      method: "GET",
+      baseUrl: this.baseUrl,
+      path: MGMT_DASHBOARD_APPLICATIONS_OVERVIEW_PATH,
+      params: {
+        time_interval: String(query?.timeInterval ?? 30),
+        time_unit: query?.timeUnit ?? "days",
+        limit: String(query?.limit ?? 25),
+        offset: String(query?.offset ?? 0)
+      },
+      responseSchema: DashboardApplicationsOverviewSchema,
+      auth: this.auth,
+      numRetries: this.numRetries
+    });
+  }
 };
 
 // src/management/dlp/data-filtering-profiles.ts
@@ -8722,9 +8795,13 @@ export {
   DSDetailResultSchema,
   DSResultMetadataSchema,
   DashboardApplicationSchema,
+  DashboardApplicationSessionsBucketSchema,
   DashboardApplicationViolationBreakdownSchema,
+  DashboardApplicationsOverviewItemSchema,
+  DashboardApplicationsOverviewSchema,
   DashboardClient,
   DashboardOverviewResponseSchema,
+  DashboardPaginationSchema,
   DashboardSessionStatsSchema,
   DataFilteringDetailsSchema,
   DataFilteringProfileRequestSchema,
@@ -8875,6 +8952,7 @@ export {
   MGMT_CLIENT_SECRET,
   MGMT_CUSTOMER_APPS_TSG_PATH,
   MGMT_CUSTOMER_APP_PATH,
+  MGMT_DASHBOARD_APPLICATIONS_OVERVIEW_PATH,
   MGMT_DASHBOARD_APPLICATION_PATH,
   MGMT_DASHBOARD_APPLICATION_VIOLATION_BREAKDOWN_PATH,
   MGMT_DEPLOYMENT_PROFILES_PATH,