@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15

package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts

@@ -1,4 +1,41 @@
 export = FileStoragePartnerModel;
+/**
+ * @typedef SizeConstraints
+ * @property {number} [max] - Maximum allowed size (in bytes) for files in the namespace
+ */
+/**
+ * @typedef SaveProxy
+ * @property {boolean} [success]
+ */
+/**
+ * @typedef ProxyFileData
+ * @property {string} [name]
+ */
+/**
+ * @typedef ProxyFile
+ * @property {number} [id]
+ * @property {string} [customer]
+ * @property {number} [quantity]
+ * @property {number} [price]
+ * @property {ProxyFileData} [data]
+ * @property {string} [url]
+ */
+/**
+ * @typedef FetchProxyDetails
+ * @property {boolean} [success]
+ */
+/**
+ * @typedef NamespaceDetails
+ * @property {string} [namespace] - The namespace identifier
+ * @property {string[]} [valid_content_types] - List of valid content types for
+ *   the namespace
+ * @property {SizeConstraints} [size]
+ * @property {string} [file_acl] - Access control level for files in the namespace
+ */
+/**
+ * @typedef AllNamespaceDetails
+ * @property {NamespaceDetails[]} [items]
+ */
 /**
  * @typedef CDN
  * @property {string} url
@@ -11,7 +48,7 @@ export = FileStoragePartnerModel;
  * @property {string} url
  */
 /**
- * @typedef StartResponse
+ * @typedef FileUpload
  * @property {string} file_name
  * @property {string} file_path
  * @property {string} content_type
@@ -20,11 +57,10 @@ export = FileStoragePartnerModel;
  * @property {string} operation
  * @property {number} size
  * @property {Upload} upload
- * @property {CDN} cdn
  * @property {string[]} [tags]
  */
 /**
- * @typedef StartRequest
+ * @typedef FileUploadStart
  * @property {string} file_name
  * @property {string} content_type
  * @property {number} size
@@ -36,7 +72,7 @@ export = FileStoragePartnerModel;
  * @property {string} [username]
  */
 /**
- * @typedef CompleteResponse
+ * @typedef FileUploadComplete
  * @property {string} _id
  * @property {string} file_name
  * @property {string} file_path
@@ -53,14 +89,86 @@ export = FileStoragePartnerModel;
  * @property {CreatedBy} [created_by]
  */
 /**
- * @typedef FailedResponse
+ * @typedef FailedBrowseFilesResult
  * @property {string} message
  */
+/**
+ * @typedef SignedUrl
+ * @property {string} url - This is the original asset URL provided in the
+ *   request. This is the URL for which a signed URL has been generated.
+ * @property {string} signed_url - Generated signed URL.
+ * @property {number} expiry - The expiration time for the signed URL in seconds.
+ */
+/**
+ * @typedef SignUrlResult
+ * @property {SignedUrl[]} urls - Signed URL object.
+ */
+/**
+ * @typedef SignUrl
+ * @property {number} expiry - The expiration time for the signed URL.
+ * @property {string[]} urls - List of asset URLs to be signed.
+ */
 declare class FileStoragePartnerModel {
 }
 declare namespace FileStoragePartnerModel {
-    export { CDN, Upload, StartResponse, StartRequest, CreatedBy, CompleteResponse, FailedResponse };
+    export { SizeConstraints, SaveProxy, ProxyFileData, ProxyFile, FetchProxyDetails, NamespaceDetails, AllNamespaceDetails, CDN, Upload, FileUpload, FileUploadStart, CreatedBy, FileUploadComplete, FailedBrowseFilesResult, SignedUrl, SignUrlResult, SignUrl };
 }
+/** @returns {SizeConstraints} */
+declare function SizeConstraints(): SizeConstraints;
+type SizeConstraints = {
+    /**
+     * - Maximum allowed size (in bytes) for files in the namespace
+     */
+    max?: number;
+};
+/** @returns {SaveProxy} */
+declare function SaveProxy(): SaveProxy;
+type SaveProxy = {
+    success?: boolean;
+};
+/** @returns {ProxyFileData} */
+declare function ProxyFileData(): ProxyFileData;
+type ProxyFileData = {
+    name?: string;
+};
+/** @returns {ProxyFile} */
+declare function ProxyFile(): ProxyFile;
+type ProxyFile = {
+    id?: number;
+    customer?: string;
+    quantity?: number;
+    price?: number;
+    data?: ProxyFileData;
+    url?: string;
+};
+/** @returns {FetchProxyDetails} */
+declare function FetchProxyDetails(): FetchProxyDetails;
+type FetchProxyDetails = {
+    success?: boolean;
+};
+/** @returns {NamespaceDetails} */
+declare function NamespaceDetails(): NamespaceDetails;
+type NamespaceDetails = {
+    /**
+     * - The namespace identifier
+     */
+    namespace?: string;
+    /**
+     * - List of valid content types for
+     * the namespace
+     */
+    valid_content_types?: string[];
+    size?: SizeConstraints;
+    /**
+     * - Access control level for files in the namespace
+     */
+    file_acl?: string;
+};
+/** @returns {AllNamespaceDetails} */
+declare function AllNamespaceDetails(): AllNamespaceDetails;
+type AllNamespaceDetails = {
+    items?: NamespaceDetails[];
+};
 /** @returns {CDN} */
 declare function CDN(): CDN;
 type CDN = {
@@ -74,9 +182,9 @@ type Upload = {
     expiry: number;
     url: string;
 };
-/** @returns {StartResponse} */
-declare function StartResponse(): StartResponse;
-type StartResponse = {
+/** @returns {FileUpload} */
+declare function FileUpload(): FileUpload;
+type FileUpload = {
     file_name: string;
     file_path: string;
     content_type: string;
@@ -85,12 +193,11 @@ type StartResponse = {
     operation: string;
     size: number;
     upload: Upload;
-    cdn: CDN;
     tags?: string[];
 };
-/** @returns {StartRequest} */
-declare function StartRequest(): StartRequest;
-type StartRequest = {
+/** @returns {FileUploadStart} */
+declare function FileUploadStart(): FileUploadStart;
+type FileUploadStart = {
     file_name: string;
     content_type: string;
     size: number;
@@ -102,9 +209,9 @@ declare function CreatedBy(): CreatedBy;
 type CreatedBy = {
     username?: string;
 };
-/** @returns {CompleteResponse} */
-declare function CompleteResponse(): CompleteResponse;
-type CompleteResponse = {
+/** @returns {FileUploadComplete} */
+declare function FileUploadComplete(): FileUploadComplete;
+type FileUploadComplete = {
     _id: string;
     file_name: string;
     file_path: string;
@@ -120,8 +227,45 @@ type CompleteResponse = {
     modified_on: string;
     created_by?: CreatedBy;
 };
-/** @returns {FailedResponse} */
-declare function FailedResponse(): FailedResponse;
-type FailedResponse = {
+/** @returns {FailedBrowseFilesResult} */
+declare function FailedBrowseFilesResult(): FailedBrowseFilesResult;
+type FailedBrowseFilesResult = {
     message: string;
 };
+/** @returns {SignedUrl} */
+declare function SignedUrl(): SignedUrl;
+type SignedUrl = {
+    /**
+     * - This is the original asset URL provided in the
+     * request. This is the URL for which a signed URL has been generated.
+     */
+    url: string;
+    /**
+     * - Generated signed URL.
+     */
+    signed_url: string;
+    /**
+     * - The expiration time for the signed URL in seconds.
+     */
+    expiry: number;
+};
+/** @returns {SignUrlResult} */
+declare function SignUrlResult(): SignUrlResult;
+type SignUrlResult = {
+    /**
+     * - Signed URL object.
+     */
+    urls: SignedUrl[];
+};
+/** @returns {SignUrl} */
+declare function SignUrl(): SignUrl;
+type SignUrl = {
+    /**
+     * - The expiration time for the signed URL.
+     */
+    expiry: number;
+    /**
+     * - List of asset URLs to be signed.
+     */
+    urls: string[];
+};

package/sdk/partner/FileStorage/FileStoragePartnerModel.js

@@ -1,5 +1,49 @@
 const Joi = require("joi");
 
+/**
+ * @typedef SizeConstraints
+ * @property {number} [max] - Maximum allowed size (in bytes) for files in the namespace
+ */
+
+/**
+ * @typedef SaveProxy
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef ProxyFileData
+ * @property {string} [name]
+ */
+
+/**
+ * @typedef ProxyFile
+ * @property {number} [id]
+ * @property {string} [customer]
+ * @property {number} [quantity]
+ * @property {number} [price]
+ * @property {ProxyFileData} [data]
+ * @property {string} [url]
+ */
+
+/**
+ * @typedef FetchProxyDetails
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef NamespaceDetails
+ * @property {string} [namespace] - The namespace identifier
+ * @property {string[]} [valid_content_types] - List of valid content types for
+ *   the namespace
+ * @property {SizeConstraints} [size]
+ * @property {string} [file_acl] - Access control level for files in the namespace
+ */
+
+/**
+ * @typedef AllNamespaceDetails
+ * @property {NamespaceDetails[]} [items]
+ */
+
 /**
  * @typedef CDN
  * @property {string} url
@@ -14,7 +58,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef StartResponse
+ * @typedef FileUpload
  * @property {string} file_name
  * @property {string} file_path
  * @property {string} content_type
@@ -23,12 +67,11 @@ const Joi = require("joi");
  * @property {string} operation
  * @property {number} size
  * @property {Upload} upload
- * @property {CDN} cdn
  * @property {string[]} [tags]
  */
 
 /**
- * @typedef StartRequest
+ * @typedef FileUploadStart
  * @property {string} file_name
  * @property {string} content_type
  * @property {number} size
@@ -42,7 +85,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef CompleteResponse
+ * @typedef FileUploadComplete
  * @property {string} _id
  * @property {string} file_name
  * @property {string} file_path
@@ -60,11 +103,89 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef FailedResponse
+ * @typedef FailedBrowseFilesResult
  * @property {string} message
  */
 
+/**
+ * @typedef SignedUrl
+ * @property {string} url - This is the original asset URL provided in the
+ *   request. This is the URL for which a signed URL has been generated.
+ * @property {string} signed_url - Generated signed URL.
+ * @property {number} expiry - The expiration time for the signed URL in seconds.
+ */
+
+/**
+ * @typedef SignUrlResult
+ * @property {SignedUrl[]} urls - Signed URL object.
+ */
+
+/**
+ * @typedef SignUrl
+ * @property {number} expiry - The expiration time for the signed URL.
+ * @property {string[]} urls - List of asset URLs to be signed.
+ */
+
 class FileStoragePartnerModel {
+  /** @returns {SizeConstraints} */
+  static SizeConstraints() {
+    return Joi.object({
+      max: Joi.number(),
+    });
+  }
+
+  /** @returns {SaveProxy} */
+  static SaveProxy() {
+    return Joi.object({
+      success: Joi.boolean(),
+    });
+  }
+
+  /** @returns {ProxyFileData} */
+  static ProxyFileData() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ProxyFile} */
+  static ProxyFile() {
+    return Joi.object({
+      id: Joi.number(),
+      customer: Joi.string().allow(""),
+      quantity: Joi.number(),
+      price: Joi.number(),
+      data: FileStoragePartnerModel.ProxyFileData(),
+      url: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {FetchProxyDetails} */
+  static FetchProxyDetails() {
+    return Joi.object({
+      success: Joi.boolean(),
+    });
+  }
+
+  /** @returns {NamespaceDetails} */
+  static NamespaceDetails() {
+    return Joi.object({
+      namespace: Joi.string().allow(""),
+      valid_content_types: Joi.array()
+        .items(Joi.string().allow(""))
+        .allow(null, ""),
+      size: FileStoragePartnerModel.SizeConstraints(),
+      file_acl: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {AllNamespaceDetails} */
+  static AllNamespaceDetails() {
+    return Joi.object({
+      items: Joi.array().items(FileStoragePartnerModel.NamespaceDetails()),
+    });
+  }
+
   /** @returns {CDN} */
   static CDN() {
     return Joi.object({
@@ -82,8 +203,8 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {StartResponse} */
-  static StartResponse() {
+  /** @returns {FileUpload} */
+  static FileUpload() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       file_path: Joi.string().allow("").required(),
@@ -93,13 +214,12 @@ class FileStoragePartnerModel {
       operation: Joi.string().allow("").required(),
       size: Joi.number().required(),
       upload: FileStoragePartnerModel.Upload().required(),
-      cdn: FileStoragePartnerModel.CDN().required(),
       tags: Joi.array().items(Joi.string().allow("")),
     });
   }
 
-  /** @returns {StartRequest} */
-  static StartRequest() {
+  /** @returns {FileUploadStart} */
+  static FileUploadStart() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       content_type: Joi.string().allow("").required(),
@@ -116,8 +236,8 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {CompleteResponse} */
-  static CompleteResponse() {
+  /** @returns {FileUploadComplete} */
+  static FileUploadComplete() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
@@ -136,11 +256,35 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {FailedResponse} */
-  static FailedResponse() {
+  /** @returns {FailedBrowseFilesResult} */
+  static FailedBrowseFilesResult() {
     return Joi.object({
       message: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {SignedUrl} */
+  static SignedUrl() {
+    return Joi.object({
+      url: Joi.string().allow("").required(),
+      signed_url: Joi.string().allow("").required(),
+      expiry: Joi.number().required(),
+    });
+  }
+
+  /** @returns {SignUrlResult} */
+  static SignUrlResult() {
+    return Joi.object({
+      urls: Joi.array().items(FileStoragePartnerModel.SignedUrl()).required(),
+    });
+  }
+
+  /** @returns {SignUrl} */
+  static SignUrl() {
+    return Joi.object({
+      expiry: Joi.number().required(),
+      urls: Joi.array().items(Joi.string().allow("")).required(),
+    });
+  }
 }
 module.exports = FileStoragePartnerModel;

package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts

@@ -1,6 +1,9 @@
 export = FileStorageValidator;
 declare class FileStorageValidator {
-    static startUpload(): any;
     static completeUpload(): any;
-    static browse(): any;
+    static startUpload(): any;
+    static browseFiles(): any;
+    static fetchProxy(): any;
+    static saveProxyDetails(): any;
+    static signUrls(): any;
 }

package/sdk/partner/FileStorage/FileStoragePartnerValidator.js

@@ -2,32 +2,48 @@ const Joi = require("joi");
 
 const FileStorageModel = require("./FileStoragePartnerModel");
 class FileStorageValidator {
-  static startUpload() {
+  static completeUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStorageModel.StartRequest().required(),
+      body: FileStorageModel.FileUpload().required(),
     }).required();
   }
 
-  static completeUpload() {
+  static startUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStorageModel.StartResponse().required(),
+      body: FileStorageModel.FileUploadStart().required(),
     }).required();
   }
 
-  static browse() {
+  static browseFiles() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      applicationId: Joi.string().allow("").required(),
-      companyId: Joi.number().required(),
       page: Joi.number(),
       limit: Joi.number(),
     }).required();
   }
+
+  static fetchProxy() {
+    return Joi.object({
+      url: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static saveProxyDetails() {
+    return Joi.object({
+      body: FileStorageModel.ProxyFile().required(),
+    }).required();
+  }
+
+  static signUrls() {
+    return Joi.object({
+      body: FileStorageModel.SignUrl().required(),
+    }).required();
+  }
 }
 
 module.exports = FileStorageValidator;

package/sdk/partner/Lead/LeadPartnerClient.d.ts

@@ -9,7 +9,7 @@ declare class Lead {
      * @returns {Promise<LeadPartnerModel.TicketList>} - Success response
      * @name getTickets
      * @summary: Gets the list of partner level tickets and/or ticket filters depending on query params
-     * @description: Gets the list of partner level tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTickets/).
+     * @description: Gets the list of partner level tickets and/or ticket filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getTickets/).
      */
     getTickets({ items, filters, q, status, priority, category, pageNo, pageSize, requestHeaders, }?: LeadPartnerValidator.GetTicketsParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketList>;
     /**
@@ -44,7 +44,7 @@ declare class Lead {
      * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
      * @name createTicket
      * @summary: Creates a partner level ticket
-     * @description: Creates a partner level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/createTicket/).
+     * @description: Creates a partner level ticket - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/createTicket/).
      */
     createTicket({ body, requestHeaders }?: LeadPartnerValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
     /**
@@ -54,7 +54,7 @@ declare class Lead {
      * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
      * @name getTicket
      * @summary: Retreives ticket details of a partner level ticket with ticket ID
-     * @description: Retreives ticket details of a partner level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTicket/).
+     * @description: Retreives ticket details of a partner level ticket - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getTicket/).
      */
     getTicket({ id, requestHeaders }?: LeadPartnerValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
     /**
@@ -64,7 +64,7 @@ declare class Lead {
      * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
      * @name editTicket
      * @summary: Edits ticket details of a partner level ticket
-     * @description: Edits ticket details of a partner level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/editTicket/).
+     * @description: Edits ticket details of a partner level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/editTicket/).
      */
     editTicket({ id, body, requestHeaders }?: LeadPartnerValidator.EditTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
     /**
@@ -74,7 +74,7 @@ declare class Lead {
      * @returns {Promise<LeadPartnerModel.TicketHistory>} - Success response
      * @name createHistory
      * @summary: Create history for specific partner level ticket
-     * @description: Create history for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/createHistory/).
+     * @description: Create history for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/createHistory/).
      */
     createHistory({ id, body, requestHeaders }?: LeadPartnerValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketHistory>;
     /**
@@ -84,19 +84,19 @@ declare class Lead {
      * @returns {Promise<LeadPartnerModel.TicketHistoryList>} - Success response
      * @name getTicketHistory
      * @summary: Gets history list for specific partner level ticket
-     * @description: Gets history list for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTicketHistory/).
+     * @description: Gets history list for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getTicketHistory/).
      */
     getTicketHistory({ id, requestHeaders }?: LeadPartnerValidator.GetTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketHistoryList>;
     /**
      * @param {LeadPartnerValidator.GetGeneralConfigParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.GeneralConfigResponse>} - Success response
+     * @returns {Promise<LeadPartnerModel.GeneralConfigDetails>} - Success response
      * @name getGeneralConfig
      * @summary: Get general support configuration
-     * @description: Get general support configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getGeneralConfig/).
+     * @description: Get general support configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getGeneralConfig/).
      */
-    getGeneralConfig({ requestHeaders }?: LeadPartnerValidator.GetGeneralConfigParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GeneralConfigResponse>;
+    getGeneralConfig({ requestHeaders }?: LeadPartnerValidator.GetGeneralConfigParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GeneralConfigDetails>;
 }
 import LeadPartnerModel = require("./LeadPartnerModel");
 import Paginator = require("../../common/Paginator");