payjp 2.1.3 → 2.2.0

package/.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '14', '16', '18']
+        node: [ '14', '16', '18', '20']
     steps:
       - uses: actions/checkout@v2
       - name: Setup node

package/built/balance.d.ts

@@ -0,0 +1,8 @@
+import Resource from './resource';
+import * as I from './index';
+export default class Balances extends Resource {
+    resource: string;
+    constructor(payjp: any);
+    list(query?: I.BalanceListOptions): Promise<I.List<I.Balance>>;
+    retrieve(id: string): Promise<I.Balance>;
+}

package/built/balance.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("./resource");
+class Balances extends resource_1.default {
+    resource;
+    constructor(payjp) {
+        super(payjp);
+        this.resource = 'balances';
+    }
+    list(query = {}) {
+        return this.request('GET', this.resource, query);
+    }
+    retrieve(id) {
+        return this.request('GET', `${this.resource}/${id}`);
+    }
+}
+exports.default = Balances;

package/built/charge.d.ts

@@ -5,10 +5,10 @@ export default class Charges extends Resource {
     constructor(payjp: any);
     list(query?: I.ChargeListOptions): Promise<I.List<I.Charge>>;
     create(query: I.ChargeCreationOptions): Promise<I.Charge>;
-    retrieve(id: any): Promise<I.Charge>;
-    update(id: any, query?: I.ChargeUpdateOptions): Promise<I.Charge>;
-    refund(id: any, query?: I.RefundCreationOptions): Promise<I.Charge>;
-    reauth(id: any, query?: I.ChargeReauthOptions): Promise<I.Charge>;
-    capture(id: any, query?: I.ChargeCaptureOptions): Promise<I.Charge>;
-    tds_finish(id: any): Promise<I.Charge>;
+    retrieve(id: string): Promise<I.Charge>;
+    update(id: string, query?: I.ChargeUpdateOptions): Promise<I.Charge>;
+    refund(id: string, query?: I.RefundCreationOptions): Promise<I.Charge>;
+    reauth(id: string, query?: I.ChargeReauthOptions): Promise<I.Charge>;
+    capture(id: string, query?: I.ChargeCaptureOptions): Promise<I.Charge>;
+    tds_finish(id: string): Promise<I.Charge>;
 }

package/built/index.d.ts

@@ -8,6 +8,9 @@ import Tenants from './tenants';
 import TenantTransfers from './tenantTransfers';
 import Tokens from './token';
 import Transfers from './transfer';
+import Statements from './statement';
+import Terms from "./term";
+import Balances from "./balance";
 declare namespace Payjp {
     export interface PayjpStatic {
         (apikey: string, options?: PayjpOptions): Payjp;
@@ -25,6 +28,9 @@ declare namespace Payjp {
         accounts: Accounts;
         tenants: Tenants;
         tenant_transfers: TenantTransfers;
+        statements: Statements;
+        terms: Terms;
+        balances: Balances;
     }
     export interface PayjpOptions {
         timeout?: number;
@@ -33,9 +39,11 @@ declare namespace Payjp {
         retryInitialDelay?: number;
         retryMaxDelay?: number;
     }
-    export interface ListOptions {
+    export interface PaginationOptions {
         limit?: number;
         offset?: number;
+    }
+    export interface ListOptions extends PaginationOptions {
         since?: number;
         until?: number;
     }
@@ -67,6 +75,25 @@ declare namespace Payjp {
         transfer?: string;
         tenant?: string;
     }
+    export interface StatementListOptions extends ListOptions {
+        owner?: "merchant" | "tenant";
+        source_transfer?: string;
+        tenant?: string;
+        term?: string;
+        type?: "sales" | "service_fee" | "transfer_fee";
+    }
+    export interface TermListOptions extends PaginationOptions {
+        since_start_at?: number;
+        until_start_at?: number;
+    }
+    export interface BalanceListOptions extends ListOptions {
+        since_due_date?: number;
+        until_due_date?: number;
+        state?: "collecting" | "transfer" | "claim";
+        closed?: boolean;
+        owner?: "merchant" | "tenant";
+        tenant?: string;
+    }
     interface OptionsMetadata {
         [x: string]: string | number;
     }
@@ -164,6 +191,9 @@ declare namespace Payjp {
         bank_account_number?: string;
         bank_account_holder_name?: string;
     }
+    export interface StatementUrlOptions {
+        platformer?: boolean;
+    }
     export interface List<T> {
         object: "list";
         count: number;
@@ -199,6 +229,7 @@ declare namespace Payjp {
         tenant?: string | null;
         product?: any;
         three_d_secure_status: string | null;
+        term_id: string | null;
     }
     export interface Customer {
         object: "customer";
@@ -322,6 +353,7 @@ declare namespace Payjp {
         email: string;
         id: string;
         merchant: Merchant;
+        team_id: string;
     }
     export interface Merchant {
         object: "merchant";
@@ -358,8 +390,34 @@ declare namespace Payjp {
         bank_account_status: string;
         currencies_supported: string[];
         default_currency: "jpy";
+        payjp_fee_included: boolean;
         reviewed_brands: ReviewedBrand[];
     }
+    export interface Statement {
+        created: number;
+        id: string;
+        livemode: boolean;
+        object: "statement";
+        title: string;
+        tenant_id: string;
+        type: "sales" | "service_fee" | "transfer_fee";
+        net: number;
+        term: Term | null;
+        balance_id: string;
+        items: StatementItems[];
+        updated: number;
+    }
+    export interface StatementItems {
+        subject: "gross_sales" | "fee" | "platform_fee" | "gross_refund" | "refund_fee_offset" | "refund_platform_fee_offset" | "chargeback" | "chargeback_fee_offset" | "chargeback_platform_fee_offset" | "proplan" | "transfer_fee";
+        amount: number;
+        name: string;
+        tax_rate: string;
+    }
+    export interface StatementUrl {
+        object: "statement_url";
+        url: string;
+        expires: number;
+    }
     interface ReviewedBrand {
         brand: string;
         status: string;
@@ -378,6 +436,37 @@ declare namespace Payjp {
     interface TenantTransferSummary extends Summary {
         total_platform_fee: number;
     }
+    export interface Term {
+        id: string;
+        livemode: boolean;
+        object: "term";
+        charge_count: number;
+        refund_count: number;
+        dispute_count: number;
+        end_at: number;
+        start_at: number;
+    }
+    export interface BankInfo {
+        bank_code: string;
+        bank_branch_code: string;
+        bank_account_type: string;
+        bank_account_number: string;
+        bank_account_holder_name: string;
+        bank_account_status: "success" | "failed" | "pending";
+    }
+    export interface Balance {
+        created: number;
+        id: string;
+        livemode: boolean;
+        net: number;
+        object: "balance";
+        state: "collecting" | "transfer" | "claim";
+        statements: Statement[];
+        closed: boolean;
+        due_date: null | number;
+        tenant_id: string;
+        bank_info: null | BankInfo;
+    }
     export interface Deleted {
         deleted: boolean;
         id: string;

package/built/index.js

@@ -9,6 +9,9 @@ const tenants_1 = require("./tenants");
 const tenantTransfers_1 = require("./tenantTransfers");
 const token_1 = require("./token");
 const transfer_1 = require("./transfer");
+const statement_1 = require("./statement");
+const term_1 = require("./term");
+const balance_1 = require("./balance");
 const Payjp = function (apikey, options = {}) {
     if (!apikey) {
         throw new Error('Please set apikey.');
@@ -40,6 +43,9 @@ const Payjp = function (apikey, options = {}) {
         accounts: new account_1.default(payjpConfig),
         tenants: new tenants_1.default(payjpConfig),
         'tenant_transfers': new tenantTransfers_1.default(payjpConfig),
+        statements: new statement_1.default(payjpConfig),
+        terms: new term_1.default(payjpConfig),
+        balances: new balance_1.default(payjpConfig),
     };
 };
 module.exports = Payjp;

package/built/statement.d.ts

@@ -0,0 +1,9 @@
+import Resource from './resource';
+import * as I from './index';
+export default class Statements extends Resource {
+    resource: string;
+    constructor(payjp: any);
+    list(query?: I.StatementListOptions): Promise<I.List<I.Statement>>;
+    retrieve(id: string): Promise<I.Statement>;
+    statementUrls(id: string, query?: I.StatementUrlOptions): Promise<I.StatementUrl>;
+}

package/built/statement.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("./resource");
+class Statements extends resource_1.default {
+    resource;
+    constructor(payjp) {
+        super(payjp);
+        this.resource = 'statements';
+    }
+    list(query = {}) {
+        return this.request('GET', this.resource, query);
+    }
+    retrieve(id) {
+        return this.request('GET', `${this.resource}/${id}`);
+    }
+    statementUrls(id, query = {}) {
+        return this.request('POST', `${this.resource}/${id}/statement_urls`, query);
+    }
+}
+exports.default = Statements;

package/built/tenantTransfers.d.ts

@@ -4,6 +4,7 @@ export default class TenantTransfers extends Resource {
     resource: string;
     constructor(payjp: any);
     list(query?: I.TenantTransferListOptions): Promise<I.List<I.TenantTransfer>>;
-    retrieve(id: any): Promise<I.TenantTransfer>;
-    charges(id: any, query?: I.TransferChargeListOptions): Promise<I.List<I.Charge>>;
+    retrieve(id: string): Promise<I.TenantTransfer>;
+    charges(id: string, query?: I.TransferChargeListOptions): Promise<I.List<I.Charge>>;
+    statementUrls(id: string, query?: I.StatementUrlOptions): Promise<I.StatementUrl>;
 }

package/built/tenantTransfers.js

@@ -16,5 +16,8 @@ class TenantTransfers extends resource_1.default {
     charges(id, query = {}) {
         return this.request('GET', `${this.resource}/${id}/charges`, query);
     }
+    statementUrls(id, query = {}) {
+        return this.request('POST', `${this.resource}/${id}/statement_urls`, query);
+    }
 }
 exports.default = TenantTransfers;

package/built/tenants.d.ts

@@ -5,8 +5,8 @@ export default class Tenants extends Resource {
     constructor(payjp: any);
     list(query?: I.ListOptions): Promise<I.List<I.Tenant>>;
     create(query: I.TenantCreationOptions): Promise<I.Tenant>;
-    retrieve(id: any): Promise<I.Tenant>;
-    update(id: any, query?: I.TenantUpdateOptions): Promise<I.Tenant>;
+    retrieve(id: string): Promise<I.Tenant>;
+    update(id: string, query?: I.TenantUpdateOptions): Promise<I.Tenant>;
     delete(id: string): Promise<I.Deleted>;
     applicationUrls(id: string): Promise<I.ApplicationUrl>;
 }

package/built/term.d.ts

@@ -0,0 +1,8 @@
+import Resource from './resource';
+import * as I from './index';
+export default class Terms extends Resource {
+    resource: string;
+    constructor(payjp: any);
+    list(query?: I.TermListOptions): Promise<I.List<I.Term>>;
+    retrieve(id: string): Promise<I.Term>;
+}

package/built/term.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("./resource");
+class Terms extends resource_1.default {
+    resource;
+    constructor(payjp) {
+        super(payjp);
+        this.resource = 'terms';
+    }
+    list(query = {}) {
+        return this.request('GET', this.resource, query);
+    }
+    retrieve(id) {
+        return this.request('GET', `${this.resource}/${id}`);
+    }
+}
+exports.default = Terms;

package/package.json

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