Class: CustomerAppsClient

Defined in: src/management/customer-apps.ts:23

Client for AIRS customer application management operations.

Constructors

Constructor

new CustomerAppsClient(opts): CustomerAppsClient;

Defined in: src/management/customer-apps.ts:29

Parameters

Parameter	Type
opts	CustomerAppsClientOptions

Returns

CustomerAppsClient

Methods

get()

get(appName): Promise<objectOutputType<{
  customer_appId: ZodOptional<ZodString>;
  tsg_id: ZodString;
  app_name: ZodString;
  model_name: ZodOptional<ZodString>;
  cloud_provider: ZodString;
  environment: ZodString;
  status: ZodOptional<ZodString>;
  created_by: ZodOptional<ZodString>;
  updated_by: ZodOptional<ZodString>;
  ai_agent_framework: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/customer-apps.ts:50

Get a customer app by name.

Parameters

Parameter	Type	Description
appName	string	Name of the customer app.

Returns

Promise<objectOutputType<{ customer_appId: ZodOptional<ZodString>; tsg_id: ZodString; app_name: ZodString; model_name: ZodOptional<ZodString>; cloud_provider: ZodString; environment: ZodString; status: ZodOptional<ZodString>; created_by: ZodOptional<ZodString>; updated_by: ZodOptional<ZodString>; ai_agent_framework: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>

The customer app.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const app = await mgmt.customerApps.get('myapp');
// app =>
// { tsg_id: '1234567890', app_name: 'myapp', cloud_provider: 'aws', environment: 'prod' }

---

list()

list(opts?): Promise<objectOutputType<{
  customer_apps: ZodOptional<ZodArray<ZodObject<{
     customer_appId: ZodString;
     tsg_id: ZodString;
     app_name: ZodString;
     model_name: ZodOptional<ZodString>;
     cloud_provider: ZodString;
     environment: ZodString;
     ai_agent_framework: ZodOptional<ZodString>;
     api_keys_dp_info: ZodOptional<ZodArray<ZodObject<{
        api_key_name: ...;
        dp_name: ...;
        auth_code: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     customer_appId: ZodString;
     tsg_id: ZodString;
     app_name: ZodString;
     model_name: ZodOptional<ZodString>;
     cloud_provider: ZodString;
     environment: ZodString;
     ai_agent_framework: ZodOptional<ZodString>;
     api_keys_dp_info: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     customer_appId: ZodString;
     tsg_id: ZodString;
     app_name: ZodString;
     model_name: ZodOptional<ZodString>;
     cloud_provider: ZodString;
     environment: ZodString;
     ai_agent_framework: ZodOptional<ZodString>;
     api_keys_dp_info: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  next_offset: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/customer-apps.ts:77

List customer apps for the TSG.

Parameters

Parameter	Type	Description
opts?	PaginationOptions	Pagination options.

Returns

Promise<objectOutputType<{ customer_apps: ZodOptional<ZodArray<ZodObject<{ customer_appId: ZodString; tsg_id: ZodString; app_name: ZodString; model_name: ZodOptional<ZodString>; cloud_provider: ZodString; environment: ZodString; ai_agent_framework: ZodOptional<ZodString>; api_keys_dp_info: ZodOptional<ZodArray<ZodObject<{ api_key_name: ...; dp_name: ...; auth_code: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; }, "passthrough", ZodTypeAny, objectOutputType<{ customer_appId: ZodString; tsg_id: ZodString; app_name: ZodString; model_name: ZodOptional<ZodString>; cloud_provider: ZodString; environment: ZodString; ai_agent_framework: ZodOptional<ZodString>; api_keys_dp_info: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>; }, ZodTypeAny, "passthrough">, objectInputType<{ customer_appId: ZodString; tsg_id: ZodString; app_name: ZodString; model_name: ZodOptional<ZodString>; cloud_provider: ZodString; environment: ZodString; ai_agent_framework: ZodOptional<ZodString>; api_keys_dp_info: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>; }, ZodTypeAny, "passthrough">>, "many">>; next_offset: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>

Paginated list of customer apps.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const page = await mgmt.customerApps.list({ offset: 0, limit: 5 });
// page =>
// { customer_apps: [ { customer_appId: 'uuid-1', tsg_id: '1234567890',
//     app_name: 'myapp', cloud_provider: 'aws', environment: 'prod' } ], next_offset: 0 }

---

update()

update(customerAppId, body): Promise<objectOutputType<{
  customer_appId: ZodOptional<ZodString>;
  tsg_id: ZodString;
  app_name: ZodString;
  model_name: ZodOptional<ZodString>;
  cloud_provider: ZodString;
  environment: ZodString;
  status: ZodOptional<ZodString>;
  created_by: ZodOptional<ZodString>;
  updated_by: ZodOptional<ZodString>;
  ai_agent_framework: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/customer-apps.ts:114

Update a customer app.

Parameters

Parameter	Type	Description
customerAppId	string	UUID of the customer app to update.
body	objectOutputType	Updated customer app data.

Returns

Promise<objectOutputType<{ customer_appId: ZodOptional<ZodString>; tsg_id: ZodString; app_name: ZodString; model_name: ZodOptional<ZodString>; cloud_provider: ZodString; environment: ZodString; status: ZodOptional<ZodString>; created_by: ZodOptional<ZodString>; updated_by: ZodOptional<ZodString>; ai_agent_framework: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>

The updated customer app.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const app = await mgmt.customerApps.update('uuid-1', {
  tsg_id: '1234567890',
  app_name: 'myapp',
  cloud_provider: 'aws',
  environment: 'staging',
});
// app =>
// { tsg_id: '1234567890', app_name: 'myapp', cloud_provider: 'aws', environment: 'staging' }

---

delete()

delete(appName, updatedBy): Promise<
  | {
  message: string;
}
  | objectOutputType<{
  message: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/customer-apps.ts:141

Delete a customer app.

Parameters

Parameter	Type	Description
appName	string	Name of the customer app to delete.
updatedBy	string	Email of user performing the deletion.

Returns

Promise< | { message: string; } | objectOutputType<{ message: ZodString; }, ZodTypeAny, "passthrough">>

Deletion confirmation message.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const result = await mgmt.customerApps.delete('myapp', 'user@example.com');
// result => { message: 'customer app and associated keys successfully deleted' }