@robosystems/client 2.40.0 → 2.41.0
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/artifacts/graphql/generated/graphql.d.ts +3 -0
- package/artifacts/graphql/generated/graphql.js +3 -0
- package/artifacts/graphql/generated/graphql.ts +6 -0
- package/artifacts/graphql/queries/ledger/report.js +1 -0
- package/artifacts/graphql/queries/ledger/report.ts +1 -0
- package/artifacts/graphql/queries/ledger/reportPackage.js +1 -0
- package/artifacts/graphql/queries/ledger/reportPackage.ts +1 -0
- package/artifacts/graphql/queries/ledger/reports.d.ts +2 -1
- package/artifacts/graphql/queries/ledger/reports.js +3 -1
- package/artifacts/graphql/queries/ledger/reports.ts +3 -1
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +3 -2
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +8 -2
- package/sdk/sdk.gen.js +20 -5
- package/sdk/sdk.gen.ts +17 -2
- package/sdk/types.gen.d.ts +114 -3
- package/sdk/types.gen.ts +120 -3
- package/sdk.gen.d.ts +8 -2
- package/sdk.gen.js +20 -5
- package/sdk.gen.ts +17 -2
- package/types.gen.d.ts +114 -3
- package/types.gen.ts +120 -3
package/types.gen.d.ts
CHANGED
|
@@ -2528,13 +2528,13 @@ export type ConnectionResponse = {
|
|
|
2528
2528
|
/**
|
|
2529
2529
|
* Entity Id
|
|
2530
2530
|
*
|
|
2531
|
-
* The entity whose books the connection keeps: the group parent for QuickBooks, the entity a bank feed was connected for (each of its accounts can move to another entity later), none for
|
|
2531
|
+
* The entity whose books the connection keeps: the group parent for QuickBooks, the entity a bank feed was connected for (each of its accounts can move to another entity later), the entity an external ledger source was registered for, and none for any other external source, whose events name their own.
|
|
2532
2532
|
*/
|
|
2533
2533
|
entity_id?: string | null;
|
|
2534
2534
|
/**
|
|
2535
2535
|
* Keeps Books
|
|
2536
2536
|
*
|
|
2537
|
-
* Whether this connection is the ledger of record for `entity_id`: its books are kept in the connected system, and `write_policy` says whether entries are written back to it or only mirrored. False for a bank feed or an external
|
|
2537
|
+
* Whether this connection is the ledger of record for `entity_id`: its books are kept in the connected system, and `write_policy` says whether entries are written back to it or only mirrored. False for a bank feed or an external source that is not a ledger.
|
|
2538
2538
|
*/
|
|
2539
2539
|
keeps_books?: boolean;
|
|
2540
2540
|
/**
|
|
@@ -2564,7 +2564,7 @@ export type ConnectionResponse = {
|
|
|
2564
2564
|
/**
|
|
2565
2565
|
* Write Policy
|
|
2566
2566
|
*
|
|
2567
|
-
* Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (
|
|
2567
|
+
* Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (the connected ledger is the book of record, nothing is written to it and the close posts nothing locally; the only policy an external ledger source can hold), or 'native' (no external ledger; what severing leaves). It governs the books of `entity_id`, and only on the connection that keeps them. Set via the write-policy endpoint.
|
|
2568
2568
|
*/
|
|
2569
2569
|
write_policy?: string | null;
|
|
2570
2570
|
/**
|
|
@@ -3410,6 +3410,12 @@ export type CreateEventBlockRequest = {
|
|
|
3410
3410
|
* Deep link back to source-system record
|
|
3411
3411
|
*/
|
|
3412
3412
|
external_url?: string | null;
|
|
3413
|
+
/**
|
|
3414
|
+
* Source Version
|
|
3415
|
+
*
|
|
3416
|
+
* The source's revision of this record: a number that only grows, such as a revision counter or a last-modified timestamp. It matters for a `journal_entry_recorded` event from the external ledger that keeps the entity's books (a connection registered with `ledger`): sending the same `external_id` again with a higher version replaces the entry in the books, in an open period. An equal or lower version, or none, is the 409 of a repeat delivery. From any other source it is stored and has no effect.
|
|
3417
|
+
*/
|
|
3418
|
+
source_version?: number | null;
|
|
3413
3419
|
/**
|
|
3414
3420
|
* Amount
|
|
3415
3421
|
*
|
|
@@ -6737,6 +6743,18 @@ export type ExternalConnectionConfig = {
|
|
|
6737
6743
|
* Human-readable label for the connections UI.
|
|
6738
6744
|
*/
|
|
6739
6745
|
display_name?: string | null;
|
|
6746
|
+
/**
|
|
6747
|
+
* Ledger
|
|
6748
|
+
*
|
|
6749
|
+
* The source is the general ledger that keeps an entity's books. The connection becomes that entity's ledger of record in `shadow`: the journal entries the source sends land posted, nothing else posts to those books, nothing is written back, and the close stamps the period without posting. Refused (409) when another ledger already keeps the entity's books or the entity has books of its own.
|
|
6750
|
+
*/
|
|
6751
|
+
ledger?: boolean;
|
|
6752
|
+
/**
|
|
6753
|
+
* Entity Id
|
|
6754
|
+
*
|
|
6755
|
+
* With `ledger`, the entity whose books the source keeps: a subsidiary's id, or omit for the group parent. One source keeps one entity's books; register a source per entity.
|
|
6756
|
+
*/
|
|
6757
|
+
entity_id?: string | null;
|
|
6740
6758
|
};
|
|
6741
6759
|
/**
|
|
6742
6760
|
* FactLite
|
|
@@ -19204,6 +19222,38 @@ export type ReportSectionRow = {
|
|
|
19204
19222
|
*/
|
|
19205
19223
|
lines?: Array<ReportLineRow>;
|
|
19206
19224
|
};
|
|
19225
|
+
/**
|
|
19226
|
+
* ReportSyncRequest
|
|
19227
|
+
*
|
|
19228
|
+
* An external integration's report of a run it just finished.
|
|
19229
|
+
*
|
|
19230
|
+
* The platform runs no sync for an external source, so the integration says
|
|
19231
|
+
* when its last run was: a successful report is the connection's
|
|
19232
|
+
* `last_sync`, which a period close reads to tell whether the books it
|
|
19233
|
+
* mirrors are current.
|
|
19234
|
+
*/
|
|
19235
|
+
export type ReportSyncRequest = {
|
|
19236
|
+
/**
|
|
19237
|
+
* Status
|
|
19238
|
+
*
|
|
19239
|
+
* 'succeeded' moves `last_sync` to now. 'failed' records the outcome and leaves `last_sync` where it was.
|
|
19240
|
+
*/
|
|
19241
|
+
status: 'succeeded' | 'failed';
|
|
19242
|
+
/**
|
|
19243
|
+
* Counts
|
|
19244
|
+
*
|
|
19245
|
+
* What the run did, as the integration counts it (for example `entries_sent`, `entries_replaced`, `entries_withdrawn`). Shown with the connection; nothing reads the names.
|
|
19246
|
+
*/
|
|
19247
|
+
counts?: {
|
|
19248
|
+
[key: string]: number;
|
|
19249
|
+
};
|
|
19250
|
+
/**
|
|
19251
|
+
* Message
|
|
19252
|
+
*
|
|
19253
|
+
* A line about the run: the window it covered, or why it failed.
|
|
19254
|
+
*/
|
|
19255
|
+
message?: string | null;
|
|
19256
|
+
};
|
|
19207
19257
|
/**
|
|
19208
19258
|
* RepositoryInfo
|
|
19209
19259
|
*
|
|
@@ -22915,6 +22965,12 @@ export type UpdateEventBlockRequest = {
|
|
|
22915
22965
|
* Set or replace the stored document the event rests on; an empty string detaches it. Must be a document on this graph. Unset = unchanged.
|
|
22916
22966
|
*/
|
|
22917
22967
|
document_id?: string | null;
|
|
22968
|
+
/**
|
|
22969
|
+
* Source Retracted
|
|
22970
|
+
*
|
|
22971
|
+
* With `transition_to: voided`, for an event from the external ledger that keeps the entity's books: the source no longer holds this record, so its posted entries are taken out of the books and the event is voided, in an open period. Refused for any other event.
|
|
22972
|
+
*/
|
|
22973
|
+
source_retracted?: boolean;
|
|
22918
22974
|
};
|
|
22919
22975
|
/**
|
|
22920
22976
|
* UpdateEventHandlerRequest
|
|
@@ -26828,6 +26884,61 @@ export type SyncConnectionResponses = {
|
|
|
26828
26884
|
202: OperationEnvelope;
|
|
26829
26885
|
};
|
|
26830
26886
|
export type SyncConnectionResponse = SyncConnectionResponses[keyof SyncConnectionResponses];
|
|
26887
|
+
export type ReportConnectionSyncData = {
|
|
26888
|
+
body: ReportSyncRequest;
|
|
26889
|
+
path: {
|
|
26890
|
+
/**
|
|
26891
|
+
* Graph Id
|
|
26892
|
+
*/
|
|
26893
|
+
graph_id: string;
|
|
26894
|
+
/**
|
|
26895
|
+
* Connection Id
|
|
26896
|
+
*
|
|
26897
|
+
* Unique connection identifier
|
|
26898
|
+
*/
|
|
26899
|
+
connection_id: string;
|
|
26900
|
+
};
|
|
26901
|
+
query?: never;
|
|
26902
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}/sync-report';
|
|
26903
|
+
};
|
|
26904
|
+
export type ReportConnectionSyncErrors = {
|
|
26905
|
+
/**
|
|
26906
|
+
* Invalid request
|
|
26907
|
+
*/
|
|
26908
|
+
400: ErrorResponse;
|
|
26909
|
+
/**
|
|
26910
|
+
* Authentication required
|
|
26911
|
+
*/
|
|
26912
|
+
401: ErrorResponse;
|
|
26913
|
+
/**
|
|
26914
|
+
* Access denied
|
|
26915
|
+
*/
|
|
26916
|
+
403: ErrorResponse;
|
|
26917
|
+
/**
|
|
26918
|
+
* Resource not found
|
|
26919
|
+
*/
|
|
26920
|
+
404: ErrorResponse;
|
|
26921
|
+
/**
|
|
26922
|
+
* Validation Error
|
|
26923
|
+
*/
|
|
26924
|
+
422: HttpValidationError;
|
|
26925
|
+
/**
|
|
26926
|
+
* Rate limit exceeded
|
|
26927
|
+
*/
|
|
26928
|
+
429: ErrorResponse;
|
|
26929
|
+
/**
|
|
26930
|
+
* Internal server error
|
|
26931
|
+
*/
|
|
26932
|
+
500: ErrorResponse;
|
|
26933
|
+
};
|
|
26934
|
+
export type ReportConnectionSyncError = ReportConnectionSyncErrors[keyof ReportConnectionSyncErrors];
|
|
26935
|
+
export type ReportConnectionSyncResponses = {
|
|
26936
|
+
/**
|
|
26937
|
+
* Successful Response
|
|
26938
|
+
*/
|
|
26939
|
+
200: ConnectionResponse;
|
|
26940
|
+
};
|
|
26941
|
+
export type ReportConnectionSyncResponse = ReportConnectionSyncResponses[keyof ReportConnectionSyncResponses];
|
|
26831
26942
|
export type SetConnectionWritePolicyData = {
|
|
26832
26943
|
body: SetWritePolicyRequest;
|
|
26833
26944
|
path: {
|
package/types.gen.ts
CHANGED
|
@@ -2592,13 +2592,13 @@ export type ConnectionResponse = {
|
|
|
2592
2592
|
/**
|
|
2593
2593
|
* Entity Id
|
|
2594
2594
|
*
|
|
2595
|
-
* The entity whose books the connection keeps: the group parent for QuickBooks, the entity a bank feed was connected for (each of its accounts can move to another entity later), none for
|
|
2595
|
+
* The entity whose books the connection keeps: the group parent for QuickBooks, the entity a bank feed was connected for (each of its accounts can move to another entity later), the entity an external ledger source was registered for, and none for any other external source, whose events name their own.
|
|
2596
2596
|
*/
|
|
2597
2597
|
entity_id?: string | null;
|
|
2598
2598
|
/**
|
|
2599
2599
|
* Keeps Books
|
|
2600
2600
|
*
|
|
2601
|
-
* Whether this connection is the ledger of record for `entity_id`: its books are kept in the connected system, and `write_policy` says whether entries are written back to it or only mirrored. False for a bank feed or an external
|
|
2601
|
+
* Whether this connection is the ledger of record for `entity_id`: its books are kept in the connected system, and `write_policy` says whether entries are written back to it or only mirrored. False for a bank feed or an external source that is not a ledger.
|
|
2602
2602
|
*/
|
|
2603
2603
|
keeps_books?: boolean;
|
|
2604
2604
|
/**
|
|
@@ -2628,7 +2628,7 @@ export type ConnectionResponse = {
|
|
|
2628
2628
|
/**
|
|
2629
2629
|
* Write Policy
|
|
2630
2630
|
*
|
|
2631
|
-
* Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (
|
|
2631
|
+
* Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (the connected ledger is the book of record, nothing is written to it and the close posts nothing locally; the only policy an external ledger source can hold), or 'native' (no external ledger; what severing leaves). It governs the books of `entity_id`, and only on the connection that keeps them. Set via the write-policy endpoint.
|
|
2632
2632
|
*/
|
|
2633
2633
|
write_policy?: string | null;
|
|
2634
2634
|
/**
|
|
@@ -3491,6 +3491,12 @@ export type CreateEventBlockRequest = {
|
|
|
3491
3491
|
* Deep link back to source-system record
|
|
3492
3492
|
*/
|
|
3493
3493
|
external_url?: string | null;
|
|
3494
|
+
/**
|
|
3495
|
+
* Source Version
|
|
3496
|
+
*
|
|
3497
|
+
* The source's revision of this record: a number that only grows, such as a revision counter or a last-modified timestamp. It matters for a `journal_entry_recorded` event from the external ledger that keeps the entity's books (a connection registered with `ledger`): sending the same `external_id` again with a higher version replaces the entry in the books, in an open period. An equal or lower version, or none, is the 409 of a repeat delivery. From any other source it is stored and has no effect.
|
|
3498
|
+
*/
|
|
3499
|
+
source_version?: number | null;
|
|
3494
3500
|
/**
|
|
3495
3501
|
* Amount
|
|
3496
3502
|
*
|
|
@@ -6897,6 +6903,18 @@ export type ExternalConnectionConfig = {
|
|
|
6897
6903
|
* Human-readable label for the connections UI.
|
|
6898
6904
|
*/
|
|
6899
6905
|
display_name?: string | null;
|
|
6906
|
+
/**
|
|
6907
|
+
* Ledger
|
|
6908
|
+
*
|
|
6909
|
+
* The source is the general ledger that keeps an entity's books. The connection becomes that entity's ledger of record in `shadow`: the journal entries the source sends land posted, nothing else posts to those books, nothing is written back, and the close stamps the period without posting. Refused (409) when another ledger already keeps the entity's books or the entity has books of its own.
|
|
6910
|
+
*/
|
|
6911
|
+
ledger?: boolean;
|
|
6912
|
+
/**
|
|
6913
|
+
* Entity Id
|
|
6914
|
+
*
|
|
6915
|
+
* With `ledger`, the entity whose books the source keeps: a subsidiary's id, or omit for the group parent. One source keeps one entity's books; register a source per entity.
|
|
6916
|
+
*/
|
|
6917
|
+
entity_id?: string | null;
|
|
6900
6918
|
};
|
|
6901
6919
|
|
|
6902
6920
|
/**
|
|
@@ -19641,6 +19659,39 @@ export type ReportSectionRow = {
|
|
|
19641
19659
|
lines?: Array<ReportLineRow>;
|
|
19642
19660
|
};
|
|
19643
19661
|
|
|
19662
|
+
/**
|
|
19663
|
+
* ReportSyncRequest
|
|
19664
|
+
*
|
|
19665
|
+
* An external integration's report of a run it just finished.
|
|
19666
|
+
*
|
|
19667
|
+
* The platform runs no sync for an external source, so the integration says
|
|
19668
|
+
* when its last run was: a successful report is the connection's
|
|
19669
|
+
* `last_sync`, which a period close reads to tell whether the books it
|
|
19670
|
+
* mirrors are current.
|
|
19671
|
+
*/
|
|
19672
|
+
export type ReportSyncRequest = {
|
|
19673
|
+
/**
|
|
19674
|
+
* Status
|
|
19675
|
+
*
|
|
19676
|
+
* 'succeeded' moves `last_sync` to now. 'failed' records the outcome and leaves `last_sync` where it was.
|
|
19677
|
+
*/
|
|
19678
|
+
status: 'succeeded' | 'failed';
|
|
19679
|
+
/**
|
|
19680
|
+
* Counts
|
|
19681
|
+
*
|
|
19682
|
+
* What the run did, as the integration counts it (for example `entries_sent`, `entries_replaced`, `entries_withdrawn`). Shown with the connection; nothing reads the names.
|
|
19683
|
+
*/
|
|
19684
|
+
counts?: {
|
|
19685
|
+
[key: string]: number;
|
|
19686
|
+
};
|
|
19687
|
+
/**
|
|
19688
|
+
* Message
|
|
19689
|
+
*
|
|
19690
|
+
* A line about the run: the window it covered, or why it failed.
|
|
19691
|
+
*/
|
|
19692
|
+
message?: string | null;
|
|
19693
|
+
};
|
|
19694
|
+
|
|
19644
19695
|
/**
|
|
19645
19696
|
* RepositoryInfo
|
|
19646
19697
|
*
|
|
@@ -23446,6 +23497,12 @@ export type UpdateEventBlockRequest = {
|
|
|
23446
23497
|
* Set or replace the stored document the event rests on; an empty string detaches it. Must be a document on this graph. Unset = unchanged.
|
|
23447
23498
|
*/
|
|
23448
23499
|
document_id?: string | null;
|
|
23500
|
+
/**
|
|
23501
|
+
* Source Retracted
|
|
23502
|
+
*
|
|
23503
|
+
* With `transition_to: voided`, for an event from the external ledger that keeps the entity's books: the source no longer holds this record, so its posted entries are taken out of the books and the event is voided, in an open period. Refused for any other event.
|
|
23504
|
+
*/
|
|
23505
|
+
source_retracted?: boolean;
|
|
23449
23506
|
};
|
|
23450
23507
|
|
|
23451
23508
|
/**
|
|
@@ -27704,6 +27761,66 @@ export type SyncConnectionResponses = {
|
|
|
27704
27761
|
|
|
27705
27762
|
export type SyncConnectionResponse = SyncConnectionResponses[keyof SyncConnectionResponses];
|
|
27706
27763
|
|
|
27764
|
+
export type ReportConnectionSyncData = {
|
|
27765
|
+
body: ReportSyncRequest;
|
|
27766
|
+
path: {
|
|
27767
|
+
/**
|
|
27768
|
+
* Graph Id
|
|
27769
|
+
*/
|
|
27770
|
+
graph_id: string;
|
|
27771
|
+
/**
|
|
27772
|
+
* Connection Id
|
|
27773
|
+
*
|
|
27774
|
+
* Unique connection identifier
|
|
27775
|
+
*/
|
|
27776
|
+
connection_id: string;
|
|
27777
|
+
};
|
|
27778
|
+
query?: never;
|
|
27779
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}/sync-report';
|
|
27780
|
+
};
|
|
27781
|
+
|
|
27782
|
+
export type ReportConnectionSyncErrors = {
|
|
27783
|
+
/**
|
|
27784
|
+
* Invalid request
|
|
27785
|
+
*/
|
|
27786
|
+
400: ErrorResponse;
|
|
27787
|
+
/**
|
|
27788
|
+
* Authentication required
|
|
27789
|
+
*/
|
|
27790
|
+
401: ErrorResponse;
|
|
27791
|
+
/**
|
|
27792
|
+
* Access denied
|
|
27793
|
+
*/
|
|
27794
|
+
403: ErrorResponse;
|
|
27795
|
+
/**
|
|
27796
|
+
* Resource not found
|
|
27797
|
+
*/
|
|
27798
|
+
404: ErrorResponse;
|
|
27799
|
+
/**
|
|
27800
|
+
* Validation Error
|
|
27801
|
+
*/
|
|
27802
|
+
422: HttpValidationError;
|
|
27803
|
+
/**
|
|
27804
|
+
* Rate limit exceeded
|
|
27805
|
+
*/
|
|
27806
|
+
429: ErrorResponse;
|
|
27807
|
+
/**
|
|
27808
|
+
* Internal server error
|
|
27809
|
+
*/
|
|
27810
|
+
500: ErrorResponse;
|
|
27811
|
+
};
|
|
27812
|
+
|
|
27813
|
+
export type ReportConnectionSyncError = ReportConnectionSyncErrors[keyof ReportConnectionSyncErrors];
|
|
27814
|
+
|
|
27815
|
+
export type ReportConnectionSyncResponses = {
|
|
27816
|
+
/**
|
|
27817
|
+
* Successful Response
|
|
27818
|
+
*/
|
|
27819
|
+
200: ConnectionResponse;
|
|
27820
|
+
};
|
|
27821
|
+
|
|
27822
|
+
export type ReportConnectionSyncResponse = ReportConnectionSyncResponses[keyof ReportConnectionSyncResponses];
|
|
27823
|
+
|
|
27707
27824
|
export type SetConnectionWritePolicyData = {
|
|
27708
27825
|
body: SetWritePolicyRequest;
|
|
27709
27826
|
path: {
|