@weaver-apps/service-desk 0.0.0-stage → 0.1.3

package/types/weaver-apps-service-desk.d.ts

@@ -0,0 +1,348 @@
+import { Plugin } from "@loomweaver/plugin-sdk";
+import { InjectionToken, Provider } from "@angular/core";
+interface ServiceDeskPluginOptions {
+  readonly railItem?: boolean;
+}
+export declare function createServiceDeskPlugin(options?: ServiceDeskPluginOptions): Plugin;
+export declare const serviceDeskPlugin: Plugin;
+export declare const deskListPath = "service-desk";
+export declare function deskPath(deskId: string): string;
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Weaver Apps
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * A desk of the caller's tenant.
+ */
+interface DeskResponse {
+  /** The id the caller chose. */
+  id: string;
+  /** The display name. */
+  name: string;
+  /** When it was created. */
+  createdAt: string;
+}
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Weaver Apps
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * How a service request came about.
+ */
+type ServiceRequestOrigin = typeof ServiceRequestOrigin[keyof typeof ServiceRequestOrigin];
+declare const ServiceRequestOrigin: {
+  readonly manual: "manual";
+  readonly voiceChat: "voiceChat";
+  readonly textChat: "textChat";
+  readonly widget: "widget";
+  readonly email: "email";
+  readonly phone: "phone";
+};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Weaver Apps
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * How urgent a service request is.
+ */
+type ServiceRequestPriority = typeof ServiceRequestPriority[keyof typeof ServiceRequestPriority];
+declare const ServiceRequestPriority: {
+  readonly low: "low";
+  readonly normal: "normal";
+  readonly high: "high";
+  readonly urgent: "urgent";
+};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Weaver Apps
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * What kind of matter a service request is.
+ */
+type ServiceRequestType = typeof ServiceRequestType[keyof typeof ServiceRequestType];
+declare const ServiceRequestType: {
+  readonly inquiry: "inquiry";
+  readonly task: "task";
+  readonly callbackRequest: "callbackRequest";
+  readonly conversationSummary: "conversationSummary";
+  readonly complaint: "complaint";
+  readonly quote: "quote";
+};
+/**
+ * Raises a service request. Only the title is required.
+ */
+interface NewServiceRequest {
+  /**
+   * What the request is about.
+   * @minLength 1
+   * @maxLength 200
+   */
+  title: string;
+  /**
+   * More about it.
+   * @minLength 0
+   * @maxLength 4000
+   * @nullable
+   */
+  description: string | null;
+  type: null | ServiceRequestType;
+  priority: null | ServiceRequestPriority;
+  origin: null | ServiceRequestOrigin;
+  /**
+   * Who it is for.
+   * @minLength 0
+   * @maxLength 200
+   * @nullable
+   */
+  contactName: string | null;
+  /**
+   * Their phone number.
+   * @minLength 0
+   * @maxLength 50
+   * @nullable
+   */
+  contactPhone: string | null;
+  /**
+   * Their email address.
+   * @minLength 0
+   * @maxLength 320
+   * @nullable
+   */
+  contactEmail: string | null;
+  /**
+   * Who works on it.
+   * @minLength 0
+   * @maxLength 200
+   * @nullable
+   */
+  assignee: string | null;
+  /**
+   * When it is due.
+   * @nullable
+   */
+  dueAt: string | null;
+}
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Weaver Apps
+ * OpenAPI spec version: 1.0.0
+ */
+type ServiceDeskRequestsListParams = {
+  type?: string;
+  status?: string;
+  priority?: string;
+  contact?: string;
+  text?: string;
+  includeCancelled?: boolean;
+  sort?: string;
+  descending?: boolean;
+  /**
+   * @pattern ^-?(?:0|[1-9]\d*)$
+   */
+  offset?: number | string;
+  /**
+   * @pattern ^-?(?:0|[1-9]\d*)$
+   */
+  limit?: number | string;
+};
+/**
+ * Replaces what a service request says; its origin stays as it was raised.
+ */
+interface ServiceRequestChanges {
+  /**
+   * What the request is about.
+   * @minLength 1
+   * @maxLength 200
+   */
+  title: string;
+  /**
+   * More about it.
+   * @minLength 0
+   * @maxLength 4000
+   * @nullable
+   */
+  description: string | null;
+  /** Its kind. */
+  type: ServiceRequestType;
+  /** How urgent it is. */
+  priority: ServiceRequestPriority;
+  /**
+   * Who it is for.
+   * @minLength 0
+   * @maxLength 200
+   * @nullable
+   */
+  contactName: string | null;
+  /**
+   * Their phone number.
+   * @minLength 0
+   * @maxLength 50
+   * @nullable
+   */
+  contactPhone: string | null;
+  /**
+   * Their email address.
+   * @minLength 0
+   * @maxLength 320
+   * @nullable
+   */
+  contactEmail: string | null;
+  /**
+   * Who works on it.
+   * @minLength 0
+   * @maxLength 200
+   * @nullable
+   */
+  assignee: string | null;
+  /**
+   * When it is due.
+   * @nullable
+   */
+  dueAt: string | null;
+}
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Weaver Apps
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * Where a service request stands.
+ */
+type ServiceRequestStatus = typeof ServiceRequestStatus[keyof typeof ServiceRequestStatus];
+declare const ServiceRequestStatus: {
+  readonly open: "open";
+  readonly inProgress: "inProgress";
+  readonly completed: "completed";
+  readonly cancelled: "cancelled";
+};
+/**
+ * A service request.
+ */
+interface ServiceRequestResponse {
+  /** The request's id. */
+  id: string;
+  /** The desk it is on. */
+  deskId: string;
+  /** What it is about. */
+  title: string;
+  /**
+   * More about it.
+   * @nullable
+   */
+  description: string | null;
+  /** Its kind. */
+  type: ServiceRequestType;
+  /** How urgent it is. */
+  priority: ServiceRequestPriority;
+  /** Where it stands. */
+  status: ServiceRequestStatus;
+  /** How it came about. */
+  origin: ServiceRequestOrigin;
+  /**
+   * Who it is for.
+   * @nullable
+   */
+  contactName: string | null;
+  /**
+   * Their phone number.
+   * @nullable
+   */
+  contactPhone: string | null;
+  /**
+   * Their email address.
+   * @nullable
+   */
+  contactEmail: string | null;
+  /**
+   * Who works on it.
+   * @nullable
+   */
+  assignee: string | null;
+  /**
+   * When it is due.
+   * @nullable
+   */
+  dueAt: string | null;
+  /**
+   * Why it was cancelled, if it was and anyone said.
+   * @nullable
+   */
+  cancellationReason: string | null;
+  /** When it was raised. */
+  raisedAt: string;
+  /**
+   * When it was last changed.
+   * @nullable
+   */
+  changedAt: string | null;
+  /**
+   * When it was completed.
+   * @nullable
+   */
+  completedAt: string | null;
+  /**
+   * When it was cancelled.
+   * @nullable
+   */
+  cancelledAt: string | null;
+}
+/**
+ * One page of a listing.
+ */
+interface ServiceRequestPage {
+  /** The requests on this page. */
+  items: ServiceRequestResponse[];
+  /**
+   * How many requests match, across every page.
+   * @pattern ^-?(?:0|[1-9]\d*)$
+   */
+  total: number | string;
+}
+type ServiceRequestOutcome = {
+  readonly kind: 'saved';
+  readonly request: ServiceRequestResponse;
+} | {
+  readonly kind: 'closed';
+} | {
+  readonly kind: 'changed';
+} | {
+  readonly kind: 'invalid';
+} | {
+  readonly kind: 'missing';
+};
+type ServiceRequestListing = ServiceDeskRequestsListParams;
+interface ServiceDeskGateway {
+  desks(): Promise<readonly DeskResponse[]>;
+  desk(deskId: string): Promise<DeskResponse | null>;
+  saveDesk(deskId: string, name: string): Promise<DeskResponse>;
+  requests(deskId: string, listing: ServiceRequestListing, signal?: AbortSignal): Promise<ServiceRequestPage>;
+  raise(deskId: string, request: NewServiceRequest): Promise<ServiceRequestOutcome>;
+  edit(deskId: string, requestId: string, changes: ServiceRequestChanges): Promise<ServiceRequestOutcome>;
+  setStatus(deskId: string, requestId: string, status: ServiceRequestStatus): Promise<ServiceRequestOutcome>;
+  complete(deskId: string, requestId: string): Promise<ServiceRequestOutcome>;
+  cancel(deskId: string, requestId: string, reason: string | null): Promise<ServiceRequestOutcome>;
+  remove(deskId: string, requestId: string): Promise<void>;
+}
+export declare class ServiceDeskGatewayError extends Error {
+  readonly status: number;
+  constructor(status: number);
+}
+export declare const SERVICE_DESK_GATEWAY: InjectionToken<ServiceDeskGateway>;
+export declare function provideServiceDeskGateway(gateway: ServiceDeskGateway): Provider;
+interface HttpServiceDeskGatewayOptions {
+  readonly baseUrl: string;
+  readonly headers?: Readonly<Record<string, string>>;
+  readonly fetch?: typeof fetch;
+}
+export declare function createHttpServiceDeskGateway(options: HttpServiceDeskGatewayOptions): ServiceDeskGateway;
+export type { DeskResponse, HttpServiceDeskGatewayOptions, NewServiceRequest, ServiceDeskGateway, ServiceDeskPluginOptions, ServiceRequestChanges, ServiceRequestListing, ServiceRequestOrigin, ServiceRequestOutcome, ServiceRequestPage, ServiceRequestPriority, ServiceRequestResponse, ServiceRequestStatus, ServiceRequestType };