[MOB-11346] exposing baseIterableRequest (#489)

* [MOB-11346] exposing baseIterableRequest

* Update README.md

Co-authored-by: lauren-mulkern <[email protected]>

* Update README.md

Co-authored-by: lauren-mulkern <[email protected]>

* [MOB-11346] adding example for readme

---------

Co-authored-by: lauren-mulkern <[email protected]>

Author: Geoff-at-iterable

README.md

@@ -94,6 +94,7 @@ Iterable's API, see the [API Overview](https://support.iterable.com/hc/articles/
 
 | Method Name                                                                       | Description |
 | --------------------------------------------------------------------------------- | ----------- |
+| [`baseIterableRequest`](#baseiterablerequest)                                     |  Executes a custom API request to Iterable, using an extended request configuration for validation and optional features. Valid for web API keys and their supported endpoints only. [Learn more](https://support.iterable.com/hc/articles/360043464871-API-Keys#client-side-keys)  |
 | [`filterHiddenInAppMessages`](#filterhiddeninappmessages)                         | From an array of passed-in in-app messages, filters out messages that have already been read, messages that should not be displayed, and messages that only contain JSON data. |
 | [`filterOnlyReadAndNeverTriggerMessages`](#filteronlyreadandnevertriggermessages) | From an array of passed-in in-app messages, filters out messages that have already been read and messages that should not be displayed. |
 | [`getInAppMessages`](#getInAppMessages)                                           | Fetches in-app messages by calling [`GET /api/inApp/getMessages`](https://support.iterable.com/hc/articles/204780579#get-api-inapp-getmessages). |
@@ -127,6 +128,37 @@ Notes:
   automatically track `inAppClick`  events or handle custom CTAs. This will impact
   analytics for all Safari and mobile iOS users.
 
+## `baseIterableRequest`
+
+Executes a custom API request to Iterable, using an extended request configuration for validation and optional features. Valid for web API keys and their supported endpoints only. [Learn more](https://support.iterable.com/hc/articles/360043464871-API-Keys#client-side-keys) 
+
+```ts
+function baseIterableRequest(
+  payload: ExtendedRequestConfig
+): IterablePromise<T = any>
+```
+
+Parameters:
+- `payload` - A request config see [`ExtendedRequestConfig`](#ExtendedRequestConfig)
+
+Example:
+```ts
+baseIterableRequest<IterableResponse>({
+        method: 'GET',
+        url: '/embedded-messaging/messages',
+        params: {
+          placementIds: [1, 2, 3],
+          platform: 'Web',
+          sdkVersion: '1.0.0',
+          packageName: 'pkgName'
+        }
+      });
+```
+
+See also:
+
+- [`IterablePromise`](#iterablepromise)
+
 ## `filterHiddenInAppMessages`
 
 From an array of passed-in in-app messages, filters out messages that have
@@ -1793,6 +1825,20 @@ type IterableErrorStatus =
   | 'InvalidJwtPayload';
 ```
 
+## `ExtendedRequestConfig`
+
+An extension of the AxiosRequestConfig
+
+```ts
+  interface ExtendedRequestConfig extends AxiosRequestConfig {
+    validation?: {
+      data?: AnySchema;
+      params?: AnySchema;
+    };
+    sendBeacon?: boolean;
+  }
+```
+
 ## `IterablePromise`
 
 A promise.

src/index.ts

@@ -8,6 +8,7 @@ export * from './embedded';
 export * from './components/card';
 export * from './components/banner';
 export * from './components/notification';
+export { baseIterableRequest } from './request';
 export { config } from './utils/config';
 export { IterableConfig } from './utils/IterableConfig';