@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0

package/sdk/partner/Lead/LeadPartnerModel.d.ts

@@ -14,7 +14,7 @@ export = LeadPartnerModel;
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
- * @property {number} [total] - Total number of items.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef TicketHistoryList
@@ -29,7 +29,7 @@ export = LeadPartnerModel;
  * @property {string} [source] - Denotes if the ticket was created at partner or
  *   application level
  * @property {string} [status] - Denotes in what state is the ticket
- * @property {string} [priority]
+ * @property {PriorityEnum} [priority]
  * @property {AgentChangePayload} [assigned_to]
  * @property {string[]} [tags] - Tags relevant to ticket
  */
@@ -38,31 +38,17 @@ export = LeadPartnerModel;
  * @property {string} agent_id - Agent's unique ID
  */
 /**
- * @typedef GeneralConfigResponse
- * @property {string} [_id]
+ * @typedef GeneralConfigDetails
  * @property {SupportCommunicationSchema[]} [support_communication]
- * @property {boolean} [show_communication_info]
- * @property {boolean} [show_support_dris]
  * @property {string} [type]
  * @property {GeneralConfigIntegrationSchema} [integration]
- * @property {boolean} [allow_ticket_creation]
- * @property {boolean} [show_listing]
  * @property {string[]} [available_integration]
- * @property {boolean} [enable_dris]
- * @property {SupportSchema} [support_email]
- * @property {SupportSchema} [support_phone]
- * @property {SupportSchema} [support_faq]
- */
-/**
- * @typedef SupportSchema
- * @property {string} [value]
- * @property {string} [description]
- * @property {boolean} [enabled]
  */
 /**
  * @typedef SupportCommunicationSchema
  * @property {string} [type]
  * @property {string} [title]
+ * @property {Object} [value]
  * @property {string} [description]
  * @property {boolean} [enabled]
  */
@@ -75,24 +61,21 @@ export = LeadPartnerModel;
  * @property {Priority[]} priorities - List of possible priorities for tickets
  * @property {TicketCategory[]} [categories] - List of possible categories for tickets
  * @property {Status[]} statuses - List of possible statuses for tickets
- * @property {Object[]} [assignees] - List of support staff availble for tickets
- *   assignment
- * @property {Object} [all_categories]
+ * @property {Object[]} assignees - List of support staff availble for tickets assignment
  */
 /**
  * @typedef TicketHistoryPayload
  * @property {Object} value - Details of history event
- * @property {string} type
+ * @property {HistoryTypeEnum} type
  */
 /**
  * @typedef TicketContext
  * @property {string} [application_id] - Application ID related to the ticket
- * @property {string} organization_id - Organization ID related to the ticket
+ * @property {string} partner_id - Partner ID related to the ticket
  */
 /**
  * @typedef CreatedOn
  * @property {string} user_agent - Useragent details
- * @property {string} [platform]
  */
 /**
  * @typedef TicketAsset
@@ -110,14 +93,14 @@ export = LeadPartnerModel;
  * @typedef AddTicketPayload
  * @property {Object} [created_by] - Creator of the ticket
  * @property {string} [status] - Status of the ticket
- * @property {string} [priority]
+ * @property {PriorityEnum} [priority]
  * @property {string} category - Category of the ticket
  * @property {TicketContent} content
  * @property {Object} [_custom_json] - Optional custom data that needs to be sent
  */
 /**
  * @typedef Priority
- * @property {string} key - Priority value of the ticket like urgent, low, medium, high.
+ * @property {PriorityEnum} key
  * @property {string} display - Display text for priority
  * @property {string} color - Color for priority
  */
@@ -141,7 +124,7 @@ export = LeadPartnerModel;
  * @typedef TicketCategory
  * @property {string} display - Category display value identifier
  * @property {string} key - Category key value identifier
- * @property {TicketCategory[]} [sub_categories]
+ * @property {TicketCategory} [sub_categories]
  * @property {number} [group_id] - Group id of category releted data
  * @property {FeedbackForm} [feedback_form]
  */
@@ -155,7 +138,6 @@ export = LeadPartnerModel;
  * @property {string} _id - Unique identifier of the history event
  * @property {string} [updated_at] - Time of last update of the history event
  * @property {string} [created_at] - Time of creation of the history event
- * @property {number} [__v]
  */
 /**
  * @typedef Ticket
@@ -166,14 +148,13 @@ export = LeadPartnerModel;
  * @property {TicketContent} [content]
  * @property {TicketCategory} category
  * @property {string} [sub_category] - Sub-category assigned to the ticket
- * @property {string} source
+ * @property {TicketSourceEnum} source
  * @property {Status} status
  * @property {Priority} priority
  * @property {SLA} [sla]
  * @property {Object} [created_by] - User details of ticket creator
  * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
  * @property {string[]} [tags] - Tags relevant to ticket
- * @property {string[]} [subscribers]
  * @property {Object} [_custom_json] - Custom json relevant to the ticket
  * @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
  *   pending for the ticket
@@ -181,20 +162,9 @@ export = LeadPartnerModel;
  * @property {string} _id - Unique identifier for the ticket
  * @property {string} [updated_at] - Time when the ticket was last updated
  * @property {string} [created_at] - Time when the ticket was created
- * @property {Object[]} [additional_info]
- * @property {string} [ticket_link]
- * @property {number} [__v]
- */
-/**
- * @typedef Error4XX
- * @property {Object} [message]
- * @property {string} [stack]
- * @property {string} [sentry]
- */
-/**
- * @typedef NotFoundError
- * @property {string} [message]
  */
+/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
+/** @typedef {"rating" | "log" | "comment"} HistoryTypeEnum */
 /**
  * @typedef {| "image"
  *   | "video"
@@ -206,10 +176,11 @@ export = LeadPartnerModel;
  *   | "shipment"
  *   | "order"} TicketAssetTypeEnum
  */
+/** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
 declare class LeadPartnerModel {
 }
 declare namespace LeadPartnerModel {
-    export { TicketList, Page, TicketHistoryList, EditTicketPayload, AgentChangePayload, GeneralConfigResponse, SupportSchema, SupportCommunicationSchema, GeneralConfigIntegrationSchema, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, FeedbackForm, TicketCategory, TicketHistory, Ticket, Error4XX, NotFoundError, TicketAssetTypeEnum };
+    export { TicketList, Page, TicketHistoryList, EditTicketPayload, AgentChangePayload, GeneralConfigDetails, SupportCommunicationSchema, GeneralConfigIntegrationSchema, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, FeedbackForm, TicketCategory, TicketHistory, Ticket, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
 }
 /** @returns {TicketList} */
 declare function TicketList(): TicketList;
@@ -253,9 +224,9 @@ type Page = {
      */
     size?: number;
     /**
-     * - Total number of items.
+     * - The number of items per page.
      */
-    total?: number;
+    page_size?: number;
 };
 /** @returns {TicketHistoryList} */
 declare function TicketHistoryList(): TicketHistoryList;
@@ -287,7 +258,7 @@ type EditTicketPayload = {
      * - Denotes in what state is the ticket
      */
     status?: string;
-    priority?: string;
+    priority?: PriorityEnum;
     assigned_to?: AgentChangePayload;
     /**
      * - Tags relevant to ticket
@@ -302,35 +273,20 @@ type AgentChangePayload = {
      */
     agent_id: string;
 };
-/** @returns {GeneralConfigResponse} */
-declare function GeneralConfigResponse(): GeneralConfigResponse;
-type GeneralConfigResponse = {
-    _id?: string;
+/** @returns {GeneralConfigDetails} */
+declare function GeneralConfigDetails(): GeneralConfigDetails;
+type GeneralConfigDetails = {
     support_communication?: SupportCommunicationSchema[];
-    show_communication_info?: boolean;
-    show_support_dris?: boolean;
     type?: string;
     integration?: GeneralConfigIntegrationSchema;
-    allow_ticket_creation?: boolean;
-    show_listing?: boolean;
     available_integration?: string[];
-    enable_dris?: boolean;
-    support_email?: SupportSchema;
-    support_phone?: SupportSchema;
-    support_faq?: SupportSchema;
-};
-/** @returns {SupportSchema} */
-declare function SupportSchema(): SupportSchema;
-type SupportSchema = {
-    value?: string;
-    description?: string;
-    enabled?: boolean;
 };
 /** @returns {SupportCommunicationSchema} */
 declare function SupportCommunicationSchema(): SupportCommunicationSchema;
 type SupportCommunicationSchema = {
     type?: string;
     title?: string;
+    value?: any;
     description?: string;
     enabled?: boolean;
 };
@@ -355,11 +311,9 @@ type Filter = {
      */
     statuses: Status[];
     /**
-     * - List of support staff availble for tickets
-     * assignment
+     * - List of support staff availble for tickets assignment
      */
-    assignees?: any[];
-    all_categories?: any;
+    assignees: any[];
 };
 /** @returns {TicketHistoryPayload} */
 declare function TicketHistoryPayload(): TicketHistoryPayload;
@@ -368,7 +322,7 @@ type TicketHistoryPayload = {
      * - Details of history event
      */
     value: any;
-    type: string;
+    type: HistoryTypeEnum;
 };
 /** @returns {TicketContext} */
 declare function TicketContext(): TicketContext;
@@ -378,9 +332,9 @@ type TicketContext = {
      */
     application_id?: string;
     /**
-     * - Organization ID related to the ticket
+     * - Partner ID related to the ticket
      */
-    organization_id: string;
+    partner_id: string;
 };
 /** @returns {CreatedOn} */
 declare function CreatedOn(): CreatedOn;
@@ -389,7 +343,6 @@ type CreatedOn = {
      * - Useragent details
      */
     user_agent: string;
-    platform?: string;
 };
 /** @returns {TicketAsset} */
 declare function TicketAsset(): TicketAsset;
@@ -431,7 +384,7 @@ type AddTicketPayload = {
      * - Status of the ticket
      */
     status?: string;
-    priority?: string;
+    priority?: PriorityEnum;
     /**
      * - Category of the ticket
      */
@@ -445,10 +398,7 @@ type AddTicketPayload = {
 /** @returns {Priority} */
 declare function Priority(): Priority;
 type Priority = {
-    /**
-     * - Priority value of the ticket like urgent, low, medium, high.
-     */
-    key: string;
+    key: PriorityEnum;
     /**
      * - Display text for priority
      */
@@ -506,7 +456,7 @@ type TicketCategory = {
      * - Category key value identifier
      */
     key: string;
-    sub_categories?: TicketCategory[];
+    sub_categories?: TicketCategory;
     /**
      * - Group id of category releted data
      */
@@ -545,7 +495,6 @@ type TicketHistory = {
      * - Time of creation of the history event
      */
     created_at?: string;
-    __v?: number;
 };
 /** @returns {Ticket} */
 declare function Ticket(): Ticket;
@@ -563,7 +512,7 @@ type Ticket = {
      * - Sub-category assigned to the ticket
      */
     sub_category?: string;
-    source: string;
+    source: TicketSourceEnum;
     status: Status;
     priority: Priority;
     sla?: SLA;
@@ -579,7 +528,6 @@ type Ticket = {
      * - Tags relevant to ticket
      */
     tags?: string[];
-    subscribers?: string[];
     /**
      * - Custom json relevant to the ticket
      */
@@ -605,22 +553,21 @@ type Ticket = {
      * - Time when the ticket was created
      */
     created_at?: string;
-    additional_info?: any[];
-    ticket_link?: string;
-    __v?: number;
-};
-/** @returns {Error4XX} */
-declare function Error4XX(): Error4XX;
-type Error4XX = {
-    message?: any;
-    stack?: string;
-    sentry?: string;
-};
-/** @returns {NotFoundError} */
-declare function NotFoundError(): NotFoundError;
-type NotFoundError = {
-    message?: string;
 };
+/**
+ * Enum: PriorityEnum Used By: Lead
+ *
+ * @returns {PriorityEnum}
+ */
+declare function PriorityEnum(): PriorityEnum;
+type PriorityEnum = "low" | "medium" | "high" | "urgent";
+/**
+ * Enum: HistoryTypeEnum Used By: Lead
+ *
+ * @returns {HistoryTypeEnum}
+ */
+declare function HistoryTypeEnum(): HistoryTypeEnum;
+type HistoryTypeEnum = "rating" | "log" | "comment";
 /**
  * Enum: TicketAssetTypeEnum Used By: Lead
  *
@@ -628,3 +575,10 @@ type NotFoundError = {
  */
 declare function TicketAssetTypeEnum(): TicketAssetTypeEnum;
 type TicketAssetTypeEnum = "image" | "video" | "file" | "youtube" | "product" | "collection" | "brand" | "shipment" | "order";
+/**
+ * Enum: TicketSourceEnum Used By: Lead
+ *
+ * @returns {TicketSourceEnum}
+ */
+declare function TicketSourceEnum(): TicketSourceEnum;
+type TicketSourceEnum = "platform_panel" | "sales_channel";