@gofynd/fdk-client-javascript 1.1.2 → 1.1.4

package/sdk/platform/Order/OrderPlatformValidator.d.ts

@@ -1,11 +1,15 @@
 export = OrderValidator;
 declare class OrderValidator {
+    static attachOrderUser(): any;
     static checkOrderStatus(): any;
     static click2Call(): any;
     static createChannelConfig(): any;
     static createOrder(): any;
     static dispatchManifest(): any;
     static downloadBulkActionTemplate(): any;
+    static fetchCreditBalanceDetail(): any;
+    static fetchRefundModeConfig(): any;
+    static generatePOSReceiptByOrderId(): any;
     static getAnnouncements(): any;
     static getBagById(): any;
     static getBags(): any;
@@ -28,9 +32,11 @@ declare class OrderValidator {
     static processManifest(): any;
     static reassignLocation(): any;
     static sendSmsNinja(): any;
+    static sendUserMobileOTP(): any;
     static updateAddress(): any;
     static updatePackagingDimensions(): any;
     static updateShipmentLock(): any;
     static updateShipmentStatus(): any;
     static uploadConsent(): any;
+    static verifyMobileOTP(): any;
 }

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -2,6 +2,12 @@ const Joi = require("joi");
 
 const OrderModel = require("./OrderPlatformModel");
 class OrderValidator {
+  static attachOrderUser() {
+    return Joi.object({
+      body: OrderModel.AttachOrderUser().required(),
+    }).required();
+  }
+
   static checkOrderStatus() {
     return Joi.object({
       body: OrderModel.OrderStatus().required(),
@@ -42,6 +48,26 @@ class OrderValidator {
     }).required();
   }
 
+  static fetchCreditBalanceDetail() {
+    return Joi.object({
+      body: OrderModel.FetchCreditBalanceRequestPayload().required(),
+    }).required();
+  }
+
+  static fetchRefundModeConfig() {
+    return Joi.object({
+      body: OrderModel.RefundModeConfigRequestPayload().required(),
+    }).required();
+  }
+
+  static generatePOSReceiptByOrderId() {
+    return Joi.object({
+      orderId: Joi.string().allow("").required(),
+      shipmentId: Joi.string().allow(""),
+      documentType: Joi.string().allow(""),
+    }).required();
+  }
+
   static getAnnouncements() {
     return Joi.object({
       date: Joi.string().allow(""),
@@ -103,9 +129,15 @@ class OrderValidator {
       toDate: Joi.string().allow(""),
       dpIds: Joi.string().allow(""),
       stores: Joi.string().allow(""),
-      salesChannel: Joi.string().allow(""),
+      salesChannels: Joi.string().allow(""),
       paymentMode: Joi.string().allow(""),
       bagStatus: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
+      tags: Joi.string().allow(""),
+      timeToDispatch: Joi.string().allow(""),
+      paymentMethods: Joi.string().allow(""),
+      myOrders: Joi.boolean(),
     }).required();
   }
 
@@ -133,6 +165,7 @@ class OrderValidator {
       pageSize: Joi.number(),
       isPrioritySort: Joi.boolean(),
       customMeta: Joi.string().allow(""),
+      myOrders: Joi.boolean(),
     }).required();
   }
 
@@ -144,8 +177,6 @@ class OrderValidator {
     return Joi.object({
       channelShipmentId: Joi.string().allow(""),
       shipmentId: Joi.string().allow(""),
-      orderingCompanyId: Joi.string().allow(""),
-      requestByExt: Joi.string().allow(""),
     }).required();
   }
 
@@ -169,19 +200,16 @@ class OrderValidator {
       lane: Joi.string().allow(""),
       bagStatus: Joi.string().allow(""),
       statusOverrideLane: Joi.boolean(),
+      timeToDispatch: Joi.string().allow(""),
       searchType: Joi.string().allow(""),
       searchValue: Joi.string().allow(""),
-      searchId: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
       dpIds: Joi.string().allow(""),
-      orderingCompanyId: Joi.string().allow(""),
       stores: Joi.string().allow(""),
-      salesChannel: Joi.string().allow(""),
-      requestByExt: Joi.string().allow(""),
+      salesChannels: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      isPrioritySort: Joi.boolean(),
       fetchActiveShipment: Joi.boolean(),
       excludeLockedShipments: Joi.boolean(),
       paymentMethods: Joi.string().allow(""),
@@ -190,6 +218,9 @@ class OrderValidator {
       customMeta: Joi.string().allow(""),
       orderingChannel: Joi.string().allow(""),
       companyAffiliateTag: Joi.string().allow(""),
+      myOrders: Joi.boolean(),
+      platformUserId: Joi.string().allow(""),
+      tags: Joi.string().allow(""),
     }).required();
   }
 
@@ -240,6 +271,12 @@ class OrderValidator {
     }).required();
   }
 
+  static sendUserMobileOTP() {
+    return Joi.object({
+      body: OrderModel.SendUserMobileOTP().required(),
+    }).required();
+  }
+
   static updateAddress() {
     return Joi.object({
       shipmentId: Joi.string().allow("").required(),
@@ -259,7 +296,7 @@ class OrderValidator {
 
   static updatePackagingDimensions() {
     return Joi.object({
-      body: OrderModel.CreateOrderPayload().required(),
+      body: OrderModel.UpdatePackagingDimensionsPayload().required(),
     }).required();
   }
 
@@ -280,6 +317,12 @@ class OrderValidator {
       body: OrderModel.UploadConsent().required(),
     }).required();
   }
+
+  static verifyMobileOTP() {
+    return Joi.object({
+      body: OrderModel.VerifyMobileOTP().required(),
+    }).required();
+  }
 }
 
 module.exports = OrderValidator;

package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts

@@ -16,6 +16,28 @@ declare class Partner {
         extensionId: string;
         body: AddProxyReq;
     }): Promise<AddProxyResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.extensionId] - Extension id
+     * @returns {Promise<getProxyPathRes>} - Success response
+     * @summary: Proxy
+     * @description: Use this API to get proxy url
+     */
+    getProxyPath({ extensionId }?: {
+        extensionId?: string;
+    }): Promise<getProxyPathRes>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.extensionId] - Extension id
+     * @param {string} [arg.attachedPath] - Application id
+     * @returns {Promise<AddProxyResponse>} - Success response
+     * @summary: Proxy
+     * @description: Use this API to get proxy url
+     */
+    getProxyPathAttachedPath({ extensionId, attachedPath }?: {
+        extensionId?: string;
+        attachedPath?: string;
+    }): Promise<AddProxyResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.extensionId - Extension id for which proxy URL needs

package/sdk/platform/Partner/PartnerPlatformApplicationClient.js

@@ -77,6 +77,133 @@ class Partner {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.extensionId] - Extension id
+   * @returns {Promise<getProxyPathRes>} - Success response
+   * @summary: Proxy
+   * @description: Use this API to get proxy url
+   */
+  async getProxyPath({ extensionId } = {}) {
+    const { error } = PartnerValidator.getProxyPath().validate(
+      {
+        extensionId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PartnerValidator.getProxyPath().validate(
+      {
+        extensionId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getProxyPath",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}`,
+      query_params,
+      undefined
+    );
+
+    const {
+      error: res_error,
+    } = PartnerModel.getProxyPathRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getProxyPath",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.extensionId] - Extension id
+   * @param {string} [arg.attachedPath] - Application id
+   * @returns {Promise<AddProxyResponse>} - Success response
+   * @summary: Proxy
+   * @description: Use this API to get proxy url
+   */
+  async getProxyPathAttachedPath({ extensionId, attachedPath } = {}) {
+    const { error } = PartnerValidator.getProxyPathAttachedPath().validate(
+      {
+        extensionId,
+        attachedPath,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PartnerValidator.getProxyPathAttachedPath().validate(
+      {
+        extensionId,
+        attachedPath,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getProxyPathAttachedPath",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}/${attachedPath}`,
+      query_params,
+      undefined
+    );
+
+    const {
+      error: res_error,
+    } = PartnerModel.AddProxyResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getProxyPathAttachedPath",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.extensionId - Extension id for which proxy URL needs

package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts

@@ -1,5 +1,7 @@
 export = PartnerValidator;
 declare class PartnerValidator {
     static addProxyPath(): any;
+    static getProxyPath(): any;
+    static getProxyPathAttachedPath(): any;
     static removeProxyPath(): any;
 }

package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js

@@ -9,6 +9,19 @@ class PartnerValidator {
     }).required();
   }
 
+  static getProxyPath() {
+    return Joi.object({
+      extensionId: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getProxyPathAttachedPath() {
+    return Joi.object({
+      extensionId: Joi.string().allow(""),
+      attachedPath: Joi.string().allow(""),
+    }).required();
+  }
+
   static removeProxyPath() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),

package/sdk/platform/Partner/PartnerPlatformClient.d.ts

@@ -0,0 +1,145 @@
+export = Partner;
+declare class Partner {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension id
+     * @param {string} arg.message - Message while uninstalling extension
+     * @param {string} arg.uninstallReasonType - Reason for uninstalling extension
+     * @returns {Promise<UninstallExtension>} - Success response
+     * @summary: Uninstall extension
+     * @description: Use this API to remove extension from yout company or channel
+     */
+    deleteExtensionById({ extensionId, message, uninstallReasonType, }?: {
+        extensionId: string;
+        message: string;
+        uninstallReasonType: string;
+    }): Promise<UninstallExtension>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension id
+     * @returns {Promise<ExtensionCommon>} - Success response
+     * @summary: Get extension details
+     * @description: Use this API to get the details of extension
+     */
+    getExtensionById({ extensionId }?: {
+        extensionId: string;
+    }): Promise<ExtensionCommon>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - Number of records you want to get in single page
+     * @param {string} [arg.tag] - Tag
+     * @param {string} [arg.currentPage] - Tag
+     * @param {number} [arg.pageNo] - Current page number
+     * @param {string} [arg.filterBy] - Filter by
+     * @param {string} [arg.query] - Query
+     * @returns {Promise<ExtensionList>} - Success response
+     * @summary: Get the list of all the extensions
+     * @description: Use this API to get the the extensions for the company
+     */
+    getExtensionsForCompany({ pageSize, tag, currentPage, pageNo, filterBy, query, }?: {
+        pageSize?: number;
+        tag?: string;
+        currentPage?: string;
+        pageNo?: number;
+        filterBy?: string;
+        query?: string;
+    }): Promise<ExtensionList>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - Number of records you want to get in single page
+     * @returns {Promise<ExtensionSuggestionList>} - Success response
+     * @summary: Get the list of all the extension suggestions
+     * @description: Use this API to get the the extensions suggestions
+     */
+    getExtensionsSuggestions({ pageSize }?: {
+        pageSize?: number;
+    }): Promise<ExtensionSuggestionList>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.requestStatus] - Status of the request
+     * @param {string} [arg.pageSize] - Number of records per page
+     * @param {string} [arg.pageNo] - Number of page the user want to fetch
+     * @returns {Promise<PartnerRequestList>} - Success response
+     * @summary: Get partner invites
+     * @description: Use this API to get pending, accepted and rejected partner invites in platform
+     */
+    getPartnerInvites({ requestStatus, pageSize, pageNo }?: {
+        requestStatus?: string;
+        pageSize?: string;
+        pageNo?: string;
+    }): Promise<PartnerRequestList>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.inviteId - Invitation id
+     * @returns {Promise<PartnerInviteDetails>} - Success response
+     * @summary: Get partner request details
+     * @description: Use this API to get details of pending partner request
+     */
+    getPartnerRequestDetails({ inviteId }?: {
+        inviteId: string;
+    }): Promise<PartnerInviteDetails>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - Number of records you want to get in single page
+     * @param {number} [arg.pageNo] - Number of page
+     * @param {string} [arg.query] - Filter query which we want to pass
+     * @returns {Promise<ExtensionResponse>} - Success response
+     * @summary: Get the list of private extensions
+     * @description: Use this API to get the list of private extensions
+     */
+    getPrivateExtensions({ pageSize, pageNo, query }?: {
+        pageSize?: number;
+        pageNo?: number;
+        query?: string;
+    }): Promise<ExtensionResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension id
+     * @returns {Promise<PublicExtension>} - Success response
+     * @summary: Get details of public extension
+     * @description: Use this API to get the details of public extensions
+     */
+    getPublicExtension({ extensionId }?: {
+        extensionId: string;
+    }): Promise<PublicExtension>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.inviteId - Invitation id
+     * @param {ModifyPartnerReq} arg.body
+     * @returns {Promise<PartnerInviteDetails>} - Success response
+     * @summary: Act on the pending partner request
+     * @description: Use this API to approve or reject the pending partner request
+     */
+    modifyPartnerRequest({ inviteId, body }?: {
+        inviteId: string;
+        body: ModifyPartnerReq;
+    }): Promise<PartnerInviteDetails>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.requestId] - Extrequest id
+     * @returns {Promise<SetupProductRes>} - Success response
+     * @summary:
+     * @description: Use this API for setup
+     */
+    setupProducts({ requestId }?: {
+        requestId?: string;
+    }): Promise<SetupProductRes>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.entity - Entity
+     * @param {string} arg.extensionId - Extension id
+     * @param {string} arg.entityId - Entity id
+     * @param {SubscriptionRequest} arg.body
+     * @returns {Promise<SubscriptionRes>} - Success response
+     * @summary: Subscribe for extension plan
+     * @description: Use this API to select plan for paid extension
+     */
+    subscribeExtension({ entity, extensionId, entityId, body }?: {
+        entity: string;
+        extensionId: string;
+        entityId: string;
+        body: SubscriptionRequest;
+    }): Promise<SubscriptionRes>;
+}