@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js

@@ -3,96 +3,31 @@ const Joi = require("joi");
 /**
  * @typedef RequestBodyAuditLog
  * @property {LogMetaObj} log_meta
- * @property {Object} log_payload
+ * @property {Object} log_payload - Detailed information about payload.
  */
 
 /**
- * @typedef CreateLogResponse
- * @property {string} [message]
- * @property {string} [internal_message]
+ * @typedef CreateLogResp
+ * @property {string} [message] - Acknowledgement about success or failure of audit log.
+ * @property {string} [internal_message] - Status of audit log in internal system.
  */
 
 /**
  * @typedef LogMetaObj
- * @property {Object} [modifier]
- * @property {string} [application]
+ * @property {Object} [modifier] - Details about user responsible for modifying events.
+ * @property {string} [application] - The application id generating the log event.
  * @property {EntityObject} [entity]
- * @property {Object} [device_info]
- * @property {Object} [location]
+ * @property {Object} [device_info] - Contains device-specific information for
+ *   the log event.
+ * @property {Object} [location] - Holds location-related data for the event context.
+ * @property {string} [sessions] - Identifies the session associated with the log event.
  */
 
 /**
  * @typedef EntityObject
- * @property {string} [id]
- * @property {string} [type]
- * @property {string} [action]
- */
-
-/**
- * @typedef LogSchemaResponse
- * @property {LogDocs[]} [docs]
- */
-
-/**
- * @typedef LogDocs
- * @property {EntityObj} [entity]
- * @property {Modifier} [modifier]
- * @property {DeviceInfo} [device_info]
- * @property {Location} [location]
- * @property {string} [_id]
- * @property {string} [company]
- * @property {string} [application]
- * @property {string} [sessions]
- * @property {string} [date]
- * @property {Object} [logs]
- */
-
-/**
- * @typedef EntityObj
- * @property {string} [id]
- * @property {string} [type]
- * @property {string} [action]
- * @property {Object} [entity_details]
- */
-
-/**
- * @typedef Modifier
- * @property {string} [user_id]
- * @property {boolean} [as_administrator]
- * @property {Object} [user_details]
- */
-
-/**
- * @typedef DeviceInfo
- * @property {string} [user_agent]
- * @property {Object} [extra_meta]
- */
-
-/**
- * @typedef Location
- * @property {Object} [extra_meta]
- */
-
-/**
- * @typedef BadRequest
- * @property {string} [message] - Failure message.
- */
-
-/**
- * @typedef InternalServerError
- * @property {string} [message] - Internal server Server error
- * @property {string} [code] - Error code
- */
-
-/**
- * @typedef EntityTypesResponse
- * @property {EntityTypeObj[]} [items]
- */
-
-/**
- * @typedef EntityTypeObj
- * @property {string} [entity_value]
- * @property {string} [display_name]
+ * @property {string} [id] - Unique identifier for the entity.
+ * @property {string} [type] - The type/category of the entity.
+ * @property {string} [action] - The action performed on or by the entity.
  */
 
 class AuditTrailPlatformModel {
@@ -100,12 +35,12 @@ class AuditTrailPlatformModel {
   static RequestBodyAuditLog() {
     return Joi.object({
       log_meta: AuditTrailPlatformModel.LogMetaObj().required(),
-      log_payload: Joi.any().required(),
+      log_payload: Joi.object().pattern(/\S/, Joi.any()).required(),
     });
   }
 
-  /** @returns {CreateLogResponse} */
-  static CreateLogResponse() {
+  /** @returns {CreateLogResp} */
+  static CreateLogResp() {
     return Joi.object({
       message: Joi.string().allow(""),
       internal_message: Joi.string().allow(""),
@@ -115,11 +50,12 @@ class AuditTrailPlatformModel {
   /** @returns {LogMetaObj} */
   static LogMetaObj() {
     return Joi.object({
-      modifier: Joi.any(),
+      modifier: Joi.object().pattern(/\S/, Joi.any()),
       application: Joi.string().allow(""),
       entity: AuditTrailPlatformModel.EntityObject(),
-      device_info: Joi.any(),
-      location: Joi.any(),
+      device_info: Joi.object().pattern(/\S/, Joi.any()),
+      location: Joi.object().pattern(/\S/, Joi.any()),
+      sessions: Joi.string().allow(""),
     });
   }
 
@@ -131,92 +67,5 @@ class AuditTrailPlatformModel {
       action: Joi.string().allow(""),
     });
   }
-
-  /** @returns {LogSchemaResponse} */
-  static LogSchemaResponse() {
-    return Joi.object({
-      docs: Joi.array().items(AuditTrailPlatformModel.LogDocs()),
-    });
-  }
-
-  /** @returns {LogDocs} */
-  static LogDocs() {
-    return Joi.object({
-      entity: AuditTrailPlatformModel.EntityObj(),
-      modifier: AuditTrailPlatformModel.Modifier(),
-      device_info: AuditTrailPlatformModel.DeviceInfo(),
-      location: AuditTrailPlatformModel.Location(),
-      _id: Joi.string().allow(""),
-      company: Joi.string().allow(""),
-      application: Joi.string().allow(""),
-      sessions: Joi.string().allow(""),
-      date: Joi.string().allow(""),
-      logs: Joi.any(),
-    });
-  }
-
-  /** @returns {EntityObj} */
-  static EntityObj() {
-    return Joi.object({
-      id: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      action: Joi.string().allow(""),
-      entity_details: Joi.any(),
-    });
-  }
-
-  /** @returns {Modifier} */
-  static Modifier() {
-    return Joi.object({
-      user_id: Joi.string().allow(""),
-      as_administrator: Joi.boolean(),
-      user_details: Joi.any(),
-    });
-  }
-
-  /** @returns {DeviceInfo} */
-  static DeviceInfo() {
-    return Joi.object({
-      user_agent: Joi.string().allow(""),
-      extra_meta: Joi.any(),
-    });
-  }
-
-  /** @returns {Location} */
-  static Location() {
-    return Joi.object({
-      extra_meta: Joi.any(),
-    });
-  }
-
-  /** @returns {BadRequest} */
-  static BadRequest() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InternalServerError} */
-  static InternalServerError() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-      code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {EntityTypesResponse} */
-  static EntityTypesResponse() {
-    return Joi.object({
-      items: Joi.array().items(AuditTrailPlatformModel.EntityTypeObj()),
-    });
-  }
-
-  /** @returns {EntityTypeObj} */
-  static EntityTypeObj() {
-    return Joi.object({
-      entity_value: Joi.string().allow(""),
-      display_name: Joi.string().allow(""),
-    });
-  }
 }
 module.exports = AuditTrailPlatformModel;

package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts

@@ -3,52 +3,14 @@ export = AuditTrailPlatformValidator;
  * @typedef CreateAuditLogParam
  * @property {AuditTrailPlatformModel.RequestBodyAuditLog} body
  */
-/**
- * @typedef GetAuditLogParam
- * @property {string} id - Log uuid
- */
-/**
- * @typedef GetAuditLogsParam
- * @property {string} qs - Logs Query
- * @property {number} [limit] - Current request items count
- * @property {Object} [sort] - To sort based on _id
- */
-/** @typedef GetEntityTypesParam */
 declare class AuditTrailPlatformValidator {
     /** @returns {CreateAuditLogParam} */
     static createAuditLog(): CreateAuditLogParam;
-    /** @returns {GetAuditLogParam} */
-    static getAuditLog(): GetAuditLogParam;
-    /** @returns {GetAuditLogsParam} */
-    static getAuditLogs(): GetAuditLogsParam;
-    /** @returns {GetEntityTypesParam} */
-    static getEntityTypes(): any;
 }
 declare namespace AuditTrailPlatformValidator {
-    export { CreateAuditLogParam, GetAuditLogParam, GetAuditLogsParam, GetEntityTypesParam };
+    export { CreateAuditLogParam };
 }
 type CreateAuditLogParam = {
     body: AuditTrailPlatformModel.RequestBodyAuditLog;
 };
-type GetAuditLogParam = {
-    /**
-     * - Log uuid
-     */
-    id: string;
-};
-type GetAuditLogsParam = {
-    /**
-     * - Logs Query
-     */
-    qs: string;
-    /**
-     * - Current request items count
-     */
-    limit?: number;
-    /**
-     * - To sort based on _id
-     */
-    sort?: any;
-};
-type GetEntityTypesParam = any;
 import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");

package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js

@@ -7,20 +7,6 @@ const AuditTrailPlatformModel = require("./AuditTrailPlatformModel");
  * @property {AuditTrailPlatformModel.RequestBodyAuditLog} body
  */
 
-/**
- * @typedef GetAuditLogParam
- * @property {string} id - Log uuid
- */
-
-/**
- * @typedef GetAuditLogsParam
- * @property {string} qs - Logs Query
- * @property {number} [limit] - Current request items count
- * @property {Object} [sort] - To sort based on _id
- */
-
-/** @typedef GetEntityTypesParam */
-
 class AuditTrailPlatformValidator {
   /** @returns {CreateAuditLogParam} */
   static createAuditLog() {
@@ -28,27 +14,6 @@ class AuditTrailPlatformValidator {
       body: AuditTrailPlatformModel.RequestBodyAuditLog().required(),
     }).required();
   }
-
-  /** @returns {GetAuditLogParam} */
-  static getAuditLog() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetAuditLogsParam} */
-  static getAuditLogs() {
-    return Joi.object({
-      qs: Joi.string().allow("").required(),
-      limit: Joi.number(),
-      sort: Joi.any(),
-    }).required();
-  }
-
-  /** @returns {GetEntityTypesParam} */
-  static getEntityTypes() {
-    return Joi.object({}).required();
-  }
 }
 
 module.exports = AuditTrailPlatformValidator;

package/sdk/platform/Billing/BillingPlatformClient.d.ts

@@ -8,40 +8,40 @@ declare class Billing {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
      * @name cancelSubscriptionCharge
-     * @summary: Cancel a subscription charge.
-     * @description: Cancel an ongoing subscription charge for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
+     * @summary: Cancel the extension subscription
+     * @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/cancelSubscriptionCharge/).
      */
     cancelSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionChargeRes>;
     /**
      * @param {BillingPlatformValidator.CreateOneTimeChargeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<BillingPlatformModel.CreateOneTimeChargeResponse>} -
-     *   Success response
+     * @returns {Promise<BillingPlatformModel.CreateOneTimeChargeResponseSchemas>}
+     *   - Success response
+     *
      * @name createOneTimeCharge
-     * @summary: Generate a one-time charge.
-     * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
+     * @summary: Generate a one-time charge
+     * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createOneTimeCharge/).
      */
-    createOneTimeCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateOneTimeChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateOneTimeChargeResponse>;
+    createOneTimeCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateOneTimeChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateOneTimeChargeResponseSchemas>;
     /**
      * @param {BillingPlatformValidator.CreateSubscriptionChargeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
-     *   Success response
+     * @returns {Promise<BillingPlatformModel.CreateSubscription>} - Success response
      * @name createSubscriptionCharge
      * @summary: Initiate subscription billing
-     * @description: Register a subscription charge for a seller using your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
+     * @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createSubscriptionCharge/).
      */
-    createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscriptionResponse>;
+    createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscription>;
     /**
      * @param {BillingPlatformValidator.GetChargeDetailsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<BillingPlatformModel.ChargeDetails>} - Success response
      * @name getChargeDetails
-     * @summary: Obtain charge details.
-     * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
+     * @summary: Obtain charge details
+     * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getChargeDetails/).
      */
     getChargeDetails({ extensionId, chargeId, requestHeaders }?: BillingPlatformValidator.GetChargeDetailsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.ChargeDetails>;
     /**
@@ -50,8 +50,8 @@ declare class Billing {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
      * @name getSubscriptionCharge
-     * @summary: Retrieve subscription charge details.
-     * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
+     * @summary: Retrieve subscription charge details
+     * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getSubscriptionCharge/).
      */
     getSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.GetSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionChargeRes>;
 }

package/sdk/platform/Billing/BillingPlatformClient.js

@@ -20,8 +20,8 @@ class Billing {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
    * @name cancelSubscriptionCharge
-   * @summary: Cancel a subscription charge.
-   * @description: Cancel an ongoing subscription charge for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
+   * @summary: Cancel the extension subscription
+   * @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/cancelSubscriptionCharge/).
    */
   async cancelSubscriptionCharge(
     { extensionId, subscriptionId, requestHeaders } = { requestHeaders: {} },
@@ -101,11 +101,12 @@ class Billing {
    * @param {BillingPlatformValidator.CreateOneTimeChargeParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<BillingPlatformModel.CreateOneTimeChargeResponse>} -
-   *   Success response
+   * @returns {Promise<BillingPlatformModel.CreateOneTimeChargeResponseSchemas>}
+   *   - Success response
+   *
    * @name createOneTimeCharge
-   * @summary: Generate a one-time charge.
-   * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
+   * @summary: Generate a one-time charge
+   * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createOneTimeCharge/).
    */
   async createOneTimeCharge(
     { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -160,7 +161,7 @@ class Billing {
 
     const {
       error: res_error,
-    } = BillingPlatformModel.CreateOneTimeChargeResponse().validate(
+    } = BillingPlatformModel.CreateOneTimeChargeResponseSchemas().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -183,11 +184,10 @@ class Billing {
    * @param {BillingPlatformValidator.CreateSubscriptionChargeParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
-   *   Success response
+   * @returns {Promise<BillingPlatformModel.CreateSubscription>} - Success response
    * @name createSubscriptionCharge
    * @summary: Initiate subscription billing
-   * @description: Register a subscription charge for a seller using your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
+   * @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createSubscriptionCharge/).
    */
   async createSubscriptionCharge(
     { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -244,10 +244,10 @@ class Billing {
 
     const {
       error: res_error,
-    } = BillingPlatformModel.CreateSubscriptionResponse().validate(
-      responseData,
-      { abortEarly: false, allowUnknown: true }
-    );
+    } = BillingPlatformModel.CreateSubscription().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -269,8 +269,8 @@ class Billing {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<BillingPlatformModel.ChargeDetails>} - Success response
    * @name getChargeDetails
-   * @summary: Obtain charge details.
-   * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
+   * @summary: Obtain charge details
+   * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getChargeDetails/).
    */
   async getChargeDetails(
     { extensionId, chargeId, requestHeaders } = { requestHeaders: {} },
@@ -350,8 +350,8 @@ class Billing {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
    * @name getSubscriptionCharge
-   * @summary: Retrieve subscription charge details.
-   * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
+   * @summary: Retrieve subscription charge details
+   * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getSubscriptionCharge/).
    */
   async getSubscriptionCharge(
     { extensionId, subscriptionId, requestHeaders } = { requestHeaders: {} },