@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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,6 +14,12 @@ class AuditTrailValidator {
     }).required();
   }
 
+  static getAuditLogs() {
+    return Joi.object({
+      qs: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static getEntityTypes() {
     return Joi.object({}).required();
   }

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

@@ -2,108 +2,120 @@ 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.
      * @param {string} arg.couponCode - Coupon code.
+     * @returns {Promise<CheckValidityResponse>} - Success response
      * @summary: Check coupon validity
      * @description: Check coupon validity.
      */
     checkCouponValidity({ plan, couponCode }?: {
         plan: string;
         couponCode: string;
-    }): Promise<any>;
+    }): Promise<CheckValidityResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.extensionId - Extension _id
      * @param {CreateSubscriptionCharge} arg.body
+     * @returns {Promise<CreateSubscriptionResponse>} - Success response
      * @summary: Create subscription charge
      * @description: Register subscription charge for a seller of your extension.
      */
     createSubscriptionCharge({ extensionId, body }?: {
         extensionId: string;
         body: CreateSubscriptionCharge;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.extensionId - Extension _id
-     * @param {string} arg.subscriptionId - Subscription charge _id
-     * @summary: Get subscription charge details
-     * @description: Get created subscription charge details
-     */
-    getSubscriptionCharge({ extensionId, subscriptionId }?: {
-        extensionId: string;
-        subscriptionId: string;
-    }): Promise<any>;
+    }): Promise<CreateSubscriptionResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.extensionId - Extension _id
-     * @param {string} arg.subscriptionId - Subscription charge _id
-     * @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<any>;
+    getCustomerDetail({}?: any): Promise<SubscriptionCustomer>;
     /**
      * @param {Object} arg - Arg object.
-     * @summary: Get invoices
-     * @description: Get invoices.
+     * @returns {Promise<SubscriptionLimit>} - Success response
+     * @summary: Get subscription subscription limits
+     * @description: Get subscription subscription limits.
      */
-    getInvoices({}?: any): Promise<any>;
+    getFeatureLimitConfig({}?: any): Promise<SubscriptionLimit>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.invoiceId - Invoice id
+     * @returns {Promise<Invoice>} - Success response
      * @summary: Get invoice by id
      * @description: Get invoice by id.
      */
     getInvoiceById({ invoiceId }?: {
         invoiceId: string;
-    }): Promise<any>;
+    }): Promise<Invoice>;
     /**
      * @param {Object} arg - Arg object.
-     * @summary: Get subscription customer detail
-     * @description: Get subscription customer detail.
-     */
-    getCustomerDetail({}?: any): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {SubscriptionCustomerCreate} arg.body
-     * @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<any>;
+    getInvoices({}?: any): Promise<Invoices>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<SubscriptionStatus>} - Success response
      * @summary: Get current subscription detail
      * @description: If subscription is active then it will return is_enabled true and return subscription object. If subscription is not active then is_enabled false and message.
      */
-    getSubscription({}?: any): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: Get subscription subscription limits
-     * @description: Get subscription subscription limits.
-     */
-    getFeatureLimitConfig({}?: any): Promise<any>;
+    getSubscription({}?: any): Promise<SubscriptionStatus>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {SubscriptionActivateReq} arg.body
-     * @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<any>;
+    getSubscriptionCharge({ extensionId, subscriptionId }?: {
+        extensionId: string;
+        subscriptionId: string;
+    }): Promise<EntitySubscription>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {CancelSubscriptionReq} arg.body
-     * @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<any>;
+    upsertCustomerDetail({ body }?: {
+        body: SubscriptionCustomerCreate;
+    }): Promise<SubscriptionCustomer>;
 }