btrz-api-client 3.34.0 → 3.41.0

package/src/endpoints/webhooks/subscriptions.js

@@ -2,47 +2,47 @@ const { authorizationHeaders } = require("./../endpoints_helpers");
 
 function subscriptionsFactory({ client, internalAuthTokenProvider }) {
 
-  function all({ token, jwtToken, context, query = {} }) {
+  function all({ token, jwtToken, context, query = {}, headers }) {
     const queryObj = Object.assign({}, query, { context });
 
     return client({
       url: "/subscriptions",
       params: queryObj,
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider })
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
     });
   }
 
-  function getById({ token, jwtToken, id }) {
+  function getById({ token, jwtToken, id, headers }) {
     return client({
       url: `/subscriptions/${id}`,
       method: "get",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider })
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
     });
   }
 
-  function create({ token, jwtToken, subscription }) {
+  function create({ token, jwtToken, subscription, headers }) {
     return client({
       url: "/subscriptions",
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider }),
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
       data: subscription
     });
   }
 
-  function put({ token, jwtToken, id, subscription }) {
+  function put({ token, jwtToken, id, subscription, headers }) {
     return client({
       url: `/subscriptions/${id}`,
       method: "put",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider }),
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
       data: subscription
     });
   }
 
-  function deleteById({ token, jwtToken, id }) {
+  function deleteById({ token, jwtToken, id, headers }) {
     return client({
       url: `/subscriptions/${id}`,
       method: "delete",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider }),
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
     });
   }
 

package/src/endpoints/webhooks/undelivered.js

@@ -2,46 +2,46 @@ const { authorizationHeaders } = require("./../endpoints_helpers");
 
 function undeliveredFactory({ client, internalAuthTokenProvider }) {
 
-  function all({ token, jwtToken, context, query = {} }) {
+  function all({ token, jwtToken, context, query = {}, headers }) {
     const queryObj = Object.assign({}, query, { context });
 
     return client({
       url: "/undelivered",
       params: queryObj,
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider })
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
     });
   }
 
-  function getById({ token, jwtToken, id }) {
+  function getById({ token, jwtToken, id, headers }) {
     return client({
       url: `/undelivered/${id}`,
       method: "get",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider })
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
     });
   }
 
-  function patch({ token, jwtToken, operation }) {
+  function patch({ token, jwtToken, operation, headers }) {
     return client({
       url: "/undelivered",
       method: "patch",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider }),
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
       data: operation
     });
   }
 
-  function resend({ token, jwtToken, id }) {
+  function resend({ token, jwtToken, id, headers }) {
     return client({
       url: `/undelivered/${id}/retry`,
       method: "put",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider })
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
     });
   }
 
-  function resendAll({ token, jwtToken }) {
+  function resendAll({ token, jwtToken, headers }) {
     return client({
       url: `/undelivered/retry-all`,
       method: "put",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider })
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
     });
   }
 

package/src/endpoints/webhooks/webhooks.js

@@ -2,11 +2,11 @@ const { authorizationHeaders } = require("./../endpoints_helpers");
 
 function webhooksFactory({ client, internalAuthTokenProvider }) {
 
-  function emit({ token, jwtToken, webhook }) {
+  function emit({ token, jwtToken, webhook, headers }) {
     return client({
       url: "/emit",
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider }),
+      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
       data: webhook
     });
   }

package/test/endpoints/accounts/domains.test.js

@@ -0,0 +1,61 @@
+const {axiosMock, expectRequest} = require("../../test-helpers");
+const api = require("../../../src/client").createApiClient({baseURL: "http://test.com"});
+const {
+  expect
+} = require("chai");
+
+describe("accounts/domains", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should GET a list of domains", () => {
+    axiosMock.onGet("/domains").reply(expectRequest({
+      statusCode: 200,
+      token
+    }));
+    return api.accounts.domains.all({
+      token
+    }).then((httpResponse) => {
+      expect(httpResponse.status).eql(200);
+    });
+  });
+
+  it("should POST a new domains", () => {
+    const data = {
+      domain: "example1"
+    };
+    axiosMock.onPost("/domains").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.accounts.domains.create({
+      token,
+      jwtToken,
+      data
+    }).then((httpResponse) => {
+      expect(httpResponse.status).eql(200);
+    });
+  });
+
+  it("should DELETE a domain", () => {
+    const domain = "example1";
+
+    axiosMock.onDelete(`/domains/${domain}`).reply(expectRequest({
+      statusCode: 204,
+      token,
+      jwtToken
+    }));
+    return api.accounts.domains.remove({
+      domain,
+      token,
+      jwtToken
+    }).then((httpResponse) => {
+      expect(httpResponse.status).eql(204);
+    });
+  });
+});

package/test/endpoints/endpoints_helpers.test.js

@@ -56,5 +56,59 @@ describe("endpoints helpers", () => {
         "x-api-key": token
       });
     });
+
+    describe("specifing new headers with an object", () => {
+      it("should not override the provided 'token' in the 'x-api-key' field when provided in the headers object", () => {
+        const token = "E7excc6eXRKarIONB2gA";
+        const newHeaders = {
+          "test-header": "123",
+          "x-api-key": "overwritten?"
+        };
+
+        const headers = authorizationHeaders({token, headers: newHeaders});
+
+        expect(headers).to.deep.equal({
+          "x-api-key": token,
+          "test-header": "123"
+        });
+      });
+
+      it("should add the arbitrary headers passed by argument", () => {
+        const newHeaders = {
+          "test-header": "123",
+          "x-amzn-trace-id": "25342352"
+        };
+
+        const headers = authorizationHeaders({headers: newHeaders});
+
+        expect(headers).to.deep.equal({
+          "test-header": "123",
+          "x-amzn-trace-id": "25342352"
+        });
+      });
+
+      it("should not add anything if headers is not an object", () => {
+        const token = "E7excc6eXRKarIONB2gA";
+        const headers = authorizationHeaders({token, headers: 123});
+
+        expect(headers).to.deep.equal({
+          "x-api-key": token
+        });
+      });
+
+      it("should ignore x-amzn-trace-id if empty", () => {
+        const newHeaders = {
+          "test-header": "123",
+          "x-amzn-trace-id": ""
+        };
+
+        const headers = authorizationHeaders({headers: newHeaders});
+
+        expect(headers).to.not.haveOwnProperty("x-amzn-trace-id");
+        expect(headers).to.deep.equal({
+          "test-header": "123"
+        });
+      });
+    });
   });
 });

package/test/endpoints/operations/manifest.test.js

@@ -1,11 +1,15 @@
 const {expect} = require("chai");
-const { axiosMock, expectRequest } = require("./../../test-helpers"),
-  api = require("./../../../src/client").createApiClient({ baseURL: "http://test.com" });
+const {
+  axiosMock, expectRequest
+} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({
+  baseURL: "http://test.com"
+});
 
 describe("operations/manifest", () => {
-  const token = "I owe you a token",
-    jwtToken = "I owe you a JWT token",
-    providerId = "providerId";
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+  const providerId = "providerId";
 
   afterEach(() => {
     axiosMock.reset();
@@ -18,14 +22,22 @@ describe("operations/manifest", () => {
       scheduleId: "abc",
       date: "2017-10-10"
     };
-    axiosMock.onGet("/manifests").reply(expectRequest({ statusCode: 200, token }));
-    return api.operations.manifest.get({ token, jwtToken, query });
+    axiosMock.onGet("/manifests").reply(expectRequest({
+      statusCode: 200, token
+    }));
+    return api.operations.manifest.get({
+      token, jwtToken, query
+    });
   });
 
   it("should get a manifest by manifestId", () => {
     const manifestId = "manifestId";
-    axiosMock.onGet(`/manifests/${manifestId}`).reply(expectRequest({ statusCode: 200, token }));
-    return api.operations.manifest.getById({ token, jwtToken, manifestId });
+    axiosMock.onGet(`/manifests/${manifestId}`).reply(expectRequest({
+      statusCode: 200, token
+    }));
+    return api.operations.manifest.getById({
+      token, jwtToken, manifestId
+    });
   });
 
   it("should get many manifests", () => {
@@ -46,13 +58,21 @@ describe("operations/manifest", () => {
       productId: "productId",
       date: "2018-01-01"
     };
-    axiosMock.onGet("/outlook-manifests").reply(expectRequest({ statusCode: 200, token, jwtToken }));
-    return api.operations.manifest.outlook({ token, jwtToken, query });
+    axiosMock.onGet("/outlook-manifests").reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.operations.manifest.outlook({
+      token, jwtToken, query
+    });
   });
 
   it("should patch a manifest", () => {
-    axiosMock.onPatch("/manifests").reply(expectRequest({ statusCode: 200, token, jwtToken }));
-    return api.operations.manifest.patch({ token, jwtToken, query: {providerId}, operations: {op: "add_tickets", tickets: []} });
+    axiosMock.onPatch("/manifests").reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.operations.manifest.patch({
+      token, jwtToken, query: {providerId}, operations: {op: "add_tickets", tickets: []}
+    });
   });
 
   it("should save a manifest", () => {
@@ -61,8 +81,33 @@ describe("operations/manifest", () => {
       comments: "This is a comment!",
       capacity: 22
     };
-    axiosMock.onPut("/manifests").reply(expectRequest({ statusCode: 200, token, jwtToken }));
-    return api.operations.manifest.save({ token, jwtToken, providerId, data });
+    axiosMock.onPut("/manifests").reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.operations.manifest.save({
+      token, jwtToken, providerId, data
+    });
+  });
+
+  it("should add comment to the manifest", async () => {
+    const manifestId = "theId";
+    const data = {
+      comment: {
+        test: "The comment"
+      }
+    };
+
+    // optional query
+    const query = {
+      accountId: providerId,
+      routeId: "2349283409238429348",
+      scheduleId: "abc",
+      date: "2017-10-10"
+    };
+    axiosMock.onPut(`/manifests/${manifestId}/comments`).reply(expectRequest({statusCode: 201, token, jwtToken}));
+    const call = await api.operations.manifest.updateComment({token, jwtToken, manifestId, data, query});
+    expect(call.config.params).to.be.eql(query);
+    return call;
   });
 
   it("should add user to the manifest", async () => {
@@ -90,7 +135,11 @@ describe("operations/manifest", () => {
     const manifestId = "theId";
     const userId = "theUserId";
 
-    axiosMock.onDelete(`/manifests/${manifestId}/users/${userId}`).reply(expectRequest({ statusCode: 201, token, jwtToken }));
-    return api.operations.manifest.removeUser({ token, jwtToken, manifestId, userId });
+    axiosMock.onDelete(`/manifests/${manifestId}/users/${userId}`).reply(expectRequest({
+      statusCode: 201, token, jwtToken
+    }));
+    return api.operations.manifest.removeUser({
+      token, jwtToken, manifestId, userId
+    });
   });
 });