@theholocron/zendesk-client 1.31.0 → 1.32.1

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.
package/dist/index.d.mts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { RestClient } from "@theholocron/http-client";
2
2
  import { ErrorSink, Logger } from "@theholocron/observability/core";
3
- //#region src/types.d.ts
3
+ //#region ../../../../../src/types.d.ts
4
4
  interface IAPIResponse {
5
5
  next_page?: string | null;
6
6
  previous_page?: string | null;
@@ -11,7 +11,7 @@ interface IAPIError {
11
11
  description: string;
12
12
  }
13
13
  //#endregion
14
- //#region src/attachments/attachments.types.d.ts
14
+ //#region ../../../../../src/attachments/attachments.types.d.ts
15
15
  interface IImage {
16
16
  content_type?: string | null;
17
17
  content_url?: string | null;
@@ -31,12 +31,12 @@ interface IAttachment extends IImage {
31
31
  thumbnails?: IImage[];
32
32
  }
33
33
  //#endregion
34
- //#region src/attachments/attachments.mocks.d.ts
34
+ //#region ../../../../../src/attachments/attachments.mocks.d.ts
35
35
  declare const mockImage: IImage;
36
36
  declare const mockThumbnail: IImage;
37
37
  declare const mockAttachment: IAttachment;
38
38
  //#endregion
39
- //#region src/user/user.types.d.ts
39
+ //#region ../../../../../src/user/user.types.d.ts
40
40
  interface IUser {
41
41
  active?: boolean | null;
42
42
  alias?: string | null;
@@ -79,7 +79,7 @@ interface IUser {
79
79
  verified?: boolean | null;
80
80
  }
81
81
  //#endregion
82
- //#region src/activities/activities.types.d.ts
82
+ //#region ../../../../../src/activities/activities.types.d.ts
83
83
  interface IActivity {
84
84
  actor?: IUser | null;
85
85
  actor_id?: number | null;
@@ -100,7 +100,7 @@ interface IActivityResponse extends IAPIResponse {
100
100
  users: IUser[];
101
101
  }
102
102
  //#endregion
103
- //#region src/tickets/fields.types.d.ts
103
+ //#region ../../../../../src/tickets/fields.types.d.ts
104
104
  interface ICustomField {
105
105
  id: number | null;
106
106
  value: string | number | string[] | null;
@@ -142,7 +142,7 @@ type TTicketFieldResponse = IAPIResponse & {
142
142
  ticket_field: ITicketField;
143
143
  };
144
144
  //#endregion
145
- //#region src/tickets/tickets.types.d.ts
145
+ //#region ../../../../../src/tickets/tickets.types.d.ts
146
146
  type TTicketStatus = "new" | "open" | "pending" | "hold" | "solved" | "closed";
147
147
  type TTicketPriority = "urgent" | "high" | "normal" | "low";
148
148
  type TTicketType = "problem" | "incident" | "question" | "task";
@@ -227,7 +227,7 @@ type TTicketResponse = IAPIResponse & {
227
227
  deleted_ticket_forms?: Array<unknown>;
228
228
  };
229
229
  //#endregion
230
- //#region src/tickets/comments.types.d.ts
230
+ //#region ../../../../../src/tickets/comments.types.d.ts
231
231
  interface IComment {
232
232
  attachments?: IAttachment[] | null;
233
233
  audit_id?: number | null;
@@ -247,7 +247,7 @@ interface ICommentResponse {
247
247
  comments: IComment[];
248
248
  }
249
249
  //#endregion
250
- //#region src/group/group.types.d.ts
250
+ //#region ../../../../../src/group/group.types.d.ts
251
251
  interface IGroup {
252
252
  created_at?: string | null;
253
253
  default?: boolean | null;
@@ -260,13 +260,13 @@ interface IGroup {
260
260
  url?: string | null;
261
261
  }
262
262
  //#endregion
263
- //#region src/search/search.types.d.ts
263
+ //#region ../../../../../src/search/search.types.d.ts
264
264
  interface ISearchResponse extends IAPIResponse {
265
265
  facets?: string | null;
266
266
  results: ITicket[] | IUser[] | IGroup[];
267
267
  }
268
268
  //#endregion
269
- //#region src/status/status.types.d.ts
269
+ //#region ../../../../../src/status/status.types.d.ts
270
270
  interface IStatus {
271
271
  active?: boolean | null;
272
272
  agent_label?: string | null;
@@ -296,7 +296,7 @@ interface ICustomStatusResponse extends IAPIResponse {
296
296
  custom_status: ICustomStatus;
297
297
  }
298
298
  //#endregion
299
- //#region src/utils.d.ts
299
+ //#region ../../../../../src/utils.d.ts
300
300
  declare const createToken: (user: string, password: string) => string;
301
301
  interface ZendeskClientOptions {
302
302
  /** Base URL of your Zendesk instance, e.g. "https://myorg.zendesk.com". */
@@ -311,29 +311,29 @@ interface ZendeskClientOptions {
311
311
  errors?: ErrorSink;
312
312
  }
313
313
  //#endregion
314
- //#region src/activities/activities.d.ts
314
+ //#region ../../../../../src/activities/activities.d.ts
315
315
  declare function activities(rest: RestClient): {
316
316
  get: (params?: Record<string, string>) => Promise<IActivityResponse>;
317
317
  };
318
318
  //#endregion
319
- //#region src/activities/activities.mocks.d.ts
319
+ //#region ../../../../../src/activities/activities.mocks.d.ts
320
320
  declare const mockActivity: IActivity;
321
321
  declare const mockActivityResponse: IActivityResponse;
322
322
  //#endregion
323
- //#region src/group/group.mocks.d.ts
323
+ //#region ../../../../../src/group/group.mocks.d.ts
324
324
  declare const mockGroup: IGroup;
325
325
  //#endregion
326
- //#region src/search/search.d.ts
326
+ //#region ../../../../../src/search/search.d.ts
327
327
  declare function search(rest: RestClient): {
328
328
  query: (q: string, params?: Record<string, string>) => Promise<ISearchResponse>;
329
329
  };
330
330
  //#endregion
331
- //#region src/search/search.mocks.d.ts
331
+ //#region ../../../../../src/search/search.mocks.d.ts
332
332
  declare const mockSearchResponseGroups: ISearchResponse;
333
333
  declare const mockSearchResponseTickets: ISearchResponse;
334
334
  declare const mockSearchResponseUsers: ISearchResponse;
335
335
  //#endregion
336
- //#region src/status/status.d.ts
336
+ //#region ../../../../../src/status/status.d.ts
337
337
  declare function status(rest: RestClient): {
338
338
  list: () => Promise<ICustomStatusesResponse>;
339
339
  get: (id: number) => Promise<ICustomStatusResponse>;
@@ -341,23 +341,23 @@ declare function status(rest: RestClient): {
341
341
  update: (id: number, data: Partial<ICustomStatus>) => Promise<ICustomStatusResponse>;
342
342
  };
343
343
  //#endregion
344
- //#region src/status/status.mocks.d.ts
344
+ //#region ../../../../../src/status/status.mocks.d.ts
345
345
  declare const mockDefaultStatus: IDefaultStatus;
346
346
  declare const mockCustomStatus: ICustomStatus;
347
347
  declare const mockCustomStatusesResponse: ICustomStatusesResponse;
348
348
  declare const mockCustomStatusResponse: ICustomStatusResponse;
349
349
  //#endregion
350
- //#region src/tickets/comments.d.ts
350
+ //#region ../../../../../src/tickets/comments.d.ts
351
351
  declare function comments(rest: RestClient): {
352
352
  list: (ticketId: number) => Promise<ICommentResponse>;
353
353
  create: (ticketId: number, body: string) => Promise<void>;
354
354
  };
355
355
  //#endregion
356
- //#region src/tickets/comments.mocks.d.ts
356
+ //#region ../../../../../src/tickets/comments.mocks.d.ts
357
357
  declare const mockComment: IComment;
358
358
  declare const mockCommentResponse: ICommentResponse;
359
359
  //#endregion
360
- //#region src/tickets/fields.d.ts
360
+ //#region ../../../../../src/tickets/fields.d.ts
361
361
  declare function fields(rest: RestClient): {
362
362
  list: () => Promise<TTicketFieldsResponse>;
363
363
  get: (id: number) => Promise<TTicketFieldResponse>;
@@ -366,7 +366,7 @@ declare function fields(rest: RestClient): {
366
366
  delete: (id: number) => Promise<void>;
367
367
  };
368
368
  //#endregion
369
- //#region src/tickets/fields.mocks.d.ts
369
+ //#region ../../../../../src/tickets/fields.mocks.d.ts
370
370
  declare const mockCustomField1: ICustomField;
371
371
  declare const mockCustomField2: ICustomField;
372
372
  declare const mockCustomFields: ICustomField[];
@@ -374,7 +374,7 @@ declare const mockTicketField: ITicketField;
374
374
  declare const mockTicketFieldsResponse: TTicketFieldsResponse;
375
375
  declare const mockTicketFieldResponse: TTicketFieldResponse;
376
376
  //#endregion
377
- //#region src/tickets/metrics.types.d.ts
377
+ //#region ../../../../../src/tickets/metrics.types.d.ts
378
378
  interface ITimeInMinutes {
379
379
  business: number;
380
380
  calendar: number;
@@ -407,10 +407,10 @@ interface ITicketMetric {
407
407
  updated_at: string;
408
408
  }
409
409
  //#endregion
410
- //#region src/tickets/metrics.mocks.d.ts
410
+ //#region ../../../../../src/tickets/metrics.mocks.d.ts
411
411
  declare const mockTicketMetric: ITicketMetric;
412
412
  //#endregion
413
- //#region src/tickets/tickets.d.ts
413
+ //#region ../../../../../src/tickets/tickets.d.ts
414
414
  declare function tickets(rest: RestClient): {
415
415
  list: (params?: Record<string, string>) => Promise<TTicketsResponse>;
416
416
  get: (id: number) => Promise<TTicketResponse>;
@@ -419,17 +419,17 @@ declare function tickets(rest: RestClient): {
419
419
  delete: (id: number) => Promise<void>;
420
420
  };
421
421
  //#endregion
422
- //#region src/tickets/tickets.mocks.d.ts
422
+ //#region ../../../../../src/tickets/tickets.mocks.d.ts
423
423
  declare const mockVia: IVia;
424
424
  declare const mockMetadata: IMetadata;
425
425
  declare const mockTicket: ITicket;
426
426
  declare const mockTicketsResponse: TTicketsResponse;
427
427
  declare const mockTicketResponse: TTicketResponse;
428
428
  //#endregion
429
- //#region src/user/user.mocks.d.ts
429
+ //#region ../../../../../src/user/user.mocks.d.ts
430
430
  declare const mockUser: IUser;
431
431
  //#endregion
432
- //#region src/index.d.ts
432
+ //#region ../../../../../src/index.d.ts
433
433
  declare function createZendeskClient(opts: ZendeskClientOptions): {
434
434
  activities: {
435
435
  get: (params?: Record<string, string>) => Promise<IActivityResponse>;
package/dist/index.mjs CHANGED
@@ -1,11 +1,11 @@
1
1
  import { createRestClient } from "@theholocron/http-client";
2
- //#region src/activities/activities.ts
2
+ //#region ../../../../../src/activities/activities.ts
3
3
  const PATH$5 = "/api/v2/activities";
4
4
  function activities(rest) {
5
5
  return { get: (params) => rest.request(PATH$5, { query: params }) };
6
6
  }
7
7
  //#endregion
8
- //#region src/search/search.ts
8
+ //#region ../../../../../src/search/search.ts
9
9
  const PATH$4 = "/api/v2/search";
10
10
  function search(rest) {
11
11
  return { query: (q, params) => rest.request(PATH$4, { query: {
@@ -15,7 +15,7 @@ function search(rest) {
15
15
  } }) };
16
16
  }
17
17
  //#endregion
18
- //#region src/status/status.ts
18
+ //#region ../../../../../src/status/status.ts
19
19
  const PATH$3 = "/api/v2/custom_statuses";
20
20
  function status(rest) {
21
21
  return {
@@ -32,7 +32,7 @@ function status(rest) {
32
32
  };
33
33
  }
34
34
  //#endregion
35
- //#region src/tickets/comments.ts
35
+ //#region ../../../../../src/tickets/comments.ts
36
36
  const PATH$2 = "/api/v2/tickets";
37
37
  function comments(rest) {
38
38
  return {
@@ -44,7 +44,7 @@ function comments(rest) {
44
44
  };
45
45
  }
46
46
  //#endregion
47
- //#region src/tickets/fields.ts
47
+ //#region ../../../../../src/tickets/fields.ts
48
48
  const PATH$1 = "/api/v2/ticket_fields";
49
49
  function fields(rest) {
50
50
  return {
@@ -65,7 +65,7 @@ function fields(rest) {
65
65
  };
66
66
  }
67
67
  //#endregion
68
- //#region src/tickets/tickets.ts
68
+ //#region ../../../../../src/tickets/tickets.ts
69
69
  const PATH = "/api/v2/tickets";
70
70
  function tickets(rest) {
71
71
  return {
@@ -89,7 +89,7 @@ function tickets(rest) {
89
89
  };
90
90
  }
91
91
  //#endregion
92
- //#region src/utils.ts
92
+ //#region ../../../../../src/utils.ts
93
93
  const createToken = (user, password) => Buffer.from(`${user}/token:${password}`).toString("base64");
94
94
  function createZendeskRestClient(opts) {
95
95
  return createRestClient({
@@ -102,7 +102,7 @@ function createZendeskRestClient(opts) {
102
102
  });
103
103
  }
104
104
  //#endregion
105
- //#region src/attachments/attachments.mocks.ts
105
+ //#region ../../../../../src/attachments/attachments.mocks.ts
106
106
  const mockImage = {
107
107
  content_type: "image/gif",
108
108
  content_url: "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif",
@@ -134,7 +134,7 @@ const mockAttachment = {
134
134
  thumbnails: [mockThumbnail]
135
135
  };
136
136
  //#endregion
137
- //#region src/user/user.mocks.ts
137
+ //#region ../../../../../src/user/user.mocks.ts
138
138
  const mockUser = {
139
139
  active: true,
140
140
  alias: "test",
@@ -179,7 +179,7 @@ const mockUser = {
179
179
  verified: true
180
180
  };
181
181
  //#endregion
182
- //#region src/activities/activities.mocks.ts
182
+ //#region ../../../../../src/activities/activities.mocks.ts
183
183
  const mockActivity = {
184
184
  actor: mockUser,
185
185
  actor_id: 158488612,
@@ -209,7 +209,7 @@ const mockActivityResponse = {
209
209
  users: [mockUser]
210
210
  };
211
211
  //#endregion
212
- //#region src/group/group.mocks.ts
212
+ //#region ../../../../../src/group/group.mocks.ts
213
213
  const mockGroup = {
214
214
  created_at: "2018-04-06T03:17:05Z",
215
215
  default: false,
@@ -221,7 +221,7 @@ const mockGroup = {
221
221
  url: "https://example.zendesk.com/api/v2/groups/1835972.json"
222
222
  };
223
223
  //#endregion
224
- //#region src/tickets/fields.mocks.ts
224
+ //#region ../../../../../src/tickets/fields.mocks.ts
225
225
  const mockCustomField1 = {
226
226
  id: 27642,
227
227
  value: "745"
@@ -263,7 +263,7 @@ const mockTicketFieldResponse = {
263
263
  ticket_field: mockTicketField
264
264
  };
265
265
  //#endregion
266
- //#region src/tickets/tickets.mocks.ts
266
+ //#region ../../../../../src/tickets/tickets.mocks.ts
267
267
  const mockVia = {
268
268
  channel: "web",
269
269
  source: {
@@ -326,7 +326,7 @@ const mockTicketResponse = {
326
326
  ticket: mockTicket
327
327
  };
328
328
  //#endregion
329
- //#region src/search/search.mocks.ts
329
+ //#region ../../../../../src/search/search.mocks.ts
330
330
  const mockSearchResponseGroups = {
331
331
  count: 1,
332
332
  facets: null,
@@ -343,7 +343,7 @@ const mockSearchResponseUsers = {
343
343
  results: [mockUser]
344
344
  };
345
345
  //#endregion
346
- //#region src/status/status.mocks.ts
346
+ //#region ../../../../../src/status/status.mocks.ts
347
347
  const mockDefaultStatus = {
348
348
  active: true,
349
349
  agent_label: "open",
@@ -377,7 +377,7 @@ const mockCustomStatusResponse = {
377
377
  custom_status: mockCustomStatus
378
378
  };
379
379
  //#endregion
380
- //#region src/tickets/comments.mocks.ts
380
+ //#region ../../../../../src/tickets/comments.mocks.ts
381
381
  const mockComment = {
382
382
  attachments: [mockAttachment],
383
383
  audit_id: 432567,
@@ -391,7 +391,7 @@ const mockComment = {
391
391
  };
392
392
  const mockCommentResponse = { comments: [mockComment] };
393
393
  //#endregion
394
- //#region src/tickets/metrics.mocks.ts
394
+ //#region ../../../../../src/tickets/metrics.mocks.ts
395
395
  const mockTicketMetric = {
396
396
  agent_wait_time_in_minutes: {
397
397
  business: 737,
@@ -436,7 +436,7 @@ const mockTicketMetric = {
436
436
  updated_at: "2011-05-05T10:38:52Z"
437
437
  };
438
438
  //#endregion
439
- //#region src/index.ts
439
+ //#region ../../../../../src/index.ts
440
440
  function createZendeskClient(opts) {
441
441
  const rest = createZendeskRestClient(opts);
442
442
  return {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theholocron/zendesk-client",
3
- "version": "1.31.0",
3
+ "version": "1.32.1",
4
4
  "description": "A TypeScript client for the Zendesk API",
5
5
  "keywords": [
6
6
  "zendesk",
@@ -33,13 +33,13 @@
33
33
  ],
34
34
  "dependencies": {
35
35
  "@theholocron/observability": "^0.3.0",
36
- "@theholocron/http-client": "^1.31.0"
36
+ "@theholocron/http-client": "^1.32.1"
37
37
  },
38
38
  "devDependencies": {
39
- "@theholocron/cli": "5.0.0-alpha.33",
39
+ "@theholocron/cli": "5.0.0-alpha.79",
40
40
  "@theholocron/eslint-config": "^8.4.3",
41
41
  "@theholocron/tsconfig": "^8.2.0",
42
- "@theholocron/tsdown-config": "^8.2.0",
42
+ "@theholocron/tsdown-config": "^8.6.1",
43
43
  "@theholocron/vitest-config": "^8.2.0",
44
44
  "@types/node": "^26.4.1",
45
45
  "@vitest/coverage-v8": "^5.0.0",
@@ -61,7 +61,7 @@
61
61
  "releases": "https://github.com/theholocron/clients/releases",
62
62
  "wiki": "https://github.com/theholocron/clients/wiki",
63
63
  "scripts": {
64
- "delivery.build": "tsdown",
64
+ "delivery.build": "holocron run delivery.build -- && node ../../scripts/check-bundle-size.mjs",
65
65
  "sourceQuality.staticAnalysis": "holocron run sourceQuality.staticAnalysis --",
66
66
  "test:watch": "vitest",
67
67
  "verification.typeSafety": "holocron run verification.typeSafety --",