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