@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1

package/sdk/platform/Content/ContentPlatformValidator.d.ts

@@ -0,0 +1,247 @@
+export = ContentPlatformValidator;
+/**
+ * @typedef CreateCustomFieldByResourceIdParam
+ * @property {string} resource
+ * @property {string} resourceId
+ * @property {ContentPlatformModel.CustomFieldRequestSchema} body
+ */
+/**
+ * @typedef CreateCustomFieldDefinitionParam
+ * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
+ */
+/**
+ * @typedef CreateCustomObjectParam
+ * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ */
+/**
+ * @typedef CreateCustomObjectDefinitionParam
+ * @property {ContentPlatformModel.CustomObjectDefinitionRequestSchema} body
+ */
+/**
+ * @typedef DeleteCustomFieldDefinitionParam
+ * @property {string} definitionId
+ */
+/**
+ * @typedef DeleteCustomObjectParam
+ * @property {string} metaobjectId
+ */
+/**
+ * @typedef DeleteCustomObjectDefinitionParam
+ * @property {string} definitionId
+ */
+/**
+ * @typedef ExportCustomObjectEntriesParam
+ * @property {string} definitionId
+ */
+/**
+ * @typedef GetCustomFieldDefinitionParam
+ * @property {string} definitionId
+ */
+/**
+ * @typedef GetCustomFieldDefinitionsParam
+ * @property {string} pageNo
+ * @property {string} pageSize
+ * @property {string} [resource]
+ * @property {string} [type]
+ * @property {string} [search]
+ */
+/** @typedef GetCustomFieldTypesParam */
+/**
+ * @typedef GetCustomFieldsParam
+ * @property {string} resource
+ */
+/**
+ * @typedef GetCustomFieldsByResourceIdParam
+ * @property {string} resource
+ * @property {string} resourceId
+ */
+/**
+ * @typedef GetCustomObjectParam
+ * @property {string} metaobjectId
+ */
+/**
+ * @typedef GetCustomObjectDefinitionParam
+ * @property {string} definitionId
+ */
+/**
+ * @typedef GetCustomObjectDefinitionsParam
+ * @property {string} pageNo
+ * @property {string} pageSize
+ * @property {string} [search]
+ */
+/**
+ * @typedef GetCustomObjectsParam
+ * @property {string} [definitionId]
+ * @property {string} pageNo
+ * @property {string} pageSize
+ */
+/**
+ * @typedef GetJobsParam
+ * @property {string} page
+ * @property {string} pageSize
+ * @property {string} actionType
+ */
+/** @typedef GetResourcesParam */
+/**
+ * @typedef ImportCustomObjectEntriesParam
+ * @property {string} definitionId
+ * @property {ContentPlatformModel.CustomObjectBulkSchema} body
+ */
+/**
+ * @typedef SampleCustomObjectBulkEntryParam
+ * @property {string} definitionId
+ */
+/**
+ * @typedef UpdateCustomFieldDefinitionParam
+ * @property {string} definitionId
+ * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
+ */
+/**
+ * @typedef UpdateCustomObjectParam
+ * @property {string} metaobjectId
+ * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ */
+/**
+ * @typedef UpdateCustomObjectDefinitionParam
+ * @property {string} definitionId
+ * @property {ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema} body
+ */
+declare class ContentPlatformValidator {
+    /** @returns {CreateCustomFieldByResourceIdParam} */
+    static createCustomFieldByResourceId(): CreateCustomFieldByResourceIdParam;
+    /** @returns {CreateCustomFieldDefinitionParam} */
+    static createCustomFieldDefinition(): CreateCustomFieldDefinitionParam;
+    /** @returns {CreateCustomObjectParam} */
+    static createCustomObject(): CreateCustomObjectParam;
+    /** @returns {CreateCustomObjectDefinitionParam} */
+    static createCustomObjectDefinition(): CreateCustomObjectDefinitionParam;
+    /** @returns {DeleteCustomFieldDefinitionParam} */
+    static deleteCustomFieldDefinition(): DeleteCustomFieldDefinitionParam;
+    /** @returns {DeleteCustomObjectParam} */
+    static deleteCustomObject(): DeleteCustomObjectParam;
+    /** @returns {DeleteCustomObjectDefinitionParam} */
+    static deleteCustomObjectDefinition(): DeleteCustomObjectDefinitionParam;
+    /** @returns {ExportCustomObjectEntriesParam} */
+    static exportCustomObjectEntries(): ExportCustomObjectEntriesParam;
+    /** @returns {GetCustomFieldDefinitionParam} */
+    static getCustomFieldDefinition(): GetCustomFieldDefinitionParam;
+    /** @returns {GetCustomFieldDefinitionsParam} */
+    static getCustomFieldDefinitions(): GetCustomFieldDefinitionsParam;
+    /** @returns {GetCustomFieldTypesParam} */
+    static getCustomFieldTypes(): any;
+    /** @returns {GetCustomFieldsParam} */
+    static getCustomFields(): GetCustomFieldsParam;
+    /** @returns {GetCustomFieldsByResourceIdParam} */
+    static getCustomFieldsByResourceId(): GetCustomFieldsByResourceIdParam;
+    /** @returns {GetCustomObjectParam} */
+    static getCustomObject(): GetCustomObjectParam;
+    /** @returns {GetCustomObjectDefinitionParam} */
+    static getCustomObjectDefinition(): GetCustomObjectDefinitionParam;
+    /** @returns {GetCustomObjectDefinitionsParam} */
+    static getCustomObjectDefinitions(): GetCustomObjectDefinitionsParam;
+    /** @returns {GetCustomObjectsParam} */
+    static getCustomObjects(): GetCustomObjectsParam;
+    /** @returns {GetJobsParam} */
+    static getJobs(): GetJobsParam;
+    /** @returns {GetResourcesParam} */
+    static getResources(): any;
+    /** @returns {ImportCustomObjectEntriesParam} */
+    static importCustomObjectEntries(): ImportCustomObjectEntriesParam;
+    /** @returns {SampleCustomObjectBulkEntryParam} */
+    static sampleCustomObjectBulkEntry(): SampleCustomObjectBulkEntryParam;
+    /** @returns {UpdateCustomFieldDefinitionParam} */
+    static updateCustomFieldDefinition(): UpdateCustomFieldDefinitionParam;
+    /** @returns {UpdateCustomObjectParam} */
+    static updateCustomObject(): UpdateCustomObjectParam;
+    /** @returns {UpdateCustomObjectDefinitionParam} */
+    static updateCustomObjectDefinition(): UpdateCustomObjectDefinitionParam;
+}
+declare namespace ContentPlatformValidator {
+    export { CreateCustomFieldByResourceIdParam, CreateCustomFieldDefinitionParam, CreateCustomObjectParam, CreateCustomObjectDefinitionParam, DeleteCustomFieldDefinitionParam, DeleteCustomObjectParam, DeleteCustomObjectDefinitionParam, ExportCustomObjectEntriesParam, GetCustomFieldDefinitionParam, GetCustomFieldDefinitionsParam, GetCustomFieldTypesParam, GetCustomFieldsParam, GetCustomFieldsByResourceIdParam, GetCustomObjectParam, GetCustomObjectDefinitionParam, GetCustomObjectDefinitionsParam, GetCustomObjectsParam, GetJobsParam, GetResourcesParam, ImportCustomObjectEntriesParam, SampleCustomObjectBulkEntryParam, UpdateCustomFieldDefinitionParam, UpdateCustomObjectParam, UpdateCustomObjectDefinitionParam };
+}
+type CreateCustomFieldByResourceIdParam = {
+    resource: string;
+    resourceId: string;
+    body: ContentPlatformModel.CustomFieldRequestSchema;
+};
+type CreateCustomFieldDefinitionParam = {
+    body: ContentPlatformModel.CustomFieldDefinitionRequestSchema;
+};
+type CreateCustomObjectParam = {
+    body: ContentPlatformModel.CustomObjectRequestSchema;
+};
+type CreateCustomObjectDefinitionParam = {
+    body: ContentPlatformModel.CustomObjectDefinitionRequestSchema;
+};
+type DeleteCustomFieldDefinitionParam = {
+    definitionId: string;
+};
+type DeleteCustomObjectParam = {
+    metaobjectId: string;
+};
+type DeleteCustomObjectDefinitionParam = {
+    definitionId: string;
+};
+type ExportCustomObjectEntriesParam = {
+    definitionId: string;
+};
+type GetCustomFieldDefinitionParam = {
+    definitionId: string;
+};
+type GetCustomFieldDefinitionsParam = {
+    pageNo: string;
+    pageSize: string;
+    resource?: string;
+    type?: string;
+    search?: string;
+};
+type GetCustomFieldsParam = {
+    resource: string;
+};
+type GetCustomFieldsByResourceIdParam = {
+    resource: string;
+    resourceId: string;
+};
+type GetCustomObjectParam = {
+    metaobjectId: string;
+};
+type GetCustomObjectDefinitionParam = {
+    definitionId: string;
+};
+type GetCustomObjectDefinitionsParam = {
+    pageNo: string;
+    pageSize: string;
+    search?: string;
+};
+type GetCustomObjectsParam = {
+    definitionId?: string;
+    pageNo: string;
+    pageSize: string;
+};
+type GetJobsParam = {
+    page: string;
+    pageSize: string;
+    actionType: string;
+};
+type ImportCustomObjectEntriesParam = {
+    definitionId: string;
+    body: ContentPlatformModel.CustomObjectBulkSchema;
+};
+type SampleCustomObjectBulkEntryParam = {
+    definitionId: string;
+};
+type UpdateCustomFieldDefinitionParam = {
+    definitionId: string;
+    body: ContentPlatformModel.CustomFieldDefinitionRequestSchema;
+};
+type UpdateCustomObjectParam = {
+    metaobjectId: string;
+    body: ContentPlatformModel.CustomObjectRequestSchema;
+};
+type UpdateCustomObjectDefinitionParam = {
+    definitionId: string;
+    body: ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema;
+};
+type GetCustomFieldTypesParam = any;
+type GetResourcesParam = any;
+import ContentPlatformModel = require("./ContentPlatformModel");

package/sdk/platform/Content/ContentPlatformValidator.js

@@ -0,0 +1,319 @@
+const Joi = require("joi");
+
+const ContentPlatformModel = require("./ContentPlatformModel");
+
+/**
+ * @typedef CreateCustomFieldByResourceIdParam
+ * @property {string} resource
+ * @property {string} resourceId
+ * @property {ContentPlatformModel.CustomFieldRequestSchema} body
+ */
+
+/**
+ * @typedef CreateCustomFieldDefinitionParam
+ * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
+ */
+
+/**
+ * @typedef CreateCustomObjectParam
+ * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ */
+
+/**
+ * @typedef CreateCustomObjectDefinitionParam
+ * @property {ContentPlatformModel.CustomObjectDefinitionRequestSchema} body
+ */
+
+/**
+ * @typedef DeleteCustomFieldDefinitionParam
+ * @property {string} definitionId
+ */
+
+/**
+ * @typedef DeleteCustomObjectParam
+ * @property {string} metaobjectId
+ */
+
+/**
+ * @typedef DeleteCustomObjectDefinitionParam
+ * @property {string} definitionId
+ */
+
+/**
+ * @typedef ExportCustomObjectEntriesParam
+ * @property {string} definitionId
+ */
+
+/**
+ * @typedef GetCustomFieldDefinitionParam
+ * @property {string} definitionId
+ */
+
+/**
+ * @typedef GetCustomFieldDefinitionsParam
+ * @property {string} pageNo
+ * @property {string} pageSize
+ * @property {string} [resource]
+ * @property {string} [type]
+ * @property {string} [search]
+ */
+
+/** @typedef GetCustomFieldTypesParam */
+
+/**
+ * @typedef GetCustomFieldsParam
+ * @property {string} resource
+ */
+
+/**
+ * @typedef GetCustomFieldsByResourceIdParam
+ * @property {string} resource
+ * @property {string} resourceId
+ */
+
+/**
+ * @typedef GetCustomObjectParam
+ * @property {string} metaobjectId
+ */
+
+/**
+ * @typedef GetCustomObjectDefinitionParam
+ * @property {string} definitionId
+ */
+
+/**
+ * @typedef GetCustomObjectDefinitionsParam
+ * @property {string} pageNo
+ * @property {string} pageSize
+ * @property {string} [search]
+ */
+
+/**
+ * @typedef GetCustomObjectsParam
+ * @property {string} [definitionId]
+ * @property {string} pageNo
+ * @property {string} pageSize
+ */
+
+/**
+ * @typedef GetJobsParam
+ * @property {string} page
+ * @property {string} pageSize
+ * @property {string} actionType
+ */
+
+/** @typedef GetResourcesParam */
+
+/**
+ * @typedef ImportCustomObjectEntriesParam
+ * @property {string} definitionId
+ * @property {ContentPlatformModel.CustomObjectBulkSchema} body
+ */
+
+/**
+ * @typedef SampleCustomObjectBulkEntryParam
+ * @property {string} definitionId
+ */
+
+/**
+ * @typedef UpdateCustomFieldDefinitionParam
+ * @property {string} definitionId
+ * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
+ */
+
+/**
+ * @typedef UpdateCustomObjectParam
+ * @property {string} metaobjectId
+ * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ */
+
+/**
+ * @typedef UpdateCustomObjectDefinitionParam
+ * @property {string} definitionId
+ * @property {ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema} body
+ */
+
+class ContentPlatformValidator {
+  /** @returns {CreateCustomFieldByResourceIdParam} */
+  static createCustomFieldByResourceId() {
+    return Joi.object({
+      resource: Joi.string().allow("").required(),
+      resourceId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomFieldRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {CreateCustomFieldDefinitionParam} */
+  static createCustomFieldDefinition() {
+    return Joi.object({
+      body: ContentPlatformModel.CustomFieldDefinitionRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {CreateCustomObjectParam} */
+  static createCustomObject() {
+    return Joi.object({
+      body: ContentPlatformModel.CustomObjectRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {CreateCustomObjectDefinitionParam} */
+  static createCustomObjectDefinition() {
+    return Joi.object({
+      body: ContentPlatformModel.CustomObjectDefinitionRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {DeleteCustomFieldDefinitionParam} */
+  static deleteCustomFieldDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {DeleteCustomObjectParam} */
+  static deleteCustomObject() {
+    return Joi.object({
+      metaobjectId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {DeleteCustomObjectDefinitionParam} */
+  static deleteCustomObjectDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {ExportCustomObjectEntriesParam} */
+  static exportCustomObjectEntries() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomFieldDefinitionParam} */
+  static getCustomFieldDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomFieldDefinitionsParam} */
+  static getCustomFieldDefinitions() {
+    return Joi.object({
+      pageNo: Joi.string().allow("").required(),
+      pageSize: Joi.string().allow("").required(),
+      resource: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      search: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetCustomFieldTypesParam} */
+  static getCustomFieldTypes() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {GetCustomFieldsParam} */
+  static getCustomFields() {
+    return Joi.object({
+      resource: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomFieldsByResourceIdParam} */
+  static getCustomFieldsByResourceId() {
+    return Joi.object({
+      resource: Joi.string().allow("").required(),
+      resourceId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomObjectParam} */
+  static getCustomObject() {
+    return Joi.object({
+      metaobjectId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomObjectDefinitionParam} */
+  static getCustomObjectDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomObjectDefinitionsParam} */
+  static getCustomObjectDefinitions() {
+    return Joi.object({
+      pageNo: Joi.string().allow("").required(),
+      pageSize: Joi.string().allow("").required(),
+      search: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetCustomObjectsParam} */
+  static getCustomObjects() {
+    return Joi.object({
+      definitionId: Joi.string().allow(""),
+      pageNo: Joi.string().allow("").required(),
+      pageSize: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetJobsParam} */
+  static getJobs() {
+    return Joi.object({
+      page: Joi.string().allow("").required(),
+      pageSize: Joi.string().allow("").required(),
+      actionType: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetResourcesParam} */
+  static getResources() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {ImportCustomObjectEntriesParam} */
+  static importCustomObjectEntries() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectBulkSchema().required(),
+    }).required();
+  }
+
+  /** @returns {SampleCustomObjectBulkEntryParam} */
+  static sampleCustomObjectBulkEntry() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {UpdateCustomFieldDefinitionParam} */
+  static updateCustomFieldDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomFieldDefinitionRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateCustomObjectParam} */
+  static updateCustomObject() {
+    return Joi.object({
+      metaobjectId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateCustomObjectDefinitionParam} */
+  static updateCustomObjectDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema().required(),
+    }).required();
+  }
+}
+
+module.exports = ContentPlatformValidator;

package/sdk/platform/Discount/DiscountPlatformClient.d.ts

@@ -113,8 +113,8 @@ declare class Discount {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
      * @name updateDiscount
-     * @summary: Create Discount.
-     * @description: Create Discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
+     * @summary: Update Discount.
+     * @description: Update Discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
      */
     updateDiscount({ id, body, requestHeaders }?: DiscountPlatformValidator.UpdateDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
     /**

package/sdk/platform/Discount/DiscountPlatformClient.js

@@ -741,8 +741,8 @@ class Discount {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
    * @name updateDiscount
-   * @summary: Create Discount.
-   * @description: Create Discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
+   * @summary: Update Discount.
+   * @description: Update Discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
    */
   async updateDiscount(
     { id, body, requestHeaders } = { requestHeaders: {} },