@gofynd/fdk-client-javascript 0.1.35

package/sdk/platform/client/PaymentPlatformClient.js

@@ -0,0 +1,331 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const PaymentValidator = require("../models/PaymentValidator");
+class Payment {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.uniqueExternalId] - Fetch payouts using unique external id
+   * @summary: Get All Payouts
+   * @description: Get All Payouts
+   */
+  getAllPayouts({ uniqueExternalId } = {}) {
+    const { error } = PaymentValidator.getAllPayouts().validate(
+      {
+        uniqueExternalId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["unique_external_id"] = uniqueExternalId;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {PayoutRequest} arg.body
+   * @summary: Save Payout
+   * @description: Save Payout
+   */
+  savePayout({ body } = {}) {
+    const { error } = PaymentValidator.savePayout().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.uniqueTransferNo - Unique transfer id
+   * @param {PayoutRequest} arg.body
+   * @summary: Update Payout
+   * @description: Update Payout
+   */
+  updatePayout({ uniqueTransferNo, body } = {}) {
+    const { error } = PaymentValidator.updatePayout().validate(
+      {
+        uniqueTransferNo,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.uniqueTransferNo - Unique transfer id
+   * @param {UpdatePayoutRequest} arg.body
+   * @summary: Partial Update Payout
+   * @description: Partial Update Payout
+   */
+  activateAndDectivatePayout({ uniqueTransferNo, body } = {}) {
+    const { error } = PaymentValidator.activateAndDectivatePayout().validate(
+      {
+        uniqueTransferNo,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "patch",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.uniqueTransferNo - Unique transfer id
+   * @summary: Delete Payout
+   * @description: Delete Payout
+   */
+  deletePayout({ uniqueTransferNo } = {}) {
+    const { error } = PaymentValidator.deletePayout().validate(
+      {
+        uniqueTransferNo,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.uniqueExternalId] - Unique external id
+   * @summary: List Subscription Payment Method
+   * @description: Get all  Subscription  Payment Method
+   */
+  getSubscriptionPaymentMethod({ uniqueExternalId } = {}) {
+    const { error } = PaymentValidator.getSubscriptionPaymentMethod().validate(
+      {
+        uniqueExternalId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["unique_external_id"] = uniqueExternalId;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/methods`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.uniqueExternalId -
+   * @param {string} arg.paymentMethodId -
+   * @summary: Delete Subscription Payment Method
+   * @description: Uses this api to Delete Subscription Payment Method
+   */
+  deleteSubscriptionPaymentMethod({ uniqueExternalId, paymentMethodId } = {}) {
+    const {
+      error,
+    } = PaymentValidator.deleteSubscriptionPaymentMethod().validate(
+      {
+        uniqueExternalId,
+        paymentMethodId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["unique_external_id"] = uniqueExternalId;
+    query_params["payment_method_id"] = paymentMethodId;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/methods`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @summary: List Subscription Config
+   * @description: Get all  Subscription Config details
+   */
+  getSubscriptionConfig({} = {}) {
+    const { error } = PaymentValidator.getSubscriptionConfig().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/configs`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {SaveSubscriptionSetupIntentRequest} arg.body
+   * @summary: Save Subscription Setup Intent
+   * @description: Uses this api to Save Subscription Setup Intent
+   */
+  saveSubscriptionSetupIntent({ body } = {}) {
+    const { error } = PaymentValidator.saveSubscriptionSetupIntent().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/setup/intent`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.ifscCode] -
+   * @summary: Ifsc Code Verification
+   * @description: Get True/False for correct IFSC Code for adding bank details for refund
+   */
+  verifyIfscCode({ ifscCode } = {}) {
+    const { error } = PaymentValidator.verifyIfscCode().validate(
+      {
+        ifscCode,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["ifsc_code"] = ifscCode;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/payment/v1.0/company/${this.config.companyId}/ifsc-code/verify`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Payment;

package/sdk/platform/client/WebhookPlatformClient.d.ts

@@ -0,0 +1,64 @@
+export = Webhook;
+declare class Webhook {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Page Number
+     * @param {number} [arg.pageSize] - Page Size
+     * @param {string} [arg.extensionId] - Extension ID
+     * @summary: Get Subscribers By Company ID
+     * @description: Get Subscribers By CompanyId
+     */
+    getSubscribersByCompany({ pageNo, pageSize, extensionId }?: {
+        pageNo?: number;
+        pageSize?: number;
+        extensionId?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SubscriberConfig} arg.body
+     * @summary: Register Subscriber
+     * @description: Register Subscriber
+     */
+    registerSubscriberToEvent({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SubscriberConfig} arg.body
+     * @summary: Update Subscriber
+     * @description: Update Subscriber
+     */
+    updateSubscriberConfig({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Page Number
+     * @param {number} [arg.pageSize] - Page Size
+     * @param {string} arg.extensionId - Extension ID
+     * @summary: Get Subscribers By Extension ID
+     * @description: Get Subscribers By ExtensionID
+     */
+    getSubscribersByExtensionId({ extensionId, pageNo, pageSize }?: {
+        pageNo?: number;
+        pageSize?: number;
+        extensionId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.subscriberId - Subscriber ID
+     * @summary: Get Subscriber By Subscriber ID
+     * @description: Get Subscriber By Subscriber ID
+     */
+    getSubscriberById({ subscriberId }?: {
+        subscriberId: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary:
+     * @description: Get All Webhook Events
+     */
+    fetchAllEventConfigurations({}?: any): Promise<any>;
+}

package/sdk/platform/client/WebhookPlatformClient.js

@@ -0,0 +1,207 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const WebhookValidator = require("../models/WebhookValidator");
+class Webhook {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageNo] - Page Number
+   * @param {number} [arg.pageSize] - Page Size
+   * @param {string} [arg.extensionId] - Extension ID
+   * @summary: Get Subscribers By Company ID
+   * @description: Get Subscribers By CompanyId
+   */
+  getSubscribersByCompany({ pageNo, pageSize, extensionId } = {}) {
+    const { error } = WebhookValidator.getSubscribersByCompany().validate(
+      {
+        pageNo,
+        pageSize,
+        extensionId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["extension_id"] = extensionId;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {SubscriberConfig} arg.body
+   * @summary: Register Subscriber
+   * @description: Register Subscriber
+   */
+  registerSubscriberToEvent({ body } = {}) {
+    const { error } = WebhookValidator.registerSubscriberToEvent().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {SubscriberConfig} arg.body
+   * @summary: Update Subscriber
+   * @description: Update Subscriber
+   */
+  updateSubscriberConfig({ body } = {}) {
+    const { error } = WebhookValidator.updateSubscriberConfig().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageNo] - Page Number
+   * @param {number} [arg.pageSize] - Page Size
+   * @param {string} arg.extensionId - Extension ID
+   * @summary: Get Subscribers By Extension ID
+   * @description: Get Subscribers By ExtensionID
+   */
+  getSubscribersByExtensionId({ extensionId, pageNo, pageSize } = {}) {
+    const { error } = WebhookValidator.getSubscribersByExtensionId().validate(
+      {
+        extensionId,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscriber`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} arg.subscriberId - Subscriber ID
+   * @summary: Get Subscriber By Subscriber ID
+   * @description: Get Subscriber By Subscriber ID
+   */
+  getSubscriberById({ subscriberId } = {}) {
+    const { error } = WebhookValidator.getSubscriberById().validate(
+      {
+        subscriberId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/${subscriberId}`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @summary:
+   * @description: Get All Webhook Events
+   */
+  fetchAllEventConfigurations({} = {}) {
+    const { error } = WebhookValidator.fetchAllEventConfigurations().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/events`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Webhook;

package/sdk/platform/index.d.ts

@@ -0,0 +1,2 @@
+export const PlatformConfig: typeof import("./PlatformConfig");
+export const PlatformClient: typeof import("./PlatformClient");

package/sdk/platform/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  PlatformConfig: require("./PlatformConfig"),
+  PlatformClient: require("./PlatformClient"),
+};

package/sdk/platform/models/AnalyticsValidator.d.ts

@@ -0,0 +1,7 @@
+export = AnalyticsValidator;
+declare class AnalyticsValidator {
+    static createExportJob(): any;
+    static getExportJobStatus(): any;
+    static getLogsList(): any;
+    static searchLogs(): any;
+}

package/sdk/platform/models/AnalyticsValidator.js

@@ -0,0 +1,36 @@
+const Joi = require("joi");
+const Validator = require("../PlatformModels");
+class AnalyticsValidator {
+  static createExportJob() {
+    return Joi.object({
+      exportType: Joi.string().allow("").required(),
+      body: Validator.ExportJobReq().required(),
+    }).required();
+  }
+
+  static getExportJobStatus() {
+    return Joi.object({
+      exportType: Joi.string().allow("").required(),
+      jobId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getLogsList() {
+    return Joi.object({
+      logType: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      body: Validator.GetLogsListReq().required(),
+    }).required();
+  }
+
+  static searchLogs() {
+    return Joi.object({
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      logType: Joi.string().allow("").required(),
+      body: Validator.SearchLogReq().required(),
+    }).required();
+  }
+}
+module.exports = AnalyticsValidator;

package/sdk/platform/models/AuditTrailValidator.d.ts

@@ -0,0 +1,7 @@
+export = AuditTrailValidator;
+declare class AuditTrailValidator {
+    static getAuditLogs(): any;
+    static createAuditLog(): any;
+    static getAuditLog(): any;
+    static getEntityTypes(): any;
+}

package/sdk/platform/models/AuditTrailValidator.js

@@ -0,0 +1,26 @@
+const Joi = require("joi");
+const Validator = require("../PlatformModels");
+class AuditTrailValidator {
+  static getAuditLogs() {
+    return Joi.object({
+      qs: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static createAuditLog() {
+    return Joi.object({
+      body: Validator.RequestBodyAuditLog().required(),
+    }).required();
+  }
+
+  static getAuditLog() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getEntityTypes() {
+    return Joi.object({}).required();
+  }
+}
+module.exports = AuditTrailValidator;

package/sdk/platform/models/BillingValidator.d.ts

@@ -0,0 +1,15 @@
+export = BillingValidator;
+declare class BillingValidator {
+    static checkCouponValidity(): any;
+    static createSubscriptionCharge(): any;
+    static getSubscriptionCharge(): any;
+    static cancelSubscriptionCharge(): any;
+    static getInvoices(): any;
+    static getInvoiceById(): any;
+    static getCustomerDetail(): any;
+    static upsertCustomerDetail(): any;
+    static getSubscription(): any;
+    static getFeatureLimitConfig(): any;
+    static activateSubscriptionPlan(): any;
+    static cancelSubscriptionPlan(): any;
+}