@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts

@@ -1,231 +0,0 @@
-export = AuthorizationPartnerModel;
-/**
- * @typedef ClientData
- * @property {ClientScopes} [scopes]
- * @property {string[]} [grants] - List of grants for the client.
- * @property {ClientMeta} [meta]
- */
-/**
- * @typedef ClientScopes
- * @property {string} [type] - The type of the scope.
- * @property {string[]} [permissions] - List of permissions for the scope.
- */
-/**
- * @typedef UpdateClient
- * @property {ClientMeta} [meta]
- */
-/**
- * @typedef ClientMeta
- * @property {string[]} [tags] - Tags associated with the client.
- * @property {string} [name] - Name of the client.
- * @property {string} [description] - Description of the client.
- * @property {string} [user_id] - ID of the user associated with the client.
- */
-/**
- * @typedef ClientResponse
- * @property {number} [company_id] - The ID of the company associated with the client.
- * @property {string} [client_id] - The unique identifier for the client.
- * @property {string[]} [secret] - List of secrets associated with the client.
- * @property {string} [slug] - Slug for the client.
- * @property {ClientScopes} [scopes]
- * @property {string[]} [grants] - List of grants for the client.
- * @property {string[]} [redirect_urls] - List of redirect URLs for the client.
- * @property {number} [access_token_lifetime] - Lifetime of the access token in seconds.
- * @property {number} [refresh_token_lifetime] - Lifetime of the refresh token in seconds.
- * @property {ClientMeta} [meta]
- * @property {Object} [author] - Author information related to the client.
- * @property {boolean} [is_active] - Wheather the client is active or not
- * @property {string} [client_type] - Type of the client.
- * @property {string} [organization_id] - ID of the organization associated with
- *   the client.
- * @property {string} [_id] - Unique identifier for the client.
- * @property {string} [created_at] - Timestamp when the client was created.
- * @property {string} [modified_at] - Timestamp when the client was last modified.
- * @property {string[]} [raw_permissions] - List of raw permissions associated
- *   with the client.
- */
-/**
- * @typedef ClientListSchema
- * @property {ClientResponse[]} [items] - List of client responses.
- * @property {Page} [page]
- */
-/**
- * @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.
- */
-declare class AuthorizationPartnerModel {
-}
-declare namespace AuthorizationPartnerModel {
-    export { ClientData, ClientScopes, UpdateClient, ClientMeta, ClientResponse, ClientListSchema, Page };
-}
-/** @returns {ClientData} */
-declare function ClientData(): ClientData;
-type ClientData = {
-    scopes?: ClientScopes;
-    /**
-     * - List of grants for the client.
-     */
-    grants?: string[];
-    meta?: ClientMeta;
-};
-/** @returns {ClientScopes} */
-declare function ClientScopes(): ClientScopes;
-type ClientScopes = {
-    /**
-     * - The type of the scope.
-     */
-    type?: string;
-    /**
-     * - List of permissions for the scope.
-     */
-    permissions?: string[];
-};
-/** @returns {UpdateClient} */
-declare function UpdateClient(): UpdateClient;
-type UpdateClient = {
-    meta?: ClientMeta;
-};
-/** @returns {ClientMeta} */
-declare function ClientMeta(): ClientMeta;
-type ClientMeta = {
-    /**
-     * - Tags associated with the client.
-     */
-    tags?: string[];
-    /**
-     * - Name of the client.
-     */
-    name?: string;
-    /**
-     * - Description of the client.
-     */
-    description?: string;
-    /**
-     * - ID of the user associated with the client.
-     */
-    user_id?: string;
-};
-/** @returns {ClientResponse} */
-declare function ClientResponse(): ClientResponse;
-type ClientResponse = {
-    /**
-     * - The ID of the company associated with the client.
-     */
-    company_id?: number;
-    /**
-     * - The unique identifier for the client.
-     */
-    client_id?: string;
-    /**
-     * - List of secrets associated with the client.
-     */
-    secret?: string[];
-    /**
-     * - Slug for the client.
-     */
-    slug?: string;
-    scopes?: ClientScopes;
-    /**
-     * - List of grants for the client.
-     */
-    grants?: string[];
-    /**
-     * - List of redirect URLs for the client.
-     */
-    redirect_urls?: string[];
-    /**
-     * - Lifetime of the access token in seconds.
-     */
-    access_token_lifetime?: number;
-    /**
-     * - Lifetime of the refresh token in seconds.
-     */
-    refresh_token_lifetime?: number;
-    meta?: ClientMeta;
-    /**
-     * - Author information related to the client.
-     */
-    author?: any;
-    /**
-     * - Wheather the client is active or not
-     */
-    is_active?: boolean;
-    /**
-     * - Type of the client.
-     */
-    client_type?: string;
-    /**
-     * - ID of the organization associated with
-     * the client.
-     */
-    organization_id?: string;
-    /**
-     * - Unique identifier for the client.
-     */
-    _id?: string;
-    /**
-     * - Timestamp when the client was created.
-     */
-    created_at?: string;
-    /**
-     * - Timestamp when the client was last modified.
-     */
-    modified_at?: string;
-    /**
-     * - List of raw permissions associated
-     * with the client.
-     */
-    raw_permissions?: string[];
-};
-/** @returns {ClientListSchema} */
-declare function ClientListSchema(): ClientListSchema;
-type ClientListSchema = {
-    /**
-     * - List of client responses.
-     */
-    items?: ClientResponse[];
-    page?: Page;
-};
-/** @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;
-};

package/sdk/partner/Authorization/AuthorizationPartnerModel.js

@@ -1,152 +0,0 @@
-const Joi = require("joi");
-
-/**
- * @typedef ClientData
- * @property {ClientScopes} [scopes]
- * @property {string[]} [grants] - List of grants for the client.
- * @property {ClientMeta} [meta]
- */
-
-/**
- * @typedef ClientScopes
- * @property {string} [type] - The type of the scope.
- * @property {string[]} [permissions] - List of permissions for the scope.
- */
-
-/**
- * @typedef UpdateClient
- * @property {ClientMeta} [meta]
- */
-
-/**
- * @typedef ClientMeta
- * @property {string[]} [tags] - Tags associated with the client.
- * @property {string} [name] - Name of the client.
- * @property {string} [description] - Description of the client.
- * @property {string} [user_id] - ID of the user associated with the client.
- */
-
-/**
- * @typedef ClientResponse
- * @property {number} [company_id] - The ID of the company associated with the client.
- * @property {string} [client_id] - The unique identifier for the client.
- * @property {string[]} [secret] - List of secrets associated with the client.
- * @property {string} [slug] - Slug for the client.
- * @property {ClientScopes} [scopes]
- * @property {string[]} [grants] - List of grants for the client.
- * @property {string[]} [redirect_urls] - List of redirect URLs for the client.
- * @property {number} [access_token_lifetime] - Lifetime of the access token in seconds.
- * @property {number} [refresh_token_lifetime] - Lifetime of the refresh token in seconds.
- * @property {ClientMeta} [meta]
- * @property {Object} [author] - Author information related to the client.
- * @property {boolean} [is_active] - Wheather the client is active or not
- * @property {string} [client_type] - Type of the client.
- * @property {string} [organization_id] - ID of the organization associated with
- *   the client.
- * @property {string} [_id] - Unique identifier for the client.
- * @property {string} [created_at] - Timestamp when the client was created.
- * @property {string} [modified_at] - Timestamp when the client was last modified.
- * @property {string[]} [raw_permissions] - List of raw permissions associated
- *   with the client.
- */
-
-/**
- * @typedef ClientListSchema
- * @property {ClientResponse[]} [items] - List of client responses.
- * @property {Page} [page]
- */
-
-/**
- * @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.
- */
-
-class AuthorizationPartnerModel {
-  /** @returns {ClientData} */
-  static ClientData() {
-    return Joi.object({
-      scopes: AuthorizationPartnerModel.ClientScopes(),
-      grants: Joi.array().items(Joi.string().allow("")),
-      meta: AuthorizationPartnerModel.ClientMeta(),
-    });
-  }
-
-  /** @returns {ClientScopes} */
-  static ClientScopes() {
-    return Joi.object({
-      type: Joi.string().allow(""),
-      permissions: Joi.array().items(Joi.string().allow("")),
-    });
-  }
-
-  /** @returns {UpdateClient} */
-  static UpdateClient() {
-    return Joi.object({
-      meta: AuthorizationPartnerModel.ClientMeta(),
-    });
-  }
-
-  /** @returns {ClientMeta} */
-  static ClientMeta() {
-    return Joi.object({
-      tags: Joi.array().items(Joi.string().allow("")),
-      name: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      user_id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ClientResponse} */
-  static ClientResponse() {
-    return Joi.object({
-      company_id: Joi.number(),
-      client_id: Joi.string().allow(""),
-      secret: Joi.array().items(Joi.string().allow("")),
-      slug: Joi.string().allow(""),
-      scopes: AuthorizationPartnerModel.ClientScopes(),
-      grants: Joi.array().items(Joi.string().allow("")),
-      redirect_urls: Joi.array().items(Joi.string().allow("")),
-      access_token_lifetime: Joi.number(),
-      refresh_token_lifetime: Joi.number(),
-      meta: AuthorizationPartnerModel.ClientMeta(),
-      author: Joi.any(),
-      is_active: Joi.boolean(),
-      client_type: Joi.string().allow(""),
-      organization_id: Joi.string().allow(""),
-      _id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      raw_permissions: Joi.array().items(Joi.string().allow("")),
-    });
-  }
-
-  /** @returns {ClientListSchema} */
-  static ClientListSchema() {
-    return Joi.object({
-      items: Joi.array().items(AuthorizationPartnerModel.ClientResponse()),
-      page: AuthorizationPartnerModel.Page(),
-    });
-  }
-
-  /** @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(),
-    });
-  }
-}
-module.exports = AuthorizationPartnerModel;

package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts

@@ -1,8 +0,0 @@
-export = AuthorizationValidator;
-declare class AuthorizationValidator {
-    static createOrganizationClient(): any;
-    static getOrganizationClientList(): any;
-    static getOrganizationClientById(): any;
-    static updateOrganizationClientById(): any;
-    static deleteOrganizationOAuthClientById(): any;
-}

package/sdk/partner/Authorization/AuthorizationPartnerValidator.js

@@ -1,39 +0,0 @@
-const Joi = require("joi");
-
-const AuthorizationModel = require("./AuthorizationPartnerModel");
-class AuthorizationValidator {
-  static createOrganizationClient() {
-    return Joi.object({
-      body: AuthorizationModel.ClientData().required(),
-    }).required();
-  }
-
-  static getOrganizationClientList() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      isActive: Joi.boolean(),
-    }).required();
-  }
-
-  static getOrganizationClientById() {
-    return Joi.object({
-      clientId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  static updateOrganizationClientById() {
-    return Joi.object({
-      clientId: Joi.string().allow("").required(),
-      body: AuthorizationModel.UpdateClient().required(),
-    }).required();
-  }
-
-  static deleteOrganizationOAuthClientById() {
-    return Joi.object({
-      clientId: Joi.string().allow("").required(),
-    }).required();
-  }
-}
-
-module.exports = AuthorizationValidator;

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

@@ -1,26 +0,0 @@
-export = Catalog;
-declare class Catalog {
-    constructor(config: any);
-    config: any;
-    /**
-     * @param {CatalogPartnerValidator.PartnerCompanyDetailsParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<CatalogPartnerModel.CompaniesSerializer>} - Success response
-     * @name partnerCompanyDetails
-     * @summary: Fetch partner company details
-     * @description: This API helps in fetch details of partner companies with the help of uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/catalog/partnerCompanyDetails/).
-     */
-    partnerCompanyDetails({ body, requestHeaders }?: CatalogPartnerValidator.PartnerCompanyDetailsParam, { responseHeaders }?: object): Promise<CatalogPartnerModel.CompaniesSerializer>;
-    /**
-     * @param {CatalogPartnerValidator.GetCompaniesParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<CatalogPartnerModel.CompanyListSerializer>} - Success response
-     * @name getCompanies
-     * @summary: Get company profile
-     * @description: This API allows to view the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/catalog/getCompanies/).
-     */
-    getCompanies({ q, stage, requestHeaders }?: CatalogPartnerValidator.GetCompaniesParam, { responseHeaders }?: object): Promise<CatalogPartnerModel.CompanyListSerializer>;
-}
-import CatalogPartnerModel = require("./CatalogPartnerModel");

package/sdk/partner/Catalog/CatalogPartnerClient.js

@@ -1,173 +0,0 @@
-const PartnerAPIClient = require("../PartnerAPIClient");
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
-const Paginator = require("../../common/Paginator");
-const CatalogPartnerValidator = require("./CatalogPartnerValidator");
-const CatalogPartnerModel = require("./CatalogPartnerModel");
-const { Logger } = require("./../../common/Logger");
-const Joi = require("joi");
-
-class Catalog {
-  constructor(config) {
-    this.config = config;
-  }
-
-  /**
-   * @param {CatalogPartnerValidator.PartnerCompanyDetailsParam} arg - Arg object.
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<CatalogPartnerModel.CompaniesSerializer>} - Success response
-   * @name partnerCompanyDetails
-   * @summary: Fetch partner company details
-   * @description: This API helps in fetch details of partner companies with the help of uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/catalog/partnerCompanyDetails/).
-   */
-  async partnerCompanyDetails(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = CatalogPartnerValidator.partnerCompanyDetails().validate(
-      {
-        body,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = CatalogPartnerValidator.partnerCompanyDetails().validate(
-      {
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for partner > Catalog > partnerCompanyDetails \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PartnerAPIClient.execute(
-      this.config,
-      "post",
-      `/service/partner/catalog/v2.0/organization/${this.config.organizationId}/company-details`,
-      query_params,
-      body,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = CatalogPartnerModel.CompaniesSerializer().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for partner > Catalog > partnerCompanyDetails \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {CatalogPartnerValidator.GetCompaniesParam} arg - Arg object.
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<CatalogPartnerModel.CompanyListSerializer>} - Success response
-   * @name getCompanies
-   * @summary: Get company profile
-   * @description: This API allows to view the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/catalog/getCompanies/).
-   */
-  async getCompanies(
-    { q, stage, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = CatalogPartnerValidator.getCompanies().validate(
-      {
-        q,
-        stage,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CatalogPartnerValidator.getCompanies().validate(
-      {
-        q,
-        stage,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for partner > Catalog > getCompanies \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["q"] = q;
-    query_params["stage"] = stage;
-
-    const response = await PartnerAPIClient.execute(
-      this.config,
-      "get",
-      `/service/partner/catalog/v2.0/organization/${this.config.organizationId}/referred-companies`,
-      query_params,
-      undefined,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = CatalogPartnerModel.CompanyListSerializer().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for partner > Catalog > getCompanies \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-}
-module.exports = Catalog;