@dereekb/zoho 13.11.14 → 13.11.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/cli/index.js +5 -5
  2. package/cli/package.json +7 -7
  3. package/index.cjs.js +569 -503
  4. package/index.esm.js +569 -503
  5. package/nestjs/index.cjs.js +248 -255
  6. package/nestjs/index.esm.js +248 -255
  7. package/nestjs/package.json +5 -5
  8. package/nestjs/src/lib/accounts/accounts.config.d.ts +1 -1
  9. package/nestjs/src/lib/accounts/accounts.service.d.ts +11 -11
  10. package/nestjs/src/lib/crm/crm.api.d.ts +31 -31
  11. package/nestjs/src/lib/crm/crm.config.d.ts +1 -1
  12. package/nestjs/src/lib/crm/crm.module.d.ts +12 -13
  13. package/nestjs/src/lib/desk/desk.api.d.ts +48 -48
  14. package/nestjs/src/lib/desk/desk.config.d.ts +2 -1
  15. package/nestjs/src/lib/desk/desk.module.d.ts +6 -6
  16. package/nestjs/src/lib/recruit/recruit.api.d.ts +35 -35
  17. package/nestjs/src/lib/recruit/recruit.config.d.ts +1 -1
  18. package/nestjs/src/lib/recruit/recruit.module.d.ts +12 -13
  19. package/nestjs/src/lib/sign/sign.api.d.ts +16 -16
  20. package/nestjs/src/lib/sign/sign.module.d.ts +12 -13
  21. package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.d.ts +2 -2
  22. package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.module.d.ts +3 -3
  23. package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.verify.d.ts +2 -2
  24. package/nestjs/src/lib/zoho.config.d.ts +2 -1
  25. package/package.json +8 -8
  26. package/src/lib/accounts/accounts.api.d.ts +10 -10
  27. package/src/lib/accounts/accounts.config.d.ts +2 -2
  28. package/src/lib/accounts/accounts.d.ts +3 -2
  29. package/src/lib/accounts/accounts.error.api.d.ts +5 -5
  30. package/src/lib/accounts/accounts.factory.d.ts +8 -6
  31. package/src/lib/crm/crm.api.d.ts +87 -81
  32. package/src/lib/crm/crm.api.notes.d.ts +11 -10
  33. package/src/lib/crm/crm.api.tags.d.ts +16 -14
  34. package/src/lib/crm/crm.config.d.ts +2 -2
  35. package/src/lib/crm/crm.d.ts +2 -2
  36. package/src/lib/crm/crm.error.api.d.ts +10 -10
  37. package/src/lib/crm/crm.factory.d.ts +3 -2
  38. package/src/lib/crm/crm.notes.d.ts +2 -2
  39. package/src/lib/desk/desk.agent.d.ts +2 -2
  40. package/src/lib/desk/desk.api.activities.d.ts +5 -4
  41. package/src/lib/desk/desk.api.agents.d.ts +11 -10
  42. package/src/lib/desk/desk.api.attachments.d.ts +4 -4
  43. package/src/lib/desk/desk.api.comments.d.ts +8 -8
  44. package/src/lib/desk/desk.api.contacts.d.ts +9 -8
  45. package/src/lib/desk/desk.api.departments.d.ts +4 -4
  46. package/src/lib/desk/desk.api.followers.d.ts +6 -6
  47. package/src/lib/desk/desk.api.page.d.ts +6 -5
  48. package/src/lib/desk/desk.api.tags.d.ts +10 -10
  49. package/src/lib/desk/desk.api.threads.d.ts +7 -6
  50. package/src/lib/desk/desk.api.tickets.d.ts +23 -21
  51. package/src/lib/desk/desk.api.time.d.ts +10 -10
  52. package/src/lib/desk/desk.config.d.ts +2 -2
  53. package/src/lib/desk/desk.error.api.d.ts +5 -5
  54. package/src/lib/desk/desk.factory.d.ts +3 -2
  55. package/src/lib/desk/desk.limit.d.ts +3 -3
  56. package/src/lib/desk/desk.ticket.d.ts +4 -4
  57. package/src/lib/recruit/recruit.api.candidates.d.ts +15 -13
  58. package/src/lib/recruit/recruit.api.d.ts +85 -80
  59. package/src/lib/recruit/recruit.api.notes.d.ts +11 -10
  60. package/src/lib/recruit/recruit.api.tags.d.ts +19 -18
  61. package/src/lib/recruit/recruit.config.d.ts +2 -2
  62. package/src/lib/recruit/recruit.d.ts +2 -2
  63. package/src/lib/recruit/recruit.error.api.d.ts +10 -10
  64. package/src/lib/recruit/recruit.factory.d.ts +3 -2
  65. package/src/lib/recruit/recruit.notes.d.ts +2 -2
  66. package/src/lib/shared/criteria.d.ts +5 -5
  67. package/src/lib/shared/criteria.util.d.ts +2 -2
  68. package/src/lib/sign/sign.api.d.ts +47 -46
  69. package/src/lib/sign/sign.api.page.d.ts +6 -5
  70. package/src/lib/sign/sign.config.d.ts +2 -2
  71. package/src/lib/sign/sign.d.ts +4 -4
  72. package/src/lib/sign/sign.error.api.d.ts +5 -5
  73. package/src/lib/sign/sign.factory.d.ts +3 -2
  74. package/src/lib/zoho.api.page.d.ts +5 -4
  75. package/src/lib/zoho.error.api.d.ts +17 -14
  76. package/src/lib/zoho.limit.d.ts +6 -5
  77. package/src/lib/zoho.type.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- import { type ISO8601DateString, type UniqueModelWithId } from '@dereekb/util';
1
+ import { type ISO8601DateString, type UniqueModelWithId, type Maybe } from '@dereekb/util';
2
2
  import { type ZohoCrmReferenceData, type ZohoCrmParentReferenceData, type ZohoCrmTypeId, type ZohoCrmModuleName, type ZohoCrmCreatedByData, type ZohoCrmModifiedByData, type ZohoCrmId } from './crm';
3
3
  /**
4
4
  * Unique identifier for a CRM note.
@@ -50,7 +50,7 @@ export interface ZohoCrmNoteData {
50
50
  readonly Note_Owner: ZohoCrmNoteOwnerData;
51
51
  readonly Created_By: ZohoCrmCreatedByData;
52
52
  readonly Modified_By: ZohoCrmModifiedByData;
53
- readonly $size: ZohoCrmNoteFileSize | null;
53
+ readonly $size: Maybe<ZohoCrmNoteFileSize>;
54
54
  readonly $voice_note: boolean;
55
55
  readonly $status: ZohoCrmNoteStatus;
56
56
  }
@@ -1,4 +1,4 @@
1
- import { type Maybe } from '@dereekb/util';
1
+ import { type SuggestedString, type Maybe } from '@dereekb/util';
2
2
  import { type ZohoDeskAgentId } from './desk';
3
3
  /**
4
4
  * Agent status in Zoho Desk.
@@ -7,7 +7,7 @@ export type ZohoDeskAgentStatus = 'ACTIVE' | 'DISABLED';
7
7
  /**
8
8
  * Agent role permission type in Zoho Desk.
9
9
  */
10
- export type ZohoDeskAgentRolePermissionType = 'Light' | 'AgentPublic' | 'Custom' | 'AgentPersonal' | 'Admin' | (string & {});
10
+ export type ZohoDeskAgentRolePermissionType = SuggestedString<'Light' | 'AgentPublic' | 'Custom' | 'AgentPersonal' | 'Admin'>;
11
11
  /**
12
12
  * Related entities that can be expanded when fetching agents.
13
13
  */
@@ -26,8 +26,8 @@ export type ZohoDeskGetTicketActivitiesFunction = (input: ZohoDeskGetTicketActiv
26
26
  *
27
27
  * Retrieves a paginated list of activities (tasks, events, calls) associated with a ticket.
28
28
  *
29
- * @param context - Authenticated Zoho Desk context
30
- * @returns Function that retrieves activities for a ticket
29
+ * @param context - Authenticated Zoho Desk context.
30
+ * @returns Function that retrieves activities for a ticket.
31
31
  */
32
32
  export declare function zohoDeskGetTicketActivities(context: ZohoDeskContext): ZohoDeskGetTicketActivitiesFunction;
33
33
  /**
@@ -37,8 +37,9 @@ export type ZohoDeskGetTicketActivitiesPageFactory = (input: ZohoDeskGetTicketAc
37
37
  /**
38
38
  * Creates a {@link ZohoDeskGetTicketActivitiesPageFactory} bound to the given context.
39
39
  *
40
- * @param context - Authenticated Zoho Desk context
41
- * @returns Page factory for iterating over activity results
40
+ * @param context - Authenticated Zoho Desk context.
41
+ * @returns Page factory for iterating over activity results.
42
+ *
42
43
  * @__NO_SIDE_EFFECTS__
43
44
  */
44
45
  export declare function zohoDeskGetTicketActivitiesPageFactory(context: ZohoDeskContext): ZohoDeskGetTicketActivitiesPageFactory;
@@ -26,8 +26,8 @@ export type ZohoDeskGetAgentsFunction = (input: ZohoDeskGetAgentsInput) => Promi
26
26
  * Retrieves a paginated list of agents, with optional filtering by department and status,
27
27
  * and inline expansion of related entities (role, profile, departments).
28
28
  *
29
- * @param context - Authenticated Zoho Desk context
30
- * @returns Function that retrieves paginated agents
29
+ * @param context - Authenticated Zoho Desk context.
30
+ * @returns Function that retrieves paginated agents.
31
31
  */
32
32
  export declare function zohoDeskGetAgents(context: ZohoDeskContext): ZohoDeskGetAgentsFunction;
33
33
  /**
@@ -44,8 +44,8 @@ export type ZohoDeskGetAgentByIdFunction = (input: ZohoDeskGetAgentByIdInput) =>
44
44
  /**
45
45
  * Creates a {@link ZohoDeskGetAgentByIdFunction} bound to the given context.
46
46
  *
47
- * @param context - Authenticated Zoho Desk context
48
- * @returns Function that retrieves a single agent
47
+ * @param context - Authenticated Zoho Desk context.
48
+ * @returns Function that retrieves a single agent.
49
49
  */
50
50
  export declare function zohoDeskGetAgentById(context: ZohoDeskContext): ZohoDeskGetAgentByIdFunction;
51
51
  /**
@@ -61,8 +61,8 @@ export type ZohoDeskGetAgentsByIdsFunction = (input: ZohoDeskGetAgentsByIdsInput
61
61
  /**
62
62
  * Creates a {@link ZohoDeskGetAgentsByIdsFunction} bound to the given context.
63
63
  *
64
- * @param context - Authenticated Zoho Desk context
65
- * @returns Function that retrieves agents by IDs
64
+ * @param context - Authenticated Zoho Desk context.
65
+ * @returns Function that retrieves agents by IDs.
66
66
  */
67
67
  export declare function zohoDeskGetAgentsByIds(context: ZohoDeskContext): ZohoDeskGetAgentsByIdsFunction;
68
68
  /**
@@ -74,8 +74,8 @@ export type ZohoDeskGetMyInfoFunction = () => Promise<ZohoDeskAgent>;
74
74
  *
75
75
  * Retrieves the profile of the agent associated with the current OAuth token.
76
76
  *
77
- * @param context - Authenticated Zoho Desk context
78
- * @returns Function that retrieves the current agent's info
77
+ * @param context - Authenticated Zoho Desk context.
78
+ * @returns Function that retrieves the current agent's info.
79
79
  */
80
80
  export declare function zohoDeskGetMyInfo(context: ZohoDeskContext): ZohoDeskGetMyInfoFunction;
81
81
  /**
@@ -85,8 +85,9 @@ export type ZohoDeskGetAgentsPageFactory = (input: ZohoDeskGetAgentsInput, optio
85
85
  /**
86
86
  * Creates a {@link ZohoDeskGetAgentsPageFactory} bound to the given context.
87
87
  *
88
- * @param context - Authenticated Zoho Desk context
89
- * @returns Page factory for iterating over agent results
88
+ * @param context - Authenticated Zoho Desk context.
89
+ * @returns Page factory for iterating over agent results.
90
+ *
90
91
  * @__NO_SIDE_EFFECTS__
91
92
  */
92
93
  export declare function zohoDeskGetAgentsPageFactory(context: ZohoDeskContext): ZohoDeskGetAgentsPageFactory;
@@ -23,8 +23,8 @@ export type ZohoDeskGetTicketAttachmentsFunction = (input: ZohoDeskGetTicketAtta
23
23
  /**
24
24
  * Creates a {@link ZohoDeskGetTicketAttachmentsFunction} bound to the given context.
25
25
  *
26
- * @param context - Authenticated Zoho Desk context
27
- * @returns Function that retrieves attachments for a ticket
26
+ * @param context - Authenticated Zoho Desk context.
27
+ * @returns Function that retrieves attachments for a ticket.
28
28
  */
29
29
  export declare function zohoDeskGetTicketAttachments(context: ZohoDeskContext): ZohoDeskGetTicketAttachmentsFunction;
30
30
  /**
@@ -41,7 +41,7 @@ export type ZohoDeskDeleteTicketAttachmentFunction = (input: ZohoDeskDeleteTicke
41
41
  /**
42
42
  * Creates a {@link ZohoDeskDeleteTicketAttachmentFunction} bound to the given context.
43
43
  *
44
- * @param context - Authenticated Zoho Desk context
45
- * @returns Function that deletes a ticket attachment
44
+ * @param context - Authenticated Zoho Desk context.
45
+ * @returns Function that deletes a ticket attachment.
46
46
  */
47
47
  export declare function zohoDeskDeleteTicketAttachment(context: ZohoDeskContext): ZohoDeskDeleteTicketAttachmentFunction;
@@ -22,8 +22,8 @@ export type ZohoDeskGetTicketCommentsFunction = (input: ZohoDeskGetTicketComment
22
22
  /**
23
23
  * Creates a {@link ZohoDeskGetTicketCommentsFunction} bound to the given context.
24
24
  *
25
- * @param context - Authenticated Zoho Desk context
26
- * @returns Function that retrieves comments for a ticket
25
+ * @param context - Authenticated Zoho Desk context.
26
+ * @returns Function that retrieves comments for a ticket.
27
27
  */
28
28
  export declare function zohoDeskGetTicketComments(context: ZohoDeskContext): ZohoDeskGetTicketCommentsFunction;
29
29
  /**
@@ -41,8 +41,8 @@ export type ZohoDeskGetTicketCommentByIdFunction = (input: ZohoDeskGetTicketComm
41
41
  /**
42
42
  * Creates a {@link ZohoDeskGetTicketCommentByIdFunction} bound to the given context.
43
43
  *
44
- * @param context - Authenticated Zoho Desk context
45
- * @returns Function that retrieves a single comment
44
+ * @param context - Authenticated Zoho Desk context.
45
+ * @returns Function that retrieves a single comment.
46
46
  */
47
47
  export declare function zohoDeskGetTicketCommentById(context: ZohoDeskContext): ZohoDeskGetTicketCommentByIdFunction;
48
48
  /**
@@ -62,8 +62,8 @@ export type ZohoDeskCreateTicketCommentFunction = (input: ZohoDeskCreateTicketCo
62
62
  /**
63
63
  * Creates a {@link ZohoDeskCreateTicketCommentFunction} bound to the given context.
64
64
  *
65
- * @param context - Authenticated Zoho Desk context
66
- * @returns Function that creates a comment on a ticket
65
+ * @param context - Authenticated Zoho Desk context.
66
+ * @returns Function that creates a comment on a ticket.
67
67
  */
68
68
  export declare function zohoDeskCreateTicketComment(context: ZohoDeskContext): ZohoDeskCreateTicketCommentFunction;
69
69
  /**
@@ -80,7 +80,7 @@ export type ZohoDeskDeleteTicketCommentFunction = (input: ZohoDeskDeleteTicketCo
80
80
  /**
81
81
  * Creates a {@link ZohoDeskDeleteTicketCommentFunction} bound to the given context.
82
82
  *
83
- * @param context - Authenticated Zoho Desk context
84
- * @returns Function that deletes a comment from a ticket
83
+ * @param context - Authenticated Zoho Desk context.
84
+ * @returns Function that deletes a comment from a ticket.
85
85
  */
86
86
  export declare function zohoDeskDeleteTicketComment(context: ZohoDeskContext): ZohoDeskDeleteTicketCommentFunction;
@@ -27,8 +27,8 @@ export type ZohoDeskGetContactsFunction = (input: ZohoDeskGetContactsInput) => P
27
27
  * Retrieves a paginated list of contacts from Zoho Desk, with optional sorting,
28
28
  * inline expansion of related entities, and custom view filtering.
29
29
  *
30
- * @param context - Authenticated Zoho Desk context
31
- * @returns Function that retrieves paginated contacts
30
+ * @param context - Authenticated Zoho Desk context.
31
+ * @returns Function that retrieves paginated contacts.
32
32
  */
33
33
  export declare function zohoDeskGetContacts(context: ZohoDeskContext): ZohoDeskGetContactsFunction;
34
34
  /**
@@ -45,8 +45,8 @@ export type ZohoDeskGetContactByIdFunction = (input: ZohoDeskGetContactByIdInput
45
45
  /**
46
46
  * Creates a {@link ZohoDeskGetContactByIdFunction} bound to the given context.
47
47
  *
48
- * @param context - Authenticated Zoho Desk context
49
- * @returns Function that retrieves a single contact
48
+ * @param context - Authenticated Zoho Desk context.
49
+ * @returns Function that retrieves a single contact.
50
50
  */
51
51
  export declare function zohoDeskGetContactById(context: ZohoDeskContext): ZohoDeskGetContactByIdFunction;
52
52
  /**
@@ -64,8 +64,8 @@ export type ZohoDeskGetContactsByIdsFunction = (input: ZohoDeskGetContactsByIdsI
64
64
  *
65
65
  * Retrieves multiple contacts in a single request by providing their IDs.
66
66
  *
67
- * @param context - Authenticated Zoho Desk context
68
- * @returns Function that retrieves contacts by IDs
67
+ * @param context - Authenticated Zoho Desk context.
68
+ * @returns Function that retrieves contacts by IDs.
69
69
  */
70
70
  export declare function zohoDeskGetContactsByIds(context: ZohoDeskContext): ZohoDeskGetContactsByIdsFunction;
71
71
  /**
@@ -75,8 +75,9 @@ export type ZohoDeskGetContactsPageFactory = (input: ZohoDeskGetContactsInput, o
75
75
  /**
76
76
  * Creates a {@link ZohoDeskGetContactsPageFactory} bound to the given context.
77
77
  *
78
- * @param context - Authenticated Zoho Desk context
79
- * @returns Page factory for iterating over contact results
78
+ * @param context - Authenticated Zoho Desk context.
79
+ * @returns Page factory for iterating over contact results.
80
+ *
80
81
  * @__NO_SIDE_EFFECTS__
81
82
  */
82
83
  export declare function zohoDeskGetContactsPageFactory(context: ZohoDeskContext): ZohoDeskGetContactsPageFactory;
@@ -24,8 +24,8 @@ export type ZohoDeskGetDepartmentsFunction = (input: ZohoDeskGetDepartmentsInput
24
24
  * Retrieves a paginated list of departments from Zoho Desk, with optional filtering
25
25
  * by chat status, search string, and enabled state.
26
26
  *
27
- * @param context - Authenticated Zoho Desk context
28
- * @returns Function that retrieves paginated departments
27
+ * @param context - Authenticated Zoho Desk context.
28
+ * @returns Function that retrieves paginated departments.
29
29
  */
30
30
  export declare function zohoDeskGetDepartments(context: ZohoDeskContext): ZohoDeskGetDepartmentsFunction;
31
31
  /**
@@ -41,7 +41,7 @@ export type ZohoDeskGetDepartmentByIdFunction = (input: ZohoDeskGetDepartmentByI
41
41
  /**
42
42
  * Creates a {@link ZohoDeskGetDepartmentByIdFunction} bound to the given context.
43
43
  *
44
- * @param context - Authenticated Zoho Desk context
45
- * @returns Function that retrieves a single department
44
+ * @param context - Authenticated Zoho Desk context.
45
+ * @returns Function that retrieves a single department.
46
46
  */
47
47
  export declare function zohoDeskGetDepartmentById(context: ZohoDeskContext): ZohoDeskGetDepartmentByIdFunction;
@@ -15,8 +15,8 @@ export type ZohoDeskGetTicketFollowersFunction = (input: ZohoDeskGetTicketFollow
15
15
  /**
16
16
  * Creates a {@link ZohoDeskGetTicketFollowersFunction} bound to the given context.
17
17
  *
18
- * @param context - Authenticated Zoho Desk context
19
- * @returns Function that retrieves followers for a ticket
18
+ * @param context - Authenticated Zoho Desk context.
19
+ * @returns Function that retrieves followers for a ticket.
20
20
  */
21
21
  export declare function zohoDeskGetTicketFollowers(context: ZohoDeskContext): ZohoDeskGetTicketFollowersFunction;
22
22
  /**
@@ -33,8 +33,8 @@ export type ZohoDeskAddTicketFollowersFunction = (input: ZohoDeskAddTicketFollow
33
33
  /**
34
34
  * Creates a {@link ZohoDeskAddTicketFollowersFunction} bound to the given context.
35
35
  *
36
- * @param context - Authenticated Zoho Desk context
37
- * @returns Function that adds followers to a ticket
36
+ * @param context - Authenticated Zoho Desk context.
37
+ * @returns Function that adds followers to a ticket.
38
38
  */
39
39
  export declare function zohoDeskAddTicketFollowers(context: ZohoDeskContext): ZohoDeskAddTicketFollowersFunction;
40
40
  /**
@@ -51,7 +51,7 @@ export type ZohoDeskRemoveTicketFollowersFunction = (input: ZohoDeskRemoveTicket
51
51
  /**
52
52
  * Creates a {@link ZohoDeskRemoveTicketFollowersFunction} bound to the given context.
53
53
  *
54
- * @param context - Authenticated Zoho Desk context
55
- * @returns Function that removes followers from a ticket
54
+ * @param context - Authenticated Zoho Desk context.
55
+ * @returns Function that removes followers from a ticket.
56
56
  */
57
57
  export declare function zohoDeskRemoveTicketFollowers(context: ZohoDeskContext): ZohoDeskRemoveTicketFollowersFunction;
@@ -7,7 +7,7 @@ export declare const ZOHO_DESK_MAX_PAGE_LIMIT = 50;
7
7
  /**
8
8
  * Default number of records per page for Zoho Desk list endpoints.
9
9
  */
10
- export declare const ZOHO_DESK_DEFAULT_PAGE_LIMIT = 25;
10
+ export declare const DEFAULT_ZOHO_DESK_PAGE_LIMIT = 25;
11
11
  /**
12
12
  * Pagination parameters for Zoho Desk list endpoints.
13
13
  *
@@ -24,7 +24,7 @@ export interface ZohoDeskPageFilter {
24
24
  /**
25
25
  * Number of records to return per page.
26
26
  *
27
- * Defaults to {@link ZOHO_DESK_DEFAULT_PAGE_LIMIT}. Maximum is {@link ZOHO_DESK_MAX_PAGE_LIMIT}.
27
+ * Defaults to {@link DEFAULT_ZOHO_DESK_PAGE_LIMIT}. Maximum is {@link ZOHO_DESK_MAX_PAGE_LIMIT}.
28
28
  */
29
29
  readonly limit?: number;
30
30
  }
@@ -53,9 +53,9 @@ export type ZohoDeskFetchPageFetchFunction<I extends ZohoDeskPageFilter, R exten
53
53
  * against the requested `limit`. If `data.length >= limit`, more records are assumed to exist.
54
54
  * The `from` offset is automatically advanced by `limit` for subsequent requests.
55
55
  *
56
- * @param fetch - The Zoho Desk fetch function to paginate over
57
- * @param defaults - Optional default configuration for the page factory
58
- * @returns A page factory that produces iterable page fetchers
56
+ * @param fetch - The Zoho Desk fetch function to paginate over.
57
+ * @param defaults - Optional default configuration for the page factory.
58
+ * @returns A page factory that produces iterable page fetchers.
59
59
  *
60
60
  * @example
61
61
  * ```typescript
@@ -68,6 +68,7 @@ export type ZohoDeskFetchPageFetchFunction<I extends ZohoDeskPageFilter, R exten
68
68
  * const secondPage = await firstPage.fetchNext();
69
69
  * }
70
70
  * ```
71
+ *
71
72
  * @__NO_SIDE_EFFECTS__
72
73
  */
73
74
  export declare function zohoDeskFetchPageFactory<I extends ZohoDeskPageFilter, R extends ZohoDeskPageResult<any>>(fetch: ZohoDeskFetchPageFetchFunction<I, R>, defaults?: Maybe<FetchPageFactoryConfigDefaults>): import("@dereekb/util/fetch").FetchPageFactory<I, R>;
@@ -16,8 +16,8 @@ export type ZohoDeskGetTicketTagsFunction = (input: ZohoDeskGetTicketTagsInput)
16
16
  /**
17
17
  * Creates a {@link ZohoDeskGetTicketTagsFunction} bound to the given context.
18
18
  *
19
- * @param context - Authenticated Zoho Desk context
20
- * @returns Function that retrieves tags for a ticket
19
+ * @param context - Authenticated Zoho Desk context.
20
+ * @returns Function that retrieves tags for a ticket.
21
21
  */
22
22
  export declare function zohoDeskGetTicketTags(context: ZohoDeskContext): ZohoDeskGetTicketTagsFunction;
23
23
  /**
@@ -36,8 +36,8 @@ export type ZohoDeskAssociateTicketTagsFunction = (input: ZohoDeskAssociateTicke
36
36
  *
37
37
  * Associates one or more tags with a ticket. If the tag does not exist, it will be created.
38
38
  *
39
- * @param context - Authenticated Zoho Desk context
40
- * @returns Function that associates tags with a ticket
39
+ * @param context - Authenticated Zoho Desk context.
40
+ * @returns Function that associates tags with a ticket.
41
41
  */
42
42
  export declare function zohoDeskAssociateTicketTags(context: ZohoDeskContext): ZohoDeskAssociateTicketTagsFunction;
43
43
  /**
@@ -54,8 +54,8 @@ export type ZohoDeskDissociateTicketTagFunction = (input: ZohoDeskDissociateTick
54
54
  /**
55
55
  * Creates a {@link ZohoDeskDissociateTicketTagFunction} bound to the given context.
56
56
  *
57
- * @param context - Authenticated Zoho Desk context
58
- * @returns Function that removes a tag from a ticket
57
+ * @param context - Authenticated Zoho Desk context.
58
+ * @returns Function that removes a tag from a ticket.
59
59
  */
60
60
  export declare function zohoDeskDissociateTicketTag(context: ZohoDeskContext): ZohoDeskDissociateTicketTagFunction;
61
61
  /**
@@ -72,8 +72,8 @@ export type ZohoDeskSearchTagsFunction = (input: ZohoDeskSearchTagsInput) => Pro
72
72
  /**
73
73
  * Creates a {@link ZohoDeskSearchTagsFunction} bound to the given context.
74
74
  *
75
- * @param context - Authenticated Zoho Desk context
76
- * @returns Function that searches for tags
75
+ * @param context - Authenticated Zoho Desk context.
76
+ * @returns Function that searches for tags.
77
77
  */
78
78
  export declare function zohoDeskSearchTags(context: ZohoDeskContext): ZohoDeskSearchTagsFunction;
79
79
  /**
@@ -96,7 +96,7 @@ export type ZohoDeskGetAllTagsFunction = (input: ZohoDeskGetAllTagsInput) => Pro
96
96
  /**
97
97
  * Creates a {@link ZohoDeskGetAllTagsFunction} bound to the given context.
98
98
  *
99
- * @param context - Authenticated Zoho Desk context
100
- * @returns Function that retrieves all tags
99
+ * @param context - Authenticated Zoho Desk context.
100
+ * @returns Function that retrieves all tags.
101
101
  */
102
102
  export declare function zohoDeskGetAllTags(context: ZohoDeskContext): ZohoDeskGetAllTagsFunction;
@@ -24,8 +24,8 @@ export type ZohoDeskGetTicketThreadsFunction = (input: ZohoDeskGetTicketThreadsI
24
24
  *
25
25
  * Retrieves a paginated list of conversation threads (emails, replies, notes) for a ticket.
26
26
  *
27
- * @param context - Authenticated Zoho Desk context
28
- * @returns Function that retrieves threads for a ticket
27
+ * @param context - Authenticated Zoho Desk context.
28
+ * @returns Function that retrieves threads for a ticket.
29
29
  */
30
30
  export declare function zohoDeskGetTicketThreads(context: ZohoDeskContext): ZohoDeskGetTicketThreadsFunction;
31
31
  /**
@@ -43,8 +43,8 @@ export type ZohoDeskGetTicketThreadByIdFunction = (input: ZohoDeskGetTicketThrea
43
43
  /**
44
44
  * Creates a {@link ZohoDeskGetTicketThreadByIdFunction} bound to the given context.
45
45
  *
46
- * @param context - Authenticated Zoho Desk context
47
- * @returns Function that retrieves a single thread
46
+ * @param context - Authenticated Zoho Desk context.
47
+ * @returns Function that retrieves a single thread.
48
48
  */
49
49
  export declare function zohoDeskGetTicketThreadById(context: ZohoDeskContext): ZohoDeskGetTicketThreadByIdFunction;
50
50
  /**
@@ -54,8 +54,9 @@ export type ZohoDeskGetTicketThreadsPageFactory = (input: ZohoDeskGetTicketThrea
54
54
  /**
55
55
  * Creates a {@link ZohoDeskGetTicketThreadsPageFactory} bound to the given context.
56
56
  *
57
- * @param context - Authenticated Zoho Desk context
58
- * @returns Page factory for iterating over thread results
57
+ * @param context - Authenticated Zoho Desk context.
58
+ * @returns Page factory for iterating over thread results.
59
+ *
59
60
  * @__NO_SIDE_EFFECTS__
60
61
  */
61
62
  export declare function zohoDeskGetTicketThreadsPageFactory(context: ZohoDeskContext): ZohoDeskGetTicketThreadsPageFactory;
@@ -7,9 +7,9 @@ import { type ZohoDeskPageFilter, type ZohoDeskPageResult } from './desk.api.pag
7
7
  /**
8
8
  * Constructs the standard FetchJsonInput used by Desk API calls, pairing the HTTP method with an optional body.
9
9
  *
10
- * @param method - HTTP method to use for the request
11
- * @param body - Optional request body to include
12
- * @returns Configured fetch input for the Zoho Desk API call
10
+ * @param method - HTTP method to use for the request.
11
+ * @param body - Optional request body to include.
12
+ * @returns Configured fetch input for the Zoho Desk API call.
13
13
  */
14
14
  export declare function zohoDeskApiFetchJsonInput(method: string, body?: Maybe<FetchJsonBody>): FetchJsonInput;
15
15
  /**
@@ -42,8 +42,8 @@ export type ZohoDeskGetTicketsFunction = (input: ZohoDeskGetTicketsInput) => Pro
42
42
  * Retrieves a paginated list of tickets from Zoho Desk, with optional filtering by
43
43
  * department, status, priority, channel, assignee, and view.
44
44
  *
45
- * @param context - Authenticated Zoho Desk context
46
- * @returns Function that retrieves paginated tickets
45
+ * @param context - Authenticated Zoho Desk context.
46
+ * @returns Function that retrieves paginated tickets.
47
47
  */
48
48
  export declare function zohoDeskGetTickets(context: ZohoDeskContext): ZohoDeskGetTicketsFunction;
49
49
  /**
@@ -62,8 +62,8 @@ export type ZohoDeskGetTicketByIdFunction = (input: ZohoDeskGetTicketByIdInput)
62
62
  *
63
63
  * Retrieves a single ticket by its ID, with optional inline expansion of related entities.
64
64
  *
65
- * @param context - Authenticated Zoho Desk context
66
- * @returns Function that retrieves a single ticket
65
+ * @param context - Authenticated Zoho Desk context.
66
+ * @returns Function that retrieves a single ticket.
67
67
  */
68
68
  export declare function zohoDeskGetTicketById(context: ZohoDeskContext): ZohoDeskGetTicketByIdFunction;
69
69
  /**
@@ -119,8 +119,8 @@ export type ZohoDeskSearchTicketsFunction = (input: ZohoDeskSearchTicketsInput)
119
119
  * Searches for tickets matching the given filter criteria. Supports filtering by
120
120
  * many fields including subject, email, status, priority, date ranges, and custom fields.
121
121
  *
122
- * @param context - Authenticated Zoho Desk context
123
- * @returns Function that searches for tickets
122
+ * @param context - Authenticated Zoho Desk context.
123
+ * @returns Function that searches for tickets.
124
124
  */
125
125
  export declare function zohoDeskSearchTickets(context: ZohoDeskContext): ZohoDeskSearchTicketsFunction;
126
126
  /**
@@ -140,8 +140,8 @@ export type ZohoDeskGetTicketsForContactFunction = (input: ZohoDeskGetTicketsFor
140
140
  /**
141
141
  * Creates a {@link ZohoDeskGetTicketsForContactFunction} bound to the given context.
142
142
  *
143
- * @param context - Authenticated Zoho Desk context
144
- * @returns Function that retrieves tickets for a contact
143
+ * @param context - Authenticated Zoho Desk context.
144
+ * @returns Function that retrieves tickets for a contact.
145
145
  */
146
146
  export declare function zohoDeskGetTicketsForContact(context: ZohoDeskContext): ZohoDeskGetTicketsForContactFunction;
147
147
  /**
@@ -161,8 +161,8 @@ export type ZohoDeskGetTicketsForProductFunction = (input: ZohoDeskGetTicketsFor
161
161
  /**
162
162
  * Creates a {@link ZohoDeskGetTicketsForProductFunction} bound to the given context.
163
163
  *
164
- * @param context - Authenticated Zoho Desk context
165
- * @returns Function that retrieves tickets for a product
164
+ * @param context - Authenticated Zoho Desk context.
165
+ * @returns Function that retrieves tickets for a product.
166
166
  */
167
167
  export declare function zohoDeskGetTicketsForProduct(context: ZohoDeskContext): ZohoDeskGetTicketsForProductFunction;
168
168
  /**
@@ -178,8 +178,8 @@ export type ZohoDeskGetTicketMetricsFunction = (input: ZohoDeskGetTicketMetricsI
178
178
  /**
179
179
  * Creates a {@link ZohoDeskGetTicketMetricsFunction} bound to the given context.
180
180
  *
181
- * @param context - Authenticated Zoho Desk context
182
- * @returns Function that retrieves ticket metrics
181
+ * @param context - Authenticated Zoho Desk context.
182
+ * @returns Function that retrieves ticket metrics.
183
183
  */
184
184
  export declare function zohoDeskGetTicketMetrics(context: ZohoDeskContext): ZohoDeskGetTicketMetricsFunction;
185
185
  /**
@@ -196,8 +196,8 @@ export type ZohoDeskGetAgentsTicketsCountFunction = (input: ZohoDeskGetAgentsTic
196
196
  /**
197
197
  * Creates a {@link ZohoDeskGetAgentsTicketsCountFunction} bound to the given context.
198
198
  *
199
- * @param context - Authenticated Zoho Desk context
200
- * @returns Function that retrieves agent ticket counts
199
+ * @param context - Authenticated Zoho Desk context.
200
+ * @returns Function that retrieves agent ticket counts.
201
201
  */
202
202
  export declare function zohoDeskGetAgentsTicketsCount(context: ZohoDeskContext): ZohoDeskGetAgentsTicketsCountFunction;
203
203
  /**
@@ -210,8 +210,9 @@ export type ZohoDeskGetTicketsPageFactory = (input: ZohoDeskGetTicketsInput, opt
210
210
  * Returns a page factory that automatically handles Zoho Desk's offset-based pagination,
211
211
  * making it easy to iterate through all tickets across multiple pages.
212
212
  *
213
- * @param context - Authenticated Zoho Desk context
214
- * @returns Page factory for iterating over ticket results
213
+ * @param context - Authenticated Zoho Desk context.
214
+ * @returns Page factory for iterating over ticket results.
215
+ *
215
216
  * @__NO_SIDE_EFFECTS__
216
217
  */
217
218
  export declare function zohoDeskGetTicketsPageFactory(context: ZohoDeskContext): ZohoDeskGetTicketsPageFactory;
@@ -222,8 +223,9 @@ export type ZohoDeskSearchTicketsPageFactory = (input: ZohoDeskSearchTicketsInpu
222
223
  /**
223
224
  * Creates a {@link ZohoDeskSearchTicketsPageFactory} bound to the given context.
224
225
  *
225
- * @param context - Authenticated Zoho Desk context
226
- * @returns Page factory for iterating over search results
226
+ * @param context - Authenticated Zoho Desk context.
227
+ * @returns Page factory for iterating over search results.
228
+ *
227
229
  * @__NO_SIDE_EFFECTS__
228
230
  */
229
231
  export declare function zohoDeskSearchTicketsPageFactory(context: ZohoDeskContext): ZohoDeskSearchTicketsPageFactory;
@@ -16,8 +16,8 @@ export type ZohoDeskGetTicketTimerFunction = (input: ZohoDeskGetTicketTimerInput
16
16
  /**
17
17
  * Creates a {@link ZohoDeskGetTicketTimerFunction} bound to the given context.
18
18
  *
19
- * @param context - Authenticated Zoho Desk context
20
- * @returns Function that retrieves the ticket timer
19
+ * @param context - Authenticated Zoho Desk context.
20
+ * @returns Function that retrieves the ticket timer.
21
21
  */
22
22
  export declare function zohoDeskGetTicketTimer(context: ZohoDeskContext): ZohoDeskGetTicketTimerFunction;
23
23
  /**
@@ -38,8 +38,8 @@ export type ZohoDeskPerformTicketTimerActionFunction = (input: ZohoDeskPerformTi
38
38
  /**
39
39
  * Creates a {@link ZohoDeskPerformTicketTimerActionFunction} bound to the given context.
40
40
  *
41
- * @param context - Authenticated Zoho Desk context
42
- * @returns Function that performs a timer action on a ticket
41
+ * @param context - Authenticated Zoho Desk context.
42
+ * @returns Function that performs a timer action on a ticket.
43
43
  */
44
44
  export declare function zohoDeskPerformTicketTimerAction(context: ZohoDeskContext): ZohoDeskPerformTicketTimerActionFunction;
45
45
  /**
@@ -60,8 +60,8 @@ export type ZohoDeskGetTicketTimeEntriesFunction = (input: ZohoDeskGetTicketTime
60
60
  /**
61
61
  * Creates a {@link ZohoDeskGetTicketTimeEntriesFunction} bound to the given context.
62
62
  *
63
- * @param context - Authenticated Zoho Desk context
64
- * @returns Function that retrieves time entries for a ticket
63
+ * @param context - Authenticated Zoho Desk context.
64
+ * @returns Function that retrieves time entries for a ticket.
65
65
  */
66
66
  export declare function zohoDeskGetTicketTimeEntries(context: ZohoDeskContext): ZohoDeskGetTicketTimeEntriesFunction;
67
67
  /**
@@ -78,8 +78,8 @@ export type ZohoDeskGetTicketTimeEntryByIdFunction = (input: ZohoDeskGetTicketTi
78
78
  /**
79
79
  * Creates a {@link ZohoDeskGetTicketTimeEntryByIdFunction} bound to the given context.
80
80
  *
81
- * @param context - Authenticated Zoho Desk context
82
- * @returns Function that retrieves a single time entry
81
+ * @param context - Authenticated Zoho Desk context.
82
+ * @returns Function that retrieves a single time entry.
83
83
  */
84
84
  export declare function zohoDeskGetTicketTimeEntryById(context: ZohoDeskContext): ZohoDeskGetTicketTimeEntryByIdFunction;
85
85
  /**
@@ -103,7 +103,7 @@ export type ZohoDeskGetTicketTimeEntrySummationFunction = (input: ZohoDeskGetTic
103
103
  /**
104
104
  * Creates a {@link ZohoDeskGetTicketTimeEntrySummationFunction} bound to the given context.
105
105
  *
106
- * @param context - Authenticated Zoho Desk context
107
- * @returns Function that retrieves time entry summation
106
+ * @param context - Authenticated Zoho Desk context.
107
+ * @returns Function that retrieves time entry summation.
108
108
  */
109
109
  export declare function zohoDeskGetTicketTimeEntrySummation(context: ZohoDeskContext): ZohoDeskGetTicketTimeEntrySummationFunction;
@@ -28,8 +28,8 @@ export type ZohoDeskConfigApiUrlInput = ZohoDeskApiUrlKey | ZohoDeskApiUrl;
28
28
  * Resolves a Desk API URL input to its full base URL. The 'production' key maps to the
29
29
  * primary Zoho Desk endpoint; custom URLs pass through unchanged.
30
30
  *
31
- * @param input - A well-known environment key or a custom Desk API URL
32
- * @returns The resolved full Zoho Desk API base URL
31
+ * @param input - A well-known environment key or a custom Desk API URL.
32
+ * @returns The resolved full Zoho Desk API base URL.
33
33
  */
34
34
  export declare function zohoDeskConfigApiUrl(input: ZohoDeskConfigApiUrlInput): ZohoApiUrl;
35
35
  /**
@@ -8,17 +8,17 @@ export declare const logZohoDeskErrorToConsole: import("..").LogZohoServerErrorF
8
8
  /**
9
9
  * Parses a fetch response error into a typed Zoho Desk server error by extracting and interpreting the JSON error body.
10
10
  *
11
- * @param responseError - The fetch response error to parse
12
- * @returns The parsed Zoho server error, or undefined if the response could not be parsed
11
+ * @param responseError - The fetch response error to parse.
12
+ * @returns The parsed Zoho server error, or undefined if the response could not be parsed.
13
13
  */
14
14
  export declare function parseZohoDeskError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
15
15
  /**
16
16
  * Parses a Zoho Desk error response body into a typed error. Delegates to Desk-specific
17
17
  * error code handling before falling back to the generic Zoho error parser.
18
18
  *
19
- * @param errorResponseData - The raw error response data from the Zoho Desk API
20
- * @param responseError - The original fetch response error for context
21
- * @returns The parsed Zoho server error, or undefined if the error could not be classified
19
+ * @param errorResponseData - The raw error response data from the Zoho Desk API.
20
+ * @param responseError - The original fetch response error for context.
21
+ * @returns The parsed Zoho server error, or undefined if the error could not be classified.
22
22
  */
23
23
  export declare function parseZohoDeskServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData | ZohoServerErrorResponseDataArrayRef, responseError: FetchResponseError): ParsedZohoServerError;
24
24
  /**
@@ -41,8 +41,9 @@ export type ZohoDeskFactory = (config: ZohoDeskConfig) => ZohoDesk;
41
41
  * Unlike CRM/Recruit/Sign, the Desk API requires an `orgId` header on every request.
42
42
  * This is injected automatically from the config.
43
43
  *
44
- * @param factoryConfig - Configuration providing account credentials and optional overrides
45
- * @returns A factory function that creates authenticated Zoho Desk clients
44
+ * @param factoryConfig - Configuration providing account credentials and optional overrides.
45
+ * @returns A factory function that creates authenticated Zoho Desk clients.
46
+ *
46
47
  * @__NO_SIDE_EFFECTS__
47
48
  */
48
49
  export declare function zohoDeskFactory(factoryConfig: ZohoDeskFactoryConfig): ZohoDeskFactory;
@@ -22,8 +22,8 @@ export declare const DEFAULT_ZOHO_DESK_API_RATE_LIMIT = 200;
22
22
  * Desk uses a credit-based system with `X-Rate-Limit-Remaining-v3` and `Retry-After` (in seconds)
23
23
  * rather than the `X-RATELIMIT-*` headers used by CRM/Recruit/Sign.
24
24
  *
25
- * @param headers - HTTP response headers from a Zoho Desk API call
26
- * @returns Parsed rate limit details, or null if the Desk rate limit headers are absent
25
+ * @param headers - HTTP response headers from a Zoho Desk API call.
26
+ * @returns Parsed rate limit details, or null if the Desk rate limit headers are absent.
27
27
  */
28
28
  export declare function zohoDeskRateLimitDetailsReader(headers: Headers): Maybe<ZohoRateLimitResponseDetails>;
29
29
  /**
@@ -33,7 +33,7 @@ export declare function zohoDeskRateLimitDetailsReader(headers: Headers): Maybe<
33
33
  * with the Desk-specific header reader. Unlike CRM, Desk does not provide a total limit header,
34
34
  * so the configured `maxRateLimit` (defaulting to {@link DEFAULT_ZOHO_DESK_API_RATE_LIMIT}) is used throughout.
35
35
  *
36
- * @param config - Optional configuration for rate limit, reset period, and 429 handling
36
+ * @param config - Optional configuration for rate limit, reset period, and 429 handling.
37
37
  * @returns A rate-limited fetch handler with the underlying rate limiter accessible via `_rateLimiter`
38
38
  */
39
39
  export declare function zohoDeskRateLimitedFetchHandler(config?: Maybe<ZohoRateLimitedFetchHandlerConfig>): ZohoRateLimitedFetchHandler;