@mercurjs/types 2.0.0-canary.91 → 2.0.0-canary.92
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/payout/common.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { BigNumberInput,
|
|
1
|
+
import { BigNumberInput, FulfillmentStatus } from "@medusajs/types";
|
|
2
2
|
export declare enum PayoutAccountStatus {
|
|
3
3
|
/**
|
|
4
4
|
* User hasn't completed setup
|
|
@@ -24,6 +24,46 @@ export declare enum PayoutStatus {
|
|
|
24
24
|
FAILED = "failed",
|
|
25
25
|
CANCELED = "canceled"
|
|
26
26
|
}
|
|
27
|
+
export declare enum PayoutEvents {
|
|
28
|
+
OrderCaptureRequested = "order.capture_requested",
|
|
29
|
+
OrderAuthorizationExpired = "order.authorization_expired",
|
|
30
|
+
PayoutRequested = "payout.requested"
|
|
31
|
+
}
|
|
32
|
+
export interface PayoutModuleOptions {
|
|
33
|
+
/**
|
|
34
|
+
* Disable automatic capture checks and daily payout jobs.
|
|
35
|
+
* When true, both the capture-check and daily-payouts scheduled jobs
|
|
36
|
+
* will exit immediately without processing any orders.
|
|
37
|
+
* Default: false.
|
|
38
|
+
*/
|
|
39
|
+
disabled?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* How long a payment authorization remains valid before capture is no longer possible.
|
|
42
|
+
* Default: 7 days.
|
|
43
|
+
*/
|
|
44
|
+
authorizationWindowMs?: number;
|
|
45
|
+
/**
|
|
46
|
+
* How long a seller has to complete required acceptance or fulfillment actions
|
|
47
|
+
* before the order should be rejected or canceled.
|
|
48
|
+
* Example: 72 hours.
|
|
49
|
+
*/
|
|
50
|
+
sellerActionWindowMs?: number;
|
|
51
|
+
/**
|
|
52
|
+
* Safety margin before authorization expiry. Capture should happen before:
|
|
53
|
+
* authorization expiry - capture safety buffer.
|
|
54
|
+
* Default: 24 hours.
|
|
55
|
+
*/
|
|
56
|
+
captureSafetyBufferMs?: number;
|
|
57
|
+
/**
|
|
58
|
+
* Minimum fulfillment status an order must have before it becomes eligible
|
|
59
|
+
* for capture and payout. The check uses an ordered scale:
|
|
60
|
+
* not_fulfilled < partially_fulfilled < fulfilled < partially_shipped < shipped < partially_delivered < delivered
|
|
61
|
+
* An order qualifies when its status is >= the configured requirement.
|
|
62
|
+
* Default: "fulfilled".
|
|
63
|
+
*/
|
|
64
|
+
requiredFulfillmentStatus?: FulfillmentStatus;
|
|
65
|
+
}
|
|
66
|
+
export declare const PAYOUT_MODULE_OPTION_DEFAULTS: Required<PayoutModuleOptions>;
|
|
27
67
|
export type PayoutWebhookAction = "not_supported" | "account.activated" | "account.restricted" | "account.rejected" | "payout.processing" | "payout.paid" | "payout.failed" | "payout.canceled";
|
|
28
68
|
export interface PayoutAccountDTO {
|
|
29
69
|
id: string;
|
|
@@ -52,29 +92,4 @@ export interface PayoutDTO {
|
|
|
52
92
|
created_at: Date;
|
|
53
93
|
updated_at: Date;
|
|
54
94
|
}
|
|
55
|
-
/**
|
|
56
|
-
* The payout balance totals stored in JSON
|
|
57
|
-
*/
|
|
58
|
-
export type PayoutBalanceTotals = {
|
|
59
|
-
balance: BigNumberValue;
|
|
60
|
-
raw_balance: BigNumberRawValue;
|
|
61
|
-
};
|
|
62
|
-
export interface PayoutBalanceDTO {
|
|
63
|
-
id: string;
|
|
64
|
-
account_id: string;
|
|
65
|
-
currency_code: string;
|
|
66
|
-
totals: PayoutBalanceTotals;
|
|
67
|
-
created_at: Date;
|
|
68
|
-
updated_at: Date;
|
|
69
|
-
}
|
|
70
|
-
export interface PayoutTransactionDTO {
|
|
71
|
-
id: string;
|
|
72
|
-
account_id: string;
|
|
73
|
-
amount: BigNumberInput;
|
|
74
|
-
currency_code: string;
|
|
75
|
-
reference: string | null;
|
|
76
|
-
reference_id: string | null;
|
|
77
|
-
created_at: Date;
|
|
78
|
-
updated_at: Date;
|
|
79
|
-
}
|
|
80
95
|
//# sourceMappingURL=common.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/payout/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,
|
|
1
|
+
{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/payout/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAEnE,oBAAY,mBAAmB;IAC7B;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,QAAQ,aAAa;CACtB;AAED,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED,oBAAY,YAAY;IAEtB,qBAAqB,4BAA4B;IACjD,yBAAyB,gCAAgC;IACzD,eAAe,qBAAqB;CACrC;AAGD,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAE7B;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B;;;;;;OAMG;IACH,yBAAyB,CAAC,EAAE,iBAAiB,CAAA;CAC9C;AAED,eAAO,MAAM,6BAA6B,EAAE,QAAQ,CAAC,mBAAmB,CAMvE,CAAA;AAGD,MAAM,MAAM,mBAAmB,GAC3B,eAAe,GACf,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,mBAAmB,GACnB,aAAa,GACb,eAAe,GACf,iBAAiB,CAAA;AAGrB,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,mBAAmB,CAAA;IAC3B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACvC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACvC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,cAAc,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;CACjB"}
|
package/dist/payout/common.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.PayoutStatus = exports.PayoutAccountStatus = void 0;
|
|
3
|
+
exports.PAYOUT_MODULE_OPTION_DEFAULTS = exports.PayoutEvents = exports.PayoutStatus = exports.PayoutAccountStatus = void 0;
|
|
4
4
|
var PayoutAccountStatus;
|
|
5
5
|
(function (PayoutAccountStatus) {
|
|
6
6
|
/**
|
|
@@ -28,3 +28,17 @@ var PayoutStatus;
|
|
|
28
28
|
PayoutStatus["FAILED"] = "failed";
|
|
29
29
|
PayoutStatus["CANCELED"] = "canceled";
|
|
30
30
|
})(PayoutStatus || (exports.PayoutStatus = PayoutStatus = {}));
|
|
31
|
+
var PayoutEvents;
|
|
32
|
+
(function (PayoutEvents) {
|
|
33
|
+
// TODO: Move to order-related domain events
|
|
34
|
+
PayoutEvents["OrderCaptureRequested"] = "order.capture_requested";
|
|
35
|
+
PayoutEvents["OrderAuthorizationExpired"] = "order.authorization_expired";
|
|
36
|
+
PayoutEvents["PayoutRequested"] = "payout.requested";
|
|
37
|
+
})(PayoutEvents || (exports.PayoutEvents = PayoutEvents = {}));
|
|
38
|
+
exports.PAYOUT_MODULE_OPTION_DEFAULTS = {
|
|
39
|
+
disabled: false,
|
|
40
|
+
authorizationWindowMs: 7 * 24 * 60 * 60 * 1000,
|
|
41
|
+
sellerActionWindowMs: 72 * 60 * 60 * 1000,
|
|
42
|
+
captureSafetyBufferMs: 24 * 60 * 60 * 1000,
|
|
43
|
+
requiredFulfillmentStatus: "fulfilled",
|
|
44
|
+
};
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { PayoutAccountStatus, PayoutStatus } from "./common";
|
|
2
2
|
import { PayoutProviderInput } from "./provider";
|
|
3
|
-
import { BigNumberInput } from "@medusajs/types";
|
|
4
3
|
export interface CreatePayoutAccountDTO extends PayoutProviderInput {
|
|
5
4
|
}
|
|
6
5
|
export interface CreateOnboardingDTO extends PayoutProviderInput {
|
|
@@ -19,16 +18,4 @@ export interface UpdatePayoutDTO {
|
|
|
19
18
|
id: string;
|
|
20
19
|
status: PayoutStatus;
|
|
21
20
|
}
|
|
22
|
-
export interface CreatePayoutTransactionDTO {
|
|
23
|
-
account_id: string;
|
|
24
|
-
amount: BigNumberInput;
|
|
25
|
-
currency_code: string;
|
|
26
|
-
reference?: string;
|
|
27
|
-
reference_id?: string;
|
|
28
|
-
}
|
|
29
|
-
export interface CreatePayoutBalanceDTO {
|
|
30
|
-
account_id: string;
|
|
31
|
-
currency_code: string;
|
|
32
|
-
totals?: Record<string, unknown>;
|
|
33
|
-
}
|
|
34
21
|
//# sourceMappingURL=mutations.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/payout/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;
|
|
1
|
+
{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/payout/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAEhD,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;CAClE;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC1D,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,mBAAmB,CAAA;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,YAAY,CAAA;CACrB"}
|