@dereekb/zoho 13.8.0 → 13.10.0

package/nestjs/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dereekb/zoho/nestjs",
-  "version": "13.8.0",
+  "version": "13.10.0",
   "peerDependencies": {
-    "@dereekb/nestjs": "13.8.0",
-    "@dereekb/rxjs": "13.8.0",
-    "@dereekb/util": "13.8.0",
-    "@dereekb/zoho": "13.8.0",
+    "@dereekb/nestjs": "13.10.0",
+    "@dereekb/rxjs": "13.10.0",
+    "@dereekb/util": "13.10.0",
+    "@dereekb/zoho": "13.10.0",
     "@nestjs/common": "^11.1.17",
     "@nestjs/config": "^4.0.4",
     "express": "^5.0.0"

package/nestjs/src/lib/desk/desk.api.d.ts

@@ -0,0 +1,213 @@
+import { type ZohoDesk, type ZohoDeskContext } from '@dereekb/zoho';
+import { ZohoDeskServiceConfig } from './desk.config';
+import { ZohoAccountsApi } from '../accounts/accounts.api';
+/**
+ * NestJS injectable service that wraps the Zoho Desk API.
+ *
+ * Provides convenient accessor getters for all Desk operations (tickets, departments, contacts),
+ * each bound to the authenticated Desk context created during construction.
+ */
+export declare class ZohoDeskApi {
+    readonly config: ZohoDeskServiceConfig;
+    readonly zohoAccountsApi: ZohoAccountsApi;
+    /**
+     * Underlying Zoho Desk client instance, initialized from the injected config and accounts context.
+     */
+    readonly zohoDesk: ZohoDesk;
+    /**
+     * The authenticated Desk context used by all operation accessors.
+     *
+     * @returns the Desk context from the underlying client
+     */
+    get deskContext(): ZohoDeskContext;
+    /**
+     * Rate limiter shared across all Desk requests to respect Zoho API quotas.
+     *
+     * @returns the shared rate limiter instance
+     */
+    get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
+    /**
+     * Initializes the Desk client by combining the service config with the
+     * accounts context for OAuth token management.
+     *
+     * @param config - Zoho Desk service configuration
+     * @param zohoAccountsApi - accounts API used for OAuth token management
+     */
+    constructor(config: ZohoDeskServiceConfig, zohoAccountsApi: ZohoAccountsApi);
+    /**
+     * Configured pass-through for {@link zohoDeskGetTickets}.
+     */
+    get getTickets(): import("@dereekb/zoho").ZohoDeskGetTicketsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketById}.
+     */
+    get getTicketById(): import("@dereekb/zoho").ZohoDeskGetTicketByIdFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskSearchTickets}.
+     */
+    get searchTickets(): import("@dereekb/zoho").ZohoDeskSearchTicketsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketsForContact}.
+     */
+    get getTicketsForContact(): import("@dereekb/zoho").ZohoDeskGetTicketsForContactFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketsForProduct}.
+     */
+    get getTicketsForProduct(): import("@dereekb/zoho").ZohoDeskGetTicketsForProductFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketMetrics}.
+     */
+    get getTicketMetrics(): import("@dereekb/zoho").ZohoDeskGetTicketMetricsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetAgentsTicketsCount}.
+     */
+    get getAgentsTicketsCount(): import("@dereekb/zoho").ZohoDeskGetAgentsTicketsCountFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketsPageFactory}.
+     */
+    get getTicketsPageFactory(): import("@dereekb/zoho").ZohoDeskGetTicketsPageFactory;
+    /**
+     * Configured pass-through for {@link zohoDeskSearchTicketsPageFactory}.
+     */
+    get searchTicketsPageFactory(): import("@dereekb/zoho").ZohoDeskSearchTicketsPageFactory;
+    /**
+     * Configured pass-through for {@link zohoDeskGetDepartments}.
+     */
+    get getDepartments(): import("@dereekb/zoho").ZohoDeskGetDepartmentsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetDepartmentById}.
+     */
+    get getDepartmentById(): import("@dereekb/zoho").ZohoDeskGetDepartmentByIdFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetContacts}.
+     */
+    get getContacts(): import("@dereekb/zoho").ZohoDeskGetContactsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetContactById}.
+     */
+    get getContactById(): import("@dereekb/zoho").ZohoDeskGetContactByIdFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetContactsByIds}.
+     */
+    get getContactsByIds(): import("@dereekb/zoho").ZohoDeskGetContactsByIdsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetContactsPageFactory}.
+     */
+    get getContactsPageFactory(): import("@dereekb/zoho").ZohoDeskGetContactsPageFactory;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketTags}.
+     */
+    get getTicketTags(): import("@dereekb/zoho").ZohoDeskGetTicketTagsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskAssociateTicketTags}.
+     */
+    get associateTicketTags(): import("@dereekb/zoho").ZohoDeskAssociateTicketTagsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskDissociateTicketTag}.
+     */
+    get dissociateTicketTag(): import("@dereekb/zoho").ZohoDeskDissociateTicketTagFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskSearchTags}.
+     */
+    get searchTags(): import("@dereekb/zoho").ZohoDeskSearchTagsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetAllTags}.
+     */
+    get getAllTags(): import("@dereekb/zoho").ZohoDeskGetAllTagsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketFollowers}.
+     */
+    get getTicketFollowers(): import("@dereekb/zoho").ZohoDeskGetTicketFollowersFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskAddTicketFollowers}.
+     */
+    get addTicketFollowers(): import("@dereekb/zoho").ZohoDeskAddTicketFollowersFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskRemoveTicketFollowers}.
+     */
+    get removeTicketFollowers(): import("@dereekb/zoho").ZohoDeskRemoveTicketFollowersFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketAttachments}.
+     */
+    get getTicketAttachments(): import("@dereekb/zoho").ZohoDeskGetTicketAttachmentsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskDeleteTicketAttachment}.
+     */
+    get deleteTicketAttachment(): import("@dereekb/zoho").ZohoDeskDeleteTicketAttachmentFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketComments}.
+     */
+    get getTicketComments(): import("@dereekb/zoho").ZohoDeskGetTicketCommentsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketCommentById}.
+     */
+    get getTicketCommentById(): import("@dereekb/zoho").ZohoDeskGetTicketCommentByIdFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskCreateTicketComment}.
+     */
+    get createTicketComment(): import("@dereekb/zoho").ZohoDeskCreateTicketCommentFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskDeleteTicketComment}.
+     */
+    get deleteTicketComment(): import("@dereekb/zoho").ZohoDeskDeleteTicketCommentFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketTimer}.
+     */
+    get getTicketTimer(): import("@dereekb/zoho").ZohoDeskGetTicketTimerFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskPerformTicketTimerAction}.
+     */
+    get performTicketTimerAction(): import("@dereekb/zoho").ZohoDeskPerformTicketTimerActionFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketTimeEntries}.
+     */
+    get getTicketTimeEntries(): import("@dereekb/zoho").ZohoDeskGetTicketTimeEntriesFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketTimeEntryById}.
+     */
+    get getTicketTimeEntryById(): import("@dereekb/zoho").ZohoDeskGetTicketTimeEntryByIdFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketTimeEntrySummation}.
+     */
+    get getTicketTimeEntrySummation(): import("@dereekb/zoho").ZohoDeskGetTicketTimeEntrySummationFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketThreads}.
+     */
+    get getTicketThreads(): import("@dereekb/zoho").ZohoDeskGetTicketThreadsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketThreadById}.
+     */
+    get getTicketThreadById(): import("@dereekb/zoho").ZohoDeskGetTicketThreadByIdFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketThreadsPageFactory}.
+     */
+    get getTicketThreadsPageFactory(): import("@dereekb/zoho").ZohoDeskGetTicketThreadsPageFactory;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketActivities}.
+     */
+    get getTicketActivities(): import("@dereekb/zoho").ZohoDeskGetTicketActivitiesFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetTicketActivitiesPageFactory}.
+     */
+    get getTicketActivitiesPageFactory(): import("@dereekb/zoho").ZohoDeskGetTicketActivitiesPageFactory;
+    /**
+     * Configured pass-through for {@link zohoDeskGetAgents}.
+     */
+    get getAgents(): import("@dereekb/zoho").ZohoDeskGetAgentsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetAgentById}.
+     */
+    get getAgentById(): import("@dereekb/zoho").ZohoDeskGetAgentByIdFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetAgentsByIds}.
+     */
+    get getAgentsByIds(): import("@dereekb/zoho").ZohoDeskGetAgentsByIdsFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetMyInfo}.
+     */
+    get getMyInfo(): import("@dereekb/zoho").ZohoDeskGetMyInfoFunction;
+    /**
+     * Configured pass-through for {@link zohoDeskGetAgentsPageFactory}.
+     */
+    get getAgentsPageFactory(): import("@dereekb/zoho").ZohoDeskGetAgentsPageFactory;
+}

package/nestjs/src/lib/desk/desk.config.d.ts

@@ -0,0 +1,27 @@
+import { type ZohoDeskConfig, type ZohoDeskFactoryConfig } from '@dereekb/zoho';
+/**
+ * API configuration for connecting to the Zoho Desk service endpoint.
+ */
+export type ZohoDeskServiceApiConfig = ZohoDeskConfig;
+/**
+ * Abstract configuration class for the NestJS Zoho Desk service.
+ *
+ * Used as a DI token so that applications can provide their own config values
+ * while keeping the expected shape consistent.
+ */
+export declare abstract class ZohoDeskServiceConfig {
+    /**
+     * Zoho Desk API connection settings (endpoint URL, org ID, etc.).
+     */
+    readonly zohoDesk: ZohoDeskServiceApiConfig;
+    /**
+     * Optional factory-level overrides applied when creating the underlying Desk client.
+     */
+    readonly factoryConfig?: ZohoDeskFactoryConfig;
+    /**
+     * Validates that the required Zoho Desk connection fields are present and well-formed.
+     *
+     * @param config - the Desk service config to validate
+     */
+    static assertValidConfig(config: ZohoDeskServiceConfig): void;
+}

package/nestjs/src/lib/desk/desk.module.d.ts

@@ -0,0 +1,62 @@
+import { type ModuleMetadata } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { ZohoDeskServiceConfig } from './desk.config';
+import { ZohoAccountsServiceConfig } from '../accounts/accounts.config';
+import { type Maybe } from '@dereekb/util';
+/**
+ * Config key suffix for the Zoho Desk organization ID.
+ * Resolves to `ZOHO_DESK_ORG_ID` or `ZOHO_ORG_ID`.
+ */
+export declare const ZOHO_ORG_ID_CONFIG_KEY = "ORG_ID";
+/**
+ * Reads Zoho Desk connection settings from the NestJS ConfigService
+ * and returns a validated service config.
+ *
+ * Resolves the API URL via environment variables following the naming convention
+ * `ZOHO_DESK_API_URL` (service-specific) or `ZOHO_API_URL` (shared fallback).
+ * The organization ID is read from `ZOHO_DESK_ORG_ID` or `ZOHO_ORG_ID`.
+ *
+ * @param configService - NestJS config service populated with Zoho environment variables
+ * @returns Validated Zoho Desk service configuration
+ * @throws {Error} If required config values (API URL or orgId) are missing
+ */
+export declare function zohoDeskServiceConfigFactory(configService: ConfigService): ZohoDeskServiceConfig;
+/**
+ * Reads Zoho Accounts (OAuth) settings scoped to the Desk service from
+ * the NestJS ConfigService and returns an accounts service config.
+ *
+ * @param configService - NestJS config service populated with Zoho OAuth environment variables
+ * @returns Zoho Accounts service config scoped to the Desk service access token
+ */
+export declare function zohoDeskAccountServiceConfigFactory(configService: ConfigService): ZohoAccountsServiceConfig;
+/**
+ * Configuration for generating the application-level Zoho Desk NestJS module metadata.
+ *
+ * Extends standard NestJS {@link ModuleMetadata} fields (`imports`, `exports`, `providers`)
+ * so additional providers or modules can be merged into the generated metadata.
+ */
+export interface ProvideAppZohoDeskMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
+    /**
+     * Module that exports the required dependencies for this module.
+     * When provided, this module is automatically included in the generated `imports` array.
+     */
+    readonly dependencyModule?: Maybe<Required<ModuleMetadata>['imports']['0']>;
+}
+/**
+ * Generates NestJS {@link ModuleMetadata} that wires up the full Zoho Desk stack
+ * (config, accounts, and API service) so consuming modules only need a single import.
+ *
+ * The generated module requires the following dependencies in order to initialize properly:
+ * - {@link ZohoAccountsAccessTokenCacheService}
+ *
+ * Use the `dependencyModule` config option to import a module that exports those dependencies.
+ *
+ * The returned metadata registers {@link ZohoDeskServiceConfig}, {@link ZohoDeskApi},
+ * {@link ZohoAccountsServiceConfig}, and {@link ZohoAccountsApi} as providers, and
+ * exports {@link ZohoDeskApi} by default. Additional imports, exports, and providers
+ * from the config are merged in.
+ *
+ * @param config - Module configuration with optional dependency module and extra metadata
+ * @returns Complete NestJS module metadata ready to pass to `@Module()`
+ */
+export declare function appZohoDeskModuleMetadata(config: ProvideAppZohoDeskMetadataConfig): ModuleMetadata;

package/nestjs/src/lib/desk/index.d.ts

@@ -0,0 +1,3 @@
+export * from './desk.api';
+export * from './desk.config';
+export * from './desk.module';

package/nestjs/src/lib/index.d.ts

@@ -2,4 +2,5 @@ export * from './accounts';
 export * from './crm';
 export * from './recruit';
 export * from './sign';
+export * from './desk';
 export * from './zoho.config';

package/package.json

@@ -1,6 +1,9 @@
 {
   "name": "@dereekb/zoho",
-  "version": "13.8.0",
+  "version": "13.10.0",
+  "bin": {
+    "zoho-cli": "./cli/index.js"
+  },
   "exports": {
     "./nestjs": {
       "module": "./nestjs/index.esm.js",
@@ -8,6 +11,9 @@
       "import": "./nestjs/index.cjs.mjs",
       "default": "./nestjs/index.cjs.js"
     },
+    "./cli": {
+      "default": "./cli/index.js"
+    },
     "./package.json": "./package.json",
     ".": {
       "module": "./index.esm.js",
@@ -17,13 +23,14 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/nestjs": "13.8.0",
-    "@dereekb/rxjs": "13.8.0",
-    "@dereekb/util": "13.8.0",
+    "@dereekb/nestjs": "13.10.0",
+    "@dereekb/rxjs": "13.10.0",
+    "@dereekb/util": "13.10.0",
     "@nestjs/common": "^11.1.17",
     "@nestjs/config": "^4.0.4",
     "express": "^5.0.0",
-    "make-error": "^1.3.0"
+    "make-error": "^1.3.0",
+    "yargs": "^18.0.0"
   },
   "devDependencies": {
     "@nestjs/testing": "^11.1.14",

package/src/lib/desk/desk.agent.d.ts

@@ -0,0 +1,45 @@
+import { type Maybe } from '@dereekb/util';
+import { type ZohoDeskAgentId } from './desk';
+/**
+ * Agent status in Zoho Desk.
+ */
+export type ZohoDeskAgentStatus = 'ACTIVE' | 'DISABLED';
+/**
+ * Agent role permission type in Zoho Desk.
+ */
+export type ZohoDeskAgentRolePermissionType = 'Light' | 'AgentPublic' | 'Custom' | 'AgentPersonal' | 'Admin' | string;
+/**
+ * Related entities that can be expanded when fetching agents.
+ */
+export type ZohoDeskAgentInclude = 'associatedChatDepartments' | 'role' | 'profile' | 'associatedDepartments';
+/**
+ * An agent (support staff member) in Zoho Desk.
+ */
+export interface ZohoDeskAgent {
+    readonly id: ZohoDeskAgentId;
+    readonly name?: Maybe<string>;
+    readonly firstName?: Maybe<string>;
+    readonly lastName?: Maybe<string>;
+    readonly emailId?: Maybe<string>;
+    readonly phone?: Maybe<string>;
+    readonly mobile?: Maybe<string>;
+    readonly extn?: Maybe<string>;
+    readonly photoURL?: Maybe<string>;
+    readonly timeZone?: Maybe<string>;
+    readonly langCode?: Maybe<string>;
+    readonly countryCode?: Maybe<string>;
+    readonly aboutInfo?: Maybe<string>;
+    readonly channelExpert?: Maybe<string>;
+    readonly roleId?: Maybe<string>;
+    readonly profileId?: Maybe<string>;
+    readonly zuid?: Maybe<string>;
+    readonly isConfirmed?: Maybe<boolean>;
+    readonly status?: Maybe<ZohoDeskAgentStatus>;
+    readonly rolePermissionType?: Maybe<ZohoDeskAgentRolePermissionType>;
+    readonly associatedDepartmentIds?: Maybe<string[]>;
+    readonly associatedChatDepartmentIds?: Maybe<string[]>;
+    readonly role?: Maybe<Record<string, unknown>>;
+    readonly profile?: Maybe<Record<string, unknown>>;
+    readonly associatedDepartments?: Maybe<Record<string, unknown>[]>;
+    readonly associatedChatDepartments?: Maybe<Record<string, unknown>[]>;
+}

package/src/lib/desk/desk.api.activities.d.ts

@@ -0,0 +1,43 @@
+import { type Maybe, type ArrayOrValue } from '@dereekb/util';
+import { type FetchPage, type FetchPageFactoryOptions } from '@dereekb/util/fetch';
+import { type ZohoDeskContext } from './desk.config';
+import { type ZohoDeskTicketId } from './desk';
+import { type ZohoDeskTicketActivity, type ZohoDeskActivityInclude } from './desk.ticket';
+import { type ZohoDeskPageFilter, type ZohoDeskPageResult } from './desk.api.page';
+/**
+ * Input parameters for listing activities on a ticket via `GET /tickets/{ticketId}/activities`.
+ */
+export interface ZohoDeskGetTicketActivitiesInput extends ZohoDeskPageFilter {
+    readonly ticketId: ZohoDeskTicketId;
+    readonly include?: ArrayOrValue<ZohoDeskActivityInclude>;
+    readonly isSpam?: boolean;
+    readonly isCompleted?: boolean;
+}
+/**
+ * Response from listing ticket activities.
+ */
+export type ZohoDeskGetTicketActivitiesResponse = ZohoDeskPageResult<ZohoDeskTicketActivity>;
+/**
+ * Function that retrieves activities for a specific ticket.
+ */
+export type ZohoDeskGetTicketActivitiesFunction = (input: ZohoDeskGetTicketActivitiesInput) => Promise<ZohoDeskGetTicketActivitiesResponse>;
+/**
+ * Creates a {@link ZohoDeskGetTicketActivitiesFunction} bound to the given context.
+ *
+ * Retrieves a paginated list of activities (tasks, events, calls) associated with a ticket.
+ *
+ * @param context - Authenticated Zoho Desk context
+ * @returns Function that retrieves activities for a ticket
+ */
+export declare function zohoDeskGetTicketActivities(context: ZohoDeskContext): ZohoDeskGetTicketActivitiesFunction;
+/**
+ * Factory that creates paginated iterators for ticket activity queries.
+ */
+export type ZohoDeskGetTicketActivitiesPageFactory = (input: ZohoDeskGetTicketActivitiesInput, options?: Maybe<FetchPageFactoryOptions<ZohoDeskGetTicketActivitiesInput, ZohoDeskGetTicketActivitiesResponse>>) => FetchPage<ZohoDeskGetTicketActivitiesInput, ZohoDeskGetTicketActivitiesResponse>;
+/**
+ * Creates a {@link ZohoDeskGetTicketActivitiesPageFactory} bound to the given context.
+ *
+ * @param context - Authenticated Zoho Desk context
+ * @returns Page factory for iterating over activity results
+ */
+export declare function zohoDeskGetTicketActivitiesPageFactory(context: ZohoDeskContext): ZohoDeskGetTicketActivitiesPageFactory;

package/src/lib/desk/desk.api.agents.d.ts

@@ -0,0 +1,91 @@
+import { type Maybe, type ArrayOrValue } from '@dereekb/util';
+import { type FetchPage, type FetchPageFactoryOptions } from '@dereekb/util/fetch';
+import { type ZohoDeskContext } from './desk.config';
+import { type ZohoDeskAgentId, type ZohoDeskDepartmentId } from './desk';
+import { type ZohoDeskAgent, type ZohoDeskAgentInclude, type ZohoDeskAgentStatus } from './desk.agent';
+import { type ZohoDeskPageFilter, type ZohoDeskPageResult } from './desk.api.page';
+/**
+ * Input parameters for listing agents via `GET /agents`.
+ */
+export interface ZohoDeskGetAgentsInput extends ZohoDeskPageFilter {
+    readonly include?: ArrayOrValue<ZohoDeskAgentInclude>;
+    readonly departmentId?: ZohoDeskDepartmentId;
+    readonly status?: ZohoDeskAgentStatus;
+}
+/**
+ * Response from listing agents.
+ */
+export type ZohoDeskGetAgentsResponse = ZohoDeskPageResult<ZohoDeskAgent>;
+/**
+ * Function that retrieves a paginated list of agents.
+ */
+export type ZohoDeskGetAgentsFunction = (input: ZohoDeskGetAgentsInput) => Promise<ZohoDeskGetAgentsResponse>;
+/**
+ * Creates a {@link ZohoDeskGetAgentsFunction} bound to the given context.
+ *
+ * Retrieves a paginated list of agents, with optional filtering by department and status,
+ * and inline expansion of related entities (role, profile, departments).
+ *
+ * @param context - Authenticated Zoho Desk context
+ * @returns Function that retrieves paginated agents
+ */
+export declare function zohoDeskGetAgents(context: ZohoDeskContext): ZohoDeskGetAgentsFunction;
+/**
+ * Input parameters for retrieving a single agent via `GET /agents/{agentId}`.
+ */
+export interface ZohoDeskGetAgentByIdInput {
+    readonly agentId: ZohoDeskAgentId;
+    readonly include?: ArrayOrValue<ZohoDeskAgentInclude>;
+}
+/**
+ * Function that retrieves a single agent by ID.
+ */
+export type ZohoDeskGetAgentByIdFunction = (input: ZohoDeskGetAgentByIdInput) => Promise<ZohoDeskAgent>;
+/**
+ * Creates a {@link ZohoDeskGetAgentByIdFunction} bound to the given context.
+ *
+ * @param context - Authenticated Zoho Desk context
+ * @returns Function that retrieves a single agent
+ */
+export declare function zohoDeskGetAgentById(context: ZohoDeskContext): ZohoDeskGetAgentByIdFunction;
+/**
+ * Input parameters for retrieving multiple agents by their IDs via `GET /agentsByIds`.
+ */
+export interface ZohoDeskGetAgentsByIdsInput {
+    readonly agentIds: ArrayOrValue<ZohoDeskAgentId>;
+}
+/**
+ * Function that retrieves multiple agents by their IDs.
+ */
+export type ZohoDeskGetAgentsByIdsFunction = (input: ZohoDeskGetAgentsByIdsInput) => Promise<ZohoDeskAgent[]>;
+/**
+ * Creates a {@link ZohoDeskGetAgentsByIdsFunction} bound to the given context.
+ *
+ * @param context - Authenticated Zoho Desk context
+ * @returns Function that retrieves agents by IDs
+ */
+export declare function zohoDeskGetAgentsByIds(context: ZohoDeskContext): ZohoDeskGetAgentsByIdsFunction;
+/**
+ * Function that retrieves the current authenticated agent's profile.
+ */
+export type ZohoDeskGetMyInfoFunction = () => Promise<ZohoDeskAgent>;
+/**
+ * Creates a {@link ZohoDeskGetMyInfoFunction} bound to the given context.
+ *
+ * Retrieves the profile of the agent associated with the current OAuth token.
+ *
+ * @param context - Authenticated Zoho Desk context
+ * @returns Function that retrieves the current agent's info
+ */
+export declare function zohoDeskGetMyInfo(context: ZohoDeskContext): ZohoDeskGetMyInfoFunction;
+/**
+ * Factory that creates paginated iterators for agent list queries.
+ */
+export type ZohoDeskGetAgentsPageFactory = (input: ZohoDeskGetAgentsInput, options?: Maybe<FetchPageFactoryOptions<ZohoDeskGetAgentsInput, ZohoDeskGetAgentsResponse>>) => FetchPage<ZohoDeskGetAgentsInput, ZohoDeskGetAgentsResponse>;
+/**
+ * Creates a {@link ZohoDeskGetAgentsPageFactory} bound to the given context.
+ *
+ * @param context - Authenticated Zoho Desk context
+ * @returns Page factory for iterating over agent results
+ */
+export declare function zohoDeskGetAgentsPageFactory(context: ZohoDeskContext): ZohoDeskGetAgentsPageFactory;

package/src/lib/desk/desk.api.attachments.d.ts

@@ -0,0 +1,47 @@
+import { type ArrayOrValue } from '@dereekb/util';
+import { type ZohoDeskContext } from './desk.config';
+import { type ZohoDeskTicketId } from './desk';
+import { type ZohoDeskTicketAttachment, type ZohoDeskAttachmentSortBy, type ZohoDeskAttachmentInclude } from './desk.ticket';
+import { type ZohoDeskPageFilter, type ZohoDeskPageResult } from './desk.api.page';
+/**
+ * Input parameters for listing attachments on a ticket via `GET /tickets/{ticketId}/attachments`.
+ */
+export interface ZohoDeskGetTicketAttachmentsInput extends ZohoDeskPageFilter {
+    readonly ticketId: ZohoDeskTicketId;
+    readonly sortBy?: ZohoDeskAttachmentSortBy;
+    readonly include?: ArrayOrValue<ZohoDeskAttachmentInclude>;
+    readonly isPublic?: boolean;
+}
+/**
+ * Response from listing ticket attachments.
+ */
+export type ZohoDeskGetTicketAttachmentsResponse = ZohoDeskPageResult<ZohoDeskTicketAttachment>;
+/**
+ * Function that retrieves attachments for a specific ticket.
+ */
+export type ZohoDeskGetTicketAttachmentsFunction = (input: ZohoDeskGetTicketAttachmentsInput) => Promise<ZohoDeskGetTicketAttachmentsResponse>;
+/**
+ * Creates a {@link ZohoDeskGetTicketAttachmentsFunction} bound to the given context.
+ *
+ * @param context - Authenticated Zoho Desk context
+ * @returns Function that retrieves attachments for a ticket
+ */
+export declare function zohoDeskGetTicketAttachments(context: ZohoDeskContext): ZohoDeskGetTicketAttachmentsFunction;
+/**
+ * Input parameters for deleting an attachment from a ticket via `DELETE /tickets/{ticketId}/attachments/{attachmentId}`.
+ */
+export interface ZohoDeskDeleteTicketAttachmentInput {
+    readonly ticketId: ZohoDeskTicketId;
+    readonly attachmentId: string;
+}
+/**
+ * Function that deletes an attachment from a ticket.
+ */
+export type ZohoDeskDeleteTicketAttachmentFunction = (input: ZohoDeskDeleteTicketAttachmentInput) => Promise<void>;
+/**
+ * Creates a {@link ZohoDeskDeleteTicketAttachmentFunction} bound to the given context.
+ *
+ * @param context - Authenticated Zoho Desk context
+ * @returns Function that deletes a ticket attachment
+ */
+export declare function zohoDeskDeleteTicketAttachment(context: ZohoDeskContext): ZohoDeskDeleteTicketAttachmentFunction;