@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
-const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const AuditTrailValidator = require("./AuditTrailPlatformValidator");
 const AuditTrailModel = require("./AuditTrailPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class AuditTrail {
   constructor(config) {
@@ -12,15 +13,15 @@ class AuditTrail {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.qs - Logs Query
-   * @returns {Promise<LogSchemaResponse>} - Success response
-   * @summary: Get paginated audit logs
-   * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
+   * @param {RequestBodyAuditLog} arg.body
+   * @returns {Promise<CreateLogResponse>} - Success response
+   * @summary: Create logs for auditing later on
+   * @description: Create a log instance that stores all the relevant info to be logged
    */
-  async getAuditLogs({ qs } = {}) {
-    const { error } = AuditTrailValidator.getAuditLogs().validate(
+  async createAuditLog({ body } = {}) {
+    const { error } = AuditTrailValidator.createAuditLog().validate(
       {
-        qs,
+        body,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -29,37 +30,36 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.getAuditLogs().validate(
+    const { error: warrning } = AuditTrailValidator.createAuditLog().validate(
       {
-        qs,
+        body,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getAuditLogs",
+        message: "Parameter Validation warrnings for createAuditLog",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["qs"] = qs;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "get",
+      "post",
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
-      undefined,
+      body,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = AuditTrailModel.LogSchemaResponse().validate(response, {
+    } = AuditTrailModel.CreateLogResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -67,7 +67,7 @@ class AuditTrail {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getAuditLogs",
+        message: "Response Validation Warnnings for createAuditLog",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -77,15 +77,15 @@ class AuditTrail {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {RequestBodyAuditLog} arg.body
-   * @returns {Promise<CreateLogResponse>} - Success response
-   * @summary: Create logs for auditing later on
-   * @description: Create a log instance that stores all the relevant info to be logged
+   * @param {string} arg.id - Log uuid
+   * @returns {Promise<LogSchemaResponse>} - Success response
+   * @summary: Get audit log
+   * @description: Get detailed log information by their id
    */
-  async createAuditLog({ body } = {}) {
-    const { error } = AuditTrailValidator.createAuditLog().validate(
+  async getAuditLog({ id } = {}) {
+    const { error } = AuditTrailValidator.getAuditLog().validate(
       {
-        body,
+        id,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -94,16 +94,16 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.createAuditLog().validate(
+    const { error: warrning } = AuditTrailValidator.getAuditLog().validate(
       {
-        body,
+        id,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createAuditLog",
+        message: "Parameter Validation warrnings for getAuditLog",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -114,16 +114,16 @@ class AuditTrail {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "post",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
+      "get",
+      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
       query_params,
-      body,
+      undefined,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = AuditTrailModel.CreateLogResponse().validate(response, {
+    } = AuditTrailModel.LogSchemaResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -131,7 +131,7 @@ class AuditTrail {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createAuditLog",
+        message: "Response Validation Warnnings for getAuditLog",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -141,15 +141,15 @@ class AuditTrail {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.id - Log uuid
+   * @param {string} arg.qs - Logs Query
    * @returns {Promise<LogSchemaResponse>} - Success response
-   * @summary: Get audit log
-   * @description: Get detailed log information by their id
+   * @summary: Get paginated audit logs
+   * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
    */
-  async getAuditLog({ id } = {}) {
-    const { error } = AuditTrailValidator.getAuditLog().validate(
+  async getAuditLogs({ qs } = {}) {
+    const { error } = AuditTrailValidator.getAuditLogs().validate(
       {
-        id,
+        qs,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -158,28 +158,29 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.getAuditLog().validate(
+    const { error: warrning } = AuditTrailValidator.getAuditLogs().validate(
       {
-        id,
+        qs,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getAuditLog",
+        message: "Parameter Validation warrnings for getAuditLogs",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["qs"] = qs;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
+      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
       undefined,
       xHeaders
@@ -195,7 +196,7 @@ class AuditTrail {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getAuditLog",
+        message: "Response Validation Warnnings for getAuditLogs",
       });
       Logger({ level: "WARN", message: res_error });
     }

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

@@ -1,18 +1,18 @@
 export = AuditTrailModel;
 declare class AuditTrailModel {
-    static RequestBodyAuditLog(): any;
+    static BadRequest(): any;
     static CreateLogResponse(): any;
-    static LogMetaObj(): any;
+    static DeviceInfo(): any;
+    static EntityObj(): any;
     static EntityObject(): any;
-    static LogSchemaResponse(): any;
+    static EntityTypeObj(): any;
+    static EntityTypesResponse(): any;
+    static InternalServerError(): any;
+    static Location(): any;
     static LogDocs(): any;
-    static EntityObj(): any;
+    static LogMetaObj(): any;
+    static LogSchemaResponse(): any;
     static Modifier(): any;
-    static DeviceInfo(): any;
-    static Location(): any;
-    static BadRequest(): any;
+    static RequestBodyAuditLog(): any;
     static ResourceNotFound(): any;
-    static InternalServerError(): any;
-    static EntityTypesResponse(): any;
-    static EntityTypeObj(): any;
 }

package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js

@@ -1,143 +1,104 @@
 const Joi = require("joi");
 
 class AuditTrailModel {
-  static RequestBodyAuditLog() {
+  static BadRequest() {
     return Joi.object({
-      log_meta: AuditTrailModel.LogMetaObj().required(),
-
-      log_payload: Joi.any().required(),
+      message: Joi.string().allow(""),
     });
   }
-
   static CreateLogResponse() {
     return Joi.object({
-      message: Joi.string().allow(""),
-
       internal_message: Joi.string().allow(""),
+      message: Joi.string().allow(""),
     });
   }
-
-  static LogMetaObj() {
+  static DeviceInfo() {
     return Joi.object({
-      modifier: Joi.any(),
-
-      application: Joi.string().allow(""),
-
-      entity: AuditTrailModel.EntityObject(),
-
-      device_info: Joi.any(),
-
-      location: Joi.any(),
+      extra_meta: Joi.any(),
+      user_agent: Joi.string().allow(""),
     });
   }
-
-  static EntityObject() {
+  static EntityObj() {
     return Joi.object({
+      action: Joi.string().allow(""),
+      entity_details: Joi.any(),
       id: Joi.string().allow(""),
-
       type: Joi.string().allow(""),
-
-      action: Joi.string().allow(""),
     });
   }
-
-  static LogSchemaResponse() {
+  static EntityObject() {
     return Joi.object({
-      docs: Joi.array().items(AuditTrailModel.LogDocs()),
+      action: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+      type: Joi.string().allow(""),
     });
   }
-
-  static LogDocs() {
+  static EntityTypeObj() {
     return Joi.object({
-      entity: AuditTrailModel.EntityObj(),
-
-      modifier: AuditTrailModel.Modifier(),
-
-      device_info: AuditTrailModel.DeviceInfo(),
-
-      location: AuditTrailModel.Location(),
-
-      _id: Joi.string().allow(""),
-
-      company: Joi.string().allow(""),
-
-      application: Joi.string().allow(""),
-
-      sessions: Joi.string().allow(""),
-
-      date: Joi.string().allow(""),
-
-      logs: Joi.any(),
+      display_name: Joi.string().allow(""),
+      entity_value: Joi.string().allow(""),
     });
   }
-
-  static EntityObj() {
+  static EntityTypesResponse() {
     return Joi.object({
-      id: Joi.string().allow(""),
-
-      type: Joi.string().allow(""),
-
-      action: Joi.string().allow(""),
-
-      entity_details: Joi.any(),
+      items: Joi.array().items(AuditTrailModel.EntityTypeObj()),
     });
   }
-
-  static Modifier() {
+  static InternalServerError() {
     return Joi.object({
-      user_id: Joi.string().allow(""),
-
-      as_administrator: Joi.boolean(),
-
-      user_details: Joi.any(),
+      code: Joi.string().allow(""),
+      message: Joi.string().allow(""),
     });
   }
-
-  static DeviceInfo() {
+  static Location() {
     return Joi.object({
-      user_agent: Joi.string().allow(""),
-
       extra_meta: Joi.any(),
     });
   }
-
-  static Location() {
+  static LogDocs() {
     return Joi.object({
-      extra_meta: Joi.any(),
+      _id: Joi.string().allow(""),
+      application: Joi.string().allow(""),
+      company: Joi.string().allow(""),
+      date: Joi.string().allow(""),
+      device_info: AuditTrailModel.DeviceInfo(),
+      entity: AuditTrailModel.EntityObj(),
+      location: AuditTrailModel.Location(),
+      logs: Joi.any(),
+      modifier: AuditTrailModel.Modifier(),
+      sessions: Joi.string().allow(""),
     });
   }
-
-  static BadRequest() {
+  static LogMetaObj() {
     return Joi.object({
-      message: Joi.string().allow(""),
+      application: Joi.string().allow(""),
+      device_info: Joi.any(),
+      entity: AuditTrailModel.EntityObject(),
+      location: Joi.any(),
+      modifier: Joi.any(),
     });
   }
-
-  static ResourceNotFound() {
+  static LogSchemaResponse() {
     return Joi.object({
-      message: Joi.string().allow(""),
+      docs: Joi.array().items(AuditTrailModel.LogDocs()),
     });
   }
-
-  static InternalServerError() {
+  static Modifier() {
     return Joi.object({
-      message: Joi.string().allow(""),
-
-      code: Joi.string().allow(""),
+      as_administrator: Joi.boolean(),
+      user_details: Joi.any(),
+      user_id: Joi.string().allow(""),
     });
   }
-
-  static EntityTypesResponse() {
+  static RequestBodyAuditLog() {
     return Joi.object({
-      items: Joi.array().items(AuditTrailModel.EntityTypeObj()),
+      log_meta: AuditTrailModel.LogMetaObj().required(),
+      log_payload: Joi.any().required(),
     });
   }
-
-  static EntityTypeObj() {
+  static ResourceNotFound() {
     return Joi.object({
-      entity_value: Joi.string().allow(""),
-
-      display_name: Joi.string().allow(""),
+      message: Joi.string().allow(""),
     });
   }
 }

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

@@ -1,7 +1,7 @@
 export = AuditTrailValidator;
 declare class AuditTrailValidator {
-    static getAuditLogs(): any;
     static createAuditLog(): any;
     static getAuditLog(): any;
+    static getAuditLogs(): any;
     static getEntityTypes(): any;
 }

package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js

@@ -2,12 +2,6 @@ const Joi = require("joi");
 
 const AuditTrailModel = require("./AuditTrailPlatformModel");
 class AuditTrailValidator {
-  static getAuditLogs() {
-    return Joi.object({
-      qs: Joi.string().allow("").required(),
-    }).required();
-  }
-
   static createAuditLog() {
     return Joi.object({
       body: AuditTrailModel.RequestBodyAuditLog().required(),
@@ -20,8 +14,15 @@ class AuditTrailValidator {
     }).required();
   }
 
+  static getAuditLogs() {
+    return Joi.object({
+      qs: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static getEntityTypes() {
     return Joi.object({}).required();
   }
 }
+
 module.exports = AuditTrailValidator;

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

@@ -2,6 +2,38 @@ export = Billing;
 declare class Billing {
     constructor(config: any);
     config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SubscriptionActivateReq} arg.body
+     * @returns {Promise<SubscriptionActivateRes>} - Success response
+     * @summary: Activate subscription
+     * @description: It will activate subscription plan for customer
+     */
+    activateSubscriptionPlan({ body }?: {
+        body: SubscriptionActivateReq;
+    }): Promise<SubscriptionActivateRes>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension _id
+     * @param {string} arg.subscriptionId - Subscription charge _id
+     * @returns {Promise<EntitySubscription>} - Success response
+     * @summary: Cancel subscription charge
+     * @description: Cancel subscription and attached charges.
+     */
+    cancelSubscriptionCharge({ extensionId, subscriptionId }?: {
+        extensionId: string;
+        subscriptionId: string;
+    }): Promise<EntitySubscription>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CancelSubscriptionReq} arg.body
+     * @returns {Promise<CancelSubscriptionRes>} - Success response
+     * @summary: Cancel subscription
+     * @description: It will cancel current active subscription.
+     */
+    cancelSubscriptionPlan({ body }?: {
+        body: CancelSubscriptionReq;
+    }): Promise<CancelSubscriptionRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.plan - ID of the plan.
@@ -28,35 +60,18 @@ declare class Billing {
     }): Promise<CreateSubscriptionResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.extensionId - Extension _id
-     * @param {string} arg.subscriptionId - Subscription charge _id
-     * @returns {Promise<EntitySubscription>} - Success response
-     * @summary: Get subscription charge details
-     * @description: Get created subscription charge details
-     */
-    getSubscriptionCharge({ extensionId, subscriptionId }?: {
-        extensionId: string;
-        subscriptionId: string;
-    }): Promise<EntitySubscription>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.extensionId - Extension _id
-     * @param {string} arg.subscriptionId - Subscription charge _id
-     * @returns {Promise<EntitySubscription>} - Success response
-     * @summary: Cancel subscription charge
-     * @description: Cancel subscription and attached charges.
+     * @returns {Promise<SubscriptionCustomer>} - Success response
+     * @summary: Get subscription customer detail
+     * @description: Get subscription customer detail.
      */
-    cancelSubscriptionCharge({ extensionId, subscriptionId }?: {
-        extensionId: string;
-        subscriptionId: string;
-    }): Promise<EntitySubscription>;
+    getCustomerDetail({}?: any): Promise<SubscriptionCustomer>;
     /**
      * @param {Object} arg - Arg object.
-     * @returns {Promise<Invoices>} - Success response
-     * @summary: Get invoices
-     * @description: Get invoices.
+     * @returns {Promise<SubscriptionLimit>} - Success response
+     * @summary: Get subscription subscription limits
+     * @description: Get subscription subscription limits.
      */
-    getInvoices({}?: any): Promise<Invoices>;
+    getFeatureLimitConfig({}?: any): Promise<SubscriptionLimit>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.invoiceId - Invoice id
@@ -69,21 +84,11 @@ declare class Billing {
     }): Promise<Invoice>;
     /**
      * @param {Object} arg - Arg object.
-     * @returns {Promise<SubscriptionCustomer>} - Success response
-     * @summary: Get subscription customer detail
-     * @description: Get subscription customer detail.
-     */
-    getCustomerDetail({}?: any): Promise<SubscriptionCustomer>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {SubscriptionCustomerCreate} arg.body
-     * @returns {Promise<SubscriptionCustomer>} - Success response
-     * @summary: Upsert subscription customer detail
-     * @description: Upsert subscription customer detail.
+     * @returns {Promise<Invoices>} - Success response
+     * @summary: Get invoices
+     * @description: Get invoices.
      */
-    upsertCustomerDetail({ body }?: {
-        body: SubscriptionCustomerCreate;
-    }): Promise<SubscriptionCustomer>;
+    getInvoices({}?: any): Promise<Invoices>;
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<SubscriptionStatus>} - Success response
@@ -93,29 +98,24 @@ declare class Billing {
     getSubscription({}?: any): Promise<SubscriptionStatus>;
     /**
      * @param {Object} arg - Arg object.
-     * @returns {Promise<SubscriptionLimit>} - Success response
-     * @summary: Get subscription subscription limits
-     * @description: Get subscription subscription limits.
-     */
-    getFeatureLimitConfig({}?: any): Promise<SubscriptionLimit>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {SubscriptionActivateReq} arg.body
-     * @returns {Promise<SubscriptionActivateRes>} - Success response
-     * @summary: Activate subscription
-     * @description: It will activate subscription plan for customer
+     * @param {string} arg.extensionId - Extension _id
+     * @param {string} arg.subscriptionId - Subscription charge _id
+     * @returns {Promise<EntitySubscription>} - Success response
+     * @summary: Get subscription charge details
+     * @description: Get created subscription charge details
      */
-    activateSubscriptionPlan({ body }?: {
-        body: SubscriptionActivateReq;
-    }): Promise<SubscriptionActivateRes>;
+    getSubscriptionCharge({ extensionId, subscriptionId }?: {
+        extensionId: string;
+        subscriptionId: string;
+    }): Promise<EntitySubscription>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {CancelSubscriptionReq} arg.body
-     * @returns {Promise<CancelSubscriptionRes>} - Success response
-     * @summary: Cancel subscription
-     * @description: It will cancel current active subscription.
+     * @param {SubscriptionCustomerCreate} arg.body
+     * @returns {Promise<SubscriptionCustomer>} - Success response
+     * @summary: Upsert subscription customer detail
+     * @description: Upsert subscription customer detail.
      */
-    cancelSubscriptionPlan({ body }?: {
-        body: CancelSubscriptionReq;
-    }): Promise<CancelSubscriptionRes>;
+    upsertCustomerDetail({ body }?: {
+        body: SubscriptionCustomerCreate;
+    }): Promise<SubscriptionCustomer>;
 }