ubill-sms-client 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -0
- package/dist/client.d.ts +1 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +13 -0
- package/dist/client.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -74,6 +74,16 @@ const client = new UBillSMSClient({
|
|
|
74
74
|
|
|
75
75
|
Create a new brand name (sender ID) for your SMS messages. Brand names must be 2-11 characters and require approval before use.
|
|
76
76
|
|
|
77
|
+
**Validation Rules:**
|
|
78
|
+
|
|
79
|
+
- **Length:** Minimum 2 characters, maximum 11 characters
|
|
80
|
+
- **Allowed characters:**
|
|
81
|
+
- Letters: `a-z`, `A-Z`
|
|
82
|
+
- Numbers: `0-9`
|
|
83
|
+
- Period: `.`
|
|
84
|
+
- Hyphen: `-`
|
|
85
|
+
- Space: ` `
|
|
86
|
+
|
|
77
87
|
```typescript
|
|
78
88
|
const response = await client.createBrandName("MyBrand");
|
|
79
89
|
|
|
@@ -84,6 +94,22 @@ if (response.statusID === 0) {
|
|
|
84
94
|
}
|
|
85
95
|
```
|
|
86
96
|
|
|
97
|
+
**Valid Examples:**
|
|
98
|
+
|
|
99
|
+
- `MyBrand`
|
|
100
|
+
- `Test-Co`
|
|
101
|
+
- `Test.Co`
|
|
102
|
+
- `My Brand`
|
|
103
|
+
- `Brand123`
|
|
104
|
+
|
|
105
|
+
**Invalid Examples:**
|
|
106
|
+
|
|
107
|
+
- `A` (too short)
|
|
108
|
+
- `ThisIsTooLong` (more than 11 characters)
|
|
109
|
+
- `Test@Brand` (@ not allowed)
|
|
110
|
+
- `Test_Brand` (underscore not allowed)
|
|
111
|
+
- `Test#Brand` (# not allowed)
|
|
112
|
+
|
|
87
113
|
**Error Codes:**
|
|
88
114
|
|
|
89
115
|
- `0` - Brand name created successfully
|
package/dist/client.d.ts
CHANGED
|
@@ -34,6 +34,7 @@ export declare class UBillSMSClient {
|
|
|
34
34
|
* Create a new brand name
|
|
35
35
|
*
|
|
36
36
|
* Brand names must be 2-11 characters and approved before use.
|
|
37
|
+
* Allowed characters: a-z, A-Z, 0-9, period (.), hyphen (-), space
|
|
37
38
|
*
|
|
38
39
|
* @param brandName - The brand name to create (2-11 characters)
|
|
39
40
|
* @returns Response containing the created brand ID
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EAElB,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,aAAa,CAAgB;IAErC;;;;OAIG;gBACS,MAAM,EAAE,cAAc;IAiBlC
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EAElB,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,aAAa,CAAgB;IAErC;;;;OAIG;gBACS,MAAM,EAAE,cAAc;IAiBlC;;;;;;;;;;;;;;OAcG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA4B1E;;;;;;;;;;;;OAYG;IACG,aAAa,IAAI,OAAO,CAAC,kBAAkB,CAAC;IASlD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAyBhE;;;;;;;;;;;;;;;;;OAiBG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,eAAe,CAAC;IAuBtE;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAkB7B;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAa5B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,iBAAiB,CACrB,KAAK,EAAE,MAAM,GAAG,MAAM,GACrB,OAAO,CAAC,sBAAsB,CAAC;IASlC;;;;;;;;;;OAUG;IACG,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC;IAW5C;;;OAGG;IACH,OAAO,CAAC,WAAW;CA4BpB"}
|
package/dist/client.js
CHANGED
|
@@ -51,6 +51,7 @@ class UBillSMSClient {
|
|
|
51
51
|
* Create a new brand name
|
|
52
52
|
*
|
|
53
53
|
* Brand names must be 2-11 characters and approved before use.
|
|
54
|
+
* Allowed characters: a-z, A-Z, 0-9, period (.), hyphen (-), space
|
|
54
55
|
*
|
|
55
56
|
* @param brandName - The brand name to create (2-11 characters)
|
|
56
57
|
* @returns Response containing the created brand ID
|
|
@@ -63,6 +64,18 @@ class UBillSMSClient {
|
|
|
63
64
|
*/
|
|
64
65
|
async createBrandName(brandName) {
|
|
65
66
|
try {
|
|
67
|
+
// Validate brand name format
|
|
68
|
+
if (!brandName || brandName.length < 2) {
|
|
69
|
+
throw new Error("Brand name must be at least 2 characters long");
|
|
70
|
+
}
|
|
71
|
+
if (brandName.length > 11) {
|
|
72
|
+
throw new Error("Brand name must be maximum 11 characters long");
|
|
73
|
+
}
|
|
74
|
+
// Allowed: a-z, A-Z, 0-9, period (.), hyphen (-), space
|
|
75
|
+
if (!/^[a-zA-Z0-9.\- ]+$/.test(brandName)) {
|
|
76
|
+
throw new Error("Brand name contains invalid characters. " +
|
|
77
|
+
"Allowed: letters (a-z, A-Z), numbers (0-9), period (.), hyphen (-), and space");
|
|
78
|
+
}
|
|
66
79
|
const response = await this.axiosInstance.post("/sms/brandNameCreate", {
|
|
67
80
|
brandName,
|
|
68
81
|
});
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyD;AAazD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,cAAc;IAIzB;;;;OAIG;IACH,YAAY,MAAsB;QAChC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAE5B,IAAI,CAAC,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,0BAA0B;YACrD,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,KAAK;YAChC,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,GAAG,EAAE,IAAI,CAAC,MAAM;aACjB;SACF,CAAC,CAAC;IACL,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyD;AAazD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,cAAc;IAIzB;;;;OAIG;IACH,YAAY,MAAsB;QAChC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAE5B,IAAI,CAAC,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,0BAA0B;YACrD,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,KAAK;YAChC,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,GAAG,EAAE,IAAI,CAAC,MAAM;aACjB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,eAAe,CAAC,SAAiB;QACrC,IAAI,CAAC;YACH,6BAA6B;YAC7B,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;YACnE,CAAC;YAED,IAAI,SAAS,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;YACnE,CAAC;YAED,wDAAwD;YACxD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CACb,0CAA0C;oBACxC,+EAA+E,CAClF,CAAC;YACJ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,sBAAsB,EAAE;gBACrE,SAAS;aACV,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa;QACjB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACjE,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,OAAO,CAAC,OAAuB;QACnC,IAAI,CAAC;YACH,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;YAE7D,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;gBACzC,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAEtD,yBAAyB;YACzB,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;YAExC,MAAM,OAAO,GAAG;gBACd,OAAO;gBACP,OAAO,EAAE,YAAY;gBACrB,IAAI;gBACJ,QAAQ;aACT,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACrE,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,UAAU,CAAC,OAA0B;QACzC,IAAI,CAAC;YACH,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;YAE7D,qDAAqD;YACrD,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACvE,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;YAExC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE;gBACzD,MAAM,EAAE;oBACN,GAAG,EAAE,IAAI,CAAC,MAAM;oBAChB,OAAO;oBACP,OAAO;oBACP,IAAI;oBACJ,QAAQ;iBACT;aACF,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,MAAuB;QACnD,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QAEjC,mCAAmC;QACnC,uDAAuD;QACvD,sDAAsD;QACtD,oFAAoF;QAEpF,gCAAgC;QAChC,MAAM,eAAe,GAAG,eAAe,CAAC;QACxC,+CAA+C;QAC/C,MAAM,kBAAkB,GAAG,YAAY,CAAC;QAExC,OAAO,CACL,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,oBAAoB,CAAC,OAAiB;QAC5C,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CACnC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAC1C,CAAC;QAEF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,sCAAsC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;gBACjE,4FAA4F,CAC/F,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,iBAAiB,CACrB,KAAsB;QAEtB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,eAAe,KAAK,EAAE,CAAC,CAAC;YACtE,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,UAAU;QACd,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE;gBAC5D,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE;aAC7B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,WAAW,CAAC,KAAc;QAChC,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,UAAU,GAAG,KAAkC,CAAC;YAEtD,IAAI,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9B,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC3C,OAAO,IAAI,KAAK,CACd,oBAAoB,SAAS,CAAC,QAAQ,MAAM,SAAS,CAAC,OAAO,EAAE,CAChE,CAAC;YACJ,CAAC;YAED,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACxB,OAAO,IAAI,KAAK,CACd,cAAc,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,UAAU,CAAC,QAAQ,CAAC,UAAU,EAAE,CAC9E,CAAC;YACJ,CAAC;YAED,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;gBACvB,OAAO,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;QAED,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC7C,CAAC;CACF;AA1TD,wCA0TC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ubill-sms-client",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.5",
|
|
4
4
|
"description": "Node.js client for uBill.ge SMS API - Send SMS messages, manage brand names, check delivery status and account balance. (non official)",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|