@robosystems/client 2.9.1 → 2.10.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.
@@ -697,6 +697,7 @@ export type GetInformationBlockQueryVariables = Exact<{
697
697
  id: string | number
698
698
  scenarioId: string | null | undefined
699
699
  series?: boolean
700
+ entityId: string | null | undefined
700
701
  }>
701
702
 
702
703
  export type GetInformationBlockQuery = {
@@ -708,6 +709,7 @@ export type GetInformationBlockQuery = {
708
709
  category: string
709
710
  taxonomyId: string | null
710
711
  taxonomyName: string | null
712
+ entityId: string | null
711
713
  informationModel: { conceptArrangement: string | null; memberArrangement: string | null }
712
714
  artifact: {
713
715
  topic: string | null
@@ -844,6 +846,7 @@ export type GetInformationBlockWindowedQueryVariables = Exact<{
844
846
  series?: boolean
845
847
  seriesHistory: number | null | undefined
846
848
  seriesForecast: number | null | undefined
849
+ entityId: string | null | undefined
847
850
  }>
848
851
 
849
852
  export type GetInformationBlockWindowedQuery = {
@@ -855,6 +858,7 @@ export type GetInformationBlockWindowedQuery = {
855
858
  category: string
856
859
  taxonomyId: string | null
857
860
  taxonomyName: string | null
861
+ entityId: string | null
858
862
  informationModel: { conceptArrangement: string | null; memberArrangement: string | null }
859
863
  artifact: {
860
864
  topic: string | null
@@ -991,6 +995,7 @@ export type ListInformationBlocksQueryVariables = Exact<{
991
995
  limit: number | null | undefined
992
996
  offset: number | null | undefined
993
997
  scenarioId: string | null | undefined
998
+ entityId: string | null | undefined
994
999
  }>
995
1000
 
996
1001
  export type ListInformationBlocksQuery = {
@@ -1002,6 +1007,7 @@ export type ListInformationBlocksQuery = {
1002
1007
  category: string
1003
1008
  taxonomyId: string | null
1004
1009
  taxonomyName: string | null
1010
+ entityId: string | null
1005
1011
  informationModel: { conceptArrangement: string | null; memberArrangement: string | null }
1006
1012
  artifact: {
1007
1013
  topic: string | null
@@ -1232,6 +1238,7 @@ export type GetLedgerMappingQuery = {
1232
1238
 
1233
1239
  export type MappingCandidatesQueryVariables = Exact<{
1234
1240
  classification: string
1241
+ entityId: string | null | undefined
1235
1242
  }>
1236
1243
 
1237
1244
  export type MappingCandidatesQuery = {
@@ -1255,7 +1262,9 @@ export type GetLedgerMappingCoverageQuery = {
1255
1262
  } | null
1256
1263
  }
1257
1264
 
1258
- export type ListLedgerMappingsQueryVariables = Exact<{ [key: string]: never }>
1265
+ export type ListLedgerMappingsQueryVariables = Exact<{
1266
+ entityId: string | null | undefined
1267
+ }>
1259
1268
 
1260
1269
  export type ListLedgerMappingsQuery = {
1261
1270
  mappings: {
@@ -1267,6 +1276,7 @@ export type ListLedgerMappingsQuery = {
1267
1276
  taxonomyId: string
1268
1277
  isActive: boolean
1269
1278
  framework: string | null
1279
+ entityId: string | null
1270
1280
  }>
1271
1281
  } | null
1272
1282
  }
@@ -4162,6 +4172,11 @@ export const GetInformationBlockDocument = {
4162
4172
  },
4163
4173
  defaultValue: { kind: 'BooleanValue', value: false },
4164
4174
  },
4175
+ {
4176
+ kind: 'VariableDefinition',
4177
+ variable: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
4178
+ type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
4179
+ },
4165
4180
  ],
4166
4181
  selectionSet: {
4167
4182
  kind: 'SelectionSet',
@@ -4185,6 +4200,11 @@ export const GetInformationBlockDocument = {
4185
4200
  name: { kind: 'Name', value: 'series' },
4186
4201
  value: { kind: 'Variable', name: { kind: 'Name', value: 'series' } },
4187
4202
  },
4203
+ {
4204
+ kind: 'Argument',
4205
+ name: { kind: 'Name', value: 'entityId' },
4206
+ value: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
4207
+ },
4188
4208
  ],
4189
4209
  selectionSet: {
4190
4210
  kind: 'SelectionSet',
@@ -4196,6 +4216,7 @@ export const GetInformationBlockDocument = {
4196
4216
  { kind: 'Field', name: { kind: 'Name', value: 'category' } },
4197
4217
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
4198
4218
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyName' } },
4219
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
4199
4220
  {
4200
4221
  kind: 'Field',
4201
4222
  name: { kind: 'Name', value: 'informationModel' },
@@ -4530,6 +4551,11 @@ export const GetInformationBlockWindowedDocument = {
4530
4551
  variable: { kind: 'Variable', name: { kind: 'Name', value: 'seriesForecast' } },
4531
4552
  type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
4532
4553
  },
4554
+ {
4555
+ kind: 'VariableDefinition',
4556
+ variable: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
4557
+ type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
4558
+ },
4533
4559
  ],
4534
4560
  selectionSet: {
4535
4561
  kind: 'SelectionSet',
@@ -4563,6 +4589,11 @@ export const GetInformationBlockWindowedDocument = {
4563
4589
  name: { kind: 'Name', value: 'seriesForecast' },
4564
4590
  value: { kind: 'Variable', name: { kind: 'Name', value: 'seriesForecast' } },
4565
4591
  },
4592
+ {
4593
+ kind: 'Argument',
4594
+ name: { kind: 'Name', value: 'entityId' },
4595
+ value: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
4596
+ },
4566
4597
  ],
4567
4598
  selectionSet: {
4568
4599
  kind: 'SelectionSet',
@@ -4574,6 +4605,7 @@ export const GetInformationBlockWindowedDocument = {
4574
4605
  { kind: 'Field', name: { kind: 'Name', value: 'category' } },
4575
4606
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
4576
4607
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyName' } },
4608
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
4577
4609
  {
4578
4610
  kind: 'Field',
4579
4611
  name: { kind: 'Name', value: 'informationModel' },
@@ -4904,6 +4936,11 @@ export const ListInformationBlocksDocument = {
4904
4936
  variable: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
4905
4937
  type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
4906
4938
  },
4939
+ {
4940
+ kind: 'VariableDefinition',
4941
+ variable: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
4942
+ type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
4943
+ },
4907
4944
  ],
4908
4945
  selectionSet: {
4909
4946
  kind: 'SelectionSet',
@@ -4937,6 +4974,11 @@ export const ListInformationBlocksDocument = {
4937
4974
  name: { kind: 'Name', value: 'scenarioId' },
4938
4975
  value: { kind: 'Variable', name: { kind: 'Name', value: 'scenarioId' } },
4939
4976
  },
4977
+ {
4978
+ kind: 'Argument',
4979
+ name: { kind: 'Name', value: 'entityId' },
4980
+ value: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
4981
+ },
4940
4982
  ],
4941
4983
  selectionSet: {
4942
4984
  kind: 'SelectionSet',
@@ -4948,6 +4990,7 @@ export const ListInformationBlocksDocument = {
4948
4990
  { kind: 'Field', name: { kind: 'Name', value: 'category' } },
4949
4991
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
4950
4992
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyName' } },
4993
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
4951
4994
  {
4952
4995
  kind: 'Field',
4953
4996
  name: { kind: 'Name', value: 'informationModel' },
@@ -5590,6 +5633,11 @@ export const MappingCandidatesDocument = {
5590
5633
  type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
5591
5634
  },
5592
5635
  },
5636
+ {
5637
+ kind: 'VariableDefinition',
5638
+ variable: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
5639
+ type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
5640
+ },
5593
5641
  ],
5594
5642
  selectionSet: {
5595
5643
  kind: 'SelectionSet',
@@ -5603,6 +5651,11 @@ export const MappingCandidatesDocument = {
5603
5651
  name: { kind: 'Name', value: 'classification' },
5604
5652
  value: { kind: 'Variable', name: { kind: 'Name', value: 'classification' } },
5605
5653
  },
5654
+ {
5655
+ kind: 'Argument',
5656
+ name: { kind: 'Name', value: 'entityId' },
5657
+ value: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
5658
+ },
5606
5659
  ],
5607
5660
  selectionSet: {
5608
5661
  kind: 'SelectionSet',
@@ -5675,12 +5728,26 @@ export const ListLedgerMappingsDocument = {
5675
5728
  kind: 'OperationDefinition',
5676
5729
  operation: 'query',
5677
5730
  name: { kind: 'Name', value: 'ListLedgerMappings' },
5731
+ variableDefinitions: [
5732
+ {
5733
+ kind: 'VariableDefinition',
5734
+ variable: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
5735
+ type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
5736
+ },
5737
+ ],
5678
5738
  selectionSet: {
5679
5739
  kind: 'SelectionSet',
5680
5740
  selections: [
5681
5741
  {
5682
5742
  kind: 'Field',
5683
5743
  name: { kind: 'Name', value: 'mappings' },
5744
+ arguments: [
5745
+ {
5746
+ kind: 'Argument',
5747
+ name: { kind: 'Name', value: 'entityId' },
5748
+ value: { kind: 'Variable', name: { kind: 'Name', value: 'entityId' } },
5749
+ },
5750
+ ],
5684
5751
  selectionSet: {
5685
5752
  kind: 'SelectionSet',
5686
5753
  selections: [
@@ -5697,6 +5764,7 @@ export const ListLedgerMappingsDocument = {
5697
5764
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
5698
5765
  { kind: 'Field', name: { kind: 'Name', value: 'isActive' } },
5699
5766
  { kind: 'Field', name: { kind: 'Name', value: 'framework' } },
5767
+ { kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
5700
5768
  ],
5701
5769
  },
5702
5770
  },
@@ -10,8 +10,13 @@ const graphql_request_1 = require("graphql-request");
10
10
  * branch. See `local/docs/specs/information-block.md` §2.
11
11
  */
12
12
  exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
13
- query GetInformationBlock($id: ID!, $scenarioId: String, $series: Boolean! = false) {
14
- informationBlock(id: $id, scenarioId: $scenarioId, series: $series) {
13
+ query GetInformationBlock(
14
+ $id: ID!
15
+ $scenarioId: String
16
+ $series: Boolean! = false
17
+ $entityId: String
18
+ ) {
19
+ informationBlock(id: $id, scenarioId: $scenarioId, series: $series, entityId: $entityId) {
15
20
  id
16
21
  blockType
17
22
  name
@@ -19,6 +24,7 @@ exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
19
24
  category
20
25
  taxonomyId
21
26
  taxonomyName
27
+ entityId
22
28
  informationModel {
23
29
  conceptArrangement
24
30
  memberArrangement
@@ -180,6 +186,7 @@ exports.GET_INFORMATION_BLOCK_WINDOWED = (0, graphql_request_1.gql) `
180
186
  $series: Boolean! = false
181
187
  $seriesHistory: Int
182
188
  $seriesForecast: Int
189
+ $entityId: String
183
190
  ) {
184
191
  informationBlock(
185
192
  id: $id
@@ -187,6 +194,7 @@ exports.GET_INFORMATION_BLOCK_WINDOWED = (0, graphql_request_1.gql) `
187
194
  series: $series
188
195
  seriesHistory: $seriesHistory
189
196
  seriesForecast: $seriesForecast
197
+ entityId: $entityId
190
198
  ) {
191
199
  id
192
200
  blockType
@@ -195,6 +203,7 @@ exports.GET_INFORMATION_BLOCK_WINDOWED = (0, graphql_request_1.gql) `
195
203
  category
196
204
  taxonomyId
197
205
  taxonomyName
206
+ entityId
198
207
  informationModel {
199
208
  conceptArrangement
200
209
  memberArrangement
@@ -351,6 +360,7 @@ exports.LIST_INFORMATION_BLOCKS = (0, graphql_request_1.gql) `
351
360
  $limit: Int
352
361
  $offset: Int
353
362
  $scenarioId: String
363
+ $entityId: String
354
364
  ) {
355
365
  informationBlocks(
356
366
  blockType: $blockType
@@ -358,6 +368,7 @@ exports.LIST_INFORMATION_BLOCKS = (0, graphql_request_1.gql) `
358
368
  limit: $limit
359
369
  offset: $offset
360
370
  scenarioId: $scenarioId
371
+ entityId: $entityId
361
372
  ) {
362
373
  id
363
374
  blockType
@@ -366,6 +377,7 @@ exports.LIST_INFORMATION_BLOCKS = (0, graphql_request_1.gql) `
366
377
  category
367
378
  taxonomyId
368
379
  taxonomyName
380
+ entityId
369
381
  informationModel {
370
382
  conceptArrangement
371
383
  memberArrangement
@@ -8,8 +8,13 @@ import { gql } from 'graphql-request'
8
8
  * branch. See `local/docs/specs/information-block.md` §2.
9
9
  */
10
10
  export const GET_INFORMATION_BLOCK = gql`
11
- query GetInformationBlock($id: ID!, $scenarioId: String, $series: Boolean! = false) {
12
- informationBlock(id: $id, scenarioId: $scenarioId, series: $series) {
11
+ query GetInformationBlock(
12
+ $id: ID!
13
+ $scenarioId: String
14
+ $series: Boolean! = false
15
+ $entityId: String
16
+ ) {
17
+ informationBlock(id: $id, scenarioId: $scenarioId, series: $series, entityId: $entityId) {
13
18
  id
14
19
  blockType
15
20
  name
@@ -17,6 +22,7 @@ export const GET_INFORMATION_BLOCK = gql`
17
22
  category
18
23
  taxonomyId
19
24
  taxonomyName
25
+ entityId
20
26
  informationModel {
21
27
  conceptArrangement
22
28
  memberArrangement
@@ -179,6 +185,7 @@ export const GET_INFORMATION_BLOCK_WINDOWED = gql`
179
185
  $series: Boolean! = false
180
186
  $seriesHistory: Int
181
187
  $seriesForecast: Int
188
+ $entityId: String
182
189
  ) {
183
190
  informationBlock(
184
191
  id: $id
@@ -186,6 +193,7 @@ export const GET_INFORMATION_BLOCK_WINDOWED = gql`
186
193
  series: $series
187
194
  seriesHistory: $seriesHistory
188
195
  seriesForecast: $seriesForecast
196
+ entityId: $entityId
189
197
  ) {
190
198
  id
191
199
  blockType
@@ -194,6 +202,7 @@ export const GET_INFORMATION_BLOCK_WINDOWED = gql`
194
202
  category
195
203
  taxonomyId
196
204
  taxonomyName
205
+ entityId
197
206
  informationModel {
198
207
  conceptArrangement
199
208
  memberArrangement
@@ -351,6 +360,7 @@ export const LIST_INFORMATION_BLOCKS = gql`
351
360
  $limit: Int
352
361
  $offset: Int
353
362
  $scenarioId: String
363
+ $entityId: String
354
364
  ) {
355
365
  informationBlocks(
356
366
  blockType: $blockType
@@ -358,6 +368,7 @@ export const LIST_INFORMATION_BLOCKS = gql`
358
368
  limit: $limit
359
369
  offset: $offset
360
370
  scenarioId: $scenarioId
371
+ entityId: $entityId
361
372
  ) {
362
373
  id
363
374
  blockType
@@ -366,6 +377,7 @@ export const LIST_INFORMATION_BLOCKS = gql`
366
377
  category
367
378
  taxonomyId
368
379
  taxonomyName
380
+ entityId
369
381
  informationModel {
370
382
  conceptArrangement
371
383
  memberArrangement
@@ -1,7 +1,8 @@
1
1
  /**
2
2
  * rs-gaap concepts a CoA element of a given EFS classification may map to,
3
- * limited to concepts that render under the graph's active Reporting Style
4
- * (statement-level subtotals excluded). This is the candidate set the mapping
3
+ * limited to concepts that render under the Reporting Style of the entity whose
4
+ * chart is being mapped (`$entityId`, default the group parent; statement-level
5
+ * subtotals excluded). This is the candidate set the mapping
5
6
  * picker should offer — mapping to anything outside it would land a fact on an
6
7
  * unreachable branch that never renders.
7
8
  */
@@ -4,14 +4,15 @@ exports.MAPPING_CANDIDATES = void 0;
4
4
  const graphql_request_1 = require("graphql-request");
5
5
  /**
6
6
  * rs-gaap concepts a CoA element of a given EFS classification may map to,
7
- * limited to concepts that render under the graph's active Reporting Style
8
- * (statement-level subtotals excluded). This is the candidate set the mapping
7
+ * limited to concepts that render under the Reporting Style of the entity whose
8
+ * chart is being mapped (`$entityId`, default the group parent; statement-level
9
+ * subtotals excluded). This is the candidate set the mapping
9
10
  * picker should offer — mapping to anything outside it would land a fact on an
10
11
  * unreachable branch that never renders.
11
12
  */
12
13
  exports.MAPPING_CANDIDATES = (0, graphql_request_1.gql) `
13
- query MappingCandidates($classification: String!) {
14
- mappingCandidates(classification: $classification) {
14
+ query MappingCandidates($classification: String!, $entityId: String) {
15
+ mappingCandidates(classification: $classification, entityId: $entityId) {
15
16
  id
16
17
  name
17
18
  qname
@@ -2,14 +2,15 @@ import { gql } from 'graphql-request'
2
2
 
3
3
  /**
4
4
  * rs-gaap concepts a CoA element of a given EFS classification may map to,
5
- * limited to concepts that render under the graph's active Reporting Style
6
- * (statement-level subtotals excluded). This is the candidate set the mapping
5
+ * limited to concepts that render under the Reporting Style of the entity whose
6
+ * chart is being mapped (`$entityId`, default the group parent; statement-level
7
+ * subtotals excluded). This is the candidate set the mapping
7
8
  * picker should offer — mapping to anything outside it would land a fact on an
8
9
  * unreachable branch that never renders.
9
10
  */
10
11
  export const MAPPING_CANDIDATES = gql`
11
- query MappingCandidates($classification: String!) {
12
- mappingCandidates(classification: $classification) {
12
+ query MappingCandidates($classification: String!, $entityId: String) {
13
+ mappingCandidates(classification: $classification, entityId: $entityId) {
13
14
  id
14
15
  name
15
16
  qname
@@ -3,5 +3,7 @@
3
3
  * StructureList (same wire shape as `structures`, just filtered server-side
4
4
  * to `block_type = 'coa_mapping'`). `framework` is the reporting framework
5
5
  * each maps the chart into; a chart holds one mapping per framework.
6
+ * `entityId` is the entity whose chart it maps from, and `$entityId`
7
+ * keeps one entity's mappings.
6
8
  */
7
9
  export declare const LIST_MAPPINGS: string;
@@ -7,10 +7,12 @@ const graphql_request_1 = require("graphql-request");
7
7
  * StructureList (same wire shape as `structures`, just filtered server-side
8
8
  * to `block_type = 'coa_mapping'`). `framework` is the reporting framework
9
9
  * each maps the chart into; a chart holds one mapping per framework.
10
+ * `entityId` is the entity whose chart it maps from, and `$entityId`
11
+ * keeps one entity's mappings.
10
12
  */
11
13
  exports.LIST_MAPPINGS = (0, graphql_request_1.gql) `
12
- query ListLedgerMappings {
13
- mappings {
14
+ query ListLedgerMappings($entityId: String) {
15
+ mappings(entityId: $entityId) {
14
16
  structures {
15
17
  id
16
18
  name
@@ -19,6 +21,7 @@ exports.LIST_MAPPINGS = (0, graphql_request_1.gql) `
19
21
  taxonomyId
20
22
  isActive
21
23
  framework
24
+ entityId
22
25
  }
23
26
  }
24
27
  }
@@ -5,10 +5,12 @@ import { gql } from 'graphql-request'
5
5
  * StructureList (same wire shape as `structures`, just filtered server-side
6
6
  * to `block_type = 'coa_mapping'`). `framework` is the reporting framework
7
7
  * each maps the chart into; a chart holds one mapping per framework.
8
+ * `entityId` is the entity whose chart it maps from, and `$entityId`
9
+ * keeps one entity's mappings.
8
10
  */
9
11
  export const LIST_MAPPINGS = gql`
10
- query ListLedgerMappings {
11
- mappings {
12
+ query ListLedgerMappings($entityId: String) {
13
+ mappings(entityId: $entityId) {
12
14
  structures {
13
15
  id
14
16
  name
@@ -17,6 +19,7 @@ export const LIST_MAPPINGS = gql`
17
19
  taxonomyId
18
20
  isActive
19
21
  framework
22
+ entityId
20
23
  }
21
24
  }
22
25
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "2.9.1",
3
+ "version": "2.10.0",
4
4
  "description": "TypeScript client library for the RoboSystems financial intelligence platform",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
package/sdk/sdk.gen.d.ts CHANGED
@@ -320,7 +320,7 @@ export declare const listConnections: <ThrowOnError extends boolean = false>(opt
320
320
  /**
321
321
  * Create Connection
322
322
  *
323
- * QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) is refused (409) beside a live QuickBooks connection or on a graph with no chart of accounts.
323
+ * QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps; QuickBooks is refused (409) when the group parent's books are already native.
324
324
  */
325
325
  export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>;
326
326
  /**
@@ -352,7 +352,7 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
352
352
  /**
353
353
  * Set Connection Write Policy
354
354
  *
355
- * Opt a connection into or out of outbound write-back. 'qb_authoritative' makes QuickBooks the source of truth — RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'native' keeps RoboSystems authoritative with no write-back. This is the explicit operator opt-in for writing to your books of record.
355
+ * Choose how a live connection and RoboSystems share the books. 'qb_authoritative', the default, makes QuickBooks the book of record: RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'shadow' keeps QuickBooks the book of record and writes nothing to it: the close posts nothing locally either, its drafts become shadowed expectations compared with what QuickBooks holds, and its gates are recorded as findings. 'native' is not a choice here: it is what disconnecting or severing leaves, books kept in RoboSystems with no connection to write to. This is the explicit operator opt-in for writing to your books of record.
356
356
  */
357
357
  export declare const setConnectionWritePolicy: <ThrowOnError extends boolean = false>(options: Options<SetConnectionWritePolicyData, ThrowOnError>) => RequestResult<SetConnectionWritePolicyResponses, SetConnectionWritePolicyErrors, ThrowOnError>;
358
358
  /**
@@ -1136,7 +1136,7 @@ export declare const setCloseTarget: <ThrowOnError extends boolean = false>(opti
1136
1136
  /**
1137
1137
  * Close Fiscal Period
1138
1138
  *
1139
- * Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one, auto-advances `close_target` if this close caught up to it, and stamps the period's canonical statement FactSets from the posted ledger (`statements_stamped` / `stamped_statement_sets` in the response; soft-skipped with `statement_stamp_note` when reporting isn't set up). Period must be exactly `closed_through + 1` — sequence violations return 422 with structured `blockers`. Common blockers: `sync_stale` (override with `allow_stale_sync=true` after manual verification), `period_incomplete` (draft entries unbalanced), `sequence_violation` (out-of-order).
1139
+ * Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one, auto-advances `close_target` if this close caught up to it, and stamps the period's canonical statement FactSets from the posted ledger (`statements_stamped` / `stamped_statement_sets` in the response; soft-skipped with `statement_stamp_note` when reporting isn't set up). Period must be exactly `closed_through + 1` — sequence violations return 422 with structured `blockers`. Common blockers: `sync_stale` (override with `allow_stale_sync=true` after manual verification), `period_incomplete` (draft entries unbalanced), `sequence_violation` (out-of-order). Under a QuickBooks connection whose write_policy is `shadow`, the close observes instead: nothing is written to QuickBooks or posted, the drafts become `shadowed` expectations (`entries_shadowed`), and the gates that would have blocked are returned as `gate_findings` rather than enforced.
1140
1140
  *
1141
1141
  * **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.
1142
1142
  */
package/sdk/sdk.gen.js CHANGED
@@ -614,7 +614,7 @@ exports.listConnections = listConnections;
614
614
  /**
615
615
  * Create Connection
616
616
  *
617
- * QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) is refused (409) beside a live QuickBooks connection or on a graph with no chart of accounts.
617
+ * QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps; QuickBooks is refused (409) when the group parent's books are already native.
618
618
  */
619
619
  const createConnection = (options) => (options.client ?? client_gen_1.client).post({
620
620
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -692,7 +692,7 @@ exports.syncConnection = syncConnection;
692
692
  /**
693
693
  * Set Connection Write Policy
694
694
  *
695
- * Opt a connection into or out of outbound write-back. 'qb_authoritative' makes QuickBooks the source of truth — RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'native' keeps RoboSystems authoritative with no write-back. This is the explicit operator opt-in for writing to your books of record.
695
+ * Choose how a live connection and RoboSystems share the books. 'qb_authoritative', the default, makes QuickBooks the book of record: RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'shadow' keeps QuickBooks the book of record and writes nothing to it: the close posts nothing locally either, its drafts become shadowed expectations compared with what QuickBooks holds, and its gates are recorded as findings. 'native' is not a choice here: it is what disconnecting or severing leaves, books kept in RoboSystems with no connection to write to. This is the explicit operator opt-in for writing to your books of record.
696
696
  */
697
697
  const setConnectionWritePolicy = (options) => (options.client ?? client_gen_1.client).put({
698
698
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -2340,7 +2340,7 @@ exports.setCloseTarget = setCloseTarget;
2340
2340
  /**
2341
2341
  * Close Fiscal Period
2342
2342
  *
2343
- * Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one, auto-advances `close_target` if this close caught up to it, and stamps the period's canonical statement FactSets from the posted ledger (`statements_stamped` / `stamped_statement_sets` in the response; soft-skipped with `statement_stamp_note` when reporting isn't set up). Period must be exactly `closed_through + 1` — sequence violations return 422 with structured `blockers`. Common blockers: `sync_stale` (override with `allow_stale_sync=true` after manual verification), `period_incomplete` (draft entries unbalanced), `sequence_violation` (out-of-order).
2343
+ * Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one, auto-advances `close_target` if this close caught up to it, and stamps the period's canonical statement FactSets from the posted ledger (`statements_stamped` / `stamped_statement_sets` in the response; soft-skipped with `statement_stamp_note` when reporting isn't set up). Period must be exactly `closed_through + 1` — sequence violations return 422 with structured `blockers`. Common blockers: `sync_stale` (override with `allow_stale_sync=true` after manual verification), `period_incomplete` (draft entries unbalanced), `sequence_violation` (out-of-order). Under a QuickBooks connection whose write_policy is `shadow`, the close observes instead: nothing is written to QuickBooks or posted, the drafts become `shadowed` expectations (`entries_shadowed`), and the gates that would have blocked are returned as `gate_findings` rather than enforced.
2344
2344
  *
2345
2345
  * **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.
2346
2346
  */
package/sdk/sdk.gen.ts CHANGED
@@ -625,7 +625,7 @@ export const listConnections = <ThrowOnError extends boolean = false>(options: O
625
625
  /**
626
626
  * Create Connection
627
627
  *
628
- * QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) is refused (409) beside a live QuickBooks connection or on a graph with no chart of accounts.
628
+ * QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps; QuickBooks is refused (409) when the group parent's books are already native.
629
629
  */
630
630
  export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>): RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError> => (options.client ?? client).post<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>({
631
631
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -703,7 +703,7 @@ export const syncConnection = <ThrowOnError extends boolean = false>(options: Op
703
703
  /**
704
704
  * Set Connection Write Policy
705
705
  *
706
- * Opt a connection into or out of outbound write-back. 'qb_authoritative' makes QuickBooks the source of truth — RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'native' keeps RoboSystems authoritative with no write-back. This is the explicit operator opt-in for writing to your books of record.
706
+ * Choose how a live connection and RoboSystems share the books. 'qb_authoritative', the default, makes QuickBooks the book of record: RoboSystems-originated entries (manual JEs, schedule drafts) publish to QuickBooks when executed or at close. 'shadow' keeps QuickBooks the book of record and writes nothing to it: the close posts nothing locally either, its drafts become shadowed expectations compared with what QuickBooks holds, and its gates are recorded as findings. 'native' is not a choice here: it is what disconnecting or severing leaves, books kept in RoboSystems with no connection to write to. This is the explicit operator opt-in for writing to your books of record.
707
707
  */
708
708
  export const setConnectionWritePolicy = <ThrowOnError extends boolean = false>(options: Options<SetConnectionWritePolicyData, ThrowOnError>): RequestResult<SetConnectionWritePolicyResponses, SetConnectionWritePolicyErrors, ThrowOnError> => (options.client ?? client).put<SetConnectionWritePolicyResponses, SetConnectionWritePolicyErrors, ThrowOnError>({
709
709
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -2351,7 +2351,7 @@ export const setCloseTarget = <ThrowOnError extends boolean = false>(options: Op
2351
2351
  /**
2352
2352
  * Close Fiscal Period
2353
2353
  *
2354
- * Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one, auto-advances `close_target` if this close caught up to it, and stamps the period's canonical statement FactSets from the posted ledger (`statements_stamped` / `stamped_statement_sets` in the response; soft-skipped with `statement_stamp_note` when reporting isn't set up). Period must be exactly `closed_through + 1` — sequence violations return 422 with structured `blockers`. Common blockers: `sync_stale` (override with `allow_stale_sync=true` after manual verification), `period_incomplete` (draft entries unbalanced), `sequence_violation` (out-of-order).
2354
+ * Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one, auto-advances `close_target` if this close caught up to it, and stamps the period's canonical statement FactSets from the posted ledger (`statements_stamped` / `stamped_statement_sets` in the response; soft-skipped with `statement_stamp_note` when reporting isn't set up). Period must be exactly `closed_through + 1` — sequence violations return 422 with structured `blockers`. Common blockers: `sync_stale` (override with `allow_stale_sync=true` after manual verification), `period_incomplete` (draft entries unbalanced), `sequence_violation` (out-of-order). Under a QuickBooks connection whose write_policy is `shadow`, the close observes instead: nothing is written to QuickBooks or posted, the drafts become `shadowed` expectations (`entries_shadowed`), and the gates that would have blocked are returned as `gate_findings` rather than enforced.
2355
2355
  *
2356
2356
  * **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.
2357
2357
  */