@vexpay/node 0.13.0 → 0.14.0

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/index.d.cts CHANGED
@@ -1077,6 +1077,88 @@ interface components {
1077
1077
  /** Format: date-time */
1078
1078
  createdAt: string;
1079
1079
  };
1080
+ SimulateDepositDto: {
1081
+ /**
1082
+ * @description The `customerRef` of a deposit address you already requested.
1083
+ * @example user_123
1084
+ */
1085
+ customerRef: string;
1086
+ /**
1087
+ * @description Network of that deposit address.
1088
+ * @example TRC20
1089
+ * @enum {string}
1090
+ */
1091
+ network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1" | "BASE";
1092
+ /**
1093
+ * @description Stablecoin of that deposit address.
1094
+ * @default USDT
1095
+ * @example USDT
1096
+ * @enum {string}
1097
+ */
1098
+ currency?: "USDT" | "USDC";
1099
+ /**
1100
+ * @description Amount that "arrives", in `currency`: greater than 0, at most 10,000, at most 2 decimals.
1101
+ * @example 40.00
1102
+ */
1103
+ amount: string | number;
1104
+ };
1105
+ SimulatedDepositDto: {
1106
+ /** Format: uuid */
1107
+ paymentId: string;
1108
+ /**
1109
+ * @example COMPLETED
1110
+ * @enum {string}
1111
+ */
1112
+ status: "COMPLETED";
1113
+ /**
1114
+ * @example USDT
1115
+ * @enum {string}
1116
+ */
1117
+ method: "USDT" | "USDC";
1118
+ /**
1119
+ * @example USDT
1120
+ * @enum {string}
1121
+ */
1122
+ currency: "USDT" | "USDC";
1123
+ /**
1124
+ * @description Amount received, in `currency`.
1125
+ * @example 40.00
1126
+ */
1127
+ amount: string;
1128
+ /**
1129
+ * @description Your stablecoin fee, in `currency`. The balance is credited `amount` − `fee`.
1130
+ * @example 1.50
1131
+ */
1132
+ fee: string;
1133
+ /**
1134
+ * @description USDT only: same as `amount`.
1135
+ * @example 40.00
1136
+ */
1137
+ amountUsdt?: string;
1138
+ /**
1139
+ * @description USDT only: same as `fee`.
1140
+ * @example 1.50
1141
+ */
1142
+ feeUsdt?: string;
1143
+ /** @example TRC20 */
1144
+ network: string;
1145
+ /** @example user_123 */
1146
+ customerRef: string;
1147
+ /**
1148
+ * @description Always empty: nothing moved on chain.
1149
+ * @example []
1150
+ */
1151
+ txHashes: string[];
1152
+ /**
1153
+ * @description Always false: simulated deposits exist in Test mode only.
1154
+ * @example false
1155
+ */
1156
+ livemode: boolean;
1157
+ /** @example true */
1158
+ simulated: boolean;
1159
+ /** Format: date-time */
1160
+ createdAt: string;
1161
+ };
1080
1162
  CryptoNetworkDto: {
1081
1163
  /**
1082
1164
  * @example USDT
@@ -5495,6 +5577,87 @@ interface operations {
5495
5577
  };
5496
5578
  };
5497
5579
  };
5580
+ Crypto_simulateDeposit: {
5581
+ parameters: {
5582
+ query?: never;
5583
+ header?: {
5584
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
5585
+ "Idempotency-Key"?: string;
5586
+ };
5587
+ path?: never;
5588
+ cookie?: never;
5589
+ };
5590
+ requestBody: {
5591
+ content: {
5592
+ "application/json": components["schemas"]["SimulateDepositDto"];
5593
+ };
5594
+ };
5595
+ responses: {
5596
+ /** @description Deposit credited. */
5597
+ 201: {
5598
+ headers: {
5599
+ [name: string]: unknown;
5600
+ };
5601
+ content: {
5602
+ "application/json": components["schemas"]["SimulatedDepositDto"];
5603
+ };
5604
+ };
5605
+ /** @description `invalid_data` (amount missing, not above 0, above 10,000 or with more than 2 decimals) or `unsupported_currency`. */
5606
+ 400: {
5607
+ headers: {
5608
+ [name: string]: unknown;
5609
+ };
5610
+ content: {
5611
+ "application/json": components["schemas"]["ApiErrorDto"];
5612
+ };
5613
+ };
5614
+ /** @description Missing, invalid, or inactive tenant API key. */
5615
+ 401: {
5616
+ headers: {
5617
+ [name: string]: unknown;
5618
+ };
5619
+ content: {
5620
+ "application/json": components["schemas"]["ApiErrorDto"];
5621
+ };
5622
+ };
5623
+ /** @description `test_mode_only` — called with a Live key; or `method_not_allowed`. */
5624
+ 403: {
5625
+ headers: {
5626
+ [name: string]: unknown;
5627
+ };
5628
+ content: {
5629
+ "application/json": components["schemas"]["ApiErrorDto"];
5630
+ };
5631
+ };
5632
+ /** @description `not_found` — no deposit address was requested for that `customerRef`, `currency` and `network`. */
5633
+ 404: {
5634
+ headers: {
5635
+ [name: string]: unknown;
5636
+ };
5637
+ content: {
5638
+ "application/json": components["schemas"]["ApiErrorDto"];
5639
+ };
5640
+ };
5641
+ /** @description Client error. */
5642
+ "4XX": {
5643
+ headers: {
5644
+ [name: string]: unknown;
5645
+ };
5646
+ content: {
5647
+ "application/json": components["schemas"]["ApiErrorDto"];
5648
+ };
5649
+ };
5650
+ /** @description Server or upstream bank error. */
5651
+ "5XX": {
5652
+ headers: {
5653
+ [name: string]: unknown;
5654
+ };
5655
+ content: {
5656
+ "application/json": components["schemas"]["ApiErrorDto"];
5657
+ };
5658
+ };
5659
+ };
5660
+ };
5498
5661
  Crypto_listNetworks: {
5499
5662
  parameters: {
5500
5663
  query?: {
@@ -13573,6 +13736,27 @@ declare class Crypto extends APIResource {
13573
13736
  readonly depositAddresses: DepositAddresses;
13574
13737
  readonly networks: CryptoNetworks;
13575
13738
  readonly payouts: CryptoPayouts;
13739
+ /**
13740
+ * Test mode only: credit a deposit to one of your deposit addresses (`customerRef` + `currency` +
13741
+ * `network`, requested before) as if it had arrived on chain. Sends `payment.completed` with
13742
+ * `livemode: false`. A Live key gets 403 `test_mode_only`; an unknown address 404.
13743
+ */
13744
+ simulateDeposit(params: RequestBody<'Crypto_simulateDeposit'>, options?: RequestOptions): Promise<{
13745
+ paymentId: string;
13746
+ status: "COMPLETED";
13747
+ method: "USDT" | "USDC";
13748
+ currency: "USDT" | "USDC";
13749
+ amount: string;
13750
+ fee: string;
13751
+ amountUsdt?: string;
13752
+ feeUsdt?: string;
13753
+ network: string;
13754
+ customerRef: string;
13755
+ txHashes: string[];
13756
+ livemode: boolean;
13757
+ simulated: boolean;
13758
+ createdAt: string;
13759
+ }>;
13576
13760
  }
13577
13761
 
13578
13762
  type MerchantListParams = Omit<QueryParams<'Merchants_listOrGetByRef'>, 'externalRef'>;
@@ -14395,6 +14579,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
14395
14579
  declare class VexPaySignatureVerificationError extends VexPayError {
14396
14580
  }
14397
14581
 
14398
- declare const VERSION = "0.13.0";
14582
+ declare const VERSION = "0.14.0";
14399
14583
 
14400
14584
  export { type CopPaymentWebhookData, type CursorPage, DEFAULT_BASE_URL, DEFAULT_TOLERANCE_SECONDS, type OperationId, PagePromise, type PathParams, type PaymentWebhookData, type QueryParams, type RequestBody, type RequestOptions, type ResponseBody, SIGNATURE_HEADER, type Schemas, VERSION, VexPay, VexPayAPIError, VexPayAuthenticationError, VexPayConfigurationError, VexPayConflictError, VexPayConnectionError, VexPayError, VexPayInvalidRequestError, VexPayNotFoundError, type VexPayOptions, VexPayRateLimitError, VexPaySignatureVerificationError, VexPayTimeoutError, WEBHOOK_EVENT_NAMES, type WebhookEvent, type WebhookEventName, Webhooks, VexPay as default };
package/dist/index.d.ts CHANGED
@@ -1077,6 +1077,88 @@ interface components {
1077
1077
  /** Format: date-time */
1078
1078
  createdAt: string;
1079
1079
  };
1080
+ SimulateDepositDto: {
1081
+ /**
1082
+ * @description The `customerRef` of a deposit address you already requested.
1083
+ * @example user_123
1084
+ */
1085
+ customerRef: string;
1086
+ /**
1087
+ * @description Network of that deposit address.
1088
+ * @example TRC20
1089
+ * @enum {string}
1090
+ */
1091
+ network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1" | "BASE";
1092
+ /**
1093
+ * @description Stablecoin of that deposit address.
1094
+ * @default USDT
1095
+ * @example USDT
1096
+ * @enum {string}
1097
+ */
1098
+ currency?: "USDT" | "USDC";
1099
+ /**
1100
+ * @description Amount that "arrives", in `currency`: greater than 0, at most 10,000, at most 2 decimals.
1101
+ * @example 40.00
1102
+ */
1103
+ amount: string | number;
1104
+ };
1105
+ SimulatedDepositDto: {
1106
+ /** Format: uuid */
1107
+ paymentId: string;
1108
+ /**
1109
+ * @example COMPLETED
1110
+ * @enum {string}
1111
+ */
1112
+ status: "COMPLETED";
1113
+ /**
1114
+ * @example USDT
1115
+ * @enum {string}
1116
+ */
1117
+ method: "USDT" | "USDC";
1118
+ /**
1119
+ * @example USDT
1120
+ * @enum {string}
1121
+ */
1122
+ currency: "USDT" | "USDC";
1123
+ /**
1124
+ * @description Amount received, in `currency`.
1125
+ * @example 40.00
1126
+ */
1127
+ amount: string;
1128
+ /**
1129
+ * @description Your stablecoin fee, in `currency`. The balance is credited `amount` − `fee`.
1130
+ * @example 1.50
1131
+ */
1132
+ fee: string;
1133
+ /**
1134
+ * @description USDT only: same as `amount`.
1135
+ * @example 40.00
1136
+ */
1137
+ amountUsdt?: string;
1138
+ /**
1139
+ * @description USDT only: same as `fee`.
1140
+ * @example 1.50
1141
+ */
1142
+ feeUsdt?: string;
1143
+ /** @example TRC20 */
1144
+ network: string;
1145
+ /** @example user_123 */
1146
+ customerRef: string;
1147
+ /**
1148
+ * @description Always empty: nothing moved on chain.
1149
+ * @example []
1150
+ */
1151
+ txHashes: string[];
1152
+ /**
1153
+ * @description Always false: simulated deposits exist in Test mode only.
1154
+ * @example false
1155
+ */
1156
+ livemode: boolean;
1157
+ /** @example true */
1158
+ simulated: boolean;
1159
+ /** Format: date-time */
1160
+ createdAt: string;
1161
+ };
1080
1162
  CryptoNetworkDto: {
1081
1163
  /**
1082
1164
  * @example USDT
@@ -5495,6 +5577,87 @@ interface operations {
5495
5577
  };
5496
5578
  };
5497
5579
  };
5580
+ Crypto_simulateDeposit: {
5581
+ parameters: {
5582
+ query?: never;
5583
+ header?: {
5584
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
5585
+ "Idempotency-Key"?: string;
5586
+ };
5587
+ path?: never;
5588
+ cookie?: never;
5589
+ };
5590
+ requestBody: {
5591
+ content: {
5592
+ "application/json": components["schemas"]["SimulateDepositDto"];
5593
+ };
5594
+ };
5595
+ responses: {
5596
+ /** @description Deposit credited. */
5597
+ 201: {
5598
+ headers: {
5599
+ [name: string]: unknown;
5600
+ };
5601
+ content: {
5602
+ "application/json": components["schemas"]["SimulatedDepositDto"];
5603
+ };
5604
+ };
5605
+ /** @description `invalid_data` (amount missing, not above 0, above 10,000 or with more than 2 decimals) or `unsupported_currency`. */
5606
+ 400: {
5607
+ headers: {
5608
+ [name: string]: unknown;
5609
+ };
5610
+ content: {
5611
+ "application/json": components["schemas"]["ApiErrorDto"];
5612
+ };
5613
+ };
5614
+ /** @description Missing, invalid, or inactive tenant API key. */
5615
+ 401: {
5616
+ headers: {
5617
+ [name: string]: unknown;
5618
+ };
5619
+ content: {
5620
+ "application/json": components["schemas"]["ApiErrorDto"];
5621
+ };
5622
+ };
5623
+ /** @description `test_mode_only` — called with a Live key; or `method_not_allowed`. */
5624
+ 403: {
5625
+ headers: {
5626
+ [name: string]: unknown;
5627
+ };
5628
+ content: {
5629
+ "application/json": components["schemas"]["ApiErrorDto"];
5630
+ };
5631
+ };
5632
+ /** @description `not_found` — no deposit address was requested for that `customerRef`, `currency` and `network`. */
5633
+ 404: {
5634
+ headers: {
5635
+ [name: string]: unknown;
5636
+ };
5637
+ content: {
5638
+ "application/json": components["schemas"]["ApiErrorDto"];
5639
+ };
5640
+ };
5641
+ /** @description Client error. */
5642
+ "4XX": {
5643
+ headers: {
5644
+ [name: string]: unknown;
5645
+ };
5646
+ content: {
5647
+ "application/json": components["schemas"]["ApiErrorDto"];
5648
+ };
5649
+ };
5650
+ /** @description Server or upstream bank error. */
5651
+ "5XX": {
5652
+ headers: {
5653
+ [name: string]: unknown;
5654
+ };
5655
+ content: {
5656
+ "application/json": components["schemas"]["ApiErrorDto"];
5657
+ };
5658
+ };
5659
+ };
5660
+ };
5498
5661
  Crypto_listNetworks: {
5499
5662
  parameters: {
5500
5663
  query?: {
@@ -13573,6 +13736,27 @@ declare class Crypto extends APIResource {
13573
13736
  readonly depositAddresses: DepositAddresses;
13574
13737
  readonly networks: CryptoNetworks;
13575
13738
  readonly payouts: CryptoPayouts;
13739
+ /**
13740
+ * Test mode only: credit a deposit to one of your deposit addresses (`customerRef` + `currency` +
13741
+ * `network`, requested before) as if it had arrived on chain. Sends `payment.completed` with
13742
+ * `livemode: false`. A Live key gets 403 `test_mode_only`; an unknown address 404.
13743
+ */
13744
+ simulateDeposit(params: RequestBody<'Crypto_simulateDeposit'>, options?: RequestOptions): Promise<{
13745
+ paymentId: string;
13746
+ status: "COMPLETED";
13747
+ method: "USDT" | "USDC";
13748
+ currency: "USDT" | "USDC";
13749
+ amount: string;
13750
+ fee: string;
13751
+ amountUsdt?: string;
13752
+ feeUsdt?: string;
13753
+ network: string;
13754
+ customerRef: string;
13755
+ txHashes: string[];
13756
+ livemode: boolean;
13757
+ simulated: boolean;
13758
+ createdAt: string;
13759
+ }>;
13576
13760
  }
13577
13761
 
13578
13762
  type MerchantListParams = Omit<QueryParams<'Merchants_listOrGetByRef'>, 'externalRef'>;
@@ -14395,6 +14579,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
14395
14579
  declare class VexPaySignatureVerificationError extends VexPayError {
14396
14580
  }
14397
14581
 
14398
- declare const VERSION = "0.13.0";
14582
+ declare const VERSION = "0.14.0";
14399
14583
 
14400
14584
  export { type CopPaymentWebhookData, type CursorPage, DEFAULT_BASE_URL, DEFAULT_TOLERANCE_SECONDS, type OperationId, PagePromise, type PathParams, type PaymentWebhookData, type QueryParams, type RequestBody, type RequestOptions, type ResponseBody, SIGNATURE_HEADER, type Schemas, VERSION, VexPay, VexPayAPIError, VexPayAuthenticationError, VexPayConfigurationError, VexPayConflictError, VexPayConnectionError, VexPayError, VexPayInvalidRequestError, VexPayNotFoundError, type VexPayOptions, VexPayRateLimitError, VexPaySignatureVerificationError, VexPayTimeoutError, WEBHOOK_EVENT_NAMES, type WebhookEvent, type WebhookEventName, Webhooks, VexPay as default };
package/dist/index.js CHANGED
@@ -62,7 +62,7 @@ function errorFromResponse(status, body, requestId) {
62
62
  }
63
63
 
64
64
  // src/version.ts
65
- var VERSION = "0.13.0";
65
+ var VERSION = "0.14.0";
66
66
 
67
67
  // src/core.ts
68
68
  var INITIAL_RETRY_DELAY_MS = 500;
@@ -236,6 +236,7 @@ var ROUTES = {
236
236
  Crypto_getBalances: { method: "GET", path: "/v1/crypto/balances" },
237
237
  Crypto_getPayout: { method: "GET", path: "/v1/crypto/payouts/{id}" },
238
238
  Crypto_listNetworks: { method: "GET", path: "/v1/crypto/networks" },
239
+ Crypto_simulateDeposit: { method: "POST", path: "/v1/crypto/deposit-addresses/simulate" },
239
240
  Customers_create: { method: "POST", path: "/v1/customers" },
240
241
  Customers_list: { method: "GET", path: "/v1/customers" },
241
242
  Customers_remove: { method: "DELETE", path: "/v1/customers/{id}" },
@@ -764,6 +765,14 @@ var Crypto = class extends APIResource {
764
765
  depositAddresses = new DepositAddresses(this.http);
765
766
  networks = new CryptoNetworks(this.http);
766
767
  payouts = new CryptoPayouts(this.http);
768
+ /**
769
+ * Test mode only: credit a deposit to one of your deposit addresses (`customerRef` + `currency` +
770
+ * `network`, requested before) as if it had arrived on chain. Sends `payment.completed` with
771
+ * `livemode: false`. A Live key gets 403 `test_mode_only`; an unknown address 404.
772
+ */
773
+ simulateDeposit(params, options) {
774
+ return this.call("Crypto_simulateDeposit", { body: params }, options);
775
+ }
767
776
  };
768
777
 
769
778
  // src/resources/merchants.ts