@osise/api-client 0.0.1 → 0.0.3

package/dist/types/types/support.d.ts

@@ -0,0 +1,194 @@
+/**
+ * Support DTOs
+ * Types for support ticket management and FAQ functionality
+ */
+import { TicketStatus, TicketCategory, TicketPriority } from './enums';
+import { PaginationParams } from './common';
+/** Ticket list item */
+export interface TicketListItemDto {
+    id: string;
+    referenceNumber: string;
+    subject: string;
+    category: string;
+    priority: string;
+    status: string;
+    isEmergency: boolean;
+    hasUnreadMessages: boolean;
+    messageCount: number;
+    createdAt: string;
+    lastUpdatedAt?: string;
+}
+/** Ticket list response with pagination */
+export interface TicketListResponseDto {
+    items: TicketListItemDto[];
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+    openCount: number;
+    inProgressCount: number;
+    unreadCount: number;
+}
+/** Ticket message item */
+export interface TicketMessageDto {
+    id: string;
+    content: string;
+    senderId: string;
+    senderName: string;
+    senderProfileImageUrl?: string;
+    isFromSupport: boolean;
+    attachmentUrl?: string;
+    attachmentFileName?: string;
+    sentAt: string;
+    readAt?: string;
+    isRead: boolean;
+}
+/** Ticket detail response */
+export interface TicketDetailDto {
+    id: string;
+    referenceNumber: string;
+    subject: string;
+    description: string;
+    category: string;
+    priority: string;
+    status: string;
+    isEmergency: boolean;
+    attachmentUrl?: string;
+    jobId?: string;
+    jobReferenceNumber?: string;
+    jobTitle?: string;
+    jobStatus?: string;
+    createdById: string;
+    createdByName: string;
+    createdByProfileImageUrl?: string;
+    assignedToId?: string;
+    assignedToName?: string;
+    assignedToProfileImageUrl?: string;
+    resolutionSummary?: string;
+    satisfactionRating?: number;
+    satisfactionFeedback?: string;
+    messages: TicketMessageDto[];
+    messageCount: number;
+    createdAt: string;
+    updatedAt?: string;
+    assignedAt?: string;
+    resolvedAt?: string;
+    closedAt?: string;
+    canSendMessage: boolean;
+    canClose: boolean;
+    canRate: boolean;
+}
+/** Request to create a ticket */
+export interface CreateTicketDto {
+    subject: string;
+    description: string;
+    category: string;
+    jobId?: string;
+    attachmentUrl?: string;
+}
+/** Request to create a ticket message */
+export interface CreateTicketMessageDto {
+    content: string;
+    attachmentUrl?: string;
+    attachmentFileName?: string;
+}
+/** Ticket message response */
+export interface TicketMessageResponseDto {
+    id: string;
+    content: string;
+    senderId: string;
+    senderName: string;
+    senderProfileImageUrl?: string;
+    isFromSupport: boolean;
+    attachmentUrl?: string;
+    attachmentFileName?: string;
+    sentAt: string;
+}
+/** Request to close a ticket */
+export interface CloseTicketDto {
+    resolutionSummary?: string;
+}
+/** Request to rate a ticket */
+export interface RateTicketDto {
+    rating: number;
+    feedback?: string;
+}
+/** Request to create an emergency ticket (artisan) */
+export interface CreateEmergencyTicketDto {
+    subject: string;
+    description: string;
+    jobId?: string;
+    attachmentUrl?: string;
+}
+/** Ticket filter parameters */
+export interface TicketFilterDto extends PaginationParams {
+    status?: TicketStatus;
+    category?: TicketCategory;
+    priority?: TicketPriority;
+    emergencyOnly?: boolean;
+    fromDate?: string;
+    toDate?: string;
+    searchTerm?: string;
+}
+/** FAQ article item in a list */
+export interface FaqArticleItemDto {
+    id: string;
+    title: string;
+    summary?: string;
+    category: string;
+    isFeatured: boolean;
+}
+/** FAQ category group */
+export interface FaqCategoryGroupDto {
+    category: string;
+    displayName: string;
+    articles: FaqArticleItemDto[];
+}
+/** FAQ list response */
+export interface FaqListResponseDto {
+    categories: FaqCategoryGroupDto[];
+}
+/** FAQ search result */
+export interface FaqSearchResultDto {
+    id: string;
+    title: string;
+    excerpt: string;
+    category: string;
+    relevanceScore: number;
+}
+/** FAQ search response */
+export interface FaqSearchResponseDto {
+    results: FaqSearchResultDto[];
+    totalCount: number;
+}
+/** FAQ article detail */
+export interface FaqArticleDetailDto {
+    id: string;
+    title: string;
+    summary?: string;
+    content: string;
+    category: string;
+    tags?: string[];
+    isFeatured: boolean;
+    viewCount: number;
+    helpfulCount: number;
+    notHelpfulCount: number;
+    publishedAt?: string;
+    updatedAt?: string;
+}
+/** Request to record FAQ feedback */
+export interface FaqFeedbackDto {
+    isHelpful: boolean;
+}
+/** FAQ filter parameters */
+export interface FaqFilterDto {
+    category?: string;
+    featuredOnly?: boolean;
+}
+/** FAQ search parameters */
+export interface FaqSearchDto {
+    query: string;
+    category?: string;
+    limit?: number;
+}
+//# sourceMappingURL=support.d.ts.map

package/dist/types/types/support.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"support.d.ts","sourceRoot":"","sources":["../../../src/types/support.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAI5C,uBAAuB;AACvB,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,2CAA2C;AAC3C,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,iBAAiB,EAAE,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,0BAA0B;AAC1B,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,6BAA6B;AAC7B,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,OAAO,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,iCAAiC;AACjC,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yCAAyC;AACzC,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,8BAA8B;AAC9B,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gCAAgC;AAChC,MAAM,WAAW,cAAc;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,+BAA+B;AAC/B,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,sDAAsD;AACtD,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,+BAA+B;AAC/B,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,iCAAiC;AACjC,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,yBAAyB;AACzB,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED,wBAAwB;AACxB,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,mBAAmB,EAAE,CAAC;CACnC;AAED,wBAAwB;AACxB,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,0BAA0B;AAC1B,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAyB;AACzB,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,4BAA4B;AAC5B,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,4BAA4B;AAC5B,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osise/api-client",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Official TypeScript SDK for the Osise API - connecting consumers with skilled artisans",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",