@vrplatform/api 1.3.1-stage.5687 → 1.3.1-stage.5691

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.
@@ -981,7 +981,7 @@ export interface paths {
981
981
  get?: never;
982
982
  put?: never;
983
983
  /**
984
- * @description Import a CSV; mapped bank records require this connection's signed upload
984
+ * @description Import a CSV; mapped bank records require this Connection's upload reference
985
985
  *
986
986
  * Required scope: integrations:import
987
987
  */
@@ -1002,7 +1002,7 @@ export interface paths {
1002
1002
  get?: never;
1003
1003
  put?: never;
1004
1004
  /**
1005
- * @description Start a bank-record CSV preview from this connection's signed upload
1005
+ * @description Start a bank-record CSV preview from this Connection's upload reference
1006
1006
  *
1007
1007
  * Required scope: integrations:import
1008
1008
  */
@@ -1044,7 +1044,7 @@ export interface paths {
1044
1044
  get?: never;
1045
1045
  put?: never;
1046
1046
  /**
1047
- * @description Start a size-bound multipart CSV import upload for this connection
1047
+ * @description Create a size-bound CSV upload reference and raw PUT URL for this Connection
1048
1048
  *
1049
1049
  * Required scope: integrations:import
1050
1050
  */
@@ -1063,54 +1063,12 @@ export interface paths {
1063
1063
  cookie?: never;
1064
1064
  };
1065
1065
  get?: never;
1066
- put?: never;
1067
- post?: never;
1068
1066
  /**
1069
- * @description Abort a multipart CSV import upload
1067
+ * @description Stream the complete CSV body into regional storage using an issued upload reference
1070
1068
  *
1071
1069
  * Required scope: integrations:import
1072
1070
  */
1073
- delete: operations["deleteConnectionsByIdCsvImportUploadsByUploadRef"];
1074
- options?: never;
1075
- head?: never;
1076
- patch?: never;
1077
- trace?: never;
1078
- };
1079
- "/connections/{id}/csv-import/uploads/{uploadRef}/complete": {
1080
- parameters: {
1081
- query?: never;
1082
- header?: never;
1083
- path?: never;
1084
- cookie?: never;
1085
- };
1086
- get?: never;
1087
- put?: never;
1088
- /**
1089
- * @description Complete the full ordered multipart CSV import upload
1090
- *
1091
- * Required scope: integrations:import
1092
- */
1093
- post: operations["postConnectionsByIdCsvImportUploadsByUploadRefComplete"];
1094
- delete?: never;
1095
- options?: never;
1096
- head?: never;
1097
- patch?: never;
1098
- trace?: never;
1099
- };
1100
- "/connections/{id}/csv-import/uploads/{uploadRef}/parts/{partNumber}": {
1101
- parameters: {
1102
- query?: never;
1103
- header?: never;
1104
- path?: never;
1105
- cookie?: never;
1106
- };
1107
- get?: never;
1108
- /**
1109
- * @description Upload one exact-size part of a multipart CSV import
1110
- *
1111
- * Required scope: integrations:import
1112
- */
1113
- put: operations["putConnectionsByIdCsvImportUploadsByUploadRefPartsByPartNumber"];
1071
+ put: operations["putConnectionsByIdCsvImportUploadsByUploadRef"];
1114
1072
  post?: never;
1115
1073
  delete?: never;
1116
1074
  options?: never;
@@ -4985,7 +4943,7 @@ export interface paths {
4985
4943
  get?: never;
4986
4944
  put?: never;
4987
4945
  /**
4988
- * @description Execute owner statement payouts with one explicit selection per ownership member. Every selection books a payout transaction against its bank account. `provider: "ramp"` additionally dispatches an ACH payment through the exact Ramp entity and source bank account imported for that bank account; missing or ambiguous routing is rejected before payout creation. The first otherwise-valid Ramp payout activates a transfer flow whose status has never been configured; an explicitly inactive flow remains unavailable. `provider: null` never dispatches, even when the bank account is Ramp-backed. Each statement validates and executes atomically and independently, so one blocked statement never rolls back earlier results. Raw bank details are never accepted here; owner ACH methods are managed through `POST /contacts/{id}/payment-methods/ach`.
4946
+ * @description Execute owner statement payouts with one explicit selection per ownership member. Every selection books a payout transaction against its bank account. `provider: "ramp"` additionally dispatches an ACH payment through the exact Ramp entity and source bank account imported for that bank account; missing or ambiguous routing, or a `payout_distribution` Category account without a completed current Ramp chart-of-accounts push, is rejected before payout creation. The first otherwise-valid Ramp payout activates a transfer flow whose status has never been configured; an explicitly inactive flow remains unavailable. `provider: null` never dispatches, even when the bank account is Ramp-backed. Each statement validates and executes atomically and independently, so one blocked statement never rolls back earlier results. Raw bank details are never accepted here; owner ACH methods are managed through `POST /contacts/{id}/payment-methods/ach`.
4989
4947
  *
4990
4948
  * Required scope: statements:pay
4991
4949
  */
@@ -5006,7 +4964,7 @@ export interface paths {
5006
4964
  get?: never;
5007
4965
  put?: never;
5008
4966
  /**
5009
- * @description Preview owner statement payout plans without creating transactions. Returns authoritative per-owner allocations after server rounding, default bank accounts, ACH payment-method readiness, exact Ramp funding-source readiness, and typed blockers for the submitted owner selections. An unconfigured Ramp transfer flow is eligible but remains unchanged until payment. `POST /statements/pay` revalidates the same rules; the preview is advisory.
4967
+ * @description Preview owner statement payout plans without creating transactions. Returns authoritative per-owner allocations after server rounding, default bank accounts, ACH payment-method readiness, exact Ramp funding-source readiness, completed Ramp Category-account synchronization readiness, and typed blockers for the submitted owner selections. An unconfigured Ramp transfer flow is eligible but remains unchanged until payment. `POST /statements/pay` revalidates the same rules; the preview is advisory.
5010
4968
  *
5011
4969
  * Required scope: statements:read
5012
4970
  */
@@ -6022,7 +5980,7 @@ export interface paths {
6022
5980
  get?: never;
6023
5981
  put?: never;
6024
5982
  /**
6025
- * @description Record an expense as paid manually, or request a Ramp ACH payment for an expense or payout. Ramp requests require a fundingAccountId whose imported source provides the exact Ramp entity and bank account. A terminal provider failure can be retried against the existing transaction.
5983
+ * @description Record an expense as paid manually, or request a Ramp ACH payment for an expense or payout. Ramp requests require a fundingAccountId whose imported source provides the exact Ramp entity and bank account. Every outbound bill Category account must also have a completed current Ramp chart-of-accounts push. A terminal provider failure can be retried against the existing transaction.
6026
5984
  *
6027
5985
  * Required scope: transactions:pay
6028
5986
  */
@@ -25591,6 +25549,7 @@ export interface operations {
25591
25549
  fileData?: string;
25592
25550
  fileUri?: string;
25593
25551
  fileName?: string;
25552
+ uploadRef?: string;
25594
25553
  uniqueRef: string;
25595
25554
  params?: {
25596
25555
  [key: string]: unknown;
@@ -25896,8 +25855,7 @@ export interface operations {
25896
25855
  requestBody?: {
25897
25856
  content: {
25898
25857
  "application/json": {
25899
- /** Format: uri */
25900
- fileUri: string;
25858
+ uploadRef: string;
25901
25859
  mapping?: {
25902
25860
  /** @constant */
25903
25861
  version: 1;
@@ -26618,262 +26576,11 @@ export interface operations {
26618
26576
  };
26619
26577
  content: {
26620
26578
  "application/json": {
26621
- key: string;
26579
+ /** Format: date-time */
26580
+ expiresAt: string;
26622
26581
  uploadRef: string;
26623
- partSize: number;
26624
- };
26625
- };
26626
- };
26627
- /** @description Bad request */
26628
- 400: {
26629
- headers: {
26630
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26631
- "Retry-After"?: number;
26632
- [name: string]: unknown;
26633
- };
26634
- content: {
26635
- "application/json": {
26636
- code: string;
26637
- message: string;
26638
- links?: {
26639
- docs: string;
26640
- schema: string;
26641
- };
26642
- issues?: {
26643
- message: string;
26644
- path?: (string | number)[];
26645
- schema?: string;
26646
- }[];
26647
- retryable?: boolean;
26648
- context?: unknown;
26649
- };
26650
- };
26651
- };
26652
- /** @description Unauthorized */
26653
- 401: {
26654
- headers: {
26655
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26656
- "Retry-After"?: number;
26657
- [name: string]: unknown;
26658
- };
26659
- content: {
26660
- "application/json": {
26661
- code: string;
26662
- message: string;
26663
- links?: {
26664
- docs: string;
26665
- schema: string;
26666
- };
26667
- issues?: {
26668
- message: string;
26669
- path?: (string | number)[];
26670
- schema?: string;
26671
- }[];
26672
- retryable?: boolean;
26673
- context?: unknown;
26674
- };
26675
- };
26676
- };
26677
- /** @description Forbidden */
26678
- 403: {
26679
- headers: {
26680
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26681
- "Retry-After"?: number;
26682
- [name: string]: unknown;
26683
- };
26684
- content: {
26685
- "application/json": {
26686
- code: string;
26687
- message: string;
26688
- links?: {
26689
- docs: string;
26690
- schema: string;
26691
- };
26692
- issues?: {
26693
- message: string;
26694
- path?: (string | number)[];
26695
- schema?: string;
26696
- }[];
26697
- retryable?: boolean;
26698
- context?: unknown;
26699
- };
26700
- };
26701
- };
26702
- /** @description Not found */
26703
- 404: {
26704
- headers: {
26705
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26706
- "Retry-After"?: number;
26707
- [name: string]: unknown;
26708
- };
26709
- content: {
26710
- "application/json": {
26711
- code: string;
26712
- message: string;
26713
- links?: {
26714
- docs: string;
26715
- schema: string;
26716
- };
26717
- issues?: {
26718
- message: string;
26719
- path?: (string | number)[];
26720
- schema?: string;
26721
- }[];
26722
- retryable?: boolean;
26723
- context?: unknown;
26724
- };
26725
- };
26726
- };
26727
- /** @description Conflict */
26728
- 409: {
26729
- headers: {
26730
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26731
- "Retry-After"?: number;
26732
- [name: string]: unknown;
26733
- };
26734
- content: {
26735
- "application/json": {
26736
- code: string;
26737
- message: string;
26738
- links?: {
26739
- docs: string;
26740
- schema: string;
26741
- };
26742
- issues?: {
26743
- message: string;
26744
- path?: (string | number)[];
26745
- schema?: string;
26746
- }[];
26747
- retryable?: boolean;
26748
- context?: unknown;
26749
- };
26750
- };
26751
- };
26752
- /** @description Gone */
26753
- 410: {
26754
- headers: {
26755
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26756
- "Retry-After"?: number;
26757
- [name: string]: unknown;
26758
- };
26759
- content: {
26760
- "application/json": {
26761
- code: string;
26762
- message: string;
26763
- links?: {
26764
- docs: string;
26765
- schema: string;
26766
- };
26767
- issues?: {
26768
- message: string;
26769
- path?: (string | number)[];
26770
- schema?: string;
26771
- }[];
26772
- retryable?: boolean;
26773
- context?: unknown;
26774
- };
26775
- };
26776
- };
26777
- /** @description Unprocessable content */
26778
- 422: {
26779
- headers: {
26780
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26781
- "Retry-After"?: number;
26782
- [name: string]: unknown;
26783
- };
26784
- content: {
26785
- "application/json": {
26786
- code: string;
26787
- message: string;
26788
- links?: {
26789
- docs: string;
26790
- schema: string;
26791
- };
26792
- issues?: {
26793
- message: string;
26794
- path?: (string | number)[];
26795
- schema?: string;
26796
- }[];
26797
- retryable?: boolean;
26798
- context?: unknown;
26799
- };
26800
- };
26801
- };
26802
- /** @description Internal server error */
26803
- 500: {
26804
- headers: {
26805
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26806
- "Retry-After"?: number;
26807
- [name: string]: unknown;
26808
- };
26809
- content: {
26810
- "application/json": {
26811
- code: string;
26812
- message: string;
26813
- links?: {
26814
- docs: string;
26815
- schema: string;
26816
- };
26817
- issues?: {
26818
- message: string;
26819
- path?: (string | number)[];
26820
- schema?: string;
26821
- }[];
26822
- retryable?: boolean;
26823
- context?: unknown;
26824
- };
26825
- };
26826
- };
26827
- /** @description Service unavailable */
26828
- 503: {
26829
- headers: {
26830
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26831
- "Retry-After"?: number;
26832
- [name: string]: unknown;
26833
- };
26834
- content: {
26835
- "application/json": {
26836
- code: string;
26837
- message: string;
26838
- links?: {
26839
- docs: string;
26840
- schema: string;
26841
- };
26842
- issues?: {
26843
- message: string;
26844
- path?: (string | number)[];
26845
- schema?: string;
26846
- }[];
26847
- retryable?: boolean;
26848
- context?: unknown;
26849
- };
26850
- };
26851
- };
26852
- };
26853
- };
26854
- deleteConnectionsByIdCsvImportUploadsByUploadRef: {
26855
- parameters: {
26856
- query: {
26857
- key: string;
26858
- };
26859
- header?: never;
26860
- path: {
26861
- id: string;
26862
- uploadRef: string;
26863
- };
26864
- cookie?: never;
26865
- };
26866
- requestBody?: never;
26867
- responses: {
26868
- /** @description Successful response */
26869
- 200: {
26870
- headers: {
26871
- [name: string]: unknown;
26872
- };
26873
- content: {
26874
- "application/json": {
26875
- /** @constant */
26876
- status: "deleted";
26582
+ /** Format: uri */
26583
+ uploadUrl: string;
26877
26584
  };
26878
26585
  };
26879
26586
  };
@@ -27104,7 +26811,7 @@ export interface operations {
27104
26811
  };
27105
26812
  };
27106
26813
  };
27107
- postConnectionsByIdCsvImportUploadsByUploadRefComplete: {
26814
+ putConnectionsByIdCsvImportUploadsByUploadRef: {
27108
26815
  parameters: {
27109
26816
  query?: never;
27110
26817
  header?: never;
@@ -27114,269 +26821,6 @@ export interface operations {
27114
26821
  };
27115
26822
  cookie?: never;
27116
26823
  };
27117
- requestBody?: {
27118
- content: {
27119
- "application/json": {
27120
- key: string;
27121
- parts: {
27122
- etag: string;
27123
- partNumber: number;
27124
- }[];
27125
- };
27126
- };
27127
- };
27128
- responses: {
27129
- /** @description Successful response */
27130
- 200: {
27131
- headers: {
27132
- [name: string]: unknown;
27133
- };
27134
- content: {
27135
- "application/json": {
27136
- fileUri: string;
27137
- };
27138
- };
27139
- };
27140
- /** @description Bad request */
27141
- 400: {
27142
- headers: {
27143
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27144
- "Retry-After"?: number;
27145
- [name: string]: unknown;
27146
- };
27147
- content: {
27148
- "application/json": {
27149
- code: string;
27150
- message: string;
27151
- links?: {
27152
- docs: string;
27153
- schema: string;
27154
- };
27155
- issues?: {
27156
- message: string;
27157
- path?: (string | number)[];
27158
- schema?: string;
27159
- }[];
27160
- retryable?: boolean;
27161
- context?: unknown;
27162
- };
27163
- };
27164
- };
27165
- /** @description Unauthorized */
27166
- 401: {
27167
- headers: {
27168
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27169
- "Retry-After"?: number;
27170
- [name: string]: unknown;
27171
- };
27172
- content: {
27173
- "application/json": {
27174
- code: string;
27175
- message: string;
27176
- links?: {
27177
- docs: string;
27178
- schema: string;
27179
- };
27180
- issues?: {
27181
- message: string;
27182
- path?: (string | number)[];
27183
- schema?: string;
27184
- }[];
27185
- retryable?: boolean;
27186
- context?: unknown;
27187
- };
27188
- };
27189
- };
27190
- /** @description Forbidden */
27191
- 403: {
27192
- headers: {
27193
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27194
- "Retry-After"?: number;
27195
- [name: string]: unknown;
27196
- };
27197
- content: {
27198
- "application/json": {
27199
- code: string;
27200
- message: string;
27201
- links?: {
27202
- docs: string;
27203
- schema: string;
27204
- };
27205
- issues?: {
27206
- message: string;
27207
- path?: (string | number)[];
27208
- schema?: string;
27209
- }[];
27210
- retryable?: boolean;
27211
- context?: unknown;
27212
- };
27213
- };
27214
- };
27215
- /** @description Not found */
27216
- 404: {
27217
- headers: {
27218
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27219
- "Retry-After"?: number;
27220
- [name: string]: unknown;
27221
- };
27222
- content: {
27223
- "application/json": {
27224
- code: string;
27225
- message: string;
27226
- links?: {
27227
- docs: string;
27228
- schema: string;
27229
- };
27230
- issues?: {
27231
- message: string;
27232
- path?: (string | number)[];
27233
- schema?: string;
27234
- }[];
27235
- retryable?: boolean;
27236
- context?: unknown;
27237
- };
27238
- };
27239
- };
27240
- /** @description Conflict */
27241
- 409: {
27242
- headers: {
27243
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27244
- "Retry-After"?: number;
27245
- [name: string]: unknown;
27246
- };
27247
- content: {
27248
- "application/json": {
27249
- code: string;
27250
- message: string;
27251
- links?: {
27252
- docs: string;
27253
- schema: string;
27254
- };
27255
- issues?: {
27256
- message: string;
27257
- path?: (string | number)[];
27258
- schema?: string;
27259
- }[];
27260
- retryable?: boolean;
27261
- context?: unknown;
27262
- };
27263
- };
27264
- };
27265
- /** @description Gone */
27266
- 410: {
27267
- headers: {
27268
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27269
- "Retry-After"?: number;
27270
- [name: string]: unknown;
27271
- };
27272
- content: {
27273
- "application/json": {
27274
- code: string;
27275
- message: string;
27276
- links?: {
27277
- docs: string;
27278
- schema: string;
27279
- };
27280
- issues?: {
27281
- message: string;
27282
- path?: (string | number)[];
27283
- schema?: string;
27284
- }[];
27285
- retryable?: boolean;
27286
- context?: unknown;
27287
- };
27288
- };
27289
- };
27290
- /** @description Unprocessable content */
27291
- 422: {
27292
- headers: {
27293
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27294
- "Retry-After"?: number;
27295
- [name: string]: unknown;
27296
- };
27297
- content: {
27298
- "application/json": {
27299
- code: string;
27300
- message: string;
27301
- links?: {
27302
- docs: string;
27303
- schema: string;
27304
- };
27305
- issues?: {
27306
- message: string;
27307
- path?: (string | number)[];
27308
- schema?: string;
27309
- }[];
27310
- retryable?: boolean;
27311
- context?: unknown;
27312
- };
27313
- };
27314
- };
27315
- /** @description Internal server error */
27316
- 500: {
27317
- headers: {
27318
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27319
- "Retry-After"?: number;
27320
- [name: string]: unknown;
27321
- };
27322
- content: {
27323
- "application/json": {
27324
- code: string;
27325
- message: string;
27326
- links?: {
27327
- docs: string;
27328
- schema: string;
27329
- };
27330
- issues?: {
27331
- message: string;
27332
- path?: (string | number)[];
27333
- schema?: string;
27334
- }[];
27335
- retryable?: boolean;
27336
- context?: unknown;
27337
- };
27338
- };
27339
- };
27340
- /** @description Service unavailable */
27341
- 503: {
27342
- headers: {
27343
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27344
- "Retry-After"?: number;
27345
- [name: string]: unknown;
27346
- };
27347
- content: {
27348
- "application/json": {
27349
- code: string;
27350
- message: string;
27351
- links?: {
27352
- docs: string;
27353
- schema: string;
27354
- };
27355
- issues?: {
27356
- message: string;
27357
- path?: (string | number)[];
27358
- schema?: string;
27359
- }[];
27360
- retryable?: boolean;
27361
- context?: unknown;
27362
- };
27363
- };
27364
- };
27365
- };
27366
- };
27367
- putConnectionsByIdCsvImportUploadsByUploadRefPartsByPartNumber: {
27368
- parameters: {
27369
- query: {
27370
- key: string;
27371
- };
27372
- header?: never;
27373
- path: {
27374
- id: string;
27375
- uploadRef: string;
27376
- partNumber: number;
27377
- };
27378
- cookie?: never;
27379
- };
27380
26824
  requestBody?: never;
27381
26825
  responses: {
27382
26826
  /** @description Successful response */
@@ -27386,8 +26830,8 @@ export interface operations {
27386
26830
  };
27387
26831
  content: {
27388
26832
  "application/json": {
27389
- etag: string;
27390
- partNumber: number;
26833
+ /** @constant */
26834
+ status: "uploaded";
27391
26835
  };
27392
26836
  };
27393
26837
  };
@@ -106636,7 +106080,7 @@ export interface operations {
106636
106080
  }[];
106637
106081
  issues: {
106638
106082
  /** @enum {string} */
106639
- code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable";
106083
+ code: "statementNotFound" | "statementNotPayable" | "statementAlreadyPaid" | "providerConnectionMissing" | "providerConnectionAmbiguous" | "ownerMissing" | "ownerPaymentMethodNotReady" | "ownerSelectionMissing" | "ownerSelectionUnknown" | "ownerAllocationNotPositive" | "bankAccountInvalid" | "bankAccountNotAchCapable" | "rampCategoryAccountNotReady";
106640
106084
  message: string;
106641
106085
  /** Format: uuid */
106642
106086
  contactId?: string;