🌿 Fern Regeneration -- November 27, 2023 (#156)

* SDK regeneration

* add back Changelog, Contributing, License and README

* make some modifications to the README

---------

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: dsinghvi <[email protected]>

.fernignore

@@ -0,0 +1,6 @@
+# Specify files that shouldn't be modified by Fern
+
+README.md
+LICENSE
+CHANGELOG.md
+CONTRIBUTING.md

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: ci
+
+on: [push]
+
+jobs:
+  compile:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Set up node
+        uses: actions/setup-node@v3
+
+      - name: Compile
+        run: yarn && yarn build
+
+  publish:
+    needs: [ compile ]
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Set up node
+        uses: actions/setup-node@v3
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build
+        run: yarn build
+
+      - name: Publish to npm
+        run: |
+          npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
+          npm publish --access public
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,66 +1,12 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-# next.js build output
-.next
-
-# Ignore JS files in src
-/src/**/*.js
-
-/lib
+node_modules
+.DS_Store
+/dist
+/Client.d.ts
+/Client.js
+/environments.d.ts
+/environments.js
+/index.d.ts
+/index.js
+/api
+/core
+/errors

.npmignore

@@ -0,0 +1,8 @@
+node_modules
+src
+.gitignore
+.github
+.fernignore
+.prettierrc.yml
+tsconfig.json
+yarn.lock

.prettierrc.yml

@@ -0,0 +1,2 @@
+tabWidth: 4
+printWidth: 120

README.md

@@ -1,6 +1,7 @@
 [![Courier: Your Complete Communication Stack](https://marketing-assets-public.s3.us-west-1.amazonaws.com/github_nodejs.png)](https://courier.com)
 
-[![npm version](https://badge.fury.io/js/%40trycourier%2Fcourier.svg)](https://badge.fury.io/js/%40trycourier%2Fcourier)
+[![npm shield](https://img.shields.io/npm/v/@trycourier/courier)](https://www.npmjs.com/package/@trycourier/courier)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/?utm_source=trycourier/courier-node/readme)
 
 This is the official node.js module for sending notifications with node.js with the [Courier](https://courier.com) REST API.
 
@@ -857,6 +858,12 @@ const userPreference = await courier.users.getUserPreferenceByTopic(
 );
 ```
 
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+
 ## License
 
 [MIT License](http://www.opensource.org/licenses/mit-license.php)

package.json

@@ -1,36 +1,26 @@
 {
-  "name": "@trycourier/courier",
-  "version": "5.7.0",
-  "description": "A node.js module for communicating with the Courier REST API.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "lib/**/*"
-  ],
-  "homepage": "https://github.com/trycourier/courier-node",
-  "repository": "[email protected]:trycourier/courier-node.git",
-  "author": "Courier <[email protected]>",
-  "license": "MIT",
-  "devDependencies": {
-    "@types/jest": "^24.0.15",
-    "@types/node": "^12.6.2",
-    "jest": "^24.8.0",
-    "jest-fetch-mock": "^3.0.3",
-    "prettier": "^1.18.2",
-    "ts-jest": "^24.0.2",
-    "tslint": "^5.18.0",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.5.3"
-  },
-  "scripts": {
-    "test": "jest --config jestconfig.json",
-    "lint": "tslint -p tsconfig.json",
-    "build": "tsc",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
-    "prepare": "yarn build",
-    "prepublishOnly": "yarn lint && yarn test"
-  },
-  "dependencies": {
-    "cross-fetch": "^3.1.5"
-  }
-}
+    "name": "@trycourier/courier",
+    "version": "v6.0.0",
+    "private": false,
+    "repository": "https://github.com/trycourier/courier-node",
+    "main": "./index.js",
+    "types": "./index.d.ts",
+    "scripts": {
+        "format": "prettier --write 'src/**/*.ts'",
+        "build": "tsc",
+        "prepack": "cp -rv dist/. ."
+    },
+    "dependencies": {
+        "url-join": "4.0.1",
+        "@types/url-join": "4.0.1",
+        "axios": "0.27.2",
+        "qs": "6.11.2",
+        "@types/qs": "6.9.8",
+        "js-base64": "3.7.2"
+    },
+    "devDependencies": {
+        "@types/node": "17.0.33",
+        "prettier": "2.7.1",
+        "typescript": "4.6.4"
+    }
+}