tremendous 2.2.0 → 3.0.0

package/README.md

@@ -1,7 +1,9 @@
-tremendous
-==============
+A node.js client library for the [Tremendous API][docs].
 
-A node.js client library for the [Tremendous API][1].
+> [!NOTE]
+> This branch includes the v3 version of the Tremendous Node.JS client, a new version based
+> on our [API schema][ref] docs. If you are using the v2 versions, please check our
+> [`UPGRADING`](UPGRADING.md) guide
 
 ## Installation
 
@@ -11,79 +13,101 @@ $ npm install tremendous
 
 ## Getting started
 
-All API requests require an access token.  A sandbox access token is assigned upon signup through the [Tremendous Sandbox Environment][2]. Once you are ready to move to production, you will be assigned a production access token.
+All API requests require an access token.  A sandbox access token is assigned upon signup through the [Tremendous Sandbox Environment][docs]. Once you are ready to move to production, you will be assigned a production access token.
 
 ### Authentication
+## Getting started
 
-```javascript
-var Tremendous = require('tremendous');
+All endpoints require a `Configuration` object with a `basePath` and an `accessToken` for either your
+Production or Sandbox account:
 
-// Sandbox environment
-var client = new Tremendous("[SANDBOX_ACCESS_TOKEN]", "https://testflight.tremendous.com/api/v2/");
+```typescript
+import { Configuration, Environments } from "tremendous";
 
-// Production environment
-var client = new Tremendous("[PRODUCTION_ACCESS_TOKEN]", "https://api.tremendous.com/api/v2/");
-```
+// when you are testing your code with the sandbox environment:
+const configuration = new Configuration({
+  basePath: Environments.testflight,
+  accessToken: "YOUR-TESTFLIGHT-TOKEN",
+});
 
+// when you are ready to use the API:
+const configuration = new Configuration({
+  basePath: Environments.production,
+  accessToken: "YOUR-PRODUCTION-TOKEN",
+});
+```
 
-### Orders
+## Examples
 
-See [API documentation][3] for all Order attributes.
+Submitting an order:
 
-```javascript
-// Create a new order, specifying your gift options
-// as an array of objects.
+```typescript
+import { OrdersApi, CreateOrderRequest } from "tremendous";
 
-const order_data = {
+const orders = new OrdersApi(configuration);
+const params: CreateOrderRequest = {
   payment: {
-    funding_source_id: "[FUNDING_SOURCE_ID]",
+    funding_source_id: "[FUNDING SOURCE ID HERE]",
   },
-  reward: {
-    value: {
-      denomination: 25,
-      currency_code: "USD"
-    },
-    campaign_id: "[CAMPAIGN_ID]",
-    delivery: {
-      method: "EMAIL",
-    },
-    recipient: {
-      name: "Tremendous Recipient",
-      email: "steve@stevens.com"
+  reward:
+    {
+      delivery: {
+        method: "EMAIL"
+      },
+      recipient: {
+        name: "Recipient Name",
+        email: "recipient@domain"
+      },
+      value: {
+        denomination: 5.0,
+        currency_code: "USD",
+      },
+       campaign_id: "[CAMPAIGN_ID]",
     }
-  }
-}
+};
 
-client.createOrder(order_data, function(err, results) {
-  console.log(JSON.stringify(err, null, 2));
-  console.log(JSON.stringify(results, null, 2));
-});
+const { data } = await orders.createOrder(params);
+console.log(`Order created! ID: ${data.order.id}`);
+```
 
+Retrieving an Order and a Reward
 
-// Return a reward by ID
-client.getReward("[REWARD_ID]", function(err, result) {
-  console.log(JSON.stringify(result, null, 2));
-});
+```typescript
+import { OrdersApi, RewardsApi } from "tremendous";
+
+const orders = new OrdersApi(configuration);
+const rewards = new RewardsApi(configuration);
+
+const { order } = (await orders.getOrder("[ORDER_ID]")).data;
+const { reward } = (await rewards.getReward("[REWARD_ID]")).data;
+
+console.log(`The order status is ${order.status}`);
+console.log(`The reward was delivered to ${reward.recipient.email}`);
 ```
 
-### Funding Sources
-Production funding sources must be added through the web dashboard. A sandbox funding source is provided during development.
+Listing products:
 
-```javascript
-// Retrieve a list of your funding sources (credit card, ach, etc).
-client.getFundingSources({}, function(err, results) {
-  console.log(JSON.stringify(results, null, 2));
-});
+```typescript
+import { ProductsApi } from "tremendous";
+
+const client = new ProductsApi(configuration);
+
+const { data } = await client.listProducts();
+
+data.products.forEach(product => { /* */ });
 ```
 
-### Products
+Listing funding sources:
 
-```javascript
-client.getProducts({}, function(err, results) {
-  console.log(JSON.stringify(results, null, 2));
-});
+```typescript
+import { FundingSourcesAPI } from "tremendous";
+
+const client = new FundingSourcesAPI(configuration);
+
+const { data } = await client.listFundingSources();
+
+data.fundingSources.forEach(product => { /* */ });
 ```
 
-[1]: https://tremendous.com/docs
-[2]: https://testflight.tremendous.com/rewards
-[3]: https://tremendous.com/docs
+[ref]: https://developers.tremendous.com/reference
+[docs]: https://tremendous.com/docs