@vrplatform/api 1.3.1-6359 → 1.3.1-6364

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/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-6359",
6
+ "version": "1.3.1-6364",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -4495,7 +4495,7 @@ export interface paths {
4495
4495
  cookie?: never;
4496
4496
  };
4497
4497
  /**
4498
- * @description Owner statement summary detail PDF
4498
+ * @description Owner statement summary detail PDF. Returns 404 when the selected layout no longer exists.
4499
4499
  *
4500
4500
  * Required scope: statements:read, statements:export
4501
4501
  */
@@ -4516,7 +4516,7 @@ export interface paths {
4516
4516
  cookie?: never;
4517
4517
  };
4518
4518
  /**
4519
- * @description Owner statement summary PDF ZIP export
4519
+ * @description Owner statement summary PDF ZIP export. Returns 404 when the selected layout no longer exists.
4520
4520
  *
4521
4521
  * Required scope: statements:read, statements:export
4522
4522
  */
@@ -6540,6 +6540,27 @@ export interface paths {
6540
6540
  patch?: never;
6541
6541
  trace?: never;
6542
6542
  };
6543
+ "/transactions/{id}/provider-payments/{providerPaymentId}/cancel": {
6544
+ parameters: {
6545
+ query?: never;
6546
+ header?: never;
6547
+ path?: never;
6548
+ cookie?: never;
6549
+ };
6550
+ get?: never;
6551
+ put?: never;
6552
+ /**
6553
+ * @description Request cancellation of an uninitiated Ramp payment. Ramp archives the bill and remains authoritative about whether cancellation is still possible. This does not unlink the payment or change payout accounting.
6554
+ *
6555
+ * Required scope: transactions:mark-paid, ach-payments:execute
6556
+ */
6557
+ post: operations["postTransactionsByIdProviderPaymentsByProviderPaymentIdCancel"];
6558
+ delete?: never;
6559
+ options?: never;
6560
+ head?: never;
6561
+ patch?: never;
6562
+ trace?: never;
6563
+ };
6543
6564
  "/transactions/{transactionId}/lines/{id}": {
6544
6565
  parameters: {
6545
6566
  query?: never;
@@ -30067,6 +30088,8 @@ export interface operations {
30067
30088
  last4: string | null;
30068
30089
  /** @enum {string} */
30069
30090
  status: "notConfigured" | "pending" | "ready" | "failed";
30091
+ /** @description Safe failure detail from the latest Ramp ACH setup attempt. */
30092
+ failureReason?: string | null;
30070
30093
  /** @description True when a Ramp payment is requested or processing. Bank changes remain allowed and affect future payments only. */
30071
30094
  hasInFlightPayment: boolean;
30072
30095
  };
@@ -31635,6 +31658,8 @@ export interface operations {
31635
31658
  last4: string | null;
31636
31659
  /** @enum {string} */
31637
31660
  status: "notConfigured" | "pending" | "ready" | "failed";
31661
+ /** @description Safe failure detail from the latest Ramp ACH setup attempt. */
31662
+ failureReason?: string | null;
31638
31663
  /** @description True when a Ramp payment is requested or processing. Bank changes remain allowed and affect future payments only. */
31639
31664
  hasInFlightPayment: boolean;
31640
31665
  };
@@ -62292,7 +62317,7 @@ export interface operations {
62292
62317
  startAt?: string | null;
62293
62318
  endAt?: string | null;
62294
62319
  reserve?: number | null;
62295
- /** @description One or more unique owners for an active period; use an empty array only with setListingInactive=true */
62320
+ /** @description One or more unique owners for an active period; canonical explicit splits total 100000 basis points, while legacy 100-point totals remain accepted; use an empty array only with setListingInactive=true */
62296
62321
  members: {
62297
62322
  contactId?: string | null;
62298
62323
  split?: number | null;
@@ -62861,7 +62886,7 @@ export interface operations {
62861
62886
  startAt?: string | null;
62862
62887
  endAt?: string | null;
62863
62888
  reserve?: number | null;
62864
- /** @description One or more unique owners for an active period; use an empty array only with setListingInactive=true */
62889
+ /** @description One or more unique owners for an active period; canonical explicit splits total 100000 basis points, while legacy 100-point totals remain accepted; use an empty array only with setListingInactive=true */
62865
62890
  members?: {
62866
62891
  contactId?: string | null;
62867
62892
  split?: number | null;
@@ -115305,6 +115330,8 @@ export interface operations {
115305
115330
  last4: string | null;
115306
115331
  /** @enum {string} */
115307
115332
  status: "notConfigured" | "pending" | "ready" | "failed";
115333
+ /** @description Safe failure detail from the latest Ramp ACH setup attempt. */
115334
+ failureReason?: string | null;
115308
115335
  } | null;
115309
115336
  ready: boolean;
115310
115337
  }[];
@@ -142115,6 +142142,265 @@ export interface operations {
142115
142142
  };
142116
142143
  };
142117
142144
  };
142145
+ postTransactionsByIdProviderPaymentsByProviderPaymentIdCancel: {
142146
+ parameters: {
142147
+ query?: never;
142148
+ header?: never;
142149
+ path: {
142150
+ id: string;
142151
+ providerPaymentId: string;
142152
+ };
142153
+ cookie?: never;
142154
+ };
142155
+ requestBody?: {
142156
+ content: {
142157
+ "application/json": Record<string, never>;
142158
+ };
142159
+ };
142160
+ responses: {
142161
+ /** @description Successful response */
142162
+ 200: {
142163
+ headers: {
142164
+ [name: string]: unknown;
142165
+ };
142166
+ content: {
142167
+ "application/json": {
142168
+ /** Format: uuid */
142169
+ providerPaymentId: string;
142170
+ /** Format: uuid */
142171
+ syncId: string;
142172
+ /** @constant */
142173
+ status: "requested";
142174
+ };
142175
+ };
142176
+ };
142177
+ /** @description Bad request */
142178
+ 400: {
142179
+ headers: {
142180
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142181
+ "Retry-After"?: number;
142182
+ [name: string]: unknown;
142183
+ };
142184
+ content: {
142185
+ "application/json": {
142186
+ code: string;
142187
+ message: string;
142188
+ links?: {
142189
+ docs: string;
142190
+ schema: string;
142191
+ };
142192
+ issues?: {
142193
+ message: string;
142194
+ path?: (string | number)[];
142195
+ schema?: string;
142196
+ }[];
142197
+ retryable?: boolean;
142198
+ context?: unknown;
142199
+ };
142200
+ };
142201
+ };
142202
+ /** @description Unauthorized */
142203
+ 401: {
142204
+ headers: {
142205
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142206
+ "Retry-After"?: number;
142207
+ [name: string]: unknown;
142208
+ };
142209
+ content: {
142210
+ "application/json": {
142211
+ code: string;
142212
+ message: string;
142213
+ links?: {
142214
+ docs: string;
142215
+ schema: string;
142216
+ };
142217
+ issues?: {
142218
+ message: string;
142219
+ path?: (string | number)[];
142220
+ schema?: string;
142221
+ }[];
142222
+ retryable?: boolean;
142223
+ context?: unknown;
142224
+ };
142225
+ };
142226
+ };
142227
+ /** @description Forbidden */
142228
+ 403: {
142229
+ headers: {
142230
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142231
+ "Retry-After"?: number;
142232
+ [name: string]: unknown;
142233
+ };
142234
+ content: {
142235
+ "application/json": {
142236
+ code: string;
142237
+ message: string;
142238
+ links?: {
142239
+ docs: string;
142240
+ schema: string;
142241
+ };
142242
+ issues?: {
142243
+ message: string;
142244
+ path?: (string | number)[];
142245
+ schema?: string;
142246
+ }[];
142247
+ retryable?: boolean;
142248
+ context?: unknown;
142249
+ };
142250
+ };
142251
+ };
142252
+ /** @description Not found */
142253
+ 404: {
142254
+ headers: {
142255
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142256
+ "Retry-After"?: number;
142257
+ [name: string]: unknown;
142258
+ };
142259
+ content: {
142260
+ "application/json": {
142261
+ code: string;
142262
+ message: string;
142263
+ links?: {
142264
+ docs: string;
142265
+ schema: string;
142266
+ };
142267
+ issues?: {
142268
+ message: string;
142269
+ path?: (string | number)[];
142270
+ schema?: string;
142271
+ }[];
142272
+ retryable?: boolean;
142273
+ context?: unknown;
142274
+ };
142275
+ };
142276
+ };
142277
+ /** @description Conflict */
142278
+ 409: {
142279
+ headers: {
142280
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142281
+ "Retry-After"?: number;
142282
+ [name: string]: unknown;
142283
+ };
142284
+ content: {
142285
+ "application/json": {
142286
+ code: string;
142287
+ message: string;
142288
+ links?: {
142289
+ docs: string;
142290
+ schema: string;
142291
+ };
142292
+ issues?: {
142293
+ message: string;
142294
+ path?: (string | number)[];
142295
+ schema?: string;
142296
+ }[];
142297
+ retryable?: boolean;
142298
+ context?: unknown;
142299
+ };
142300
+ };
142301
+ };
142302
+ /** @description Gone */
142303
+ 410: {
142304
+ headers: {
142305
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142306
+ "Retry-After"?: number;
142307
+ [name: string]: unknown;
142308
+ };
142309
+ content: {
142310
+ "application/json": {
142311
+ code: string;
142312
+ message: string;
142313
+ links?: {
142314
+ docs: string;
142315
+ schema: string;
142316
+ };
142317
+ issues?: {
142318
+ message: string;
142319
+ path?: (string | number)[];
142320
+ schema?: string;
142321
+ }[];
142322
+ retryable?: boolean;
142323
+ context?: unknown;
142324
+ };
142325
+ };
142326
+ };
142327
+ /** @description Unprocessable content */
142328
+ 422: {
142329
+ headers: {
142330
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142331
+ "Retry-After"?: number;
142332
+ [name: string]: unknown;
142333
+ };
142334
+ content: {
142335
+ "application/json": {
142336
+ code: string;
142337
+ message: string;
142338
+ links?: {
142339
+ docs: string;
142340
+ schema: string;
142341
+ };
142342
+ issues?: {
142343
+ message: string;
142344
+ path?: (string | number)[];
142345
+ schema?: string;
142346
+ }[];
142347
+ retryable?: boolean;
142348
+ context?: unknown;
142349
+ };
142350
+ };
142351
+ };
142352
+ /** @description Internal server error */
142353
+ 500: {
142354
+ headers: {
142355
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142356
+ "Retry-After"?: number;
142357
+ [name: string]: unknown;
142358
+ };
142359
+ content: {
142360
+ "application/json": {
142361
+ code: string;
142362
+ message: string;
142363
+ links?: {
142364
+ docs: string;
142365
+ schema: string;
142366
+ };
142367
+ issues?: {
142368
+ message: string;
142369
+ path?: (string | number)[];
142370
+ schema?: string;
142371
+ }[];
142372
+ retryable?: boolean;
142373
+ context?: unknown;
142374
+ };
142375
+ };
142376
+ };
142377
+ /** @description Service unavailable */
142378
+ 503: {
142379
+ headers: {
142380
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
142381
+ "Retry-After"?: number;
142382
+ [name: string]: unknown;
142383
+ };
142384
+ content: {
142385
+ "application/json": {
142386
+ code: string;
142387
+ message: string;
142388
+ links?: {
142389
+ docs: string;
142390
+ schema: string;
142391
+ };
142392
+ issues?: {
142393
+ message: string;
142394
+ path?: (string | number)[];
142395
+ schema?: string;
142396
+ }[];
142397
+ retryable?: boolean;
142398
+ context?: unknown;
142399
+ };
142400
+ };
142401
+ };
142402
+ };
142403
+ };
142118
142404
  putTransactionsByTransactionIdLinesById: {
142119
142405
  parameters: {
142120
142406
  query?: {