botcast-sdk 1.0.0 → 1.0.1

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.
@@ -117,14 +117,41 @@ class InstancesModule extends base_js_1.BaseModule {
117
117
  }
118
118
  /**
119
119
  * Updates safety daily message limits and new contact limits.
120
+ *
121
+ * @param limits Payload with daily_message_limit and/or daily_new_contacts_limit (0 disables limit)
120
122
  */
121
123
  async updateLimits(limits) {
124
+ const body = {};
125
+ if (limits.daily_message_limit !== undefined)
126
+ body.daily_message_limit = limits.daily_message_limit;
127
+ if (limits.dailyMessageLimit !== undefined)
128
+ body.daily_message_limit = limits.dailyMessageLimit;
129
+ if (limits.daily_new_contacts_limit !== undefined)
130
+ body.daily_new_contacts_limit = limits.daily_new_contacts_limit;
131
+ if (limits.dailyNewContactsLimit !== undefined)
132
+ body.daily_new_contacts_limit = limits.dailyNewContactsLimit;
122
133
  return this.request({
123
134
  method: 'POST',
124
135
  path: this.buildPath('limits'),
125
- body: limits,
136
+ body,
126
137
  });
127
138
  }
139
+ /**
140
+ * Sets the maximum number of WhatsApp messages that can be dispatched per calendar day.
141
+ *
142
+ * @param limit Message count limit per day (pass `0` for unlimited).
143
+ */
144
+ async setDailyMessageLimit(limit) {
145
+ return this.updateLimits({ daily_message_limit: limit });
146
+ }
147
+ /**
148
+ * Sets the maximum number of new recipient phone numbers that can be messaged per calendar day.
149
+ *
150
+ * @param limit New contacts limit per day (pass `0` for unlimited).
151
+ */
152
+ async setDailyNewContactsLimit(limit) {
153
+ return this.updateLimits({ daily_new_contacts_limit: limit });
154
+ }
128
155
  /**
129
156
  * Triggers contact & message sync from WhatsApp.
130
157
  */
@@ -73,11 +73,30 @@ export declare class InstancesModule extends BaseModule {
73
73
  getLimits(): Promise<InstanceLimitsResponse>;
74
74
  /**
75
75
  * Updates safety daily message limits and new contact limits.
76
+ *
77
+ * @param limits Payload with daily_message_limit and/or daily_new_contacts_limit (0 disables limit)
76
78
  */
77
- updateLimits(limits: UpdateLimitsPayload): Promise<{
78
- success: boolean;
79
- message: string;
80
- limits: any;
79
+ updateLimits(limits: UpdateLimitsPayload): Promise<InstanceLimitsResponse & {
80
+ success?: boolean;
81
+ message?: string;
82
+ }>;
83
+ /**
84
+ * Sets the maximum number of WhatsApp messages that can be dispatched per calendar day.
85
+ *
86
+ * @param limit Message count limit per day (pass `0` for unlimited).
87
+ */
88
+ setDailyMessageLimit(limit: number): Promise<InstanceLimitsResponse & {
89
+ success?: boolean;
90
+ message?: string;
91
+ }>;
92
+ /**
93
+ * Sets the maximum number of new recipient phone numbers that can be messaged per calendar day.
94
+ *
95
+ * @param limit New contacts limit per day (pass `0` for unlimited).
96
+ */
97
+ setDailyNewContactsLimit(limit: number): Promise<InstanceLimitsResponse & {
98
+ success?: boolean;
99
+ message?: string;
81
100
  }>;
82
101
  /**
83
102
  * Triggers contact & message sync from WhatsApp.
@@ -1 +1 @@
1
- {"version":3,"file":"instances.d.ts","sourceRoot":"","sources":["../../../src/modules/instances.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EACf,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAE3B,qBAAa,eAAgB,SAAQ,UAAU;IAC7C;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAKxD;IAED;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAKhD;IAED;;;;OAIG;IACU,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAMxE;IAED;;;;OAIG;IACU,KAAK,CAAC,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAM7H;IAED;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAKtG;IAED;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAKxG;IAED;;OAEG;IACU,iBAAiB,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAKhE;IAED;;;;OAIG;IACU,iBAAiB,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAM3F;IAED;;;;OAIG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAM1E;IAED;;OAEG;IACU,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAMjG;IAED;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAKxD;IAED;;OAEG;IACU,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,CAAC,CAMlH;IAED;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAK1F;CACF"}
1
+ {"version":3,"file":"instances.d.ts","sourceRoot":"","sources":["../../../src/modules/instances.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EACf,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAE3B,qBAAa,eAAgB,SAAQ,UAAU;IAC7C;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAKxD;IAED;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAKhD;IAED;;;;OAIG;IACU,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAMxE;IAED;;;;OAIG;IACU,KAAK,CAAC,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAM7H;IAED;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAKtG;IAED;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAKxG;IAED;;OAEG;IACU,iBAAiB,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAKhE;IAED;;;;OAIG;IACU,iBAAiB,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAM3F;IAED;;;;OAIG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAM1E;IAED;;OAEG;IACU,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAMjG;IAED;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAKxD;IAED;;;;OAIG;IACU,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,sBAAsB,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAYhI;IAED;;;;OAIG;IACU,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAE1H;IAED;;;;OAIG;IACU,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAE9H;IAED;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAK1F;CACF"}
@@ -114,14 +114,41 @@ export class InstancesModule extends BaseModule {
114
114
  }
115
115
  /**
116
116
  * Updates safety daily message limits and new contact limits.
117
+ *
118
+ * @param limits Payload with daily_message_limit and/or daily_new_contacts_limit (0 disables limit)
117
119
  */
118
120
  async updateLimits(limits) {
121
+ const body = {};
122
+ if (limits.daily_message_limit !== undefined)
123
+ body.daily_message_limit = limits.daily_message_limit;
124
+ if (limits.dailyMessageLimit !== undefined)
125
+ body.daily_message_limit = limits.dailyMessageLimit;
126
+ if (limits.daily_new_contacts_limit !== undefined)
127
+ body.daily_new_contacts_limit = limits.daily_new_contacts_limit;
128
+ if (limits.dailyNewContactsLimit !== undefined)
129
+ body.daily_new_contacts_limit = limits.dailyNewContactsLimit;
119
130
  return this.request({
120
131
  method: 'POST',
121
132
  path: this.buildPath('limits'),
122
- body: limits,
133
+ body,
123
134
  });
124
135
  }
136
+ /**
137
+ * Sets the maximum number of WhatsApp messages that can be dispatched per calendar day.
138
+ *
139
+ * @param limit Message count limit per day (pass `0` for unlimited).
140
+ */
141
+ async setDailyMessageLimit(limit) {
142
+ return this.updateLimits({ daily_message_limit: limit });
143
+ }
144
+ /**
145
+ * Sets the maximum number of new recipient phone numbers that can be messaged per calendar day.
146
+ *
147
+ * @param limit New contacts limit per day (pass `0` for unlimited).
148
+ */
149
+ async setDailyNewContactsLimit(limit) {
150
+ return this.updateLimits({ daily_new_contacts_limit: limit });
151
+ }
125
152
  /**
126
153
  * Triggers contact & message sync from WhatsApp.
127
154
  */
@@ -61,5 +61,7 @@ export interface InstanceLimitsResponse {
61
61
  export interface UpdateLimitsPayload {
62
62
  daily_message_limit?: number;
63
63
  daily_new_contacts_limit?: number;
64
+ dailyMessageLimit?: number;
65
+ dailyNewContactsLimit?: number;
64
66
  }
65
67
  //# sourceMappingURL=instances.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"instances.d.ts","sourceRoot":"","sources":["../../../src/types/instances.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,cAAc,GAAG,YAAY,GAAG,UAAU,GAAG,SAAS,CAAC;AAClG,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErD,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,cAAc,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;IACxC,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,YAAY,CAAC;IACnB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,KAAK,EAAE,MAAM,GAAG,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC7E,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wBAAwB,EAAE,MAAM,CAAC;IACjC,uBAAuB,EAAE,OAAO,CAAC;IACjC,4BAA4B,EAAE,OAAO,CAAC;CACvC;AAED,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC"}
1
+ {"version":3,"file":"instances.d.ts","sourceRoot":"","sources":["../../../src/types/instances.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,cAAc,GAAG,YAAY,GAAG,UAAU,GAAG,SAAS,CAAC;AAClG,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErD,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,cAAc,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;IACxC,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,YAAY,CAAC;IACnB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,KAAK,EAAE,MAAM,GAAG,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC7E,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wBAAwB,EAAE,MAAM,CAAC;IACjC,uBAAuB,EAAE,OAAO,CAAC;IACjC,4BAA4B,EAAE,OAAO,CAAC;CACvC;AAED,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "botcast-sdk",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Official TypeScript/JavaScript SDK for Botcast WhatsApp Multi-Instance API Gateway",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",