Add pagination samples and clean up

Author: devmandy

node-axios-pagination-examples/README.md

@@ -0,0 +1,17 @@
+# Purpose #
+The purpose of this code example is to demonstrate how to use [Node.js](https://nodejs.org/en/) 
+and the [axios](https://github.com/axios/axios) library to make HTTP requests
+to the ShipEngine API. This example demonstrate using pagination in a POST
+to the `/labels` endpoint.
+
+# Pre-Requisites #
+This example assumes that you have already connected a UPS carrier and have a basic understanding of Javascript.
+
+# Run It! #
+1. Install [Node.js](https://nodejs.org/en/)
+2. Install [NPM](https://nodejs.org/en/download/package-manager/).
+3. Install pre-requisites by running `npm install` from the top-level directory.
+3. Replace `'<your api-key>'` with a valid API key for your ShipEngine account.
+4. Run the script by running `npm run <sript>`. Example scripts included:
+    * `loop` - This runs `loop_through_pages.js`. This script demonstrates looping through all the pages.
+    * `link` - This runs `using_next_link.js`. This script demonstrates using the `next` link to loop through all pages. 

node-axios-pagination-examples/loop_through_pages.js

@@ -0,0 +1,48 @@
+const axios = require('axios');
+
+// Set up headers to use with axios HTTP client
+const headers = {
+    'api-key': '<YOUR_API_KEY>',
+    'Content-Type': 'application/json',
+};
+
+// Create axios config
+const config = {
+    headers,
+    baseURL:  'https://api.shipengine.com',
+    validateStatus(){
+        return true;
+    }
+};
+
+async function getLabels() {
+
+    // Make the initial request
+    let getLabelsResponse = await axios.get('/v1/labels', config);
+    const { pages } = getLabelsResponse.data;
+    console.log(`There are ${pages} pages of data in this response.`);
+
+
+    // getLabelsResponse will contain the first page of data in the response
+    // Add code to use that data in your application here
+
+    console.log(`This is page ${getLabelsResponse.data.page}`)
+
+    // Loop through the paginated data using URL query parameter
+    for(let i=2; i <= pages; i++) {
+
+        // Add url params to existing config object.
+        // You can also add page_size if you wish to change the default page size, which is 25.
+        config.params = {
+            page: i,
+        };
+
+        getLabelsResponse = await axios.get('/v1/labels', config);
+        // Add code to use this page of data in your application
+      console.log(`This is page ${getLabelsResponse.data.page}`);
+    }
+}
+
+getLabels().catch( (e) => {
+    console.log(`There was an error: ${e.message}`);
+});

node-axios-pagination-examples/package-lock.json

@@ -0,0 +1,17 @@
+{
+  "name": "node-axios-manifest",
+  "version": "1.0.0",
+  "description": "",
+  "main": "using_next_link.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "loop": "node loop_through_pages.js",
+    "link": "node using_next_link.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^0.21.0"
+  }
+}

node-axios-pagination-examples/package.json

@@ -0,0 +1,39 @@
+const axios = require('axios');
+
+// Set up headers to use with axios HTTP client
+const headers = {
+    'api-key': '<YOUR_API_KEY>',
+    'Content-Type': 'application/json',
+};
+
+// Create axios config
+const config = {
+    headers,
+    baseURL:  'https://api.shipengine.com',
+    validateStatus(){
+        return true;
+    }
+};
+
+async function getLabels() {
+
+    // Make the initial request
+    let getLabelsResponse = await axios.get('/v1/labels', config);
+
+    // getLabelsResponse will contain the first page of data in the response
+    // Add code to use that data in your application
+
+    console.log(`This is page ${getLabelsResponse.data.page}`)
+
+    // Loop through the paginated data using the next link to get the rest of the data.
+    // As long as there is a next href, we have more data.
+    while (getLabelsResponse.data.links.next.href) {
+        getLabelsResponse = await axios.get(getLabelsResponse.data.links.next.href, config);
+        // Add code to use this page of data in your application
+        console.log(`This is page ${getLabelsResponse.data.page}`)
+    }
+}
+
+getLabels().catch( (e) => {
+    console.log(`There was an error: ${e.message}`);
+});