wavix-sdk 0.0.4 → 0.0.6

package/README.md

@@ -1,47 +1,48 @@
-## API
+# Wavix Node.js SDK
 
-https://wavix.com/api
+Wavix Node.js SDK provides convenient and easy-to-understand functions for interacting with the Wavix API. You can use this package to integrate your Node.js application or service with Wavix functionality.
 
-# Quick start
+The current list of Wavix HTTP REST API can be found here: https://wavix.com/api
+
+## Installation and Usage
 
 ### pnpm:
-```
+
+```sh
 pnpm install wavix-sdk
 ```
 
-### yarn 
-```
+### yarn
+
+```sh
 yarn add wavix-sdk
 ```
 
 # Using
+
 ```typescript
 import Wavix from "wavix-sdk"
 
-const wavix = new Wavix({ appid: "<YOUR APPID>" }) 
+const wavix = new Wavix({ appid: "<YOUR APPID>" })
 
 const cdrList = await wavix.cdr.list({
-    from: "2023-06-01",
-    to: "2023-12-31",
-    type: "placed" as const,
-    per_page: 1
-  })
+  from: new Date("2023-01-01"),
+  to: new Date(),
+  type: "placed" as const,
+  per_page: 1
+})
 ```
 
 You can also find examples in the "examples" directory.
 
-- API calls ✅
-- Number validator ✅
-- DID numbers ✅
-- SIP trunks ✅
-- Call Detail Records (CDRs) ✅
-- Speech analytics ✅
-- Voice campaigns ✅
-- SMS and MMS ✅
-- Link Shortener ✅
-- E911 ✅
-- Billing ✅
-- Cart ✅
-- Buy ✅
-- Profile ✅
-- 2FA ✅
+## Contributing
+
+We welcome contributions from the community. If you'd like to contribute, please fork the repository, make your changes, and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
+
+## Support and Contact
+
+If you encounter any issues or have questions about the SDK, please create an issue on our GitHub repository. For direct support, you can contact us at support@wavix.com.
+
+## License
+
+This SDK is distributed under the MIT License. See [LICENSE](./LICENSE) for more detailed information.

package/lib/cjs/http.js

@@ -102,10 +102,11 @@ class Http {
         return `${this.baseURL}${path}${path.includes("?") ? "&" : "?"}appid=${this.appid}`;
     }
     errorHandler(error) {
+        var _a, _b;
         if (axios_1.default.isAxiosError(error)) {
             const serverError = error;
             if (serverError && serverError.response) {
-                return serverError.response.data;
+                return { success: false, message: ((_b = (_a = serverError.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) || "" };
             }
         }
         return { success: false, message: "" };

package/lib/cjs/services/cdr/cdr.service.js

@@ -21,5 +21,15 @@ class Cdr extends service_base_1.default {
             return yield this.http.get(`/v1/cdr?${queryString}`);
         });
     }
+    get(uuid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/v1/cdr/${uuid}`);
+        });
+    }
+    downloadRecording(uuid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/v1/recordings/${uuid}`);
+        });
+    }
 }
 exports.Cdr = Cdr;

package/lib/cjs/types/services/cdr/cdr.interface.d.ts

@@ -12,6 +12,19 @@ export interface CdrResponse {
     to: string;
     uuid: string;
 }
+export interface CdrResponseDetails {
+    uuid: string;
+    charge: string;
+    date: Date;
+    destination: string;
+    disposition: string;
+    duration: number;
+    from: string;
+    per_minute: string;
+    recording_url: string | null;
+    sip_trunk: string;
+    to: string;
+}
 export interface QueryParameters {
     from: Date;
     to: Date;

package/lib/cjs/types/services/cdr/cdr.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cdr.interface.d.ts","sourceRoot":"","sources":["../../../../../src/services/cdr/cdr.interface.ts"],"names":[],"mappings":"AAAA,KAAK,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;AACpC,KAAK,kBAAkB,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAA;AAE7E,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,IAAI,CAAA;IACV,EAAE,EAAE,IAAI,CAAA;IACR,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAChC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd"}
+{"version":3,"file":"cdr.interface.d.ts","sourceRoot":"","sources":["../../../../../src/services/cdr/cdr.interface.ts"],"names":[],"mappings":"AAAA,KAAK,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;AACpC,KAAK,kBAAkB,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAA;AAE7E,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,IAAI,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,IAAI,CAAA;IACV,EAAE,EAAE,IAAI,CAAA;IACR,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAChC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd"}

package/lib/cjs/types/services/cdr/cdr.service.d.ts

@@ -1,7 +1,9 @@
 import ServiceBase from "../service.base";
-import { CdrResponse, QueryParameters } from "./cdr.interface";
+import { CdrResponse, QueryParameters, CdrResponseDetails } from "./cdr.interface";
 declare class Cdr extends ServiceBase {
-    list(queryParameters: QueryParameters): Promise<PaginatedResponse<CdrResponse>>;
+    list(queryParameters: QueryParameters): Promise<PaginatedResponse<CdrResponse> | ErrorResponse>;
+    get(uuid: string): Promise<CdrResponseDetails | ErrorResponse>;
+    downloadRecording(uuid: string): Promise<ArrayBuffer | ErrorResponse>;
 }
 export { Cdr };
 //# sourceMappingURL=cdr.service.d.ts.map

package/lib/cjs/types/services/cdr/cdr.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cdr.service.d.ts","sourceRoot":"","sources":["../../../../../src/services/cdr/cdr.service.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAE9D,cAAM,GAAI,SAAQ,WAAW;IACd,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;CAI7F;AAED,OAAO,EAAE,GAAG,EAAE,CAAA"}
+{"version":3,"file":"cdr.service.d.ts","sourceRoot":"","sources":["../../../../../src/services/cdr/cdr.service.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAElF,cAAM,GAAI,SAAQ,WAAW;IACd,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,aAAa,CAAC;IAK/F,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,aAAa,CAAC;IAI9D,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,aAAa,CAAC;CAGnF;AAED,OAAO,EAAE,GAAG,EAAE,CAAA"}

package/lib/esm/http.js

@@ -84,7 +84,7 @@ class Http {
         if (axios.isAxiosError(error)) {
             const serverError = error;
             if (serverError && serverError.response) {
-                return serverError.response.data;
+                return { success: false, message: serverError.response?.data?.message || "" };
             }
         }
         return { success: false, message: "" };

package/lib/esm/services/cdr/cdr.service.js

@@ -4,5 +4,11 @@ class Cdr extends ServiceBase {
         const queryString = this.http.paramsToQueryString(queryParameters);
         return await this.http.get(`/v1/cdr?${queryString}`);
     }
+    async get(uuid) {
+        return await this.http.get(`/v1/cdr/${uuid}`);
+    }
+    async downloadRecording(uuid) {
+        return await this.http.get(`/v1/recordings/${uuid}`);
+    }
 }
 export { Cdr };

package/lib/esm/types/services/cdr/cdr.interface.d.ts

@@ -12,6 +12,19 @@ export interface CdrResponse {
     to: string;
     uuid: string;
 }
+export interface CdrResponseDetails {
+    uuid: string;
+    charge: string;
+    date: Date;
+    destination: string;
+    disposition: string;
+    duration: number;
+    from: string;
+    per_minute: string;
+    recording_url: string | null;
+    sip_trunk: string;
+    to: string;
+}
 export interface QueryParameters {
     from: Date;
     to: Date;

package/lib/esm/types/services/cdr/cdr.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cdr.interface.d.ts","sourceRoot":"","sources":["../../../../../src/services/cdr/cdr.interface.ts"],"names":[],"mappings":"AAAA,KAAK,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;AACpC,KAAK,kBAAkB,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAA;AAE7E,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,IAAI,CAAA;IACV,EAAE,EAAE,IAAI,CAAA;IACR,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAChC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd"}
+{"version":3,"file":"cdr.interface.d.ts","sourceRoot":"","sources":["../../../../../src/services/cdr/cdr.interface.ts"],"names":[],"mappings":"AAAA,KAAK,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;AACpC,KAAK,kBAAkB,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAA;AAE7E,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,IAAI,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,IAAI,CAAA;IACV,EAAE,EAAE,IAAI,CAAA;IACR,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAChC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd"}

package/lib/esm/types/services/cdr/cdr.service.d.ts

@@ -1,7 +1,9 @@
 import ServiceBase from "../service.base";
-import { CdrResponse, QueryParameters } from "./cdr.interface";
+import { CdrResponse, QueryParameters, CdrResponseDetails } from "./cdr.interface";
 declare class Cdr extends ServiceBase {
-    list(queryParameters: QueryParameters): Promise<PaginatedResponse<CdrResponse>>;
+    list(queryParameters: QueryParameters): Promise<PaginatedResponse<CdrResponse> | ErrorResponse>;
+    get(uuid: string): Promise<CdrResponseDetails | ErrorResponse>;
+    downloadRecording(uuid: string): Promise<ArrayBuffer | ErrorResponse>;
 }
 export { Cdr };
 //# sourceMappingURL=cdr.service.d.ts.map

package/lib/esm/types/services/cdr/cdr.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cdr.service.d.ts","sourceRoot":"","sources":["../../../../../src/services/cdr/cdr.service.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAE9D,cAAM,GAAI,SAAQ,WAAW;IACd,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;CAI7F;AAED,OAAO,EAAE,GAAG,EAAE,CAAA"}
+{"version":3,"file":"cdr.service.d.ts","sourceRoot":"","sources":["../../../../../src/services/cdr/cdr.service.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAElF,cAAM,GAAI,SAAQ,WAAW;IACd,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,aAAa,CAAC;IAK/F,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,aAAa,CAAC;IAI9D,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,aAAa,CAAC;CAGnF;AAED,OAAO,EAAE,GAAG,EAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wavix-sdk",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "main": "./lib/cjs/index.js",
   "types": "./lib/cjs/types/index.d.ts",
   "type": "commonjs",