vibes-react-native 1.0.0 → 1.1.1

package/lib/module/index.js

@@ -7,25 +7,137 @@ const Vibes = NativeModules.Vibes ? NativeModules.Vibes : new Proxy({}, {
   get() {
     throw new Error(LINKING_ERROR);
   }
-
 });
+/**
+ * Register this device with the Vibes platform
+ *
+ * @return {Promise<DeviceResponse>}
+ */
 export function registerDevice() {
   return Vibes.registerDevice();
 }
+/**
+ * Unregister this device with the Vibes platform
+ *
+ * @return {Promise<void>}
+ */
 export function unregisterDevice() {
   return Vibes.unregisterDevice();
 }
+
+/**
+ * Register this device to receive push notifications
+ *
+ * @return {Promise<void>}
+ */
 export function registerPush() {
   return Vibes.registerPush();
 }
+
+/**
+* Unregister the device from receiving push notifications
+*
+* @return {Promise<void>}
+*/
+export function unregisterPush() {
+  return Vibes.registerPush();
+}
+
+/**
+ * Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token
+ *
+ * @return {Promise<DeviceInfoResponse>}
+ */
 export function getVibesDeviceInfo() {
   return Vibes.getVibesDeviceInfo();
 }
+
+/**
+ * Updates the Vibes platform with changes to the device since the last time device information was submitted.
+ *
+ * @param updateCredential - if true, the authentication token will be refreshed. Unless required, pass false here.
+ * @param latitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @param longitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @returns {Promise<void>}
+ */
 export function updateDevice(updateCredential, latitude, longitude) {
   return Vibes.updateDevice(updateCredential, latitude, longitude);
 }
+
+/**
+ * Associate an external ID with the current person.
+ *
+ * @param {string} externalPersonId
+ * @return {Promise<void>}
+ */
 export function associatePerson(externalPersonId) {
   return Vibes.associatePerson(externalPersonId);
 }
+
+/**
+ * Fetches the PersonResponse associated with this device currently
+ *
+ * @return {Promise<PersonResponse>}
+ */
+export function getPerson() {
+  return Vibes.getPerson();
+}
+/**
+ * Fetches an array of inbox messages for the person associated with this device.
+ *
+ * @return {Promise<InboxMessage[]>}
+ */
+export function fetchInboxMessages() {
+  return Vibes.fetchInboxMessages();
+}
+
+/**
+ * Fetches a single inbox message by it's id.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>}
+ */
+export function fetchInboxMessage(message_uid) {
+  return Vibes.fetchInboxMessage(message_uid);
+}
+
+/**
+ * Marks an inbox message as read.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with read field updated
+ */
+export function markInboxMessageAsRead(message_uid) {
+  return Vibes.markInboxMessageAsRead(message_uid);
+}
+
+/**
+ * Marks an inbox message as expired using message_uid and the expiry date supplied. Uses current date as expiry date
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with expires_at date updated
+ */
+export function expireInboxMessage(message_uid) {
+  return Vibes.expireInboxMessage(message_uid);
+}
+
+/**
+ * Records an event for when the user opens an inbox message.
+ *
+ * @param inboxMap json map of the InboxMessage
+ * @return {Promise<void>}
+ */
+export function onInboxMessageOpen(inboxMap) {
+  return Vibes.onInboxMessageOpen(inboxMap);
+}
+
+/**
+ * Records an event for when the user fetches a list of inbox messages.
+ *
+ * @return {Promise<void>}
+ */
+export function onInboxMessagesFetched() {
+  return Vibes.onInboxMessagesFetched();
+}
 export default Vibes;
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","Vibes","Proxy","get","Error","registerDevice","unregisterDevice","registerPush","getVibesDeviceInfo","updateDevice","updateCredential","latitude","longitude","associatePerson","externalPersonId"],"sources":["index.tsx"],"sourcesContent":["import { NativeModules, Platform } from 'react-native';\n\nconst LINKING_ERROR =\n  `The package 'vibes-react-native' doesn't seem to be linked. Make sure: \\n\\n` +\n  Platform.select({ ios: \"- You have run 'pod install'\\n\", default: '' }) +\n  '- You rebuilt the app after installing the package\\n' +\n  '- You are not using Expo managed workflow\\n';\n\nconst Vibes = NativeModules.Vibes\n  ? NativeModules.Vibes\n  : new Proxy(\n      {},\n      {\n        get() {\n          throw new Error(LINKING_ERROR);\n        },\n      }\n    );\n\nexport function registerDevice(): Promise<any> {\n  return Vibes.registerDevice();\n}\n\nexport function unregisterDevice(): Promise<any> {\n  return Vibes.unregisterDevice();\n}\n\nexport function registerPush(): Promise<any> {\n  return Vibes.registerPush();\n}\n\nexport function getVibesDeviceInfo(): Promise<any> {\n  return Vibes.getVibesDeviceInfo();\n}\n\nexport function updateDevice(\n  updateCredential: boolean,\n  latitude: number,\n  longitude: number\n): Promise<any> {\n  return Vibes.updateDevice(updateCredential, latitude, longitude);\n}\n\nexport function associatePerson(externalPersonId: string): Promise<any> {\n  return Vibes.associatePerson(externalPersonId);\n}\n\nexport default Vibes;\n"],"mappings":"AAAA,SAASA,aAAT,EAAwBC,QAAxB,QAAwC,cAAxC;AAEA,MAAMC,aAAa,GAChB,6EAAD,GACAD,QAAQ,CAACE,MAAT,CAAgB;EAAEC,GAAG,EAAE,gCAAP;EAAyCC,OAAO,EAAE;AAAlD,CAAhB,CADA,GAEA,sDAFA,GAGA,6CAJF;AAMA,MAAMC,KAAK,GAAGN,aAAa,CAACM,KAAd,GACVN,aAAa,CAACM,KADJ,GAEV,IAAIC,KAAJ,CACE,EADF,EAEE;EACEC,GAAG,GAAG;IACJ,MAAM,IAAIC,KAAJ,CAAUP,aAAV,CAAN;EACD;;AAHH,CAFF,CAFJ;AAWA,OAAO,SAASQ,cAAT,GAAwC;EAC7C,OAAOJ,KAAK,CAACI,cAAN,EAAP;AACD;AAED,OAAO,SAASC,gBAAT,GAA0C;EAC/C,OAAOL,KAAK,CAACK,gBAAN,EAAP;AACD;AAED,OAAO,SAASC,YAAT,GAAsC;EAC3C,OAAON,KAAK,CAACM,YAAN,EAAP;AACD;AAED,OAAO,SAASC,kBAAT,GAA4C;EACjD,OAAOP,KAAK,CAACO,kBAAN,EAAP;AACD;AAED,OAAO,SAASC,YAAT,CACLC,gBADK,EAELC,QAFK,EAGLC,SAHK,EAIS;EACd,OAAOX,KAAK,CAACQ,YAAN,CAAmBC,gBAAnB,EAAqCC,QAArC,EAA+CC,SAA/C,CAAP;AACD;AAED,OAAO,SAASC,eAAT,CAAyBC,gBAAzB,EAAiE;EACtE,OAAOb,KAAK,CAACY,eAAN,CAAsBC,gBAAtB,CAAP;AACD;AAED,eAAeb,KAAf"}
+{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","Vibes","Proxy","get","Error","registerDevice","unregisterDevice","registerPush","unregisterPush","getVibesDeviceInfo","updateDevice","updateCredential","latitude","longitude","associatePerson","externalPersonId","getPerson","fetchInboxMessages","fetchInboxMessage","message_uid","markInboxMessageAsRead","expireInboxMessage","onInboxMessageOpen","inboxMap","onInboxMessagesFetched"],"sources":["index.tsx"],"sourcesContent":["import { NativeModules, Platform } from 'react-native';\n\nconst LINKING_ERROR =\n  `The package 'vibes-react-native' doesn't seem to be linked. Make sure: \\n\\n` +\n  Platform.select({ ios: \"- You have run 'pod install'\\n\", default: '' }) +\n  '- You rebuilt the app after installing the package\\n' +\n  '- You are not using Expo managed workflow\\n';\n\nconst Vibes = NativeModules.Vibes\n  ? NativeModules.Vibes\n  : new Proxy(\n    {},\n    {\n      get() {\n        throw new Error(LINKING_ERROR);\n      },\n    }\n  );\n\nexport interface DeviceResponse {\n  device_id?: string;\n}\nexport interface DeviceInfoResponse extends DeviceResponse {\n  push_token?: string;\n}\n\nexport interface PersonResponse {\n  person_key?: string;\n  external_person_id?: string;\n}\n\nexport interface InboxMessage {\n  content?: string;\n  created_at?: string;\n  expires_at?: string;\n  message_uid?: string;\n  read?: boolean;\n  subject?: string;\n  detail?: string;\n  collapse_key?: string;\n  apprefdata?: any;\n  images?: any;\n  inbox_custom_data: any;\n}\n\n/**\n * Register this device with the Vibes platform\n *\n * @return {Promise<DeviceResponse>}\n */\nexport function registerDevice(): Promise<DeviceResponse> {\n  return Vibes.registerDevice();\n}\n/**\n * Unregister this device with the Vibes platform\n *\n * @return {Promise<void>}\n */\nexport function unregisterDevice(): Promise<void> {\n  return Vibes.unregisterDevice();\n}\n\n/**\n * Register this device to receive push notifications\n *\n * @return {Promise<void>}\n */\nexport function registerPush(): Promise<void> {\n  return Vibes.registerPush();\n}\n\n/**\n* Unregister the device from receiving push notifications\n*\n* @return {Promise<void>}\n*/\nexport function unregisterPush(): Promise<void> {\n  return Vibes.registerPush();\n}\n\n/**\n * Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token\n *\n * @return {Promise<DeviceInfoResponse>}\n */\nexport function getVibesDeviceInfo(): Promise<DeviceInfoResponse> {\n  return Vibes.getVibesDeviceInfo();\n}\n\n/**\n * Updates the Vibes platform with changes to the device since the last time device information was submitted.\n *\n * @param updateCredential - if true, the authentication token will be refreshed. Unless required, pass false here.\n * @param latitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0\n * @param longitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0\n * @returns {Promise<void>}\n */\nexport function updateDevice(\n  updateCredential: boolean,\n  latitude: number,\n  longitude: number\n): Promise<void> {\n  return Vibes.updateDevice(updateCredential, latitude, longitude);\n}\n\n/**\n * Associate an external ID with the current person.\n *\n * @param {string} externalPersonId\n * @return {Promise<void>}\n */\nexport function associatePerson(externalPersonId: string): Promise<void> {\n  return Vibes.associatePerson(externalPersonId);\n}\n\n/**\n * Fetches the PersonResponse associated with this device currently\n *\n * @return {Promise<PersonResponse>}\n */\nexport function getPerson(): Promise<PersonResponse> {\n  return Vibes.getPerson();\n}\n/**\n * Fetches an array of inbox messages for the person associated with this device.\n *\n * @return {Promise<InboxMessage[]>}\n */\nexport function fetchInboxMessages(): Promise<InboxMessage[]> {\n  return Vibes.fetchInboxMessages();\n}\n\n/**\n * Fetches a single inbox message by it's id.\n *\n * @param {string} message_uid\n * @return {Promise<InboxMessage>}\n */\nexport function fetchInboxMessage(message_uid: string): Promise<InboxMessage> {\n  return Vibes.fetchInboxMessage(message_uid);\n}\n\n/**\n * Marks an inbox message as read.\n *\n * @param {string} message_uid\n * @return {Promise<InboxMessage>} an updated version of the InboxMessage with read field updated\n */\nexport function markInboxMessageAsRead(message_uid: string): Promise<InboxMessage> {\n  return Vibes.markInboxMessageAsRead(message_uid);\n}\n\n/**\n * Marks an inbox message as expired using message_uid and the expiry date supplied. Uses current date as expiry date\n *\n * @param {string} message_uid\n * @return {Promise<InboxMessage>} an updated version of the InboxMessage with expires_at date updated\n */\nexport function expireInboxMessage(message_uid: string): Promise<InboxMessage> {\n  return Vibes.expireInboxMessage(message_uid);\n}\n\n/**\n * Records an event for when the user opens an inbox message.\n *\n * @param inboxMap json map of the InboxMessage\n * @return {Promise<void>}\n */\nexport function onInboxMessageOpen(inboxMap: InboxMessage): Promise<void> {\n  return Vibes.onInboxMessageOpen(inboxMap);\n}\n\n/**\n * Records an event for when the user fetches a list of inbox messages.\n *\n * @return {Promise<void>}\n */\nexport function onInboxMessagesFetched(): Promise<void> {\n  return Vibes.onInboxMessagesFetched();\n}\n\nexport default Vibes;\n"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAEtD,MAAMC,aAAa,GAChB,6EAA4E,GAC7ED,QAAQ,CAACE,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,6CAA6C;AAE/C,MAAMC,KAAK,GAAGN,aAAa,CAACM,KAAK,GAC7BN,aAAa,CAACM,KAAK,GACnB,IAAIC,KAAK,CACT,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACP,aAAa,CAAC;EAChC;AACF,CACF,CAAC;AA4BH;AACA;AACA;AACA;AACA;AACA,OAAO,SAASQ,cAAcA,CAAA,EAA4B;EACxD,OAAOJ,KAAK,CAACI,cAAc,CAAC,CAAC;AAC/B;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAAA,EAAkB;EAChD,OAAOL,KAAK,CAACK,gBAAgB,CAAC,CAAC;AACjC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAAA,EAAkB;EAC5C,OAAON,KAAK,CAACM,YAAY,CAAC,CAAC;AAC7B;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAAA,EAAkB;EAC9C,OAAOP,KAAK,CAACM,YAAY,CAAC,CAAC;AAC7B;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,kBAAkBA,CAAA,EAAgC;EAChE,OAAOR,KAAK,CAACQ,kBAAkB,CAAC,CAAC;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAC1BC,gBAAyB,EACzBC,QAAgB,EAChBC,SAAiB,EACF;EACf,OAAOZ,KAAK,CAACS,YAAY,CAACC,gBAAgB,EAAEC,QAAQ,EAAEC,SAAS,CAAC;AAClE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,gBAAwB,EAAiB;EACvE,OAAOd,KAAK,CAACa,eAAe,CAACC,gBAAgB,CAAC;AAChD;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAAA,EAA4B;EACnD,OAAOf,KAAK,CAACe,SAAS,CAAC,CAAC;AAC1B;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAAA,EAA4B;EAC5D,OAAOhB,KAAK,CAACgB,kBAAkB,CAAC,CAAC;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,iBAAiBA,CAACC,WAAmB,EAAyB;EAC5E,OAAOlB,KAAK,CAACiB,iBAAiB,CAACC,WAAW,CAAC;AAC7C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,sBAAsBA,CAACD,WAAmB,EAAyB;EACjF,OAAOlB,KAAK,CAACmB,sBAAsB,CAACD,WAAW,CAAC;AAClD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,kBAAkBA,CAACF,WAAmB,EAAyB;EAC7E,OAAOlB,KAAK,CAACoB,kBAAkB,CAACF,WAAW,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,kBAAkBA,CAACC,QAAsB,EAAiB;EACxE,OAAOtB,KAAK,CAACqB,kBAAkB,CAACC,QAAQ,CAAC;AAC3C;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,sBAAsBA,CAAA,EAAkB;EACtD,OAAOvB,KAAK,CAACuB,sBAAsB,CAAC,CAAC;AACvC;AAEA,eAAevB,KAAK"}

package/lib/typescript/index.d.ts

@@ -1,8 +1,117 @@
 declare const Vibes: any;
-export declare function registerDevice(): Promise<any>;
-export declare function unregisterDevice(): Promise<any>;
-export declare function registerPush(): Promise<any>;
-export declare function getVibesDeviceInfo(): Promise<any>;
-export declare function updateDevice(updateCredential: boolean, latitude: number, longitude: number): Promise<any>;
-export declare function associatePerson(externalPersonId: string): Promise<any>;
+export interface DeviceResponse {
+    device_id?: string;
+}
+export interface DeviceInfoResponse extends DeviceResponse {
+    push_token?: string;
+}
+export interface PersonResponse {
+    person_key?: string;
+    external_person_id?: string;
+}
+export interface InboxMessage {
+    content?: string;
+    created_at?: string;
+    expires_at?: string;
+    message_uid?: string;
+    read?: boolean;
+    subject?: string;
+    detail?: string;
+    collapse_key?: string;
+    apprefdata?: any;
+    images?: any;
+    inbox_custom_data: any;
+}
+/**
+ * Register this device with the Vibes platform
+ *
+ * @return {Promise<DeviceResponse>}
+ */
+export declare function registerDevice(): Promise<DeviceResponse>;
+/**
+ * Unregister this device with the Vibes platform
+ *
+ * @return {Promise<void>}
+ */
+export declare function unregisterDevice(): Promise<void>;
+/**
+ * Register this device to receive push notifications
+ *
+ * @return {Promise<void>}
+ */
+export declare function registerPush(): Promise<void>;
+/**
+* Unregister the device from receiving push notifications
+*
+* @return {Promise<void>}
+*/
+export declare function unregisterPush(): Promise<void>;
+/**
+ * Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token
+ *
+ * @return {Promise<DeviceInfoResponse>}
+ */
+export declare function getVibesDeviceInfo(): Promise<DeviceInfoResponse>;
+/**
+ * Updates the Vibes platform with changes to the device since the last time device information was submitted.
+ *
+ * @param updateCredential - if true, the authentication token will be refreshed. Unless required, pass false here.
+ * @param latitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @param longitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @returns {Promise<void>}
+ */
+export declare function updateDevice(updateCredential: boolean, latitude: number, longitude: number): Promise<void>;
+/**
+ * Associate an external ID with the current person.
+ *
+ * @param {string} externalPersonId
+ * @return {Promise<void>}
+ */
+export declare function associatePerson(externalPersonId: string): Promise<void>;
+/**
+ * Fetches the PersonResponse associated with this device currently
+ *
+ * @return {Promise<PersonResponse>}
+ */
+export declare function getPerson(): Promise<PersonResponse>;
+/**
+ * Fetches an array of inbox messages for the person associated with this device.
+ *
+ * @return {Promise<InboxMessage[]>}
+ */
+export declare function fetchInboxMessages(): Promise<InboxMessage[]>;
+/**
+ * Fetches a single inbox message by it's id.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>}
+ */
+export declare function fetchInboxMessage(message_uid: string): Promise<InboxMessage>;
+/**
+ * Marks an inbox message as read.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with read field updated
+ */
+export declare function markInboxMessageAsRead(message_uid: string): Promise<InboxMessage>;
+/**
+ * Marks an inbox message as expired using message_uid and the expiry date supplied. Uses current date as expiry date
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with expires_at date updated
+ */
+export declare function expireInboxMessage(message_uid: string): Promise<InboxMessage>;
+/**
+ * Records an event for when the user opens an inbox message.
+ *
+ * @param inboxMap json map of the InboxMessage
+ * @return {Promise<void>}
+ */
+export declare function onInboxMessageOpen(inboxMap: InboxMessage): Promise<void>;
+/**
+ * Records an event for when the user fetches a list of inbox messages.
+ *
+ * @return {Promise<void>}
+ */
+export declare function onInboxMessagesFetched(): Promise<void>;
 export default Vibes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vibes-react-native",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "The React Native plugin for the Vibes Mobile SDKs",
   "author": "Vibes",
   "main": "lib/commonjs/index",

package/src/index.tsx

@@ -9,40 +9,174 @@ const LINKING_ERROR =
 const Vibes = NativeModules.Vibes
   ? NativeModules.Vibes
   : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
-
-export function registerDevice(): Promise<any> {
-  return Vibes.registerDevice();
+    {},
+    {
+      get() {
+        throw new Error(LINKING_ERROR);
+      },
+    }
+  );
+
+export interface DeviceResponse {
+  device_id?: string;
+}
+export interface DeviceInfoResponse extends DeviceResponse {
+  push_token?: string;
+}
+
+export interface PersonResponse {
+  person_key?: string;
+  external_person_id?: string;
+}
+
+export interface InboxMessage {
+  content?: string;
+  created_at?: string;
+  expires_at?: string;
+  message_uid?: string;
+  read?: boolean;
+  subject?: string;
+  detail?: string;
+  collapse_key?: string;
+  apprefdata?: any;
+  images?: any;
+  inbox_custom_data: any;
 }
 
-export function unregisterDevice(): Promise<any> {
+/**
+ * Register this device with the Vibes platform
+ *
+ * @return {Promise<DeviceResponse>}
+ */
+export function registerDevice(): Promise<DeviceResponse> {
+  return Vibes.registerDevice();
+}
+/**
+ * Unregister this device with the Vibes platform
+ *
+ * @return {Promise<void>}
+ */
+export function unregisterDevice(): Promise<void> {
   return Vibes.unregisterDevice();
 }
 
-export function registerPush(): Promise<any> {
+/**
+ * Register this device to receive push notifications
+ *
+ * @return {Promise<void>}
+ */
+export function registerPush(): Promise<void> {
+  return Vibes.registerPush();
+}
+
+/**
+* Unregister the device from receiving push notifications
+*
+* @return {Promise<void>}
+*/
+export function unregisterPush(): Promise<void> {
   return Vibes.registerPush();
 }
 
-export function getVibesDeviceInfo(): Promise<any> {
+/**
+ * Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token
+ *
+ * @return {Promise<DeviceInfoResponse>}
+ */
+export function getVibesDeviceInfo(): Promise<DeviceInfoResponse> {
   return Vibes.getVibesDeviceInfo();
 }
 
+/**
+ * Updates the Vibes platform with changes to the device since the last time device information was submitted.
+ *
+ * @param updateCredential - if true, the authentication token will be refreshed. Unless required, pass false here.
+ * @param latitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @param longitude - if you collect geolocation information, then pass the latitude here. Otherwise, pass 0
+ * @returns {Promise<void>}
+ */
 export function updateDevice(
   updateCredential: boolean,
   latitude: number,
   longitude: number
-): Promise<any> {
+): Promise<void> {
   return Vibes.updateDevice(updateCredential, latitude, longitude);
 }
 
-export function associatePerson(externalPersonId: string): Promise<any> {
+/**
+ * Associate an external ID with the current person.
+ *
+ * @param {string} externalPersonId
+ * @return {Promise<void>}
+ */
+export function associatePerson(externalPersonId: string): Promise<void> {
   return Vibes.associatePerson(externalPersonId);
 }
 
+/**
+ * Fetches the PersonResponse associated with this device currently
+ *
+ * @return {Promise<PersonResponse>}
+ */
+export function getPerson(): Promise<PersonResponse> {
+  return Vibes.getPerson();
+}
+/**
+ * Fetches an array of inbox messages for the person associated with this device.
+ *
+ * @return {Promise<InboxMessage[]>}
+ */
+export function fetchInboxMessages(): Promise<InboxMessage[]> {
+  return Vibes.fetchInboxMessages();
+}
+
+/**
+ * Fetches a single inbox message by it's id.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>}
+ */
+export function fetchInboxMessage(message_uid: string): Promise<InboxMessage> {
+  return Vibes.fetchInboxMessage(message_uid);
+}
+
+/**
+ * Marks an inbox message as read.
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with read field updated
+ */
+export function markInboxMessageAsRead(message_uid: string): Promise<InboxMessage> {
+  return Vibes.markInboxMessageAsRead(message_uid);
+}
+
+/**
+ * Marks an inbox message as expired using message_uid and the expiry date supplied. Uses current date as expiry date
+ *
+ * @param {string} message_uid
+ * @return {Promise<InboxMessage>} an updated version of the InboxMessage with expires_at date updated
+ */
+export function expireInboxMessage(message_uid: string): Promise<InboxMessage> {
+  return Vibes.expireInboxMessage(message_uid);
+}
+
+/**
+ * Records an event for when the user opens an inbox message.
+ *
+ * @param inboxMap json map of the InboxMessage
+ * @return {Promise<void>}
+ */
+export function onInboxMessageOpen(inboxMap: InboxMessage): Promise<void> {
+  return Vibes.onInboxMessageOpen(inboxMap);
+}
+
+/**
+ * Records an event for when the user fetches a list of inbox messages.
+ *
+ * @return {Promise<void>}
+ */
+export function onInboxMessagesFetched(): Promise<void> {
+  return Vibes.onInboxMessagesFetched();
+}
+
 export default Vibes;

package/vibes-react-native.podspec

@@ -16,5 +16,5 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "VibesPush", "4.5.0"
+  s.dependency "VibesPush", "4.7.0"
 end