@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

package/sdk/public/Webhook/WebhookPublicModel.js

@@ -2,24 +2,14 @@ const Joi = require("joi");
 
 /**
  * @typedef EventConfig
- * @property {string} [created_on]
- * @property {string} [description]
- * @property {string} [display_name]
- * @property {string} [event_category]
- * @property {string} [event_name]
- * @property {Object} [event_schema]
- * @property {string} [event_type]
  * @property {number} [id]
- * @property {string} [updated_on]
- * @property {string} [version]
- */
-
-/**
- * @typedef EventConfigBase
- * @property {string} [event_category]
  * @property {string} [event_name]
  * @property {string} [event_type]
+ * @property {string} [event_category]
  * @property {string} [version]
+ * @property {string} [display_name]
+ * @property {string} [description]
+ * @property {string} [created_on]
  */
 
 /**
@@ -28,105 +18,25 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef EventNotifier
- * @property {string[]} [emails]
- * @property {string} [message]
- */
-
-/**
- * @typedef EventSchema
- * @property {Object} [meta]
- * @property {Object} [payload]
- */
-
-/**
- * @typedef InternalTransformEvent
- * @property {number} [created_timestamp]
- * @property {string} [name]
- * @property {string[]} [trace_id]
- * @property {string} [type]
- * @property {string} [version]
- */
-
-/**
- * @typedef TransformEventAssociation
- * @property {number} [company_id]
- */
-
-/**
- * @typedef TransformEventData
- * @property {number} [company_id]
- * @property {string[]} [contains]
- * @property {InternalTransformEvent} [event]
- * @property {Object} [payload]
- */
-
-/**
- * @typedef TransformEventRequest
- * @property {EventSchema} [event]
- * @property {string} [event_category]
- * @property {string} [event_name]
- * @property {string} [event_type]
- * @property {string} [event_version]
- */
-
-/**
- * @typedef TransformEventResponse
- * @property {TransformEventAssociation} [association]
- * @property {TransformEventData} [data]
+ * @typedef EventConfigBase
  * @property {string} [event_name]
- * @property {string[]} [event_trace_id]
  * @property {string} [event_type]
- * @property {TransformEventServiceMeta} [service_meta]
- * @property {boolean} [status]
- * @property {string} [version]
- */
-
-/**
- * @typedef TransformEventServiceMeta
- * @property {string} [name]
- */
-
-/**
- * @typedef ValidateSchemaRequest
- * @property {EventSchema} [event]
  * @property {string} [event_category]
- * @property {string} [event_name]
- * @property {Object} [event_schema]
- * @property {string} [event_type]
- * @property {string} [event_version]
- */
-
-/**
- * @typedef ValidateSchemaResponse
- * @property {string} [message]
- * @property {boolean} [status]
+ * @property {string} [version]
  */
 
 class WebhookPublicModel {
   /** @returns {EventConfig} */
   static EventConfig() {
     return Joi.object({
-      created_on: Joi.string().allow(""),
-      description: Joi.string().allow("").allow(null),
-      display_name: Joi.string().allow(""),
-      event_category: Joi.string().allow(""),
-      event_name: Joi.string().allow(""),
-      event_schema: Joi.object().pattern(/\S/, Joi.any()),
-      event_type: Joi.string().allow(""),
       id: Joi.number(),
-      updated_on: Joi.string().allow(""),
-      version: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {EventConfigBase} */
-  static EventConfigBase() {
-    return Joi.object({
-      event_category: Joi.string().allow(""),
       event_name: Joi.string().allow(""),
       event_type: Joi.string().allow(""),
+      event_category: Joi.string().allow(""),
       version: Joi.string().allow(""),
+      display_name: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      created_on: Joi.string().allow(""),
     });
   }
 
@@ -137,99 +47,13 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {EventNotifier} */
-  static EventNotifier() {
-    return Joi.object({
-      emails: Joi.array().items(Joi.string().allow("")),
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {EventSchema} */
-  static EventSchema() {
-    return Joi.object({
-      meta: Joi.object().pattern(/\S/, Joi.any()),
-      payload: Joi.object().pattern(/\S/, Joi.any()),
-    });
-  }
-
-  /** @returns {InternalTransformEvent} */
-  static InternalTransformEvent() {
-    return Joi.object({
-      created_timestamp: Joi.number(),
-      name: Joi.string().allow(""),
-      trace_id: Joi.array().items(Joi.string().allow("")),
-      type: Joi.string().allow(""),
-      version: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {TransformEventAssociation} */
-  static TransformEventAssociation() {
-    return Joi.object({
-      company_id: Joi.number(),
-    });
-  }
-
-  /** @returns {TransformEventData} */
-  static TransformEventData() {
-    return Joi.object({
-      company_id: Joi.number(),
-      contains: Joi.array().items(Joi.string().allow("")),
-      event: WebhookPublicModel.InternalTransformEvent(),
-      payload: Joi.object().pattern(/\S/, Joi.any()),
-    });
-  }
-
-  /** @returns {TransformEventRequest} */
-  static TransformEventRequest() {
-    return Joi.object({
-      event: WebhookPublicModel.EventSchema(),
-      event_category: Joi.string().allow(""),
-      event_name: Joi.string().allow(""),
-      event_type: Joi.string().allow(""),
-      event_version: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {TransformEventResponse} */
-  static TransformEventResponse() {
+  /** @returns {EventConfigBase} */
+  static EventConfigBase() {
     return Joi.object({
-      association: WebhookPublicModel.TransformEventAssociation(),
-      data: WebhookPublicModel.TransformEventData(),
       event_name: Joi.string().allow(""),
-      event_trace_id: Joi.array().items(Joi.string().allow("")),
       event_type: Joi.string().allow(""),
-      service_meta: WebhookPublicModel.TransformEventServiceMeta(),
-      status: Joi.boolean(),
-      version: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {TransformEventServiceMeta} */
-  static TransformEventServiceMeta() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ValidateSchemaRequest} */
-  static ValidateSchemaRequest() {
-    return Joi.object({
-      event: WebhookPublicModel.EventSchema(),
       event_category: Joi.string().allow(""),
-      event_name: Joi.string().allow(""),
-      event_schema: Joi.object().pattern(/\S/, Joi.any()),
-      event_type: Joi.string().allow(""),
-      event_version: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ValidateSchemaResponse} */
-  static ValidateSchemaResponse() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-      status: Joi.boolean(),
+      version: Joi.string().allow(""),
     });
   }
 }

package/sdk/public/Webhook/WebhookPublicValidator.d.ts

@@ -1,42 +1,20 @@
 export = WebhookPublicValidator;
 /** @typedef FetchAllWebhookEventsParam */
-/** @typedef NotifyDepricatedEventParam */
 /**
  * @typedef QueryWebhookEventDetailsParam
  * @property {WebhookPublicModel.EventConfigBase[]} body
  */
-/**
- * @typedef TestHandlerTransformationParam
- * @property {WebhookPublicModel.TransformEventRequest} body
- */
-/**
- * @typedef ValidateSchemaParam
- * @property {WebhookPublicModel.ValidateSchemaRequest} body
- */
 declare class WebhookPublicValidator {
     /** @returns {FetchAllWebhookEventsParam} */
     static fetchAllWebhookEvents(): any;
-    /** @returns {NotifyDepricatedEventParam} */
-    static notifyDepricatedEvent(): any;
     /** @returns {QueryWebhookEventDetailsParam} */
     static queryWebhookEventDetails(): QueryWebhookEventDetailsParam;
-    /** @returns {TestHandlerTransformationParam} */
-    static testHandlerTransformation(): TestHandlerTransformationParam;
-    /** @returns {ValidateSchemaParam} */
-    static validateSchema(): ValidateSchemaParam;
 }
 declare namespace WebhookPublicValidator {
-    export { FetchAllWebhookEventsParam, NotifyDepricatedEventParam, QueryWebhookEventDetailsParam, TestHandlerTransformationParam, ValidateSchemaParam };
+    export { FetchAllWebhookEventsParam, QueryWebhookEventDetailsParam };
 }
 type QueryWebhookEventDetailsParam = {
     body: WebhookPublicModel.EventConfigBase[];
 };
-type TestHandlerTransformationParam = {
-    body: WebhookPublicModel.TransformEventRequest;
-};
-type ValidateSchemaParam = {
-    body: WebhookPublicModel.ValidateSchemaRequest;
-};
 type FetchAllWebhookEventsParam = any;
-type NotifyDepricatedEventParam = any;
 import WebhookPublicModel = require("./WebhookPublicModel");

package/sdk/public/Webhook/WebhookPublicValidator.js

@@ -4,54 +4,23 @@ const WebhookPublicModel = require("./WebhookPublicModel");
 
 /** @typedef FetchAllWebhookEventsParam */
 
-/** @typedef NotifyDepricatedEventParam */
-
 /**
  * @typedef QueryWebhookEventDetailsParam
  * @property {WebhookPublicModel.EventConfigBase[]} body
  */
 
-/**
- * @typedef TestHandlerTransformationParam
- * @property {WebhookPublicModel.TransformEventRequest} body
- */
-
-/**
- * @typedef ValidateSchemaParam
- * @property {WebhookPublicModel.ValidateSchemaRequest} body
- */
-
 class WebhookPublicValidator {
   /** @returns {FetchAllWebhookEventsParam} */
   static fetchAllWebhookEvents() {
     return Joi.object({});
   }
 
-  /** @returns {NotifyDepricatedEventParam} */
-  static notifyDepricatedEvent() {
-    return Joi.object({});
-  }
-
   /** @returns {QueryWebhookEventDetailsParam} */
   static queryWebhookEventDetails() {
     return Joi.object({
       body: Joi.array().items(WebhookPublicModel.EventConfigBase()).required(),
     }).required();
   }
-
-  /** @returns {TestHandlerTransformationParam} */
-  static testHandlerTransformation() {
-    return Joi.object({
-      body: WebhookPublicModel.TransformEventRequest().required(),
-    }).required();
-  }
-
-  /** @returns {ValidateSchemaParam} */
-  static validateSchema() {
-    return Joi.object({
-      body: WebhookPublicModel.ValidateSchemaRequest().required(),
-    }).required();
-  }
 }
 
 module.exports = WebhookPublicValidator;

package/sdk/public/index.d.ts

@@ -1,9 +1,7 @@
 export const PublicConfig: typeof import("./PublicConfig");
 export const PublicClient: typeof import("./PublicClient");
 export namespace PublicModel {
-    const BillingPublicModel: typeof import("./Billing/BillingPublicModel");
     const ConfigurationPublicModel: typeof import("./Configuration/ConfigurationPublicModel");
-    const ContentPublicModel: typeof import("./Content/ContentPublicModel");
     const InventoryPublicModel: typeof import("./Inventory/InventoryPublicModel");
     const PartnerPublicModel: typeof import("./Partner/PartnerPublicModel");
     const WebhookPublicModel: typeof import("./Webhook/WebhookPublicModel");

package/sdk/public/index.js

@@ -2,12 +2,8 @@ module.exports = {
   PublicConfig: require("./PublicConfig"),
   PublicClient: require("./PublicClient"),
   PublicModel: {
-    BillingPublicModel: require("./Billing/BillingPublicModel"),
-
     ConfigurationPublicModel: require("./Configuration/ConfigurationPublicModel"),
 
-    ContentPublicModel: require("./Content/ContentPublicModel"),
-
     InventoryPublicModel: require("./Inventory/InventoryPublicModel"),
 
     PartnerPublicModel: require("./Partner/PartnerPublicModel"),

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

@@ -1,125 +0,0 @@
-export = Lead;
-declare class Lead {
-    constructor(config: any);
-    config: any;
-    /**
-     * @param {LeadPartnerValidator.GetTicketsParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.TicketList>} - Success response
-     * @name getTickets
-     * @summary: Gets the list of partner level tickets and/or ticket filters depending on query params
-     * @description: Gets the list of partner level tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTickets/).
-     */
-    getTickets({ items, filters, q, status, priority, category, pageNo, pageSize, requestHeaders, }?: LeadPartnerValidator.GetTicketsParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketList>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {boolean} [arg.items] - Decides that the reponse will contain the
-     *   list of tickets
-     * @param {boolean} [arg.filters] - Decides that the reponse will contain
-     *   the ticket filters
-     * @param {string} [arg.q] - Search through ticket titles and description
-     * @param {string} [arg.status] - Filter tickets on status
-     * @param {LeadPartnerModel.PriorityEnum} [arg.priority] - Filter tickets on priority
-     * @param {string} [arg.category] - Filter tickets on category
-     * @param {number} [arg.pageSize] - Number of items to retrieve in each
-     *   page. Default is 12.
-     * @returns {Paginator<LeadPartnerModel.TicketList>}
-     * @summary: Gets the list of partner level tickets and/or ticket filters depending on query params
-     * @description: Gets the list of partner level tickets and/or ticket filters
-     */
-    getTicketsPaginator({ items, filters, q, status, priority, category, pageSize, }?: {
-        items?: boolean;
-        filters?: boolean;
-        q?: string;
-        status?: string;
-        priority?: LeadPartnerModel.PriorityEnum;
-        category?: string;
-        pageSize?: number;
-    }): Paginator<LeadPartnerModel.TicketList>;
-    /**
-     * @param {LeadPartnerValidator.CreateTicketParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
-     * @name createTicket
-     * @summary: Creates a partner level ticket
-     * @description: Creates a partner level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/createTicket/).
-     */
-    createTicket({ body, requestHeaders }?: LeadPartnerValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
-    /**
-     * @param {LeadPartnerValidator.GetTicketParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
-     * @name getTicket
-     * @summary: Retreives ticket details of a partner level ticket with ticket ID
-     * @description: Retreives ticket details of a partner level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTicket/).
-     */
-    getTicket({ id, requestHeaders }?: LeadPartnerValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
-    /**
-     * @param {LeadPartnerValidator.EditTicketParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
-     * @name editTicket
-     * @summary: Edits ticket details of a partner level ticket
-     * @description: Edits ticket details of a partner level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/editTicket/).
-     */
-    editTicket({ id, body, requestHeaders }?: LeadPartnerValidator.EditTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
-    /**
-     * @param {LeadPartnerValidator.CreateHistoryParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.TicketHistory>} - Success response
-     * @name createHistory
-     * @summary: Create history for specific partner level ticket
-     * @description: Create history for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/createHistory/).
-     */
-    createHistory({ id, body, requestHeaders }?: LeadPartnerValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketHistory>;
-    /**
-     * @param {LeadPartnerValidator.GetTicketHistoryParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.TicketHistoryList>} - Success response
-     * @name getTicketHistory
-     * @summary: Gets history list for specific partner level ticket
-     * @description: Gets history list for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTicketHistory/).
-     */
-    getTicketHistory({ id, requestHeaders }?: LeadPartnerValidator.GetTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketHistoryList>;
-    /**
-     * @param {LeadPartnerValidator.GetTokenForVideoRoomParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.GetTokenForVideoRoomResponse>} -
-     *   Success response
-     * @name getTokenForVideoRoom
-     * @summary: Get Token to join a specific Video Room using it's unqiue name
-     * @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTokenForVideoRoom/).
-     */
-    getTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadPartnerValidator.GetTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GetTokenForVideoRoomResponse>;
-    /**
-     * @param {LeadPartnerValidator.GetVideoParticipantsParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.GetParticipantsInsideVideoRoomResponse>}
-     *   - Success response
-     *
-     * @name getVideoParticipants
-     * @summary: Get participants of a specific Video Room using it's unique name
-     * @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getVideoParticipants/).
-     */
-    getVideoParticipants({ uniqueName, requestHeaders }?: LeadPartnerValidator.GetVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GetParticipantsInsideVideoRoomResponse>;
-    /**
-     * @param {LeadPartnerValidator.GetGeneralConfigParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.GeneralConfigResponse>} - Success response
-     * @name getGeneralConfig
-     * @summary: Get general support configuration.
-     * @description: Get general support configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getGeneralConfig/).
-     */
-    getGeneralConfig({ requestHeaders }?: LeadPartnerValidator.GetGeneralConfigParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GeneralConfigResponse>;
-}
-import LeadPartnerModel = require("./LeadPartnerModel");
-import Paginator = require("../../common/Paginator");