Add issued_to field support to Orders APIs (#68)

* Add issued_to field support to Orders APIs

* Update to camelCase naming

Author: holtbp

Diff for: CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.23.0] - 2022-06-03
+
+### Added
+
+- Adds support for the `issuedTo` parameter on `orders`, to add support for creating and placing orders on behalf of another party.
+
 ## [1.22.0] - 2022-05-16
 
 ### Added

Diff for: README.md

@@ -77,6 +77,12 @@ const totalPrice = 500; // Pass in the total price in smallest currency unit (ie
 const currency = 'USD';
 patch.orders.createOrder({ total_price: totalPrice, currency: currency });
 
+// Create order with the issuedTo field (optional)
+const amount = 1_000_000; // Pass in the amount in unit specified
+const unit = 'g';
+const issuedTo = { email: '[email protected]', name: 'Olivia Jones' };
+patch.orders.createOrder({ amount: amount, unit: unit, issuedTo: issuedTo });
+
 // Retrieve an order
 orderId = 'ord_test_1234'; // Pass in the order's id
 patch.orders.retrieveOrder(orderId);
@@ -85,6 +91,11 @@ patch.orders.retrieveOrder(orderId);
 const orderId = 'ord_test_1234'; // Pass in the order's id
 patch.orders.placeOrder(orderId);
 
+// Place an order with the issuedTo field (optional)
+const orderId = 'ord_test_1234'; // Pass in the order's id
+const issuedTo = { email: '[email protected]', name: 'Olivia Jones' };
+patch.orders.placeOrder(orderId, { issuedTo: issuedTo });
+
 // Cancel an order
 const orderId = 'ord_test_1234'; // Pass in the order's id
 patch.orders.cancelOrder(orderId);

Diff for: package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@patch-technology/patch",
-  "version": "1.22.0",
+  "version": "1.23.0",
   "description": "Node.js wrapper for the Patch API",
   "license": "MIT",
   "repository": {

Diff for: package.json

@@ -16,7 +16,7 @@ class ApiClient {
     };
 
     this.defaultHeaders = {
-      'User-Agent': 'patch-node/1.22.0'
+      'User-Agent': 'patch-node/1.23.0'
     };
 
     /**

Diff for: src/ApiClient.js

@@ -10,6 +10,7 @@ import CreateOrderRequest from '../model/CreateOrderRequest';
 import ErrorResponse from '../model/ErrorResponse';
 import OrderListResponse from '../model/OrderListResponse';
 import OrderResponse from '../model/OrderResponse';
+import PlaceOrderRequest from '../model/PlaceOrderRequest';
 
 export default class OrdersApi {
   constructor(apiClient) {
@@ -100,8 +101,14 @@ export default class OrdersApi {
     return this.createOrderWithHttpInfo(createOrderRequest);
   }
 
-  placeOrderWithHttpInfo(id) {
-    let postBody = null;
+  placeOrderWithHttpInfo(id, opts) {
+    opts = opts || {};
+
+    const _placeOrderRequest = PlaceOrderRequest.constructFromObject(
+      opts,
+      new CreateOrderRequest()
+    );
+    let postBody = _placeOrderRequest;
 
     // verify the required parameter 'id' is set
     if (id === undefined || id === null) {
@@ -118,7 +125,7 @@ export default class OrdersApi {
     let formParams = {};
 
     let authNames = ['bearer_auth'];
-    let contentTypes = [];
+    let contentTypes = ['application/json'];
     let accepts = ['application/json'];
     let returnType = OrderResponse;
 
@@ -137,8 +144,8 @@ export default class OrdersApi {
     );
   }
 
-  placeOrder(id) {
-    return this.placeOrderWithHttpInfo(id);
+  placeOrder(id, opts) {
+    return this.placeOrderWithHttpInfo(id, opts);
   }
 
   retrieveOrderWithHttpInfo(id) {

Diff for: src/api/OrdersApi.js

@@ -6,6 +6,7 @@
  */
 
 import ApiClient from '../ApiClient';
+import V1OrdersIssuedTo from './V1OrdersIssuedTo';
 
 class CreateOrderRequest {
   constructor() {
@@ -69,6 +70,12 @@ class CreateOrderRequest {
       if (data.hasOwnProperty('unit')) {
         obj['unit'] = ApiClient.convertToType(data['unit'], 'String');
       }
+
+      if (data.hasOwnProperty('issuedTo')) {
+        obj['issued_to'] = V1OrdersIssuedTo.constructFromObject(
+          data['issuedTo']
+        );
+      }
     }
     return obj;
   }
@@ -94,4 +101,6 @@ CreateOrderRequest.prototype['amount'] = undefined;
 
 CreateOrderRequest.prototype['unit'] = undefined;
 
+CreateOrderRequest.prototype['issued_to'] = undefined;
+
 export default CreateOrderRequest;

Diff for: src/model/CreateOrderRequest.js

@@ -0,0 +1,37 @@
+/**
+ * Patch API V1
+ * The core API used to integrate with Patch's service
+ *
+ * Contact: [email protected]
+ */
+
+import ApiClient from '../ApiClient';
+
+class IssuedTo {
+  constructor() {
+    IssuedTo.initialize(this);
+  }
+
+  static initialize(obj) {}
+
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new IssuedTo();
+
+      if (data.hasOwnProperty('name')) {
+        obj['name'] = ApiClient.convertToType(data['name'], 'String');
+      }
+
+      if (data.hasOwnProperty('email')) {
+        obj['email'] = ApiClient.convertToType(data['email'], 'String');
+      }
+    }
+    return obj;
+  }
+}
+
+IssuedTo.prototype['name'] = undefined;
+
+IssuedTo.prototype['email'] = undefined;
+
+export default IssuedTo;

Diff for: src/model/IssuedTo.js

@@ -7,6 +7,7 @@
 
 import ApiClient from '../ApiClient';
 import Allocation from './Allocation';
+import IssuedTo from './IssuedTo';
 import OrderInventory from './OrderInventory';
 
 class Order {
@@ -164,6 +165,10 @@ class Order {
           OrderInventory
         ]);
       }
+
+      if (data.hasOwnProperty('issued_to')) {
+        obj['issued_to'] = IssuedTo.constructFromObject(data['issued_to']);
+      }
     }
     return obj;
   }
@@ -203,4 +208,6 @@ Order.prototype['metadata'] = undefined;
 
 Order.prototype['inventory'] = undefined;
 
+Order.prototype['issued_to'] = undefined;
+
 export default Order;

Diff for: src/model/Order.js

@@ -0,0 +1,34 @@
+/**
+ * Patch API V1
+ * The core API used to integrate with Patch's service
+ *
+ * Contact: [email protected]
+ */
+
+import ApiClient from '../ApiClient';
+import V1OrdersIssuedTo from './V1OrdersIssuedTo';
+
+class PlaceOrderRequest {
+  constructor() {
+    PlaceOrderRequest.initialize(this);
+  }
+
+  static initialize(obj) {}
+
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new PlaceOrderRequest();
+
+      if (data.hasOwnProperty('issuedTo')) {
+        obj['issued_to'] = V1OrdersIssuedTo.constructFromObject(
+          data['issuedTo']
+        );
+      }
+    }
+    return obj;
+  }
+}
+
+PlaceOrderRequest.prototype['issued_to'] = undefined;
+
+export default PlaceOrderRequest;

Diff for: src/model/PlaceOrderRequest.js

@@ -0,0 +1,37 @@
+/**
+ * Patch API V1
+ * The core API used to integrate with Patch's service
+ *
+ * Contact: [email protected]
+ */
+
+import ApiClient from '../ApiClient';
+
+class V1OrdersIssuedTo {
+  constructor() {
+    V1OrdersIssuedTo.initialize(this);
+  }
+
+  static initialize(obj) {}
+
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new V1OrdersIssuedTo();
+
+      if (data.hasOwnProperty('email')) {
+        obj['email'] = ApiClient.convertToType(data['email'], 'String');
+      }
+
+      if (data.hasOwnProperty('name')) {
+        obj['name'] = ApiClient.convertToType(data['name'], 'String');
+      }
+    }
+    return obj;
+  }
+}
+
+V1OrdersIssuedTo.prototype['email'] = undefined;
+
+V1OrdersIssuedTo.prototype['name'] = undefined;
+
+export default V1OrdersIssuedTo;

Diff for: src/model/V1OrdersIssuedTo.js

@@ -17,7 +17,7 @@ describe('Orders Integration', function () {
     expect(retrieveOrdersResponse.data.length).to.be.above(0);
   });
 
-  it('supports create orders with a total price', async function () {
+  it('supports creating an order with a project_id', async function () {
     const { data } = await patch.orders.createOrder({
       total_price_cents_usd: 100,
       project_id: biomass_test_project_id
@@ -26,6 +26,18 @@ describe('Orders Integration', function () {
     expect(data.price_cents_usd + data.patch_fee_cents_usd).to.eq(100);
   });
 
+  it('supports creating an order with issuedTo', async function () {
+    const issuedTo = { email: '[email protected]', name: 'Bob Dylan' };
+    const { data } = await patch.orders.createOrder({
+      total_price_cents_usd: 100,
+      issuedTo: issuedTo
+    });
+
+    expect(data.price_cents_usd + data.patch_fee_cents_usd).to.eq(100);
+    expect(data.issued_to.email).to.equal(issuedTo.email);
+    expect(data.issued_to.name).to.equal(issuedTo.name);
+  });
+
   it('supports placing orders in a `draft` state', async function () {
     const estimateResponse = await patch.orders.createOrder({
       mass_g: 100,
@@ -41,6 +53,26 @@ describe('Orders Integration', function () {
     expect(placeOrderResponse.data.mass_g).to.equal(100);
   });
 
+  it('supports placing orders in a `draft` state with issuedTo', async function () {
+    const estimateResponse = await patch.estimates.createMassEstimate({
+      mass_g: 100,
+      create_order: true
+    });
+    const orderId = estimateResponse.data.order.id;
+    expect(estimateResponse.data.order.state).to.equal('draft');
+
+    const issuedTo = { email: '[email protected]', name: 'Bob Dylan' };
+
+    const placeOrderResponse = await patch.orders.placeOrder(orderId, {
+      issuedTo: issuedTo
+    });
+    expect(placeOrderResponse.data.created_at).to.be.an.instanceOf(Date);
+    expect(placeOrderResponse.data.production).to.equal(false);
+    expect(placeOrderResponse.data.mass_g).to.equal(100);
+    expect(placeOrderResponse.data.issued_to.email).to.equal(issuedTo.email);
+    expect(placeOrderResponse.data.issued_to.name).to.equal(issuedTo.name);
+  });
+
   it('supports placing orders in a `draft` state using an estimate', async function () {
     const estimateResponse = await patch.estimates.createMassEstimate({
       mass_g: 100,