@gofynd/fdk-client-javascript 1.4.3 → 1.4.4

package/sdk/partner/index.d.ts

@@ -1,9 +1,9 @@
-export const PartnerConfig: typeof import("./PartnerConfig");
-export const PartnerClient: typeof import("./PartnerClient");
+export const PartnerConfig: typeof import("sdk/output/javascript/code/sdk/partner/PartnerConfig");
+export const PartnerClient: typeof import("sdk/output/javascript/code/sdk/partner/PartnerClient");
 export namespace PartnerModel {
-    const FileStoragePartnerModel: typeof import("./FileStorage/FileStoragePartnerModel");
-    const LeadPartnerModel: typeof import("./Lead/LeadPartnerModel");
-    const LogisticsPartnerModel: typeof import("./Logistics/LogisticsPartnerModel");
-    const ThemePartnerModel: typeof import("./Theme/ThemePartnerModel");
-    const WebhookPartnerModel: typeof import("./Webhook/WebhookPartnerModel");
+    const FileStoragePartnerModel: typeof import("sdk/output/javascript/code/sdk/partner/FileStorage/FileStoragePartnerModel");
+    const LeadPartnerModel: typeof import("sdk/output/javascript/code/sdk/partner/Lead/LeadPartnerModel");
+    const LogisticsPartnerModel: typeof import("sdk/output/javascript/code/sdk/partner/Logistics/LogisticsPartnerModel");
+    const ThemePartnerModel: typeof import("sdk/output/javascript/code/sdk/partner/Theme/ThemePartnerModel");
+    const WebhookPartnerModel: typeof import("sdk/output/javascript/code/sdk/partner/Webhook/WebhookPartnerModel");
 }

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

@@ -18,8 +18,8 @@ declare class AuditTrail {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
      * @name getAuditLog
-     * @summary: Get an audit log entry
-     * @description: Retrieve a specific audit log entry - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
+     * @summary: Get an audit log
+     * @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
      */
     getAuditLog({ id, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
     /**
@@ -28,7 +28,7 @@ declare class AuditTrail {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
      * @name getAuditLogs
-     * @summary: Retrieve audit logs
+     * @summary: Get audit logs
      * @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
      */
     getAuditLogs({ qs, limit, sort, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogsParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
@@ -38,10 +38,10 @@ declare class AuditTrail {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
      * @name getEntityTypes
-     * @summary: Obtain entity types for auditing
-     * @description: List of entity types that can be audited within the platform's - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
+     * @summary: List entity types
+     * @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
      */
     getEntityTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
 }
-import AuditTrailPlatformValidator = require("./AuditTrailPlatformValidator");
-import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");
+import AuditTrailPlatformValidator = require("sdk/output/javascript/code/sdk/platform/AuditTrail/AuditTrailPlatformValidator");
+import AuditTrailPlatformModel = require("sdk/output/javascript/code/sdk/platform/AuditTrail/AuditTrailPlatformModel");

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -99,8 +99,8 @@ class AuditTrail {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
    * @name getAuditLog
-   * @summary: Get an audit log entry
-   * @description: Retrieve a specific audit log entry - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
+   * @summary: Get an audit log
+   * @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
    */
   async getAuditLog(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -178,7 +178,7 @@ class AuditTrail {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
    * @name getAuditLogs
-   * @summary: Retrieve audit logs
+   * @summary: Get audit logs
    * @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
    */
   async getAuditLogs(
@@ -264,8 +264,8 @@ class AuditTrail {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
    * @name getEntityTypes
-   * @summary: Obtain entity types for auditing
-   * @description: List of entity types that can be audited within the platform's - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
+   * @summary: List entity types
+   * @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
    */
   async getEntityTypes(
     { requestHeaders } = { requestHeaders: {} },

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

@@ -51,4 +51,4 @@ type GetAuditLogsParam = {
     sort?: any;
 };
 type GetEntityTypesParam = any;
-import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");
+import AuditTrailPlatformModel = require("sdk/output/javascript/code/sdk/platform/AuditTrail/AuditTrailPlatformModel");

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

@@ -19,7 +19,7 @@ declare class Billing {
      * @returns {Promise<BillingPlatformModel.EntitySubscription>} - 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/).
+     * @description: When uninstalling, the extension statue will be marked as canceled. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
      */
     cancelSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntitySubscription>;
     /**
@@ -29,7 +29,7 @@ declare class Billing {
      * @returns {Promise<BillingPlatformModel.CancelSubscriptionRes>} - Success response
      * @name cancelSubscriptionPlan
      * @summary: Cancel a subscription plan
-     * @description: Cancel an active subscription plan for a customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
+     * @description: The seller will initiate a request to cancel their current subscription on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
      */
     cancelSubscriptionPlan({ body, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionPlanParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CancelSubscriptionRes>;
     /**
@@ -60,7 +60,7 @@ declare class Billing {
      * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
      *   Success response
      * @name createSubscriptionCharge
-     * @summary: Initiate subscription billing
+     * @summary: Register extension for the seller
      * @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/).
      */
     createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscriptionResponse>;
@@ -71,7 +71,7 @@ declare class Billing {
      * @returns {Promise<BillingPlatformModel.OneTimeChargeEntity>} - 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/).
+     * @description: It will fetch the information regarding the subscription for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
      */
     getChargeDetails({ extensionId, chargeId, requestHeaders }?: BillingPlatformValidator.GetChargeDetailsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.OneTimeChargeEntity>;
     /**
@@ -80,8 +80,8 @@ declare class Billing {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
      * @name getCustomerDetail
-     * @summary: Fetch customer details
-     * @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
+     * @summary: Get seller details
+     * @description: Retrieve seller information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
      */
     getCustomerDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
     /**
@@ -90,7 +90,7 @@ declare class Billing {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
      * @name getEnterprisePlans
-     * @summary: Retrieve enterprise-level plans
+     * @summary: Get enterprise-level plans
      * @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
      */
     getEnterprisePlans({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Plan[]>;
@@ -120,7 +120,7 @@ declare class Billing {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<BillingPlatformModel.Invoices>} - Success response
      * @name getInvoices
-     * @summary: Retrieve invoices
+     * @summary: Get invoices
      * @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
      */
     getInvoices({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.Invoices>;
@@ -130,8 +130,8 @@ declare class Billing {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
      * @name getSubscription
-     * @summary: Retrieve subscription details
-     * @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
+     * @summary: Get subscription details
+     * @description: t will show the most recent subscriptions of the seller for each ordering channel, regardless of their status—whether they're active, cancelled, or otherwise. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
      */
     getSubscription({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionStatus>;
     /**
@@ -140,7 +140,7 @@ declare class Billing {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
      * @name getSubscriptionCharge
-     * @summary: Retrieve subscription charge details
+     * @summary: Get 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/).
      */
     getSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.GetSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.EntitySubscription>;
@@ -180,10 +180,10 @@ declare class Billing {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
      * @name upsertCustomerDetail
-     * @summary: Update or insert customer details
-     * @description: Allows you to modify or insert customer information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
+     * @summary: Update or insert seller details
+     * @description: Allows you to modify or insert seller information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
      */
     upsertCustomerDetail({ body, requestHeaders }?: BillingPlatformValidator.UpsertCustomerDetailParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionCustomer>;
 }
-import BillingPlatformValidator = require("./BillingPlatformValidator");
-import BillingPlatformModel = require("./BillingPlatformModel");
+import BillingPlatformValidator = require("sdk/output/javascript/code/sdk/platform/Billing/BillingPlatformValidator");
+import BillingPlatformModel = require("sdk/output/javascript/code/sdk/platform/Billing/BillingPlatformModel");

package/sdk/platform/Billing/BillingPlatformClient.js

@@ -102,7 +102,7 @@ class Billing {
    * @returns {Promise<BillingPlatformModel.EntitySubscription>} - 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/).
+   * @description: When uninstalling, the extension statue will be marked as canceled. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
    */
   async cancelSubscriptionCharge(
     { extensionId, subscriptionId, requestHeaders } = { requestHeaders: {} },
@@ -185,7 +185,7 @@ class Billing {
    * @returns {Promise<BillingPlatformModel.CancelSubscriptionRes>} - Success response
    * @name cancelSubscriptionPlan
    * @summary: Cancel a subscription plan
-   * @description: Cancel an active subscription plan for a customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
+   * @description: The seller will initiate a request to cancel their current subscription on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
    */
   async cancelSubscriptionPlan(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -431,7 +431,7 @@ class Billing {
    * @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
    *   Success response
    * @name createSubscriptionCharge
-   * @summary: Initiate subscription billing
+   * @summary: Register extension for the seller
    * @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/).
    */
   async createSubscriptionCharge(
@@ -515,7 +515,7 @@ class Billing {
    * @returns {Promise<BillingPlatformModel.OneTimeChargeEntity>} - 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/).
+   * @description: It will fetch the information regarding the subscription for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
    */
   async getChargeDetails(
     { extensionId, chargeId, requestHeaders } = { requestHeaders: {} },
@@ -595,8 +595,8 @@ class Billing {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
    * @name getCustomerDetail
-   * @summary: Fetch customer details
-   * @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
+   * @summary: Get seller details
+   * @description: Retrieve seller information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
    */
   async getCustomerDetail(
     { requestHeaders } = { requestHeaders: {} },
@@ -670,7 +670,7 @@ class Billing {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
    * @name getEnterprisePlans
-   * @summary: Retrieve enterprise-level plans
+   * @summary: Get enterprise-level plans
    * @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
    */
   async getEnterprisePlans(
@@ -904,7 +904,7 @@ class Billing {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<BillingPlatformModel.Invoices>} - Success response
    * @name getInvoices
-   * @summary: Retrieve invoices
+   * @summary: Get invoices
    * @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
    */
   async getInvoices(
@@ -977,8 +977,8 @@ class Billing {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
    * @name getSubscription
-   * @summary: Retrieve subscription details
-   * @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
+   * @summary: Get subscription details
+   * @description: t will show the most recent subscriptions of the seller for each ordering channel, regardless of their status—whether they're active, cancelled, or otherwise. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
    */
   async getSubscription(
     { requestHeaders } = { requestHeaders: {} },
@@ -1052,7 +1052,7 @@ class Billing {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
    * @name getSubscriptionCharge
-   * @summary: Retrieve subscription charge details
+   * @summary: Get 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/).
    */
   async getSubscriptionCharge(
@@ -1390,8 +1390,8 @@ class Billing {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
    * @name upsertCustomerDetail
-   * @summary: Update or insert customer details
-   * @description: Allows you to modify or insert customer information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
+   * @summary: Update or insert seller details
+   * @description: Allows you to modify or insert seller information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
    */
   async upsertCustomerDetail(
     { body, requestHeaders } = { requestHeaders: {} },

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

@@ -216,4 +216,4 @@ type GetCustomerDetailParam = any;
 type GetEnterprisePlansParam = any;
 type GetInvoicesParam = any;
 type GetSubscriptionParam = any;
-import BillingPlatformModel = require("./BillingPlatformModel");
+import BillingPlatformModel = require("sdk/output/javascript/code/sdk/platform/Billing/BillingPlatformModel");