feat: add endpoints about ThreeDSecureRequest object.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "payjp",
-  "version": "2.2.5",
+  "version": "2.3.0",
   "description": "PAY.JP node.js bindings",
   "main": "built/index.js",
   "types": "built/index.d.ts",

src/index.ts

@@ -11,8 +11,9 @@
 import Statements from './statement';
 import Terms from "./term";
 import Balances from "./balance";
+import ThreeDSecureRequests from "./threeDSecureRequest";
 
 namespace Payjp {
   export interface PayjpStatic {
     (apikey: string, options?: PayjpOptions): Payjp;
   }
@@ -33,6 +34,7 @@
     statements: Statements,
     terms: Terms,
     balances: Balances,
+    three_d_secure_requests: ThreeDSecureRequests,
   }
 
   export interface PayjpOptions {
@@ -237,6 +239,8 @@
     url: string
   }
 
+  type ThreeDSecureStatus = null | 'unverified' | 'verified' | 'attempted' | 'failed' | 'error';
+
   export interface Charge {
     object: "charge",
     amount: number,
@@ -263,8 +267,8 @@
     platform_fee_rate?: string | null,
     total_platform_fee?: number,
     tenant?: string | null,
     product?: any,
-    three_d_secure_status: string | null,
+    three_d_secure_status: ThreeDSecureStatus,
     term_id: string | null,
   }
 
@@ -544,6 +548,31 @@
     bank_info: null | BankInfo
   }
 
+  export interface ThreeDSecureRequest {
+    object: 'three_d_secure_request',
+    id: string,
+    resource_id: string,
+    livemode: boolean,
+    created: number,
+    state: 'created' | 'in_progress' | 'result_received' | 'finished',
+    started_at: null | number,
+    result_received_at: null | number,
+    finished_at: null | number,
+    expired_at: null | number,
+    tenant_id: null | string,
+    three_d_secure_status: ThreeDSecureStatus,
+  }
+
+  export interface ThreeDSecureRequestCreationOptions {
+    resource_id: string,
+    tenant_id?: string,
+  }
+
+  export interface ThreeDSecureRequestListOptions extends ListOptions {
+    resource_id?: string,
+    tenant_id?: string,
+  }
+
   export interface Deleted {
     deleted: boolean,
     id: string,
@@ -563,11 +592,11 @@
 
   export interface ResponseError {
     status?: number | undefined,
     response?: { body?: PayjpError, [propName: string]: any } | undefined,
     message: string,
     timeout?: number,
 
     [propName: string]: any,
   }
 }
 
@@ -605,6 +634,7 @@
     statements: new Statements(payjpConfig),
     terms: new Terms(payjpConfig),
     balances: new Balances(payjpConfig),
+    three_d_secure_requests: new ThreeDSecureRequests(payjpConfig),
   };
 }
 

src/threeDSecureRequest.ts

@@ -0,0 +1,24 @@
+import Resource from './resource';
+import * as I from './index';
+
+export default class ThreeDSecureRequests extends Resource {
+  resource: string;
+
+  constructor(payjp) {
+    super(payjp);
+    this.resource = 'three_d_secure_requests';
+  }
+
+  list(query: I.ThreeDSecureRequestListOptions = {}): Promise<I.List<I.ThreeDSecureRequest>> {
+    return this.request('GET', this.resource, query);
+  }
+
+  create(query: I.ThreeDSecureRequestCreationOptions): Promise<I.ThreeDSecureRequest> {
+    return this.request('POST', this.resource, query);
+  }
+
+  retrieve(id: string): Promise<I.ThreeDSecureRequest> {
+    return this.request('GET', `${this.resource}/${id}`);
+  }
+
+}

test/threeDSecureRequest.spec.js

@@ -0,0 +1,39 @@
+const assert = require('assert');
+const Payjp = require('../built');
+const config = require('./config');
+
+const payjp = Payjp(config.apikey, config);
+payjp.three_d_secure_requests.request = (...args) => Promise.resolve(args);
+
+describe('ThreeDSecureRequest Resource', () => {
+  describe('list', () => {
+    it('Sends the correct request', () => {
+      return payjp.three_d_secure_requests.list().then(([_method, _endpoint]) => {
+        assert(_method === 'GET');
+        assert(_endpoint === 'three_d_secure_requests');
+      });
+    });
+  });
+
+  describe('create', () => {
+    it('Sends the correct request', () => {
+      const query = {
+        resource_id: 'car_xxxxxxxxxxxxxxxxxxxxxxxxx'
+      };
+      return payjp.three_d_secure_requests.create(query).then(([_method, _endpoint]) => {
+        assert(_method === 'POST');
+        assert(_endpoint === 'three_d_secure_requests');
+      });
+    });
+  });
+
+  describe('retrieve', () => {
+    it('Sends the correct request', () => {
+      return payjp.three_d_secure_requests.retrieve('id123').then(([_method, _endpoint]) => {
+        assert(_method === 'GET');
+        assert(_endpoint === 'three_d_secure_requests/id123');
+      });
+    });
+  });
+
+});