@gofynd/fdk-client-javascript 0.1.35

package/sdk/application/client/FileStorageApplicationClient.d.ts

@@ -0,0 +1,88 @@
+export = FileStorage;
+declare class FileStorage {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        startUpload: string;
+        completeUpload: string;
+        signUrls: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Name of the bucket created for storing objects.
+     * @param {StartRequest} arg.body
+     * @returns {Promise<StartResponse>} - Success response
+     * @summary: Initiates an upload and returns a storage link that is valid for 30 minutes. You can use the storage link to make subsequent upload request with file buffer or blob.
+     * @description: Use this API to perform the first step of uploading (i.e. **Start**) an arbitrarily sized buffer or blob.
+     *
+     * The three major steps are:
+     * Start
+     * Upload
+     * Complete
+     *
+     * ### Start
+     * Initiates the assets upload using `startUpload`.
+     * It returns a storage link in response.
+     *
+     * ### Upload
+     * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+     * Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
+     *
+     * ### Complete
+     * After successfully upload, call the `completeUpload` API to finish the upload process.
+     * This operation will return the URL of the uploaded file.
+     */
+    startUpload({ namespace, body }?: {
+        namespace: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Name of the bucket created for storing objects.
+     * @param {StartResponse} arg.body
+     * @returns {Promise<CompleteResponse>} - Success response
+     * @summary: Completes the upload process. After successfully uploading a file, call this API to finish the upload process.
+     * @description: Use this API to perform the third step of uploading (i.e. **Complete**) an arbitrarily sized buffer or blob.
+     *
+     * The three major steps are:
+     * Start
+     * Upload
+     * Complete
+     *
+     * ### Start
+     * Initiates the assets upload using `startUpload`.
+     * It returns a storage link in response.
+     *
+     * ### Upload
+     * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+     * Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
+     *
+     * ### Complete
+     * After successfully upload, call the `completeUpload` API to finish the upload process.
+     * This operation will return the URL of the uploaded file.
+     */
+    completeUpload({ namespace, body }?: {
+        namespace: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SignUrlRequest} arg.body
+     * @returns {Promise<SignUrlResponse>} - Success response
+     * @summary: Explain here
+     * @description: Describe here
+     */
+    signUrls({ body }?: {
+        body: any;
+    }): Promise<any>;
+    upload({ data, file_name, content_type, namespace, size, tags, }?: {
+        data: any;
+        file_name: any;
+        content_type: any;
+        namespace: any;
+        size: any;
+        tags: any;
+    }): Promise<any>;
+}

package/sdk/application/client/FileStorageApplicationClient.js

@@ -0,0 +1,214 @@
+const APIClient = require("../ApplicationAPIClient");
+const Paginator = require("../../common/Paginator");
+const constructUrl = require("../constructUrl");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const FileStorageValidator = require("../models/FileStorageValidator");
+const axios = require("axios");
+
+class FileStorage {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      startUpload:
+        "/service/application/assets/v1.0/namespaces/{namespace}/upload/start/",
+      completeUpload:
+        "/service/application/assets/v1.0/namespaces/{namespace}/upload/complete/",
+      signUrls: "/service/application/assets/v1.0/sign-urls/",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Name of the bucket created for storing objects.
+   * @param {StartRequest} arg.body
+   * @returns {Promise<StartResponse>} - Success response
+   * @summary: Initiates an upload and returns a storage link that is valid for 30 minutes. You can use the storage link to make subsequent upload request with file buffer or blob.
+   * @description: Use this API to perform the first step of uploading (i.e. **Start**) an arbitrarily sized buffer or blob.
+   *
+   * The three major steps are:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `startUpload`.
+   * It returns a storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
+   *
+   * ### Complete
+   * After successfully upload, call the `completeUpload` API to finish the upload process.
+   * This operation will return the URL of the uploaded file.
+   */
+  startUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.startUpload().validate(
+      { namespace, body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["startUpload"],
+        params: { namespace },
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Name of the bucket created for storing objects.
+   * @param {StartResponse} arg.body
+   * @returns {Promise<CompleteResponse>} - Success response
+   * @summary: Completes the upload process. After successfully uploading a file, call this API to finish the upload process.
+   * @description: Use this API to perform the third step of uploading (i.e. **Complete**) an arbitrarily sized buffer or blob.
+   *
+   * The three major steps are:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `startUpload`.
+   * It returns a storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
+   *
+   * ### Complete
+   * After successfully upload, call the `completeUpload` API to finish the upload process.
+   * This operation will return the URL of the uploaded file.
+   */
+  completeUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.completeUpload().validate(
+      { namespace, body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["completeUpload"],
+        params: { namespace },
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {SignUrlRequest} arg.body
+   * @returns {Promise<SignUrlResponse>} - Success response
+   * @summary: Explain here
+   * @description: Describe here
+   */
+  signUrls({ body } = {}) {
+    const { error } = FileStorageValidator.signUrls().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["signUrls"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+}
+
+/**
+ * @param data
+ * @param {string} file_name
+ * @param {string} content_type
+ * @param {string} namespace
+ * @param {number} size
+ * @param {number} tags
+ */
+FileStorage.prototype.upload = function ({
+  data,
+  file_name,
+  content_type,
+  namespace,
+  size,
+  tags,
+} = {}) {
+  return new Promise(async (resolve, reject) => {
+    try {
+      const dataObj = await this.startUpload({
+        namespace,
+        body: {
+          file_name,
+          content_type,
+          size: size,
+          tags: tags,
+        },
+      });
+      if (dataObj.upload && dataObj.upload.url) {
+        await axios.put(dataObj.upload.url, data, {
+          withCredentials: false,
+          headers: { "Content-Type": content_type },
+        });
+      } else {
+        reject({ message: "Failed to upload file" });
+      }
+      delete dataObj.tags;
+      const completeRes = await this.completeUpload({
+        namespace,
+        body: dataObj,
+      });
+      resolve(completeRes);
+    } catch (err) {
+      reject(err);
+    }
+  });
+};
+
+module.exports = FileStorage;

package/sdk/application/client/LeadApplicationClient.d.ts

@@ -0,0 +1,90 @@
+export = Lead;
+declare class Lead {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getTicket: string;
+        createHistory: string;
+        createTicket: string;
+        getCustomForm: string;
+        submitCustomForm: string;
+        getParticipantsInsideVideoRoom: string;
+        getTokenForVideoRoom: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - ID of ticket to be retrieved
+     * @returns {Promise<Ticket>} - Success response
+     * @summary: Get Ticket with the specific id
+     * @description: Get Ticket with the specific id, this is used to view the ticket details
+     */
+    getTicket({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID for which history is created
+     * @param {TicketHistoryPayload} arg.body
+     * @returns {Promise<TicketHistory>} - Success response
+     * @summary: Create history for specific Ticket
+     * @description: Create history for specific 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 {AddTicketPayload} arg.body
+     * @returns {Promise<Ticket>} - Success response
+     * @summary: Create Ticket
+     * @description: This is used to Create Ticket.
+     */
+    createTicket({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.slug - Slug of form whose response is getting submitted
+     * @returns {Promise<CustomForm>} - Success response
+     * @summary: Get specific Custom Form using it's slug
+     * @description: Get specific Custom Form using it's slug, this is used to view the form.
+     */
+    getCustomForm({ slug }?: {
+        slug: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.slug - Slug of form whose response is getting submitted
+     * @param {CustomFormSubmissionPayload} arg.body
+     * @returns {Promise<SubmitCustomFormResponse>} - Success response
+     * @summary: Submit Response for a specific Custom Form using it's slug
+     * @description: Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user.
+     */
+    submitCustomForm({ slug, body }?: {
+        slug: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.uniqueName - Unique name of Video Room
+     * @returns {Promise<GetParticipantsInsideVideoRoomResponse>} - Success response
+     * @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.
+     */
+    getParticipantsInsideVideoRoom({ uniqueName }?: {
+        uniqueName: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.uniqueName - Unique name of Video Room
+     * @returns {Promise<GetTokenForVideoRoomResponse>} - Success response
+     * @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>;
+}

package/sdk/application/client/LeadApplicationClient.js

@@ -0,0 +1,264 @@
+const APIClient = require("../ApplicationAPIClient");
+const Paginator = require("../../common/Paginator");
+const constructUrl = require("../constructUrl");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const LeadValidator = require("../models/LeadValidator");
+
+class Lead {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getTicket: "/service/application/lead/v1.0/ticket/{id}",
+      createHistory: "/service/application/lead/v1.0/ticket/{id}/history",
+      createTicket: "/service/application/lead/v1.0/ticket/",
+      getCustomForm: "/service/application/lead/v1.0/form/{slug}",
+      submitCustomForm: "/service/application/lead/v1.0/form/{slug}/submit",
+      getParticipantsInsideVideoRoom:
+        "/service/application/lead/v1.0/video/room/{unique_name}/participants",
+      getTokenForVideoRoom:
+        "/service/application/lead/v1.0/video/room/{unique_name}/token",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id - ID of ticket to be retrieved
+   * @returns {Promise<Ticket>} - Success response
+   * @summary: Get Ticket with the specific id
+   * @description: Get Ticket with the specific id, this is used to view the ticket details
+   */
+  getTicket({ id } = {}) {
+    const { error } = LeadValidator.getTicket().validate(
+      { id },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getTicket"],
+        params: { id },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id - Ticket ID for which history is created
+   * @param {TicketHistoryPayload} arg.body
+   * @returns {Promise<TicketHistory>} - Success response
+   * @summary: Create history for specific Ticket
+   * @description: Create history for specific Ticket, this history is seen on ticket detail page, this can be comment, log or rating.
+   */
+  createHistory({ id, body } = {}) {
+    const { error } = LeadValidator.createHistory().validate(
+      { id, body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["createHistory"],
+        params: { id },
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {AddTicketPayload} arg.body
+   * @returns {Promise<Ticket>} - Success response
+   * @summary: Create Ticket
+   * @description: This is used to Create Ticket.
+   */
+  createTicket({ body } = {}) {
+    const { error } = LeadValidator.createTicket().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["createTicket"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.slug - Slug of form whose response is getting submitted
+   * @returns {Promise<CustomForm>} - Success response
+   * @summary: Get specific Custom Form using it's slug
+   * @description: Get specific Custom Form using it's slug, this is used to view the form.
+   */
+  getCustomForm({ slug } = {}) {
+    const { error } = LeadValidator.getCustomForm().validate(
+      { slug },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getCustomForm"],
+        params: { slug },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.slug - Slug of form whose response is getting submitted
+   * @param {CustomFormSubmissionPayload} arg.body
+   * @returns {Promise<SubmitCustomFormResponse>} - Success response
+   * @summary: Submit Response for a specific Custom Form using it's slug
+   * @description: Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user.
+   */
+  submitCustomForm({ slug, body } = {}) {
+    const { error } = LeadValidator.submitCustomForm().validate(
+      { slug, body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["submitCustomForm"],
+        params: { slug },
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.uniqueName - Unique name of Video Room
+   * @returns {Promise<GetParticipantsInsideVideoRoomResponse>} - Success response
+   * @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.
+   */
+  getParticipantsInsideVideoRoom({ uniqueName } = {}) {
+    const { error } = LeadValidator.getParticipantsInsideVideoRoom().validate(
+      { uniqueName },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getParticipantsInsideVideoRoom"],
+        params: { uniqueName },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.uniqueName - Unique name of Video Room
+   * @returns {Promise<GetTokenForVideoRoomResponse>} - Success response
+   * @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 } = {}) {
+    const { error } = LeadValidator.getTokenForVideoRoom().validate(
+      { uniqueName },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getTokenForVideoRoom"],
+        params: { uniqueName },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Lead;

package/sdk/application/client/LogisticApplicationClient.d.ts

@@ -0,0 +1,42 @@
+export = Logistic;
+declare class Logistic {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getTatProduct: string;
+        getPincodeZones: string;
+        getPincodeCity: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {GetTatProductReqBody} arg.body
+     * @returns {Promise<GetTatProductResponse>} - Success response
+     * @summary: Get TAT of a product
+     * @description: Use this API to know the delivery turnaround time (TAT) by entering the product details along with the PIN Code of the location.
+     */
+    getTatProduct({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {GetPincodeZonesReqBody} arg.body
+     * @returns {Promise<GetPincodeZonesResponse>} - Success response
+     * @summary: Get Pincode Zones
+     * @description: Get to know the zones of a specefic pincode
+     */
+    getPincodeZones({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.pincode - The PIN Code of the area, e.g. 400059
+     * @returns {Promise<GetPincodeCityResponse>} - Success response
+     * @summary: Get city from PIN Code
+     * @description: Use this API to retrieve a city by its PIN Code.
+     */
+    getPincodeCity({ pincode }?: {
+        pincode: string;
+    }): Promise<any>;
+}