@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1

package/sdk/partner/Catalog/CatalogPartnerModel.d.ts

@@ -0,0 +1,238 @@
+export = CatalogPartnerModel;
+/**
+ * @typedef Page
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
+ * @property {number} [total] - Total number of items.
+ */
+/**
+ * @typedef CompanyListSerializer
+ * @property {Page} [page]
+ * @property {CompanySerializer[]} [items]
+ */
+/**
+ * @typedef CompaniesSerializer
+ * @property {CompanySerializer[]} [items]
+ */
+/**
+ * @typedef ErrorResponse
+ * @property {string} [code]
+ * @property {Object} [error]
+ * @property {string} [message]
+ * @property {Object} [meta]
+ * @property {number} [status]
+ */
+/**
+ * @typedef PartnerCompanyDetailsRequestSchema
+ * @property {number[]} [company_ids]
+ */
+/**
+ * @typedef CompanySerializer
+ * @property {number} [uid]
+ * @property {string} [created_on]
+ * @property {string} [modified_on]
+ * @property {string} [verified_on]
+ * @property {UserSerializer} [verified_by]
+ * @property {UserSerializer} [modified_by]
+ * @property {UserSerializer} [created_by]
+ * @property {string} [name]
+ * @property {string} company_type
+ * @property {string} business_type
+ * @property {CompanyDetails} [details]
+ * @property {GetAddressSerializer[]} [addresses]
+ * @property {string[]} [market_channels]
+ * @property {string[]} [notification_emails]
+ * @property {string} [reject_reason]
+ * @property {string} [stage]
+ * @property {Object} [_custom_json]
+ * @property {BusinessCountryInfo} [business_country_info]
+ */
+/**
+ * @typedef GetAddressSerializer
+ * @property {string} [address1]
+ * @property {string} [address2]
+ * @property {string} [address_type]
+ * @property {string} [city]
+ * @property {string} [country]
+ * @property {string} [country_code]
+ * @property {string} [landmark]
+ * @property {number} [latitude]
+ * @property {number} [longitude]
+ * @property {string} [pincode]
+ * @property {string} [state]
+ */
+/**
+ * @typedef BusinessCountryInfo
+ * @property {string} country_code
+ * @property {string} [country]
+ * @property {CountryCurrencyInfo} currency
+ * @property {string} timezone
+ */
+/**
+ * @typedef CountryCurrencyInfo
+ * @property {string} code
+ * @property {string} symbol
+ * @property {string} name
+ */
+/**
+ * @typedef UserSerializer
+ * @property {string} [_id]
+ * @property {string} [contact]
+ * @property {string} [uid]
+ * @property {string} [user_id]
+ * @property {string} [username]
+ */
+/**
+ * @typedef CompanyDetails
+ * @property {CompanySocialAccounts[]} [socials]
+ * @property {string} [website_url]
+ */
+/**
+ * @typedef CompanySocialAccounts
+ * @property {string} name
+ * @property {string} url
+ */
+declare class CatalogPartnerModel {
+}
+declare namespace CatalogPartnerModel {
+    export { Page, CompanyListSerializer, CompaniesSerializer, ErrorResponse, PartnerCompanyDetailsRequestSchema, CompanySerializer, GetAddressSerializer, BusinessCountryInfo, CountryCurrencyInfo, UserSerializer, CompanyDetails, CompanySocialAccounts };
+}
+/** @returns {Page} */
+declare function Page(): Page;
+type Page = {
+    /**
+     * - The total number of items on the page.
+     */
+    item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
+    next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
+    has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
+    has_next?: boolean;
+    /**
+     * - The current page number.
+     */
+    current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
+    type: string;
+    /**
+     * - The number of items per page.
+     */
+    size?: number;
+    /**
+     * - Total number of items.
+     */
+    total?: number;
+};
+/** @returns {CompanyListSerializer} */
+declare function CompanyListSerializer(): CompanyListSerializer;
+type CompanyListSerializer = {
+    page?: Page;
+    items?: CompanySerializer[];
+};
+/** @returns {CompaniesSerializer} */
+declare function CompaniesSerializer(): CompaniesSerializer;
+type CompaniesSerializer = {
+    items?: CompanySerializer[];
+};
+/** @returns {ErrorResponse} */
+declare function ErrorResponse(): ErrorResponse;
+type ErrorResponse = {
+    code?: string;
+    error?: any;
+    message?: string;
+    meta?: any;
+    status?: number;
+};
+/** @returns {PartnerCompanyDetailsRequestSchema} */
+declare function PartnerCompanyDetailsRequestSchema(): PartnerCompanyDetailsRequestSchema;
+type PartnerCompanyDetailsRequestSchema = {
+    company_ids?: number[];
+};
+/** @returns {CompanySerializer} */
+declare function CompanySerializer(): CompanySerializer;
+type CompanySerializer = {
+    uid?: number;
+    created_on?: string;
+    modified_on?: string;
+    verified_on?: string;
+    verified_by?: UserSerializer;
+    modified_by?: UserSerializer;
+    created_by?: UserSerializer;
+    name?: string;
+    company_type: string;
+    business_type: string;
+    details?: CompanyDetails;
+    addresses?: GetAddressSerializer[];
+    market_channels?: string[];
+    notification_emails?: string[];
+    reject_reason?: string;
+    stage?: string;
+    _custom_json?: any;
+    business_country_info?: BusinessCountryInfo;
+};
+/** @returns {GetAddressSerializer} */
+declare function GetAddressSerializer(): GetAddressSerializer;
+type GetAddressSerializer = {
+    address1?: string;
+    address2?: string;
+    address_type?: string;
+    city?: string;
+    country?: string;
+    country_code?: string;
+    landmark?: string;
+    latitude?: number;
+    longitude?: number;
+    pincode?: string;
+    state?: string;
+};
+/** @returns {BusinessCountryInfo} */
+declare function BusinessCountryInfo(): BusinessCountryInfo;
+type BusinessCountryInfo = {
+    country_code: string;
+    country?: string;
+    currency: CountryCurrencyInfo;
+    timezone: string;
+};
+/** @returns {CountryCurrencyInfo} */
+declare function CountryCurrencyInfo(): CountryCurrencyInfo;
+type CountryCurrencyInfo = {
+    code: string;
+    symbol: string;
+    name: string;
+};
+/** @returns {UserSerializer} */
+declare function UserSerializer(): UserSerializer;
+type UserSerializer = {
+    _id?: string;
+    contact?: string;
+    uid?: string;
+    user_id?: string;
+    username?: string;
+};
+/** @returns {CompanyDetails} */
+declare function CompanyDetails(): CompanyDetails;
+type CompanyDetails = {
+    socials?: CompanySocialAccounts[];
+    website_url?: string;
+};
+/** @returns {CompanySocialAccounts} */
+declare function CompanySocialAccounts(): CompanySocialAccounts;
+type CompanySocialAccounts = {
+    name: string;
+    url: string;
+};

package/sdk/partner/Catalog/CatalogPartnerModel.js

@@ -0,0 +1,248 @@
+const Joi = require("joi");
+
+/**
+ * @typedef Page
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
+ * @property {number} [total] - Total number of items.
+ */
+
+/**
+ * @typedef CompanyListSerializer
+ * @property {Page} [page]
+ * @property {CompanySerializer[]} [items]
+ */
+
+/**
+ * @typedef CompaniesSerializer
+ * @property {CompanySerializer[]} [items]
+ */
+
+/**
+ * @typedef ErrorResponse
+ * @property {string} [code]
+ * @property {Object} [error]
+ * @property {string} [message]
+ * @property {Object} [meta]
+ * @property {number} [status]
+ */
+
+/**
+ * @typedef PartnerCompanyDetailsRequestSchema
+ * @property {number[]} [company_ids]
+ */
+
+/**
+ * @typedef CompanySerializer
+ * @property {number} [uid]
+ * @property {string} [created_on]
+ * @property {string} [modified_on]
+ * @property {string} [verified_on]
+ * @property {UserSerializer} [verified_by]
+ * @property {UserSerializer} [modified_by]
+ * @property {UserSerializer} [created_by]
+ * @property {string} [name]
+ * @property {string} company_type
+ * @property {string} business_type
+ * @property {CompanyDetails} [details]
+ * @property {GetAddressSerializer[]} [addresses]
+ * @property {string[]} [market_channels]
+ * @property {string[]} [notification_emails]
+ * @property {string} [reject_reason]
+ * @property {string} [stage]
+ * @property {Object} [_custom_json]
+ * @property {BusinessCountryInfo} [business_country_info]
+ */
+
+/**
+ * @typedef GetAddressSerializer
+ * @property {string} [address1]
+ * @property {string} [address2]
+ * @property {string} [address_type]
+ * @property {string} [city]
+ * @property {string} [country]
+ * @property {string} [country_code]
+ * @property {string} [landmark]
+ * @property {number} [latitude]
+ * @property {number} [longitude]
+ * @property {string} [pincode]
+ * @property {string} [state]
+ */
+
+/**
+ * @typedef BusinessCountryInfo
+ * @property {string} country_code
+ * @property {string} [country]
+ * @property {CountryCurrencyInfo} currency
+ * @property {string} timezone
+ */
+
+/**
+ * @typedef CountryCurrencyInfo
+ * @property {string} code
+ * @property {string} symbol
+ * @property {string} name
+ */
+
+/**
+ * @typedef UserSerializer
+ * @property {string} [_id]
+ * @property {string} [contact]
+ * @property {string} [uid]
+ * @property {string} [user_id]
+ * @property {string} [username]
+ */
+
+/**
+ * @typedef CompanyDetails
+ * @property {CompanySocialAccounts[]} [socials]
+ * @property {string} [website_url]
+ */
+
+/**
+ * @typedef CompanySocialAccounts
+ * @property {string} name
+ * @property {string} url
+ */
+
+class CatalogPartnerModel {
+  /** @returns {Page} */
+  static Page() {
+    return Joi.object({
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      has_previous: Joi.boolean(),
+      has_next: Joi.boolean(),
+      current: Joi.number(),
+      type: Joi.string().allow("").required(),
+      size: Joi.number(),
+      total: Joi.number(),
+    });
+  }
+
+  /** @returns {CompanyListSerializer} */
+  static CompanyListSerializer() {
+    return Joi.object({
+      page: CatalogPartnerModel.Page(),
+      items: Joi.array().items(CatalogPartnerModel.CompanySerializer()),
+    });
+  }
+
+  /** @returns {CompaniesSerializer} */
+  static CompaniesSerializer() {
+    return Joi.object({
+      items: Joi.array().items(CatalogPartnerModel.CompanySerializer()),
+    });
+  }
+
+  /** @returns {ErrorResponse} */
+  static ErrorResponse() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      error: Joi.object().pattern(/\S/, Joi.any()),
+      message: Joi.string().allow(""),
+      meta: Joi.any(),
+      status: Joi.number(),
+    });
+  }
+
+  /** @returns {PartnerCompanyDetailsRequestSchema} */
+  static PartnerCompanyDetailsRequestSchema() {
+    return Joi.object({
+      company_ids: Joi.array().items(Joi.number()),
+    });
+  }
+
+  /** @returns {CompanySerializer} */
+  static CompanySerializer() {
+    return Joi.object({
+      uid: Joi.number(),
+      created_on: Joi.string().allow(""),
+      modified_on: Joi.string().allow(""),
+      verified_on: Joi.string().allow(""),
+      verified_by: CatalogPartnerModel.UserSerializer(),
+      modified_by: CatalogPartnerModel.UserSerializer(),
+      created_by: CatalogPartnerModel.UserSerializer(),
+      name: Joi.string().allow(""),
+      company_type: Joi.string().allow("").required(),
+      business_type: Joi.string().allow("").required(),
+      details: CatalogPartnerModel.CompanyDetails(),
+      addresses: Joi.array().items(CatalogPartnerModel.GetAddressSerializer()),
+      market_channels: Joi.array().items(Joi.string().allow("")),
+      notification_emails: Joi.array().items(Joi.string().allow("")),
+      reject_reason: Joi.string().allow(""),
+      stage: Joi.string().allow(""),
+      _custom_json: Joi.any(),
+      business_country_info: CatalogPartnerModel.BusinessCountryInfo(),
+    });
+  }
+
+  /** @returns {GetAddressSerializer} */
+  static GetAddressSerializer() {
+    return Joi.object({
+      address1: Joi.string().allow(""),
+      address2: Joi.string().allow(""),
+      address_type: Joi.string().allow(""),
+      city: Joi.string().allow(""),
+      country: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
+      landmark: Joi.string().allow(""),
+      latitude: Joi.number(),
+      longitude: Joi.number(),
+      pincode: Joi.string().allow(""),
+      state: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {BusinessCountryInfo} */
+  static BusinessCountryInfo() {
+    return Joi.object({
+      country_code: Joi.string().allow("").required(),
+      country: Joi.string().allow(""),
+      currency: CatalogPartnerModel.CountryCurrencyInfo().required(),
+      timezone: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {CountryCurrencyInfo} */
+  static CountryCurrencyInfo() {
+    return Joi.object({
+      code: Joi.string().allow("").required(),
+      symbol: Joi.string().allow("").required(),
+      name: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {UserSerializer} */
+  static UserSerializer() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      contact: Joi.string().allow(""),
+      uid: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
+      username: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CompanyDetails} */
+  static CompanyDetails() {
+    return Joi.object({
+      socials: Joi.array().items(CatalogPartnerModel.CompanySocialAccounts()),
+      website_url: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CompanySocialAccounts} */
+  static CompanySocialAccounts() {
+    return Joi.object({
+      name: Joi.string().allow("").required(),
+      url: Joi.string().allow("").required(),
+    });
+  }
+}
+module.exports = CatalogPartnerModel;

package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts

@@ -0,0 +1,5 @@
+export = CatalogValidator;
+declare class CatalogValidator {
+    static partnerCompanyDetails(): any;
+    static getCompanies(): any;
+}

package/sdk/partner/Catalog/CatalogPartnerValidator.js

@@ -0,0 +1,19 @@
+const Joi = require("joi");
+
+const CatalogModel = require("./CatalogPartnerModel");
+class CatalogValidator {
+  static partnerCompanyDetails() {
+    return Joi.object({
+      body: CatalogModel.PartnerCompanyDetailsRequestSchema().required(),
+    }).required();
+  }
+
+  static getCompanies() {
+    return Joi.object({
+      q: Joi.string().allow(""),
+      stage: Joi.string().allow(""),
+    }).required();
+  }
+}
+
+module.exports = CatalogValidator;

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

@@ -26,7 +26,7 @@ declare class FileStorage {
      * @param {FileStoragePartnerValidator.CompleteUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.FileUploadComplete>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.CompleteResponse>} - Success response
      * @name completeUpload
      * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
      * @description: Uploads an arbitrarily sized buffer or blob.
@@ -49,12 +49,12 @@ declare class FileStorage {
      * This operation will return the url for the uploaded file.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/completeUpload/).
      */
-    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUploadComplete>;
+    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.CompleteResponse>;
     /**
      * @param {FileStoragePartnerValidator.StartUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.FileUpload>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.StartResponse>} - Success response
      * @name startUpload
      * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
      * @description: Uploads an arbitrarily sized buffer or blob.
@@ -77,7 +77,7 @@ declare class FileStorage {
      * This operation will return the url for the uploaded file.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/startUpload/).
      */
-    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUpload>;
+    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.StartResponse>;
     /**
      * @param {FileStoragePartnerValidator.BrowseParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -104,53 +104,43 @@ declare class FileStorage {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.FetchProxyDetails>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.ProxyResponse>} - Success response
      * @name organizationLevelFetchProxy
      * @summary: Proxy
      * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/organizationLevelFetchProxy/).
      */
-    organizationLevelFetchProxy({ applicationId, companyId, url, requestHeaders }?: FileStoragePartnerValidator.OrganizationLevelFetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyDetails>;
+    organizationLevelFetchProxy({ applicationId, companyId, url, requestHeaders }?: FileStoragePartnerValidator.OrganizationLevelFetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.ProxyResponse>;
     /**
      * @param {FileStoragePartnerValidator.SaveOrganizationLevelProxyParam} arg
      *   - Arg object.
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.SaveProxy>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.FetchProxyResponse>} - Success response
      * @name saveOrganizationLevelProxy
      * @summary: Proxy
      * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveOrganizationLevelProxy/).
      */
-    saveOrganizationLevelProxy({ applicationId, companyId, body, requestHeaders }?: FileStoragePartnerValidator.SaveOrganizationLevelProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SaveProxy>;
+    saveOrganizationLevelProxy({ applicationId, companyId, body, requestHeaders }?: FileStoragePartnerValidator.SaveOrganizationLevelProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyResponse>;
     /**
      * @param {FileStoragePartnerValidator.FetchProxyParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.FetchProxyDetails>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.ProxyResponse>} - Success response
      * @name fetchProxy
      * @summary: Proxy
      * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/fetchProxy/).
      */
-    fetchProxy({ url, requestHeaders }?: FileStoragePartnerValidator.FetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyDetails>;
+    fetchProxy({ url, requestHeaders }?: FileStoragePartnerValidator.FetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.ProxyResponse>;
     /**
      * @param {FileStoragePartnerValidator.SaveProxyDetailsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.SaveProxy>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.FetchProxyResponse>} - Success response
      * @name saveProxyDetails
      * @summary: Proxy
      * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveProxyDetails/).
      */
-    saveProxyDetails({ body, requestHeaders }?: FileStoragePartnerValidator.SaveProxyDetailsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SaveProxy>;
-    /**
-     * @param {FileStoragePartnerValidator.SignUrlsParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.SignUrlResult>} - Success response
-     * @name signUrls
-     * @summary: Signs file URLs
-     * @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/signUrls/).
-     */
-    signUrls({ body, requestHeaders }?: FileStoragePartnerValidator.SignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SignUrlResult>;
+    saveProxyDetails({ body, requestHeaders }?: FileStoragePartnerValidator.SaveProxyDetailsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyResponse>;
 }
 import FileStoragePartnerModel = require("./FileStoragePartnerModel");