@theholocron/zendesk-client 0.0.0

package/README.md

@@ -0,0 +1,19 @@
+# Zendesk Client
+
+A NodeJS/JavaScript client for our Zendesk API.
+
+## Installation
+
+```bash
+npm install --save @theholocron/client-zendesk
+```
+
+## Usage
+
+```javascript
+import zendesk from "@theholocron/client-zendesk";
+
+const [ticketsErr, tickets] = zendesk.tickets.get("loan-guid", { token: auth.token });
+```
+
+_Check the `examples.ts` file for more._

package/dist/index.d.mts

@@ -0,0 +1,461 @@
+//#region src/types.d.ts
+interface IAPIResponse {
+  next_page?: string | null;
+  previous_page?: string | null;
+  count: number;
+}
+interface IAPIError {
+  error: string;
+  description: string;
+}
+//#endregion
+//#region src/attachments/attachments.types.d.ts
+interface IImage {
+  content_type?: string | null;
+  content_url?: string | null;
+  deleted?: boolean | null;
+  file_name?: string | null;
+  height?: number | null;
+  id?: number | null;
+  inline?: boolean | null;
+  malware_access_override?: boolean | null;
+  malware_scan_result?: "malware_found" | "malware_not_found" | "failed_to_scan" | "not_scanned" | null;
+  mapped_content_url?: string | null;
+  size?: number | null;
+  url?: string | null;
+  width?: number | null;
+}
+interface IAttachment extends IImage {
+  thumbnails?: IImage[];
+}
+//#endregion
+//#region src/attachments/attachments.mocks.d.ts
+declare const mockImage: IImage;
+declare const mockThumbnail: IImage;
+declare const mockAttachment: IAttachment;
+//#endregion
+//#region src/user/user.types.d.ts
+interface IUser {
+  active?: boolean | null;
+  alias?: string | null;
+  chat_only?: boolean | null;
+  created_at?: string | null;
+  custom_role_id?: number | null;
+  default_group_id?: number | null;
+  details?: string | null;
+  email?: string | null;
+  external_id?: string | null;
+  iana_time_zone?: string | null;
+  id?: number | null;
+  last_login_at?: string | null;
+  locale?: string | null;
+  locale_id?: number | null;
+  moderator?: boolean | null;
+  name: string | null;
+  notes?: string | null;
+  only_private_comments?: boolean | null;
+  organization_id?: number | null;
+  phone?: string | null;
+  photo?: IAttachment | null;
+  remote_photo_url?: string | null;
+  report_csv?: boolean | null;
+  restricted_agent?: boolean | null;
+  role?: "end-user" | "agent" | "admin" | null;
+  role_type?: 0 | 1 | 2 | 3 | 4 | 5 | null;
+  shared?: boolean | null;
+  shared_agent?: boolean | null;
+  shared_phone_number?: boolean | null;
+  signature?: string | null;
+  suspended?: boolean | null;
+  tags?: string[] | null;
+  ticket_restriction?: "organization" | "groups" | "assigned" | "requested" | null;
+  time_zone?: string | null;
+  two_factor_auth_enabled?: boolean | null;
+  updated_at?: string | null;
+  url?: string | null;
+  user_fields?: Record<string, unknown> | null;
+  verified?: boolean | null;
+}
+//#endregion
+//#region src/activities/activities.types.d.ts
+interface IActivity {
+  actor?: IUser | null;
+  actor_id?: number | null;
+  created_at?: string | null;
+  id?: number | null;
+  object?: Record<string, unknown> | null;
+  target?: Record<string, unknown> | null;
+  title?: string | null;
+  updated_at?: string | null;
+  url?: string | null;
+  user?: IUser | null;
+  user_id?: number | null;
+  verb?: "tickets.assignment" | "tickets.comment" | "tickets.priority_increase" | null;
+}
+interface IActivityResponse extends IAPIResponse {
+  activities: IActivity[];
+  actors: IUser[];
+  users: IUser[];
+}
+//#endregion
+//#region src/activities/activities.d.ts
+interface FetchOptions$5 {
+  environment?: string;
+  headers?: Record<string, unknown>;
+  params?: Record<string, unknown>;
+  token: string;
+}
+//#endregion
+//#region src/group/group.types.d.ts
+interface IGroup {
+  created_at?: string | null;
+  default?: boolean | null;
+  deleted?: boolean | null;
+  description?: string | null;
+  id?: number | null;
+  is_public?: boolean | null;
+  name?: string | null;
+  updated_at?: string | null;
+  url?: string | null;
+}
+//#endregion
+//#region src/tickets/comments.types.d.ts
+interface IComment {
+  attachments?: IAttachment[] | null;
+  audit_id?: number | null;
+  author_id?: number | null;
+  body?: string | null;
+  created_at?: string | null;
+  html_body?: string | null;
+  id?: number | null;
+  metadata?: IMetadata | null;
+  plain_body?: string | null;
+  public?: boolean | null;
+  type?: "Comment" | "VoiceComment" | null;
+  uploads?: string[] | null;
+  via?: IVia | null;
+}
+interface ICommentResponse {
+  comments: IComment[];
+}
+//#endregion
+//#region src/tickets/fields.types.d.ts
+interface ICustomField {
+  id: number | null;
+  value: string | number | string[] | null;
+}
+interface ITicketField {
+  active?: boolean | null;
+  agent_description?: string | null;
+  collapsed_for_agents?: boolean | null;
+  created_at?: string | null;
+  custom_field_options?: Array<unknown> | null;
+  custom_statuses?: Array<unknown> | null;
+  description?: string | null;
+  editable_in_portal?: boolean | null;
+  id?: number | null;
+  position?: number | null;
+  raw_description?: string | null;
+  raw_title?: string | null;
+  raw_title_in_portal?: string | null;
+  regexp_for_validation?: string | null;
+  relationship_filter?: Record<string, unknown> | null;
+  relationship_target_type?: string | null;
+  removable?: boolean | null;
+  required?: boolean | null;
+  required_in_portal?: boolean | null;
+  sub_type_id?: number | null;
+  system_field_options?: Array<unknown> | null;
+  tag?: string | null;
+  title: string | null;
+  title_in_portal?: string | null;
+  type: string | null;
+  updated_at?: string | null;
+  url?: string | null;
+  visible_in_portal?: boolean | null;
+}
+type TTicketFieldsResponse = IAPIResponse & {
+  ticket_fields: ITicketField[];
+};
+type TTicketFieldResponse = IAPIResponse & {
+  ticket_field: ITicketField;
+};
+//#endregion
+//#region src/tickets/tickets.types.d.ts
+type TTicketStatus = 'new' | 'open' | 'pending' | 'hold' | 'solved' | 'closed';
+type TTicketPriority = 'urgent' | 'high' | 'normal' | 'low';
+type TTicketType = 'problem' | 'incident' | 'question' | 'task';
+interface IVia {
+  channel: string | number | null;
+  source?: {
+    from?: Record<string, unknown>;
+    rel?: string | null;
+    to?: Record<string, unknown>;
+  };
+}
+interface IMetadata {
+  system?: {
+    client?: string | null;
+    ip_address?: string | null;
+    latitude?: number | null;
+    location?: string | null;
+    longitude?: number | null;
+  };
+  via: IVia;
+}
+interface ITicket$1 {
+  allow_attachments?: boolean | null;
+  allow_channelback?: boolean | null;
+  assignee_email?: string | null;
+  assignee_id?: number | null;
+  attribute_value_ids?: string[] | null;
+  brand_id?: number | null;
+  collaborator_ids?: number[] | null;
+  collaborators?: Array<unknown> | null;
+  comment?: IComment | null;
+  created_at?: string | null;
+  custom_fields?: ICustomField[] | null;
+  custom_status_id?: number | null;
+  description?: string | null;
+  due_at?: string | null;
+  email_cc_ids?: number[] | null;
+  email_ccs?: Array<Record<string, unknown>>;
+  external_id?: string | null;
+  follower_ids?: number[] | null;
+  followers?: Array<Record<string, unknown>>;
+  followup_ids?: number[] | null;
+  forum_topic_id?: number | null;
+  from_messaging_channel?: boolean | null;
+  group_id?: number | null;
+  has_incidents?: boolean | null;
+  id?: number | null;
+  is_public?: boolean | null;
+  macro_id?: number | null;
+  macro_ids?: number[] | null;
+  metadata?: IMetadata | null;
+  organization_id?: number | null;
+  priority?: TTicketPriority | null;
+  problem_id?: number | null;
+  raw_subject?: string | null;
+  recipient?: string | null;
+  requester?: Record<string, unknown>;
+  requester_id: number | null;
+  safe_update?: boolean | null;
+  satisfaction_rating?: Record<string, unknown>;
+  sharing_agreement_ids?: number[] | null;
+  status?: TTicketStatus | null;
+  subject?: string | null;
+  submitter_id?: number | null;
+  tags?: string[] | null;
+  ticket_form_id?: number | null;
+  type?: TTicketType | null;
+  updated_at?: string | null;
+  updated_stamp?: string | null;
+  url?: string | null;
+  via?: IVia | null;
+  via_followup_source_id?: number | null;
+  via_id?: number | null;
+  voice_comment?: Record<string, unknown>;
+}
+type TTicketsResponse = IAPIResponse & {
+  tickets: ITicket$1[];
+  deleted_ticket_forms?: Array<unknown>;
+};
+type TTicketResponse = IAPIResponse & {
+  ticket: ITicket$1;
+  deleted_ticket_forms?: Array<unknown>;
+};
+//#endregion
+//#region src/search/search.types.d.ts
+interface ISearchResponse extends IAPIResponse {
+  facets?: string | null;
+  results: ITicket$1[] | IUser[] | IGroup[];
+}
+//#endregion
+//#region src/search/search.d.ts
+interface FetchOptions$4 {
+  environment?: string;
+  headers?: Record<string, unknown>;
+  params?: Record<string, unknown>;
+  sort?: "asc" | "desc";
+  token: string;
+}
+//#endregion
+//#region src/status/status.types.d.ts
+interface IStatus {
+  active?: boolean | null;
+  agent_label?: string | null;
+  description?: string | null;
+  end_user_description?: string | null;
+  status_category?: string | null;
+}
+interface IDefaultStatus extends IStatus {
+  end_user_label?: "new" | "open" | "pending" | "hold" | "solved" | null;
+}
+interface ICustomStatus extends IStatus {
+  created_at?: string | null;
+  default?: boolean | null;
+  end_user_label?: string | null;
+  id?: number | null;
+  raw_agent_label?: string | null;
+  raw_description?: string | null;
+  raw_end_user_description?: string | null;
+  raw_end_user_label?: string | null;
+  updated_at?: string | null;
+  url?: string | null;
+}
+interface ICustomStatusesResponse extends IAPIResponse {
+  custom_statuses: ICustomStatus[];
+}
+interface ICustomStatusResponse extends IAPIResponse {
+  custom_status: ICustomStatus;
+}
+//#endregion
+//#region src/status/status.d.ts
+interface FetchOptions$3 {
+  environment?: string;
+  headers?: Record<string, unknown>;
+  id?: number | null;
+  method?: "create" | "delete" | "patch" | "post" | "put";
+  params?: Record<string, unknown>;
+  token: string;
+}
+//#endregion
+//#region src/tickets/comments.d.ts
+interface FetchOptions$2 {
+  environment?: string;
+  headers?: Record<string, unknown>;
+  params?: Record<string, unknown>;
+  token: string;
+}
+//#endregion
+//#region src/tickets/fields.d.ts
+interface FetchOptions$1 {
+  environment?: string;
+  headers?: Record<string, unknown>;
+  id?: number | null;
+  method?: "create" | "delete" | "patch" | "post" | "put";
+  params?: Record<string, unknown>;
+  token: string;
+}
+//#endregion
+//#region src/tickets/tickets.d.ts
+interface FetchOptions {
+  environment?: string;
+  headers?: Record<string, unknown>;
+  id?: number | null;
+  method?: "create" | "delete" | "patch" | "post" | "put";
+  params?: Record<string, unknown>;
+  token: string;
+}
+//#endregion
+//#region src/activities/activities.mocks.d.ts
+declare const mockActivity: IActivity;
+declare const mockActivityResponse: IActivityResponse;
+//#endregion
+//#region src/group/group.mocks.d.ts
+declare const mockGroup: IGroup;
+//#endregion
+//#region src/search/search.mocks.d.ts
+declare const mockSearchResponseGroups: ISearchResponse;
+declare const mockSearchResponseTickets: ISearchResponse;
+declare const mockSearchResponseUsers: ISearchResponse;
+//#endregion
+//#region src/status/status.mocks.d.ts
+declare const mockDefaultStatus: IDefaultStatus;
+declare const mockCustomStatus: ICustomStatus;
+declare const mockCustomStatusesResponse: ICustomStatusesResponse;
+declare const mockCustomStatusResponse: ICustomStatusResponse;
+//#endregion
+//#region src/tickets/comments.mocks.d.ts
+declare const mockComment: IComment;
+declare const mockCommentResponse: ICommentResponse;
+//#endregion
+//#region src/tickets/fields.mocks.d.ts
+declare const mockCustomField1: ICustomField;
+declare const mockCustomField2: ICustomField;
+declare const mockCustomFields: ICustomField[];
+declare const mockTicketField: ITicketField;
+declare const mockTicketFieldsResponse: TTicketFieldsResponse;
+declare const mockTicketFieldResponse: TTicketFieldResponse;
+//#endregion
+//#region src/tickets/metrics.types.d.ts
+interface ITimeInMinutes {
+  business: number;
+  calendar: number;
+}
+interface ITicketMetric {
+  agent_wait_time_in_minutes: ITimeInMinutes;
+  assigned_at: string;
+  assignee_stations: number;
+  assignee_updated_at: string;
+  created_at: string;
+  custom_status_updated_at: string;
+  first_resolution_time_in_minutes: ITimeInMinutes;
+  full_resolution_time_in_minutes: ITimeInMinutes;
+  group_stations: number;
+  id: number;
+  initially_assigned_at: string;
+  latest_comment_added_at: string;
+  on_hold_time_in_minutes: ITimeInMinutes;
+  reopens: number;
+  replies: number;
+  reply_time_in_minutes: ITimeInMinutes;
+  reply_time_in_seconds: {
+    calendar: number;
+  };
+  requester_updated_at: string;
+  requester_wait_time_in_minutes: ITimeInMinutes;
+  solved_at: string;
+  status_updated_at: string;
+  ticket_id: number;
+  updated_at: string;
+}
+//#endregion
+//#region src/tickets/metrics.mocks.d.ts
+declare const mockTicketMetric: ITicketMetric;
+//#endregion
+//#region src/tickets/tickets.mocks.d.ts
+declare const mockVia: IVia;
+declare const mockMetadata: IMetadata;
+declare const mockTicket: ITicket$1;
+declare const mockTicketsResponse: TTicketsResponse;
+declare const mockTicketResponse: TTicketResponse;
+//#endregion
+//#region src/user/user.mocks.d.ts
+declare const mockUser: IUser;
+//#endregion
+//#region src/utils.d.ts
+declare const createToken: (user: string, password: string) => string;
+declare function setToken(user: string, password: string): void;
+//#endregion
+//#region src/index.d.ts
+declare const _default: {
+  activities: {
+    get: (options: FetchOptions$5) => Promise<[IAPIError | null, IActivityResponse]>;
+  };
+  search: (query: string, options: FetchOptions$4) => Promise<[IAPIError | null, ISearchResponse]>;
+  status: {
+    create: (status: ICustomStatus, options: FetchOptions$3) => Promise<void>;
+    get: (id?: number | FetchOptions$3 | undefined, options?: FetchOptions$3 | undefined) => Promise<[IAPIError, ICustomStatusResponse]>;
+    update: (id: number, status: ICustomStatus, options: FetchOptions$3) => Promise<void>;
+  };
+  tickets: {
+    comments: {
+      create: (id: number, comment: string, options: FetchOptions$2) => Promise<ITicket$1>;
+      get: (ticket: number, options: FetchOptions$2) => Promise<ICommentResponse>;
+    };
+    fields: {
+      create: (field: ITicketField, options: FetchOptions$1) => Promise<ITicketField>;
+      get: (id?: number | FetchOptions$1 | undefined, options?: FetchOptions$1 | undefined) => Promise<[IAPIError | null, TTicketFieldsResponse | TTicketFieldResponse]>;
+      update: (id: number, field: ITicketField, options: FetchOptions$1) => Promise<ITicketField>;
+      delete: (id: number, options: FetchOptions$1) => any;
+    };
+    create: (ticket: ITicket$1, options: FetchOptions) => Promise<ITicket$1>;
+    get: (id?: number | FetchOptions | undefined, options?: FetchOptions | undefined) => Promise<[IAPIError | null, TTicketResponse | TTicketsResponse]>;
+    update: (id: number, ticket: ITicket$1, options: FetchOptions) => Promise<ITicket$1>;
+    delete: (id: number, options: FetchOptions) => Promise<void>;
+  };
+};
+//#endregion
+export { type IAPIError, type IAPIResponse, type IActivity, type IActivityResponse, type IAttachment, type IComment, type ICommentResponse, type ICustomField, type ICustomStatus, type ICustomStatusResponse, type ICustomStatusesResponse, type IDefaultStatus, type IGroup, type IImage, type IMetadata, type ISearchResponse, type ITicket$1 as ITicket, type ITicketField, type ITicketMetric, type IUser, type IVia, type TTicketFieldResponse, type TTicketFieldsResponse, type TTicketPriority, type TTicketResponse, type TTicketStatus, type TTicketType, type TTicketsResponse, createToken, _default as default, mockActivity, mockActivityResponse, mockAttachment, mockComment, mockCommentResponse, mockCustomField1, mockCustomField2, mockCustomFields, mockCustomStatus, mockCustomStatusResponse, mockCustomStatusesResponse, mockDefaultStatus, mockGroup, mockImage, mockMetadata, mockSearchResponseGroups, mockSearchResponseTickets, mockSearchResponseUsers, mockThumbnail, mockTicket, mockTicketField, mockTicketFieldResponse, mockTicketFieldsResponse, mockTicketMetric, mockTicketResponse, mockTicketsResponse, mockUser, mockVia, setToken };