@vrplatform/api 1.3.1-6359 → 1.3.1-6369

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