@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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

@@ -6,104 +6,116 @@ declare class Billing {
      * @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>;
+    }): 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<any>;
+    }): 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.
      */
     cancelSubscriptionCharge({ extensionId, subscriptionId }?: {
         extensionId: string;
         subscriptionId: string;
-    }): Promise<any>;
+    }): Promise<EntitySubscription>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<Invoices>} - Success response
      * @summary: Get invoices
      * @description: Get invoices.
      */
-    getInvoices({}?: any): Promise<any>;
+    getInvoices({}?: any): Promise<Invoices>;
     /**
      * @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.
+     * @returns {Promise<SubscriptionCustomer>} - Success response
      * @summary: Get subscription customer detail
      * @description: Get subscription customer detail.
      */
-    getCustomerDetail({}?: any): Promise<any>;
+    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.
      */
     upsertCustomerDetail({ body }?: {
         body: SubscriptionCustomerCreate;
-    }): Promise<any>;
+    }): Promise<SubscriptionCustomer>;
     /**
      * @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>;
+    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<any>;
+    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
      */
     activateSubscriptionPlan({ body }?: {
         body: SubscriptionActivateReq;
-    }): Promise<any>;
+    }): Promise<SubscriptionActivateRes>;
     /**
      * @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<any>;
+    }): Promise<CancelSubscriptionRes>;
 }