@robosystems/client 2.10.1 → 2.11.1

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/types.gen.ts CHANGED
@@ -1384,6 +1384,57 @@ export type CeremonyOptionsResponse = {
1384
1384
  };
1385
1385
  };
1386
1386
 
1387
+ /**
1388
+ * ChangeCalendarStartRequest
1389
+ *
1390
+ * Move where an entity's calendar starts, before its first close.
1391
+ *
1392
+ * Earlier adds open months back to `first_open_period`, for history that
1393
+ * predates the start (a bank feed's backfill, a cutover moved earlier).
1394
+ * Later removes empty leading months. Refused once any month has closed,
1395
+ * and when moving later would drop months that hold entries or unposted
1396
+ * source lines.
1397
+ */
1398
+ export type ChangeCalendarStartRequest = {
1399
+ /**
1400
+ * Entity Id
1401
+ *
1402
+ * The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.
1403
+ */
1404
+ entity_id?: string | null;
1405
+ /**
1406
+ * First Open Period
1407
+ *
1408
+ * YYYY-MM: the new first month of the calendar, open.
1409
+ */
1410
+ first_open_period: string;
1411
+ /**
1412
+ * Note
1413
+ *
1414
+ * Free-form note attached to the audit event
1415
+ */
1416
+ note?: string | null;
1417
+ };
1418
+
1419
+ /**
1420
+ * ChangeCalendarStartResponse
1421
+ */
1422
+ export type ChangeCalendarStartResponse = {
1423
+ fiscal_calendar: FiscalCalendarResponse;
1424
+ /**
1425
+ * Periods Created
1426
+ *
1427
+ * Open FiscalPeriod rows added by moving the start earlier
1428
+ */
1429
+ periods_created?: number;
1430
+ /**
1431
+ * Periods Removed
1432
+ *
1433
+ * Empty FiscalPeriod rows removed by moving the start later
1434
+ */
1435
+ periods_removed?: number;
1436
+ };
1437
+
1387
1438
  /**
1388
1439
  * ChangeReportingStyleRequest
1389
1440
  *
@@ -1836,6 +1887,38 @@ export type ClosePeriodResponse = {
1836
1887
  } | null;
1837
1888
  };
1838
1889
 
1890
+ /**
1891
+ * CompleteDocumentUploadOp
1892
+ *
1893
+ * Body for complete-document-upload: store the uploaded file as a document.
1894
+ */
1895
+ export type CompleteDocumentUploadOp = {
1896
+ /**
1897
+ * Upload Id
1898
+ *
1899
+ * The upload create-document-upload returned.
1900
+ */
1901
+ upload_id: string;
1902
+ /**
1903
+ * Title
1904
+ *
1905
+ * Document title
1906
+ */
1907
+ title: string;
1908
+ /**
1909
+ * Tags
1910
+ *
1911
+ * Optional labels
1912
+ */
1913
+ tags?: Array<string> | null;
1914
+ /**
1915
+ * Folder
1916
+ *
1917
+ * Optional folder
1918
+ */
1919
+ folder?: string | null;
1920
+ };
1921
+
1839
1922
  /**
1840
1923
  * ComputeForecastRequest
1841
1924
  *
@@ -2558,6 +2641,32 @@ export type CreateConnectionRequest = {
2558
2641
  plaid_config?: PlaidConnectionConfig | null;
2559
2642
  };
2560
2643
 
2644
+ /**
2645
+ * CreateDocumentUploadOp
2646
+ *
2647
+ * Body for create-document-upload: where to upload a document's file.
2648
+ */
2649
+ export type CreateDocumentUploadOp = {
2650
+ /**
2651
+ * File Name
2652
+ *
2653
+ * The file's name, ending in its type's extension (`.pdf`, `.png`, `.jpg` or `.jpeg`).
2654
+ */
2655
+ file_name: string;
2656
+ /**
2657
+ * Content Type
2658
+ *
2659
+ * The file's media type.
2660
+ */
2661
+ content_type?: 'application/pdf' | 'image/png' | 'image/jpeg';
2662
+ /**
2663
+ * File Size Bytes
2664
+ *
2665
+ * The file's exact size in bytes, at most 25 MB. When given it is signed into the upload URL, so an upload of any other size fails. Completing the upload checks the size either way.
2666
+ */
2667
+ file_size_bytes?: number | null;
2668
+ };
2669
+
2561
2670
  /**
2562
2671
  * CreateEntityRequest
2563
2672
  *
@@ -2815,6 +2924,12 @@ export type CreateEventBlockRequest = {
2815
2924
  * Settlement link: the obligation this event discharges (e.g. cash_received pointing at the originating sale_invoiced).
2816
2925
  */
2817
2926
  discharges_event_id?: string | null;
2927
+ /**
2928
+ * Document Id
2929
+ *
2930
+ * The stored document this event rests on, as evidence: the invoice PDF, the vendor bill, the receipt photo (upload it with create-document-upload and complete-document-upload). Must be a document on this graph. While the event is live, the document cannot be deleted.
2931
+ */
2932
+ document_id?: string | null;
2818
2933
  /**
2819
2934
  * Apply Handlers
2820
2935
  *
@@ -4784,6 +4899,16 @@ export type DocumentDetailResponse = {
4784
4899
  * Sections Indexed
4785
4900
  */
4786
4901
  sections_indexed: number;
4902
+ /**
4903
+ * The stored file, for a document that is one; its `content` is empty. Download it from `GET /documents/{document_id}/file`.
4904
+ */
4905
+ file?: DocumentFileInfo | null;
4906
+ /**
4907
+ * Evidence For
4908
+ *
4909
+ * The live events that name this document as their evidence (an invoice, a bill, a statement balance), newest first, at most 50. While any are listed, the document cannot be deleted.
4910
+ */
4911
+ evidence_for?: Array<DocumentEvidence>;
4787
4912
  /**
4788
4913
  * Created At
4789
4914
  */
@@ -4794,6 +4919,87 @@ export type DocumentDetailResponse = {
4794
4919
  updated_at: string;
4795
4920
  };
4796
4921
 
4922
+ /**
4923
+ * DocumentEvidence
4924
+ *
4925
+ * A live event on the books that names the document as its evidence.
4926
+ */
4927
+ export type DocumentEvidence = {
4928
+ /**
4929
+ * Event Id
4930
+ */
4931
+ event_id: string;
4932
+ /**
4933
+ * Event Type
4934
+ */
4935
+ event_type: string;
4936
+ /**
4937
+ * Status
4938
+ */
4939
+ status: string;
4940
+ /**
4941
+ * Occurred At
4942
+ */
4943
+ occurred_at: string;
4944
+ };
4945
+
4946
+ /**
4947
+ * DocumentFileDownloadResponse
4948
+ *
4949
+ * A short-lived link to a stored document file.
4950
+ */
4951
+ export type DocumentFileDownloadResponse = {
4952
+ /**
4953
+ * Document Id
4954
+ */
4955
+ document_id: string;
4956
+ /**
4957
+ * Download Url
4958
+ *
4959
+ * Presigned URL to GET the file.
4960
+ */
4961
+ download_url: string;
4962
+ /**
4963
+ * Expires In
4964
+ *
4965
+ * Seconds until the URL expires.
4966
+ */
4967
+ expires_in: number;
4968
+ file: DocumentFileInfo;
4969
+ };
4970
+
4971
+ /**
4972
+ * DocumentFileInfo
4973
+ *
4974
+ * The stored file behind a document, when it is one.
4975
+ */
4976
+ export type DocumentFileInfo = {
4977
+ /**
4978
+ * File Name
4979
+ *
4980
+ * The file's name as uploaded.
4981
+ */
4982
+ file_name: string;
4983
+ /**
4984
+ * Content Type
4985
+ *
4986
+ * The file's media type.
4987
+ */
4988
+ content_type: string;
4989
+ /**
4990
+ * Size Bytes
4991
+ *
4992
+ * The stored file's size.
4993
+ */
4994
+ size_bytes: number;
4995
+ /**
4996
+ * Sha256
4997
+ *
4998
+ * Hex SHA-256 of the stored bytes, taken when the upload completed. A stored file never changes, so this identifies it.
4999
+ */
5000
+ sha256: string;
5001
+ };
5002
+
4797
5003
  /**
4798
5004
  * DocumentLimits
4799
5005
  *
@@ -4850,6 +5056,10 @@ export type DocumentListItem = {
4850
5056
  * Tags
4851
5057
  */
4852
5058
  tags?: Array<string> | null;
5059
+ /**
5060
+ * The stored file, for a document that is one.
5061
+ */
5062
+ file?: DocumentFileInfo | null;
4853
5063
  /**
4854
5064
  * Created At
4855
5065
  */
@@ -5620,6 +5830,12 @@ export type EventBlockEnvelope = {
5620
5830
  * Settlement link — the obligation this event discharges (e.g. `cash_received` pointing at the originating `sale_invoiced`).
5621
5831
  */
5622
5832
  discharges_event_id?: string | null;
5833
+ /**
5834
+ * Document Id
5835
+ *
5836
+ * The stored document the event rests on (an invoice, a bill, a receipt, a statement); read it with get-document.
5837
+ */
5838
+ document_id?: string | null;
5623
5839
  /**
5624
5840
  * Created At
5625
5841
  *
@@ -9741,7 +9957,7 @@ export type MercuryConnectionConfig = {
9741
9957
  /**
9742
9958
  * Since Date
9743
9959
  *
9744
- * First day of the backfill (ISO 8601). Defaults to 1 January of last year. Incremental syncs never look back before it.
9960
+ * First day of the backfill (ISO 8601). Defaults to two years back. Incremental syncs never look back before it, and lines dated in a closed period are never captured.
9745
9961
  */
9746
9962
  since_date?: string | null;
9747
9963
  /**
@@ -10688,6 +10904,52 @@ export type OperationEnvelopeBlockedSourceGraphResponse = {
10688
10904
  idempotentReplay?: boolean;
10689
10905
  };
10690
10906
 
10907
+ /**
10908
+ * OperationEnvelope[ChangeCalendarStartResponse]
10909
+ */
10910
+ export type OperationEnvelopeChangeCalendarStartResponse = {
10911
+ /**
10912
+ * Operation
10913
+ *
10914
+ * Kebab-case operation name
10915
+ */
10916
+ operation: string;
10917
+ /**
10918
+ * Operationid
10919
+ *
10920
+ * op_-prefixed ULID for audit and SSE correlation
10921
+ */
10922
+ operationId: string;
10923
+ /**
10924
+ * Status
10925
+ *
10926
+ * Operation lifecycle state
10927
+ */
10928
+ status: 'completed' | 'pending' | 'failed';
10929
+ /**
10930
+ * Command-specific result payload
10931
+ */
10932
+ result?: ChangeCalendarStartResponse | null;
10933
+ /**
10934
+ * At
10935
+ *
10936
+ * ISO-8601 UTC timestamp
10937
+ */
10938
+ at: string;
10939
+ /**
10940
+ * Createdby
10941
+ *
10942
+ * User ID that initiated the operation
10943
+ */
10944
+ createdBy?: string | null;
10945
+ /**
10946
+ * Idempotentreplay
10947
+ *
10948
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
10949
+ */
10950
+ idempotentReplay?: boolean;
10951
+ };
10952
+
10691
10953
  /**
10692
10954
  * OperationEnvelope[ChangeReportingStyleResponse]
10693
10955
  */
@@ -13931,7 +14193,7 @@ export type PlaidConnectionConfig = {
13931
14193
  /**
13932
14194
  * Since Date
13933
14195
  *
13934
- * First day of the backfill (ISO 8601), and how much history Plaid is asked to pull for the new Item (at most two years). Defaults to 1 January of last year.
14196
+ * First day of the backfill (ISO 8601), and how much history Plaid is asked to pull for the new Item (at most two years). Defaults to as far back as Plaid goes. Lines dated in a closed period are never captured, whatever the window.
13935
14197
  */
13936
14198
  since_date?: string | null;
13937
14199
  /**
@@ -14455,6 +14717,12 @@ export type PreviewReconciliationsRequest = {
14455
14717
  * Also return the accounts that tie. Off by default: the differences are the work, and the counts cover the rest.
14456
14718
  */
14457
14719
  include_tied?: boolean;
14720
+ /**
14721
+ * Entity Id
14722
+ *
14723
+ * The entity whose books to compare, by id. Omit for the group parent. `source_ledger` applies to the group parent only: QuickBooks keeps its books, not a subsidiary's.
14724
+ */
14725
+ entity_id?: string | null;
14458
14726
  };
14459
14727
 
14460
14728
  /**
@@ -15587,6 +15855,12 @@ export type RecordStatementBalanceRequest = {
15587
15855
  * The balance-sheet account the statement is for (a chart-of-accounts element id).
15588
15856
  */
15589
15857
  element_id: string;
15858
+ /**
15859
+ * Entity Id
15860
+ *
15861
+ * The entity whose books the account is in, by id. Omit for the group parent. The account must be in that entity's chart.
15862
+ */
15863
+ entity_id?: string | null;
15590
15864
  /**
15591
15865
  * As Of
15592
15866
  *
@@ -15661,6 +15935,12 @@ export type RefreshReconciliationsRequest = {
15661
15935
  * Period to reconcile at its last day, as YYYY-MM.
15662
15936
  */
15663
15937
  period: string;
15938
+ /**
15939
+ * Entity Id
15940
+ *
15941
+ * The entity whose books to reconcile, by id. Omit for the group parent. Each entity's reconciliations, and the close they hold, are its own.
15942
+ */
15943
+ entity_id?: string | null;
15664
15944
  };
15665
15945
 
15666
15946
  /**
@@ -19520,6 +19800,12 @@ export type UpdateEventBlockRequest = {
19520
19800
  * Set/update the settlement link.
19521
19801
  */
19522
19802
  discharges_event_id?: string | null;
19803
+ /**
19804
+ * Document Id
19805
+ *
19806
+ * Set or replace the stored document the event rests on; an empty string detaches it. Must be a document on this graph. Unset = unchanged.
19807
+ */
19808
+ document_id?: string | null;
19523
19809
  };
19524
19810
 
19525
19811
  /**
@@ -25953,6 +26239,64 @@ export type GetDocumentResponses = {
25953
26239
 
25954
26240
  export type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses];
25955
26241
 
26242
+ export type GetDocumentFileData = {
26243
+ body?: never;
26244
+ path: {
26245
+ /**
26246
+ * Graph Id
26247
+ */
26248
+ graph_id: string;
26249
+ /**
26250
+ * Document Id
26251
+ */
26252
+ document_id: string;
26253
+ };
26254
+ query?: never;
26255
+ url: '/v1/graphs/{graph_id}/documents/{document_id}/file';
26256
+ };
26257
+
26258
+ export type GetDocumentFileErrors = {
26259
+ /**
26260
+ * Invalid request
26261
+ */
26262
+ 400: ErrorResponse;
26263
+ /**
26264
+ * Authentication required
26265
+ */
26266
+ 401: ErrorResponse;
26267
+ /**
26268
+ * Access denied
26269
+ */
26270
+ 403: ErrorResponse;
26271
+ /**
26272
+ * Resource not found
26273
+ */
26274
+ 404: ErrorResponse;
26275
+ /**
26276
+ * Validation Error
26277
+ */
26278
+ 422: HttpValidationError;
26279
+ /**
26280
+ * Rate limit exceeded
26281
+ */
26282
+ 429: ErrorResponse;
26283
+ /**
26284
+ * Internal server error
26285
+ */
26286
+ 500: ErrorResponse;
26287
+ };
26288
+
26289
+ export type GetDocumentFileError = GetDocumentFileErrors[keyof GetDocumentFileErrors];
26290
+
26291
+ export type GetDocumentFileResponses = {
26292
+ /**
26293
+ * Successful Response
26294
+ */
26295
+ 200: DocumentFileDownloadResponse;
26296
+ };
26297
+
26298
+ export type GetDocumentFileResponse = GetDocumentFileResponses[keyof GetDocumentFileResponses];
26299
+
25956
26300
  export type ListMemoriesData = {
25957
26301
  body?: never;
25958
26302
  path: {
@@ -26912,6 +27256,134 @@ export type DeleteDocumentResponses = {
26912
27256
 
26913
27257
  export type DeleteDocumentResponse = DeleteDocumentResponses[keyof DeleteDocumentResponses];
26914
27258
 
27259
+ export type CreateDocumentUploadData = {
27260
+ body: CreateDocumentUploadOp;
27261
+ headers?: {
27262
+ /**
27263
+ * Idempotency-Key
27264
+ */
27265
+ 'Idempotency-Key'?: string | null;
27266
+ };
27267
+ path: {
27268
+ /**
27269
+ * Graph Id
27270
+ */
27271
+ graph_id: string;
27272
+ };
27273
+ query?: never;
27274
+ url: '/v1/graphs/{graph_id}/operations/create-document-upload';
27275
+ };
27276
+
27277
+ export type CreateDocumentUploadErrors = {
27278
+ /**
27279
+ * Invalid request
27280
+ */
27281
+ 400: ErrorResponse;
27282
+ /**
27283
+ * Authentication required
27284
+ */
27285
+ 401: ErrorResponse;
27286
+ /**
27287
+ * Access denied
27288
+ */
27289
+ 403: ErrorResponse;
27290
+ /**
27291
+ * Resource not found
27292
+ */
27293
+ 404: ErrorResponse;
27294
+ /**
27295
+ * Idempotency-Key conflict — key reused with different body
27296
+ */
27297
+ 409: ErrorResponse;
27298
+ /**
27299
+ * Validation error
27300
+ */
27301
+ 422: ErrorResponse;
27302
+ /**
27303
+ * Rate limit exceeded
27304
+ */
27305
+ 429: ErrorResponse;
27306
+ /**
27307
+ * Internal server error
27308
+ */
27309
+ 500: ErrorResponse;
27310
+ };
27311
+
27312
+ export type CreateDocumentUploadError = CreateDocumentUploadErrors[keyof CreateDocumentUploadErrors];
27313
+
27314
+ export type CreateDocumentUploadResponses = {
27315
+ /**
27316
+ * Successful Response
27317
+ */
27318
+ 200: OperationEnvelope;
27319
+ };
27320
+
27321
+ export type CreateDocumentUploadResponse = CreateDocumentUploadResponses[keyof CreateDocumentUploadResponses];
27322
+
27323
+ export type CompleteDocumentUploadData = {
27324
+ body: CompleteDocumentUploadOp;
27325
+ headers?: {
27326
+ /**
27327
+ * Idempotency-Key
27328
+ */
27329
+ 'Idempotency-Key'?: string | null;
27330
+ };
27331
+ path: {
27332
+ /**
27333
+ * Graph Id
27334
+ */
27335
+ graph_id: string;
27336
+ };
27337
+ query?: never;
27338
+ url: '/v1/graphs/{graph_id}/operations/complete-document-upload';
27339
+ };
27340
+
27341
+ export type CompleteDocumentUploadErrors = {
27342
+ /**
27343
+ * Invalid request
27344
+ */
27345
+ 400: ErrorResponse;
27346
+ /**
27347
+ * Authentication required
27348
+ */
27349
+ 401: ErrorResponse;
27350
+ /**
27351
+ * Access denied
27352
+ */
27353
+ 403: ErrorResponse;
27354
+ /**
27355
+ * Resource not found
27356
+ */
27357
+ 404: ErrorResponse;
27358
+ /**
27359
+ * Idempotency-Key conflict — key reused with different body
27360
+ */
27361
+ 409: ErrorResponse;
27362
+ /**
27363
+ * Validation error
27364
+ */
27365
+ 422: ErrorResponse;
27366
+ /**
27367
+ * Rate limit exceeded
27368
+ */
27369
+ 429: ErrorResponse;
27370
+ /**
27371
+ * Internal server error
27372
+ */
27373
+ 500: ErrorResponse;
27374
+ };
27375
+
27376
+ export type CompleteDocumentUploadError = CompleteDocumentUploadErrors[keyof CompleteDocumentUploadErrors];
27377
+
27378
+ export type CompleteDocumentUploadResponses = {
27379
+ /**
27380
+ * Successful Response
27381
+ */
27382
+ 200: OperationEnvelope;
27383
+ };
27384
+
27385
+ export type CompleteDocumentUploadResponse = CompleteDocumentUploadResponses[keyof CompleteDocumentUploadResponses];
27386
+
26915
27387
  export type CreateFileUploadData = {
26916
27388
  body: FileUploadRequest;
26917
27389
  headers?: {
@@ -28480,6 +28952,70 @@ export type InitializeLedgerResponses = {
28480
28952
 
28481
28953
  export type InitializeLedgerResponse2 = InitializeLedgerResponses[keyof InitializeLedgerResponses];
28482
28954
 
28955
+ export type ChangeCalendarStartData = {
28956
+ body: ChangeCalendarStartRequest;
28957
+ headers?: {
28958
+ /**
28959
+ * Idempotency-Key
28960
+ */
28961
+ 'Idempotency-Key'?: string | null;
28962
+ };
28963
+ path: {
28964
+ /**
28965
+ * Graph Id
28966
+ */
28967
+ graph_id: string;
28968
+ };
28969
+ query?: never;
28970
+ url: '/extensions/roboledger/{graph_id}/operations/change-calendar-start';
28971
+ };
28972
+
28973
+ export type ChangeCalendarStartErrors = {
28974
+ /**
28975
+ * Invalid request
28976
+ */
28977
+ 400: ErrorResponse;
28978
+ /**
28979
+ * Authentication required
28980
+ */
28981
+ 401: ErrorResponse;
28982
+ /**
28983
+ * Access denied
28984
+ */
28985
+ 403: ErrorResponse;
28986
+ /**
28987
+ * Resource not found
28988
+ */
28989
+ 404: ErrorResponse;
28990
+ /**
28991
+ * Idempotency-Key conflict — key reused with different body
28992
+ */
28993
+ 409: ErrorResponse;
28994
+ /**
28995
+ * Validation error
28996
+ */
28997
+ 422: ErrorResponse;
28998
+ /**
28999
+ * Rate limit exceeded
29000
+ */
29001
+ 429: ErrorResponse;
29002
+ /**
29003
+ * Internal server error
29004
+ */
29005
+ 500: ErrorResponse;
29006
+ };
29007
+
29008
+ export type ChangeCalendarStartError = ChangeCalendarStartErrors[keyof ChangeCalendarStartErrors];
29009
+
29010
+ export type ChangeCalendarStartResponses = {
29011
+ /**
29012
+ * Successful Response
29013
+ */
29014
+ 200: OperationEnvelopeChangeCalendarStartResponse;
29015
+ };
29016
+
29017
+ export type ChangeCalendarStartResponse2 = ChangeCalendarStartResponses[keyof ChangeCalendarStartResponses];
29018
+
28483
29019
  export type InitializeChartOfAccountsData = {
28484
29020
  body: InitializeChartOfAccountsRequest;
28485
29021
  headers?: {