@robosystems/client 2.37.0 → 2.38.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/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  [![npm version](https://badge.fury.io/js/@robosystems%2Fclient.svg)](https://www.npmjs.com/package/@robosystems/client)
4
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
5
 
6
- Official TypeScript client for the RoboSystems financial intelligence platform — accounting, financial reporting, and investment management over a knowledge graph API. Type-safe and modern, generated from the OpenAPI spec, with GraphQL reads and idempotent operation writes.
6
+ Part of RoboSystems, the open-source knowledge graph for finance. The official TypeScript client for the RoboSystems API: accounting, financial reporting, and investment management over the graph. Type-safe and modern, generated from the OpenAPI spec, with GraphQL reads and idempotent operation writes.
7
7
 
8
8
  ## Features
9
9
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "2.37.0",
4
- "description": "TypeScript client library for the RoboSystems financial intelligence platform",
3
+ "version": "2.38.1",
4
+ "description": "TypeScript SDK for RoboSystems, the open-source knowledge graph for finance",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
7
  "bin": {
package/sdk/sdk.gen.d.ts CHANGED
@@ -214,7 +214,7 @@ export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(opt
214
214
  /**
215
215
  * Create API Key
216
216
  *
217
- * The raw key value is only returned once at creation time and cannot be retrieved again.
217
+ * The raw key value is only returned once at creation time and cannot be retrieved again. Requires a signed-in session; API keys are not accepted.
218
218
  */
219
219
  export declare const createUserApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) => RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>;
220
220
  /**
@@ -270,7 +270,7 @@ export declare const removeOrgMember: <ThrowOnError extends boolean = false>(opt
270
270
  /**
271
271
  * Update Member Role
272
272
  *
273
- * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
273
+ * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow. Requires a signed-in session; API keys are not accepted.
274
274
  */
275
275
  export declare const updateOrgMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) => RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError>;
276
276
  /**
@@ -282,7 +282,7 @@ export declare const listOrgInvitations: <ThrowOnError extends boolean = false>(
282
282
  /**
283
283
  * Invite Member
284
284
  *
285
- * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.
285
+ * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited. Requires a signed-in session; API keys are not accepted.
286
286
  */
287
287
  export declare const createOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<CreateOrgInvitationData, ThrowOnError>) => RequestResult<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError>;
288
288
  /**
@@ -294,7 +294,7 @@ export declare const revokeOrgInvitation: <ThrowOnError extends boolean = false>
294
294
  /**
295
295
  * Resend Invitation
296
296
  *
297
- * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
297
+ * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email. Requires a signed-in session; API keys are not accepted.
298
298
  */
299
299
  export declare const resendOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<ResendOrgInvitationData, ThrowOnError>) => RequestResult<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError>;
300
300
  /**
@@ -456,7 +456,7 @@ export declare const listGraphMembers: <ThrowOnError extends boolean = false>(op
456
456
  /**
457
457
  * Add Graph Member
458
458
  *
459
- * Grant a member of the graph's organization access at a chosen role. Requires graph admin.
459
+ * Grant a member of the graph's organization access at a chosen role. Requires graph admin. Requires a signed-in session; API keys are not accepted.
460
460
  */
461
461
  export declare const addGraphMember: <ThrowOnError extends boolean = false>(options: Options<AddGraphMemberData, ThrowOnError>) => RequestResult<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError>;
462
462
  /**
@@ -468,7 +468,7 @@ export declare const removeGraphMember: <ThrowOnError extends boolean = false>(o
468
468
  /**
469
469
  * Update Graph Member Role
470
470
  *
471
- * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
471
+ * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles. Requires a signed-in session; API keys are not accepted.
472
472
  */
473
473
  export declare const updateGraphMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMemberRoleData, ThrowOnError>) => RequestResult<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError>;
474
474
  /**
@@ -910,7 +910,7 @@ export declare const updateEntity: <ThrowOnError extends boolean = false>(option
910
910
  /**
911
911
  * Change Reporting Style
912
912
  *
913
- * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
913
+ * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. A group's consolidation entity follows the parent's Style: changing the parent's changes both, and it cannot be set on its own. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
914
914
  *
915
915
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
916
916
  */
package/sdk/sdk.gen.js CHANGED
@@ -388,7 +388,7 @@ exports.listUserApiKeys = listUserApiKeys;
388
388
  /**
389
389
  * Create API Key
390
390
  *
391
- * The raw key value is only returned once at creation time and cannot be retrieved again.
391
+ * The raw key value is only returned once at creation time and cannot be retrieved again. Requires a signed-in session; API keys are not accepted.
392
392
  */
393
393
  const createUserApiKey = (options) => (options.client ?? client_gen_1.client).post({
394
394
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -511,7 +511,7 @@ exports.removeOrgMember = removeOrgMember;
511
511
  /**
512
512
  * Update Member Role
513
513
  *
514
- * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
514
+ * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow. Requires a signed-in session; API keys are not accepted.
515
515
  */
516
516
  const updateOrgMemberRole = (options) => (options.client ?? client_gen_1.client).put({
517
517
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -537,7 +537,7 @@ exports.listOrgInvitations = listOrgInvitations;
537
537
  /**
538
538
  * Invite Member
539
539
  *
540
- * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.
540
+ * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited. Requires a signed-in session; API keys are not accepted.
541
541
  */
542
542
  const createOrgInvitation = (options) => (options.client ?? client_gen_1.client).post({
543
543
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -563,7 +563,7 @@ exports.revokeOrgInvitation = revokeOrgInvitation;
563
563
  /**
564
564
  * Resend Invitation
565
565
  *
566
- * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
566
+ * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email. Requires a signed-in session; API keys are not accepted.
567
567
  */
568
568
  const resendOrgInvitation = (options) => (options.client ?? client_gen_1.client).post({
569
569
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -916,7 +916,7 @@ exports.listGraphMembers = listGraphMembers;
916
916
  /**
917
917
  * Add Graph Member
918
918
  *
919
- * Grant a member of the graph's organization access at a chosen role. Requires graph admin.
919
+ * Grant a member of the graph's organization access at a chosen role. Requires graph admin. Requires a signed-in session; API keys are not accepted.
920
920
  */
921
921
  const addGraphMember = (options) => (options.client ?? client_gen_1.client).post({
922
922
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -942,7 +942,7 @@ exports.removeGraphMember = removeGraphMember;
942
942
  /**
943
943
  * Update Graph Member Role
944
944
  *
945
- * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
945
+ * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles. Requires a signed-in session; API keys are not accepted.
946
946
  */
947
947
  const updateGraphMemberRole = (options) => (options.client ?? client_gen_1.client).put({
948
948
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -1851,7 +1851,7 @@ exports.updateEntity = updateEntity;
1851
1851
  /**
1852
1852
  * Change Reporting Style
1853
1853
  *
1854
- * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
1854
+ * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. A group's consolidation entity follows the parent's Style: changing the parent's changes both, and it cannot be set on its own. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
1855
1855
  *
1856
1856
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1857
1857
  */
package/sdk/sdk.gen.ts CHANGED
@@ -399,7 +399,7 @@ export const listUserApiKeys = <ThrowOnError extends boolean = false>(options?:
399
399
  /**
400
400
  * Create API Key
401
401
  *
402
- * The raw key value is only returned once at creation time and cannot be retrieved again.
402
+ * The raw key value is only returned once at creation time and cannot be retrieved again. Requires a signed-in session; API keys are not accepted.
403
403
  */
404
404
  export const createUserApiKey = <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>): RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError> => (options.client ?? client).post<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>({
405
405
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -522,7 +522,7 @@ export const removeOrgMember = <ThrowOnError extends boolean = false>(options: O
522
522
  /**
523
523
  * Update Member Role
524
524
  *
525
- * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
525
+ * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow. Requires a signed-in session; API keys are not accepted.
526
526
  */
527
527
  export const updateOrgMemberRole = <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>): RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError> => (options.client ?? client).put<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError>({
528
528
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -548,7 +548,7 @@ export const listOrgInvitations = <ThrowOnError extends boolean = false>(options
548
548
  /**
549
549
  * Invite Member
550
550
  *
551
- * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.
551
+ * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited. Requires a signed-in session; API keys are not accepted.
552
552
  */
553
553
  export const createOrgInvitation = <ThrowOnError extends boolean = false>(options: Options<CreateOrgInvitationData, ThrowOnError>): RequestResult<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError> => (options.client ?? client).post<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError>({
554
554
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -574,7 +574,7 @@ export const revokeOrgInvitation = <ThrowOnError extends boolean = false>(option
574
574
  /**
575
575
  * Resend Invitation
576
576
  *
577
- * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
577
+ * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email. Requires a signed-in session; API keys are not accepted.
578
578
  */
579
579
  export const resendOrgInvitation = <ThrowOnError extends boolean = false>(options: Options<ResendOrgInvitationData, ThrowOnError>): RequestResult<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError> => (options.client ?? client).post<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError>({
580
580
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -927,7 +927,7 @@ export const listGraphMembers = <ThrowOnError extends boolean = false>(options:
927
927
  /**
928
928
  * Add Graph Member
929
929
  *
930
- * Grant a member of the graph's organization access at a chosen role. Requires graph admin.
930
+ * Grant a member of the graph's organization access at a chosen role. Requires graph admin. Requires a signed-in session; API keys are not accepted.
931
931
  */
932
932
  export const addGraphMember = <ThrowOnError extends boolean = false>(options: Options<AddGraphMemberData, ThrowOnError>): RequestResult<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError> => (options.client ?? client).post<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError>({
933
933
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -953,7 +953,7 @@ export const removeGraphMember = <ThrowOnError extends boolean = false>(options:
953
953
  /**
954
954
  * Update Graph Member Role
955
955
  *
956
- * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
956
+ * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles. Requires a signed-in session; API keys are not accepted.
957
957
  */
958
958
  export const updateGraphMemberRole = <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMemberRoleData, ThrowOnError>): RequestResult<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError> => (options.client ?? client).put<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError>({
959
959
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -1862,7 +1862,7 @@ export const updateEntity = <ThrowOnError extends boolean = false>(options: Opti
1862
1862
  /**
1863
1863
  * Change Reporting Style
1864
1864
  *
1865
- * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
1865
+ * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. A group's consolidation entity follows the parent's Style: changing the parent's changes both, and it cannot be set on its own. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
1866
1866
  *
1867
1867
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1868
1868
  */
@@ -2527,6 +2527,12 @@ export type ConnectionResponse = {
2527
2527
  * 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 an external source, whose events name their own.
2528
2528
  */
2529
2529
  entity_id?: string | null;
2530
+ /**
2531
+ * Keeps Books
2532
+ *
2533
+ * 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 event source.
2534
+ */
2535
+ keeps_books?: boolean;
2530
2536
  /**
2531
2537
  * Status
2532
2538
  *
@@ -2554,7 +2560,7 @@ export type ConnectionResponse = {
2554
2560
  /**
2555
2561
  * Write Policy
2556
2562
  *
2557
- * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), or 'native' (no external ledger; what severing leaves). Set via the write-policy endpoint.
2563
+ * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), 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.
2558
2564
  */
2559
2565
  write_policy?: string | null;
2560
2566
  /**
@@ -3192,7 +3198,7 @@ export type CreateEntityRequest = {
3192
3198
  /**
3193
3199
  * Reporting Style Id
3194
3200
  *
3195
- * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`.
3201
+ * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`. A consolidation entity always takes the group parent's.
3196
3202
  */
3197
3203
  reporting_style_id?: string | null;
3198
3204
  /**
package/sdk/types.gen.ts CHANGED
@@ -2591,6 +2591,12 @@ export type ConnectionResponse = {
2591
2591
  * 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 an external source, whose events name their own.
2592
2592
  */
2593
2593
  entity_id?: string | null;
2594
+ /**
2595
+ * Keeps Books
2596
+ *
2597
+ * 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 event source.
2598
+ */
2599
+ keeps_books?: boolean;
2594
2600
  /**
2595
2601
  * Status
2596
2602
  *
@@ -2618,7 +2624,7 @@ export type ConnectionResponse = {
2618
2624
  /**
2619
2625
  * Write Policy
2620
2626
  *
2621
- * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), or 'native' (no external ledger; what severing leaves). Set via the write-policy endpoint.
2627
+ * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), 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.
2622
2628
  */
2623
2629
  write_policy?: string | null;
2624
2630
  /**
@@ -3272,7 +3278,7 @@ export type CreateEntityRequest = {
3272
3278
  /**
3273
3279
  * Reporting Style Id
3274
3280
  *
3275
- * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`.
3281
+ * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`. A consolidation entity always takes the group parent's.
3276
3282
  */
3277
3283
  reporting_style_id?: string | null;
3278
3284
  /**
package/sdk.gen.d.ts CHANGED
@@ -214,7 +214,7 @@ export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(opt
214
214
  /**
215
215
  * Create API Key
216
216
  *
217
- * The raw key value is only returned once at creation time and cannot be retrieved again.
217
+ * The raw key value is only returned once at creation time and cannot be retrieved again. Requires a signed-in session; API keys are not accepted.
218
218
  */
219
219
  export declare const createUserApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) => RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>;
220
220
  /**
@@ -270,7 +270,7 @@ export declare const removeOrgMember: <ThrowOnError extends boolean = false>(opt
270
270
  /**
271
271
  * Update Member Role
272
272
  *
273
- * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
273
+ * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow. Requires a signed-in session; API keys are not accepted.
274
274
  */
275
275
  export declare const updateOrgMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>) => RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError>;
276
276
  /**
@@ -282,7 +282,7 @@ export declare const listOrgInvitations: <ThrowOnError extends boolean = false>(
282
282
  /**
283
283
  * Invite Member
284
284
  *
285
- * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.
285
+ * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited. Requires a signed-in session; API keys are not accepted.
286
286
  */
287
287
  export declare const createOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<CreateOrgInvitationData, ThrowOnError>) => RequestResult<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError>;
288
288
  /**
@@ -294,7 +294,7 @@ export declare const revokeOrgInvitation: <ThrowOnError extends boolean = false>
294
294
  /**
295
295
  * Resend Invitation
296
296
  *
297
- * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
297
+ * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email. Requires a signed-in session; API keys are not accepted.
298
298
  */
299
299
  export declare const resendOrgInvitation: <ThrowOnError extends boolean = false>(options: Options<ResendOrgInvitationData, ThrowOnError>) => RequestResult<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError>;
300
300
  /**
@@ -456,7 +456,7 @@ export declare const listGraphMembers: <ThrowOnError extends boolean = false>(op
456
456
  /**
457
457
  * Add Graph Member
458
458
  *
459
- * Grant a member of the graph's organization access at a chosen role. Requires graph admin.
459
+ * Grant a member of the graph's organization access at a chosen role. Requires graph admin. Requires a signed-in session; API keys are not accepted.
460
460
  */
461
461
  export declare const addGraphMember: <ThrowOnError extends boolean = false>(options: Options<AddGraphMemberData, ThrowOnError>) => RequestResult<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError>;
462
462
  /**
@@ -468,7 +468,7 @@ export declare const removeGraphMember: <ThrowOnError extends boolean = false>(o
468
468
  /**
469
469
  * Update Graph Member Role
470
470
  *
471
- * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
471
+ * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles. Requires a signed-in session; API keys are not accepted.
472
472
  */
473
473
  export declare const updateGraphMemberRole: <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMemberRoleData, ThrowOnError>) => RequestResult<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError>;
474
474
  /**
@@ -910,7 +910,7 @@ export declare const updateEntity: <ThrowOnError extends boolean = false>(option
910
910
  /**
911
911
  * Change Reporting Style
912
912
  *
913
- * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
913
+ * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. A group's consolidation entity follows the parent's Style: changing the parent's changes both, and it cannot be set on its own. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
914
914
  *
915
915
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
916
916
  */
package/sdk.gen.js CHANGED
@@ -388,7 +388,7 @@ exports.listUserApiKeys = listUserApiKeys;
388
388
  /**
389
389
  * Create API Key
390
390
  *
391
- * The raw key value is only returned once at creation time and cannot be retrieved again.
391
+ * The raw key value is only returned once at creation time and cannot be retrieved again. Requires a signed-in session; API keys are not accepted.
392
392
  */
393
393
  const createUserApiKey = (options) => (options.client ?? client_gen_1.client).post({
394
394
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -511,7 +511,7 @@ exports.removeOrgMember = removeOrgMember;
511
511
  /**
512
512
  * Update Member Role
513
513
  *
514
- * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
514
+ * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow. Requires a signed-in session; API keys are not accepted.
515
515
  */
516
516
  const updateOrgMemberRole = (options) => (options.client ?? client_gen_1.client).put({
517
517
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -537,7 +537,7 @@ exports.listOrgInvitations = listOrgInvitations;
537
537
  /**
538
538
  * Invite Member
539
539
  *
540
- * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.
540
+ * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited. Requires a signed-in session; API keys are not accepted.
541
541
  */
542
542
  const createOrgInvitation = (options) => (options.client ?? client_gen_1.client).post({
543
543
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -563,7 +563,7 @@ exports.revokeOrgInvitation = revokeOrgInvitation;
563
563
  /**
564
564
  * Resend Invitation
565
565
  *
566
- * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
566
+ * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email. Requires a signed-in session; API keys are not accepted.
567
567
  */
568
568
  const resendOrgInvitation = (options) => (options.client ?? client_gen_1.client).post({
569
569
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -916,7 +916,7 @@ exports.listGraphMembers = listGraphMembers;
916
916
  /**
917
917
  * Add Graph Member
918
918
  *
919
- * Grant a member of the graph's organization access at a chosen role. Requires graph admin.
919
+ * Grant a member of the graph's organization access at a chosen role. Requires graph admin. Requires a signed-in session; API keys are not accepted.
920
920
  */
921
921
  const addGraphMember = (options) => (options.client ?? client_gen_1.client).post({
922
922
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -942,7 +942,7 @@ exports.removeGraphMember = removeGraphMember;
942
942
  /**
943
943
  * Update Graph Member Role
944
944
  *
945
- * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
945
+ * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles. Requires a signed-in session; API keys are not accepted.
946
946
  */
947
947
  const updateGraphMemberRole = (options) => (options.client ?? client_gen_1.client).put({
948
948
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -1851,7 +1851,7 @@ exports.updateEntity = updateEntity;
1851
1851
  /**
1852
1852
  * Change Reporting Style
1853
1853
  *
1854
- * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
1854
+ * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. A group's consolidation entity follows the parent's Style: changing the parent's changes both, and it cannot be set on its own. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
1855
1855
  *
1856
1856
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1857
1857
  */
package/sdk.gen.ts CHANGED
@@ -399,7 +399,7 @@ export const listUserApiKeys = <ThrowOnError extends boolean = false>(options?:
399
399
  /**
400
400
  * Create API Key
401
401
  *
402
- * The raw key value is only returned once at creation time and cannot be retrieved again.
402
+ * The raw key value is only returned once at creation time and cannot be retrieved again. Requires a signed-in session; API keys are not accepted.
403
403
  */
404
404
  export const createUserApiKey = <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>): RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError> => (options.client ?? client).post<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>({
405
405
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -522,7 +522,7 @@ export const removeOrgMember = <ThrowOnError extends boolean = false>(options: O
522
522
  /**
523
523
  * Update Member Role
524
524
  *
525
- * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow.
525
+ * Requires admin or owner role. Owner promotion/demotion requires a dedicated ownership transfer workflow. Requires a signed-in session; API keys are not accepted.
526
526
  */
527
527
  export const updateOrgMemberRole = <ThrowOnError extends boolean = false>(options: Options<UpdateOrgMemberRoleData, ThrowOnError>): RequestResult<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError> => (options.client ?? client).put<UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, ThrowOnError>({
528
528
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -548,7 +548,7 @@ export const listOrgInvitations = <ThrowOnError extends boolean = false>(options
548
548
  /**
549
549
  * Invite Member
550
550
  *
551
- * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.
551
+ * Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited. Requires a signed-in session; API keys are not accepted.
552
552
  */
553
553
  export const createOrgInvitation = <ThrowOnError extends boolean = false>(options: Options<CreateOrgInvitationData, ThrowOnError>): RequestResult<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError> => (options.client ?? client).post<CreateOrgInvitationResponses, CreateOrgInvitationErrors, ThrowOnError>({
554
554
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -574,7 +574,7 @@ export const revokeOrgInvitation = <ThrowOnError extends boolean = false>(option
574
574
  /**
575
575
  * Resend Invitation
576
576
  *
577
- * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email.
577
+ * Requires admin or owner role. Rotates the invitation token, extends its expiry, and re-sends the email. Requires a signed-in session; API keys are not accepted.
578
578
  */
579
579
  export const resendOrgInvitation = <ThrowOnError extends boolean = false>(options: Options<ResendOrgInvitationData, ThrowOnError>): RequestResult<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError> => (options.client ?? client).post<ResendOrgInvitationResponses, ResendOrgInvitationErrors, ThrowOnError>({
580
580
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -927,7 +927,7 @@ export const listGraphMembers = <ThrowOnError extends boolean = false>(options:
927
927
  /**
928
928
  * Add Graph Member
929
929
  *
930
- * Grant a member of the graph's organization access at a chosen role. Requires graph admin.
930
+ * Grant a member of the graph's organization access at a chosen role. Requires graph admin. Requires a signed-in session; API keys are not accepted.
931
931
  */
932
932
  export const addGraphMember = <ThrowOnError extends boolean = false>(options: Options<AddGraphMemberData, ThrowOnError>): RequestResult<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError> => (options.client ?? client).post<AddGraphMemberResponses, AddGraphMemberErrors, ThrowOnError>({
933
933
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -953,7 +953,7 @@ export const removeGraphMember = <ThrowOnError extends boolean = false>(options:
953
953
  /**
954
954
  * Update Graph Member Role
955
955
  *
956
- * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles.
956
+ * Change an explicit member's graph role. Requires graph admin. Implicit org owner/admin access is managed through org roles. Requires a signed-in session; API keys are not accepted.
957
957
  */
958
958
  export const updateGraphMemberRole = <ThrowOnError extends boolean = false>(options: Options<UpdateGraphMemberRoleData, ThrowOnError>): RequestResult<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError> => (options.client ?? client).put<UpdateGraphMemberRoleResponses, UpdateGraphMemberRoleErrors, ThrowOnError>({
959
959
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -1862,7 +1862,7 @@ export const updateEntity = <ThrowOnError extends boolean = false>(options: Opti
1862
1862
  /**
1863
1863
  * Change Reporting Style
1864
1864
  *
1865
- * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
1865
+ * Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips `entities.reporting_style_id`. Omit `entity_id` to target the graph's primary entity. A group's consolidation entity follows the parent's Style: changing the parent's changes both, and it cannot be set on its own. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.
1866
1866
  *
1867
1867
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1868
1868
  */
package/types.gen.d.ts CHANGED
@@ -2527,6 +2527,12 @@ export type ConnectionResponse = {
2527
2527
  * 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 an external source, whose events name their own.
2528
2528
  */
2529
2529
  entity_id?: string | null;
2530
+ /**
2531
+ * Keeps Books
2532
+ *
2533
+ * 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 event source.
2534
+ */
2535
+ keeps_books?: boolean;
2530
2536
  /**
2531
2537
  * Status
2532
2538
  *
@@ -2554,7 +2560,7 @@ export type ConnectionResponse = {
2554
2560
  /**
2555
2561
  * Write Policy
2556
2562
  *
2557
- * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), or 'native' (no external ledger; what severing leaves). Set via the write-policy endpoint.
2563
+ * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), 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.
2558
2564
  */
2559
2565
  write_policy?: string | null;
2560
2566
  /**
@@ -3192,7 +3198,7 @@ export type CreateEntityRequest = {
3192
3198
  /**
3193
3199
  * Reporting Style Id
3194
3200
  *
3195
- * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`.
3201
+ * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`. A consolidation entity always takes the group parent's.
3196
3202
  */
3197
3203
  reporting_style_id?: string | null;
3198
3204
  /**
package/types.gen.ts CHANGED
@@ -2591,6 +2591,12 @@ export type ConnectionResponse = {
2591
2591
  * 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 an external source, whose events name their own.
2592
2592
  */
2593
2593
  entity_id?: string | null;
2594
+ /**
2595
+ * Keeps Books
2596
+ *
2597
+ * 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 event source.
2598
+ */
2599
+ keeps_books?: boolean;
2594
2600
  /**
2595
2601
  * Status
2596
2602
  *
@@ -2618,7 +2624,7 @@ export type ConnectionResponse = {
2618
2624
  /**
2619
2625
  * Write Policy
2620
2626
  *
2621
- * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), or 'native' (no external ledger; what severing leaves). Set via the write-policy endpoint.
2627
+ * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), 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.
2622
2628
  */
2623
2629
  write_policy?: string | null;
2624
2630
  /**
@@ -3272,7 +3278,7 @@ export type CreateEntityRequest = {
3272
3278
  /**
3273
3279
  * Reporting Style Id
3274
3280
  *
3275
- * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`.
3281
+ * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`. A consolidation entity always takes the group parent's.
3276
3282
  */
3277
3283
  reporting_style_id?: string | null;
3278
3284
  /**