Merge pull request #361 from plivo/typescript-complaince-api-fix

Compliance submit API

Author: narayana-plivo

CHANGELOG.md

@@ -1,4 +1,13 @@
 # Change Log
+## [v4.75.1](https://github.com/plivo/plivo-node/tree/v4.75.1) (2025-07-21)
+**Feature - Comprehensive Compliance APIs TypeScript Support**
+- Added missing `submit` method for compliance applications
+- Fixed property name inconsistencies (`endUserID` → `endUserId`, `ComplianceRequirementId` → `complianceRequirementId`, `documentTypeID` → `documentTypeId`)
+- Corrected property types (`endUserType: object` → `endUserType: string`)
+- Fixed class name consistency (`ListComplianceDocumentResponse` → `ListComplianceDocumentsResponse`)
+- Improved return type accuracy for delete methods (`Promise<unknown>` → `Promise<boolean>`)
+- Added missing properties and removed incorrect ones in compliance document responses
+- Enhanced TypeScript definitions to match JavaScript implementations for better type safety and IntelliSense support
 ## [v4.75.0](https://github.com/plivo/plivo-node/tree/v4.75.0) (2025-07-07)
 **Bug Fix - Update Number API**
 - Fixed the issue where the subaccount parameter was not being updated in the Plivo Number API in node SDK

package.json

@@ -1,6 +1,6 @@
 {
   "name": "plivo",
-  "version": "4.75.0",
+  "version": "4.75.1",
   "description": "A Node.js SDK to make voice calls and send SMS using Plivo and to generate Plivo XML",
   "homepage": "https://github.com/plivo/plivo-node",
   "files": [

types/resources/complianceApplications.d.ts

@@ -2,7 +2,7 @@ export class ComplianceApplicationResponse {
     constructor(params: object);
     apiId: string;
     complianceApplicationId: string;
-    endUserID: string;
+    endUserId: string;
     endUserType: string;
     alias: string;
     status: string;
@@ -17,7 +17,7 @@ export class CreateComplianceApplicationResponse {
     constructor(params: object);
     apiId: string;
     complianceApplicationId: string;
-    endUserID: string;
+    endUserId: string;
     endUserType: string;
     alias: string;
     status: string;
@@ -70,7 +70,7 @@ export class ComplianceApplication extends PlivoResource {
     * @promise {boolean} return true if success
     * @fail {Error} return Error
     */
-    delete(): Promise<unknown>;
+    delete(): Promise<boolean>;
     [clientKey]: symbol;
 }
 
@@ -136,7 +136,15 @@ export class ComplianceApplicationInterface extends PlivoResourceInterface {
     * @promise {boolean} return true if success
     * @fail {Error} return Error
     */
-    delete(id: string): any;
+    delete(id: string): Promise<boolean>;
+
+    /**
+     * submit an application by given id
+     * @method
+     * @param {string} id - id of application
+     * @fail {Error} return Error
+     */
+    submit(id: string): Promise<ComplianceApplicationResponse>;
     [clientKey]: symbol;
 }
 

types/resources/complianceDocumentTypes.d.ts

@@ -1,7 +1,7 @@
 export class ComplianceDocumentTypeResponse {
     constructor(params: object);
     apiId: string;
-    documentTypeID: string;
+    documentTypeId: string;
     documentName: string;
     description: string;
     information: object;

types/resources/complianceDocuments.d.ts

@@ -2,11 +2,10 @@ export class ComplianceDocumentResponse {
     constructor(params: object);
     apiId: string;
     documentTypeId: string;
-    complianceDocumentId: string;
     documentId: string;
+    endUserId: string;
     alias: string;
     metaInformation: string;
-    file: string;
     fileName: string;
     createdAt: string;
 }
@@ -15,7 +14,6 @@ export class CreateComplianceDocumentResponse {
     constructor(params: object);
     apiId: string;
     documentTypeId: string;
-    complianceDocumentId: string;
     documentId: string;
     endUserId: string;
     alias: string;
@@ -25,7 +23,7 @@ export class CreateComplianceDocumentResponse {
     createdAt: string;
 }
 
-export class ListComplianceDocumentResponse {
+export class ListComplianceDocumentsResponse {
     constructor(params: object);
     apiId: string;
     meta: Object;
@@ -64,7 +62,7 @@ export class ComplianceDocument extends PlivoResource {
     * @promise {boolean} return true if success
     * @fail {Error} return Error
     */
-    delete(): Promise<unknown>;
+    delete(): Promise<boolean>;
     [clientKey]: symbol;
 }
 
@@ -92,7 +90,7 @@ export class ComplianceDocumentInterface extends PlivoResourceInterface {
      * @method
      * @param {object} params - params containing options to list compliance documents by.
      */
-    list(params: object): Promise<ListComplianceDocumentResponse>;
+    list(params: object): Promise<ListComplianceDocumentsResponse>;
 
     /**
      * Create a complaince document
@@ -124,7 +122,7 @@ export class ComplianceDocumentInterface extends PlivoResourceInterface {
     * @promise {boolean} return true if success
     * @fail {Error} return Error
     */
-    delete(id: string): any;
+    delete(id: string): Promise<boolean>;
     [clientKey]: symbol;
 }
 

types/resources/complianceRequirements.d.ts

@@ -1,10 +1,10 @@
 export class ComplianceRequirementResponse {
     constructor(params: object);
     apiId: string;
-    ComplianceRequirementId: string;
+    complianceRequirementId: string;
     countryIso2: string;
     numberType: string;
-    endUserType: object;
+    endUserType: string;
     acceptableDocumentTypes: string;
 }