@payhos/api 0.0.5 → 0.1.0

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.
Files changed (8) hide show
  1. package/README.md +7 -4
  2. package/models/index.d.ts +6 -0
  3. package/modules/sms/index.d.ts +2 -1
  4. package/modules/sms/index.js +5 -4
  5. package/modules/sms/index.js.map +1 -1
  6. package/package.json +1 -1
  7. package/test.js +7 -4
  8. package/test.js.map +1 -1
package/README.md CHANGED
@@ -34,12 +34,15 @@ const airtime = payhos.airtime;
34
34
  ## SMS
35
35
  ```javascript
36
36
  const sms = payhos.sms;
37
- const smsMessage = 'Hello there, this is a test message from PayHos SDK';
38
- const recipients = ['+2348166666666', '+2348055555555'];
39
- const isFlashMessage = false;
37
+ const data = {
38
+ message: 'Hello there, this is a test message from PayHos SDK',
39
+ recipients: ['+2348166666666', '+2348055555555'],
40
+ flash: false,
41
+ senderId: 'PayHos',
42
+ };
40
43
 
41
44
  // to send SMS
42
- sms.send(smsMessage, recipients, isFlashMessage).then(response => {
45
+ sms.send(data).then(response => {
43
46
  // message(s) sent successfully
44
47
  console.log(response);
45
48
  }).catch(err => {
package/models/index.d.ts CHANGED
@@ -7,3 +7,9 @@ export interface ApiResponse<T> {
7
7
  message?: string;
8
8
  stackTrace?: any;
9
9
  }
10
+ export interface PayHosSMSPayload {
11
+ message: string;
12
+ recipients: string[];
13
+ flash?: boolean;
14
+ senderId?: string;
15
+ }
package/modules/sms/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { PayHosApiClient } from '../../services/api.service';
2
+ import { PayHosSMSPayload } from '../../models';
2
3
  export declare class PayHosSMS {
3
4
  private client;
4
5
  constructor(c: PayHosApiClient);
5
- send(msg: string, recipients: string[], flash?: boolean): Promise<{}>;
6
+ send(data: PayHosSMSPayload): Promise<{}>;
6
7
  }
package/modules/sms/index.js CHANGED
@@ -6,11 +6,12 @@ class PayHosSMS {
6
6
  constructor(c) {
7
7
  this.client = c;
8
8
  }
9
- send(msg, recipients, flash) {
9
+ send(data) {
10
10
  const body = {
11
- message: msg,
12
- recipients: recipients.map(r => (0, utilities_service_1.formatPhoneNumber)(r)),
13
- flash,
11
+ message: data.message,
12
+ recipients: data.recipients.map(r => (0, utilities_service_1.formatPhoneNumber)(r)),
13
+ flash: data.flash || false,
14
+ senderId: data.senderId || 'PayHos',
14
15
  };
15
16
  return this.client.postApi('/sms/send', body);
16
17
  }
package/modules/sms/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/sms/index.ts"],"names":[],"mappings":";;;AAAA,wEAAqE;AAGrE,MAAa,SAAS;IAGpB,YAAY,CAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAEM,IAAI,CAAC,GAAW,EAAE,UAAoB,EAAE,KAAe;QAC5D,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,GAAG;YACZ,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,qCAAiB,EAAC,CAAC,CAAC,CAAC;YACrD,KAAK;SACN,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;CACF;AAhBD,8BAgBC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/sms/index.ts"],"names":[],"mappings":";;;AAAA,wEAAqE;AAIrE,MAAa,SAAS;IAGpB,YAAY,CAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAEM,IAAI,CAAC,IAAsB;QAChC,MAAM,IAAI,GAAqB;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,qCAAiB,EAAC,CAAC,CAAC,CAAC;YAC1D,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,KAAK;YAC1B,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ;SACpC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;CACF;AAjBD,8BAiBC"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@payhos/api",
3
3
  "description": "An API SDK to communicate with the PayHos API",
4
- "version": "0.0.5",
4
+ "version": "0.1.0",
5
5
  "main": "index.js",
6
6
  "typings": "index.d.ts",
7
7
  "scripts": {
package/test.js CHANGED
@@ -3,11 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const index_1 = require("./index");
4
4
  const payhos = new index_1.PayHos('<TOKEN_STRING>');
5
5
  const sms = payhos.sms;
6
- const smsMessage = 'Hello there, this is a test message from PayHos SDK';
7
- const recipients = ['+2348166666666', '+2348055555555'];
8
- const isFlashMessage = false;
6
+ const data = {
7
+ message: 'Hello there, this is a test message from PayHos SDK',
8
+ recipients: ['+2348166666666', '+2348055555555'],
9
+ flash: false,
10
+ senderId: 'PayHos',
11
+ };
9
12
  // to send SMS
10
- sms.send(smsMessage, recipients, isFlashMessage).then(response => {
13
+ sms.send(data).then(response => {
11
14
  // message(s) sent successfully
12
15
  console.log(response);
13
16
  }).catch(err => {
package/test.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;AAAA,mCAAiC;AAEjC,MAAM,MAAM,GAAG,IAAI,cAAM,CAAC,gBAAgB,CAAC,CAAC;AAE5C,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;AACvB,MAAM,UAAU,GAAG,qDAAqD,CAAC;AACzE,MAAM,UAAU,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;AACxD,MAAM,cAAc,GAAG,KAAK,CAAC;AAE7B,cAAc;AACd,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;IAC/D,+BAA+B;IAC/B,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACxB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;IACb,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;AAAA,mCAAiC;AAGjC,MAAM,MAAM,GAAG,IAAI,cAAM,CAAC,gBAAgB,CAAC,CAAC;AAE5C,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;AACvB,MAAM,IAAI,GAAqB;IAC7B,OAAO,EAAE,qDAAqD;IAC9D,UAAU,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IAChD,KAAK,EAAE,KAAK;IACZ,QAAQ,EAAE,QAAQ;CACnB,CAAC;AAEF,cAAc;AACd,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;IAC7B,+BAA+B;IAC/B,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACxB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;IACb,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC,CAAC,CAAC"}