added ability to pass headers to client calls (#111)

* feat: added headers for select required endpoints

* fix: update Readme.md for new launchpad header example

* fix: incorrect param assignment

* fix: README typo

* fix: update summaries endpoint with header additions

* fix: remove change of broken headers being passed

* fix: update headers structure

* chore: update docs and example location

Author: mpatel18

README.md

@@ -48,6 +48,8 @@ const reference = referenceClient("api key");
 reference.tickers().then(/* your success handler */);
 ```
 
+#### [For Launchpad Examples and Usage, see Polygon Launchpad Examples](examples/rest/launchpad/README.md)
+
 ### [Websocket](https://polygon.io/docs/stocks/ws_getting-started)
 
 You can get preauthenticated [websocket clients](https://www.npmjs.com/package/websocket) for the 3 topics.

examples/rest/launchpad/README.md

@@ -0,0 +1,26 @@
+### [Launchpad REST API](https://polygon.io/docs/stocks/launchpad/getting-started)
+
+- import all the rest submodule or a specific submodule
+
+```typescript
+// The entire rest submodule
+import { restClient } from "@polygon.io/client-js";
+// A specific submodule, in this instance the reference client
+import { referenceClient } from "@polygon.io/client-js";
+
+// Headers required to use the Launchpad product.
+const edgeHeaders = {
+  // X-Polygon-Edge-ID is a required Launchpad header. It identifies the Edge User requesting data.
+  'X-Polygon-Edge-ID': sampleEdgeID,
+  // X-Polygon-Edge-IP-Address is a required Launchpad header. It denotes the originating IP Address of the Edge User requesting data.
+  'X-Polygon-Edge-IP-Address': 192.0.2.1,
+  // X-Polygon-Edge-User-Agent is an optional Launchpad header. It denotes the originating UserAgent of the Edge User requesting data.
+  'X-Polygon-Edge-User-Agent': useragent
+}
+
+const rest = restClient("api key", "https://api.polygon.io", edgeHeaders);
+rest.forex.previousClose("C:EURUSD").then(/* your success handler */);
+
+const reference = referenceClient("api key", "https://api.polygon.io", edgeHeaders);
+reference.tickers().then(/* your success handler */);
+```

examples/rest/launchpad/index.js

@@ -0,0 +1,18 @@
+import { restClient } from "@polygon.io/client-js";
+import { referenceClient } from "@polygon.io/client-js";
+
+// Headers required to use the Launchpad product.
+const edgeHeaders = {
+  // X-Polygon-Edge-ID is a required Launchpad header. It identifies the Edge User requesting data.
+  'X-Polygon-Edge-ID': 'sampleEdgeID',
+  // X-Polygon-Edge-IP-Address is a required Launchpad header. It denotes the originating IP Address of the Edge User requesting data.
+  'X-Polygon-Edge-IP-Address': '192.0.2.1',
+  // X-Polygon-Edge-User-Agent is an optional Launchpad header. It denotes the originating UserAgent of the Edge User requesting data.
+  'X-Polygon-Edge-User-Agent': 'useragent'
+}
+
+const rest = restClient("api key", "https://api.polygon.io", edgeHeaders);
+rest.forex.previousClose("C:EURUSD").then(/* your success handler */);
+
+const reference = referenceClient("api key", "https://api.polygon.io", edgeHeaders);
+reference.tickers().then(/* your success handler */);

websocket_example/advanced.js renamed to examples/websocket/advanced.js

@@ -1,6 +1,6 @@
 // CF: https://polygon.io/docs/crypto/get_v2_aggs_ticker__cryptoTicker__range__multiplier___timespan___from___to
 
-import { get } from "../transport/request";
+import { get, IHeaders } from "../transport/request";
 import { IAggsQuery, IAggs } from "../stocks/aggregates";
 
 export const aggregates = async (
@@ -11,11 +11,13 @@ export const aggregates = async (
   timespan: string,
   from: string,
   to: string,
-  query?: IAggsQuery
+  query?: IAggsQuery,
+  headers?: IHeaders,
 ): Promise<IAggs> =>
   get(
     `/v2/aggs/ticker/${ticker}/range/${multiplier}/${timespan}/${from}/${to}`,
     apikey,
     apiBase,
-    query
+    query,
+    headers
   );

websocket_example/index.js renamed to examples/websocket/index.js

@@ -1,4 +1,4 @@
-import { auth } from "../transport/request";
+import { auth, IHeaders } from "../transport/request";
 
 import { IAggsQuery, IAggs } from "../stocks/aggregates";
 import {
@@ -53,13 +53,14 @@ export interface ICryptoClient {
     timespan: string,
     from: string,
     to: string,
-    query?: IAggsQuery
+    query?: IAggsQuery,
+    headers?: IHeaders
   ) => Promise<IAggs>;
   aggregatesGroupedDaily: (
     date: string,
     query?: IAggsGroupedDailyQuery
   ) => Promise<IAggsGroupedDaily>;
-  summaries: (query?: ISummariesQuery) => Promise<ISummaries>;
+  summaries: (query?: ISummariesQuery, headers?: IHeaders) => Promise<ISummaries>;
   dailyOpenClose: (
     from: string,
     to: string,
@@ -89,11 +90,12 @@ export interface ICryptoClient {
 
 export const cryptoClient = (
   apiKey,
-  apiBase = "https://api.polygon.io"
+  apiBase = "https://api.polygon.io",
+  headers?: IHeaders
 ): ICryptoClient => ({
-  aggregates: auth(apiKey, aggregates, apiBase),
+  aggregates: auth(apiKey, aggregates, apiBase, headers),
   aggregatesGroupedDaily: auth(apiKey, aggregatesGroupedDaily, apiBase),
-  summaries: auth(apiKey, summaries, apiBase),
+  summaries: auth(apiKey, summaries, apiBase, headers),
   dailyOpenClose: auth(apiKey, dailyOpenClose, apiBase),
   lastTrade: auth(apiKey, lastTrade, apiBase),
   trades: auth(apiKey, trades, apiBase),

src/rest/crypto/aggregates.ts

@@ -1,16 +1,18 @@
-// CF: 
+// CF: https://polygon.io/docs/crypto/launchpad/get_v1_summaries
 
-import { get } from "../transport/request";
+import { get, IHeaders } from "../transport/request";
 import { ISummaries, ISummariesQuery } from "../stocks/summaries";
 
 export const summaries = async (
   apikey: string,
   apiBase: string,
-  query?: ISummariesQuery
+  query?: ISummariesQuery,
+  headers?: IHeaders
 ): Promise<ISummaries> =>
   get(
     `/v1/summaries`,
     apikey,
     apiBase,
-    query
+    query,
+    headers
   );

src/rest/crypto/index.ts

@@ -1,6 +1,6 @@
 // CF: https://polygon.io/docs/forex/get_v2_aggs_ticker__forexTicker__range__multiplier___timespan___from___to
 
-import { get } from "../transport/request";
+import { get, IHeaders } from "../transport/request";
 import { IAggsQuery, IAggs } from "../stocks/aggregates";
 
 export const aggregates = async (
@@ -11,11 +11,13 @@ export const aggregates = async (
   timespan: string,
   from: string,
   to: string,
-  query?: IAggsQuery
+  query?: IAggsQuery,
+  headers?: IHeaders
 ): Promise<IAggs> =>
   get(
     `/v2/aggs/ticker/${ticker}/range/${multiplier}/${timespan}/${from}/${to}`,
     apikey,
     apiBase,
-    query
+    query,
+    headers
   );

src/rest/crypto/summaries.ts

@@ -1,4 +1,4 @@
-import { auth } from "../transport/request";
+import { auth, IHeaders } from "../transport/request";
 
 import { IAggsQuery, IAggs } from "../stocks/aggregates";
 import {
@@ -47,13 +47,14 @@ export interface IForexClient {
     timespan: string,
     from: string,
     to: string,
-    query?: IAggsQuery
+    query?: IAggsQuery,
+    headers?: IHeaders
   ) => Promise<IAggs>;
   aggregatesGroupedDaily: (
     date: string,
     query?: IAggsGroupedDailyQuery
   ) => Promise<IAggsGroupedDaily>;
-  summaries: (query?: ISummariesQuery) => Promise<ISummaries>;
+  summaries: (query?: ISummariesQuery, headers?: IHeaders) => Promise<ISummaries>;
   conversion: (
     from: string,
     to: string,
@@ -79,11 +80,12 @@ export interface IForexClient {
 
 export const forexClient = (
   apiKey: string,
-  apiBase = "https://api.polygon.io"
+  apiBase = "https://api.polygon.io",
+  headers?: IHeaders
 ): IForexClient => ({
-  aggregates: auth(apiKey, aggregates, apiBase),
+  aggregates: auth(apiKey, aggregates, apiBase, headers),
   aggregatesGroupedDaily: auth(apiKey, aggregatesGroupedDaily, apiBase),
-  summaries: auth(apiKey, summaries, apiBase),
+  summaries: auth(apiKey, summaries, apiBase, headers),
   conversion: auth(apiKey, conversion, apiBase),
   quotes: auth(apiKey, quotes, apiBase),
   lastQuote: auth(apiKey, lastQuote, apiBase),