@gofynd/fdk-client-javascript 0.1.35

package/sdk/platform/client/InventoryPlatformClient.js

@@ -0,0 +1,409 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const InventoryValidator = require("../models/InventoryValidator");
+class Inventory {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageNo] - Page Number
+   * @param {number} [arg.pageSize] - Page Size
+   * @summary: Get Job Configs For A Company
+   * @description: REST Endpoint that returns all job configs for a company
+   */
+  getJobsByCompany({ pageNo, pageSize } = {}) {
+    const { error } = InventoryValidator.getJobsByCompany().validate(
+      {
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {JobConfigDTO} arg.body
+   * @summary: Updates An Existing Job Config
+   * @description: REST Endpoint that updates a job config
+   */
+  updateJob({ body } = {}) {
+    const { error } = InventoryValidator.updateJob().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {JobConfigDTO} arg.body
+   * @summary: Creates A New Job Config
+   * @description: REST Endpoint that creates a new job config
+   */
+  createJob({ body } = {}) {
+    const { error } = InventoryValidator.createJob().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {SuppressStorePayload} arg.body
+   * @summary: Get Slingshot Configuration Of  A Company
+   * @description: REST Endpoint that returns all configuration detail of a company
+   */
+  suppressStores({ body } = {}) {
+    const { error } = InventoryValidator.suppressStores().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/kafka/suppressStore`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @summary: Get Slingshot Configuration Of  A Company
+   * @description: REST Endpoint that returns all configuration detail of a company
+   */
+  getConfigByCompany({} = {}) {
+    const { error } = InventoryValidator.getConfigByCompany().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/slingshot`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} arg.jobId - Job Id
+   * @summary: Get Job Code Steps
+   * @description: REST Endpoint that returns Inventory Job Steps
+   */
+  getJobSteps({ jobId } = {}) {
+    const { error } = InventoryValidator.getJobSteps().validate(
+      {
+        jobId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/steps/${jobId}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.integrationId - Integration Id
+   * @param {number} [arg.pageNo] - Page Number
+   * @param {number} [arg.pageSize] - Page Size
+   * @summary: Get Job Configs By Company And Integration
+   * @description: REST Endpoint that returns all job configs by company And integration
+   */
+  getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize } = {}) {
+    const {
+      error,
+    } = InventoryValidator.getJobByCompanyAndIntegration().validate(
+      {
+        integrationId,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/integration/${integrationId}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.integrationId - IntegrationId
+   * @summary: Disable Job Config
+   * @description: REST Endpoint that disables Inventory Job Config
+   */
+  disable({ integrationId } = {}) {
+    const { error } = InventoryValidator.disable().validate(
+      {
+        integrationId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/disable/integration/${integrationId}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @summary: Get Job Configs Defaults
+   * @description: REST Endpoint that returns default fields job configs by company And integration
+   */
+  getJobConfigDefaults({} = {}) {
+    const { error } = InventoryValidator.getJobConfigDefaults().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/defaults`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.code - Job Code
+   * @summary: Get Job Config By Code
+   * @description: REST Endpoint that returns job config by code
+   */
+  getJobByCode({ code } = {}) {
+    const { error } = InventoryValidator.getJobByCode().validate(
+      {
+        code,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/code/${code}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.code - Code
+   * @param {number} [arg.pageNo] - Page Number
+   * @param {number} [arg.pageSize] - Page Size
+   * @param {string} [arg.status] - Status
+   * @param {string} [arg.date] - From Date
+   * @summary: Get Job Metrics
+   * @description: REST Endpoint that returns Inventory Run History For A Job Code
+   */
+  getJobCodeMetrics({ code, pageNo, pageSize, status, date } = {}) {
+    const { error } = InventoryValidator.getJobCodeMetrics().validate(
+      {
+        code,
+        pageNo,
+        pageSize,
+        status,
+        date,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["status"] = status;
+    query_params["date"] = date;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/code/${code}/metrics`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.integrationId - Integration Id
+   * @param {number} [arg.pageNo] - Page Number
+   * @param {number} [arg.pageSize] - Page Size
+   * @summary: Get Job Codes By Company And Integration
+   * @description: REST Endpoint that returns all job codes by company And integration
+   */
+  getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize } = {}) {
+    const {
+      error,
+    } = InventoryValidator.getJobCodesByCompanyAndIntegration().validate(
+      {
+        integrationId,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/code/integration/${integrationId}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Inventory;

package/sdk/platform/client/LeadPlatformClient.d.ts

@@ -0,0 +1,150 @@
+export = Lead;
+declare class Lead {
+    constructor(config: any);
+    config: any;
+    /**
+     * @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 {PriorityEnum} [arg.priority] - Filter tickets on priority
+     * @param {string} [arg.category] - Filter tickets on category
+     * @param {number} [arg.pageNo] - The page number to navigate through the
+     *   given set of results.
+     * @param {number} [arg.pageSize] - Number of items to retrieve in each
+     *   page. Default is 12.
+     * @summary: Gets the list of company level tickets and/or ticket filters depending on query params
+     * @description: Gets the list of company level tickets and/or ticket filters
+     */
+    getTickets({ items, filters, q, status, priority, category, pageNo, pageSize, }?: {
+        items?: boolean;
+        filters?: boolean;
+        q?: string;
+        status?: string;
+        priority?: any;
+        category?: string;
+        pageNo?: number;
+        pageSize?: number;
+    }): Promise<any>;
+    /**
+     * @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 {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.
+     * @summary: Gets the list of company level tickets and/or ticket filters depending on query params
+     * @description: Gets the list of company level tickets and/or ticket filters
+     */
+    getTicketsPaginator({ items, filters, q, status, priority, category, pageSize, }?: {
+        items?: boolean;
+        filters?: boolean;
+        q?: string;
+        status?: string;
+        priority?: any;
+        category?: string;
+        pageSize?: number;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {AddTicketPayload} arg.body
+     * @summary: Creates a company level ticket
+     * @description: Creates a company level ticket
+     */
+    createTicket({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Tiket ID of the ticket to be fetched
+     * @summary: Retreives ticket details of a company level ticket with ticket ID
+     * @description: Retreives ticket details of a company level ticket
+     */
+    getTicket({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID of ticket to be edited
+     * @param {EditTicketPayload} arg.body
+     * @summary: Edits ticket details of a company level ticket
+     * @description: Edits ticket details of a company level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
+     */
+    editTicket({ id, body }?: {
+        id: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID for which history is created
+     * @param {TicketHistoryPayload} arg.body
+     * @summary: Create history for specific company level ticket
+     * @description: Create history for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
+     */
+    createHistory({ id, body }?: {
+        id: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID for which history is to be fetched
+     * @summary: Gets history list for specific company level ticket
+     * @description: Gets history list for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
+     */
+    getTicketHistory({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID for which feedbacks are to be fetched
+     * @summary: Gets a list of feedback submitted against that ticket
+     * @description: Gets a list of feedback submitted against that ticket
+     */
+    getFeedbacks({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID for which feedback is to be submitted
+     * @param {TicketFeedbackPayload} arg.body
+     * @summary: Submit a response for feeback form against that ticket
+     * @description: Submit a response for feeback form against that ticket
+     */
+    submitFeedback({ id, body }?: {
+        id: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.uniqueName - Unique name of video room
+     * @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.
+     */
+    getTokenForVideoRoom({ uniqueName }?: {
+        uniqueName: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.uniqueName - Unique name of Video Room
+     * @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.
+     */
+    getVideoParticipants({ uniqueName }?: {
+        uniqueName: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get general support configuration.
+     * @description: Get general support configuration.
+     */
+    getGeneralConfig({}?: any): Promise<any>;
+}
+import Paginator = require("../../common/Paginator");