@company-semantics/contracts 79.0.0 → 79.1.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/package.json
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
// AUTO-GENERATED — do not edit. Run pnpm generate:spec-hash to regenerate.
|
|
2
|
-
export const SPEC_HASH = '
|
|
3
|
-
export const SPEC_HASH_FULL = '
|
|
2
|
+
export const SPEC_HASH = 'c6eea14298b3' as const;
|
|
3
|
+
export const SPEC_HASH_FULL = 'c6eea14298b3f6282e821b61fac860d7c18fbb8af4b5ecf660bc09665a215d9b' as const;
|
package/src/api/generated.ts
CHANGED
|
@@ -4589,6 +4589,30 @@ export interface paths {
|
|
|
4589
4589
|
patch?: never;
|
|
4590
4590
|
trace?: never;
|
|
4591
4591
|
};
|
|
4592
|
+
"/api/source-sync/settings": {
|
|
4593
|
+
parameters: {
|
|
4594
|
+
query?: never;
|
|
4595
|
+
header?: never;
|
|
4596
|
+
path?: never;
|
|
4597
|
+
cookie?: never;
|
|
4598
|
+
};
|
|
4599
|
+
/**
|
|
4600
|
+
* Read whether Source Sync is on for the org
|
|
4601
|
+
* @description The org switch every Source Sync route, job and sweep gates on, and who last changed it and when. Off until an admin turns it on.
|
|
4602
|
+
*/
|
|
4603
|
+
get: operations["getSourceSyncSettings"];
|
|
4604
|
+
/**
|
|
4605
|
+
* Switch Source Sync on or off for the org
|
|
4606
|
+
* @description On lets Source Sync search the connected Drive and propose company.md updates for review. Off pauses it: nothing is read or run, and nothing already brought in is deleted. The caller is recorded as the person who changed it.
|
|
4607
|
+
*/
|
|
4608
|
+
put: operations["putSourceSyncSettings"];
|
|
4609
|
+
post?: never;
|
|
4610
|
+
delete?: never;
|
|
4611
|
+
options?: never;
|
|
4612
|
+
head?: never;
|
|
4613
|
+
patch?: never;
|
|
4614
|
+
trace?: never;
|
|
4615
|
+
};
|
|
4592
4616
|
}
|
|
4593
4617
|
export type webhooks = Record<string, never>;
|
|
4594
4618
|
export interface components {
|
|
@@ -9296,6 +9320,14 @@ export interface components {
|
|
|
9296
9320
|
/** @constant */
|
|
9297
9321
|
confirm: true;
|
|
9298
9322
|
};
|
|
9323
|
+
SourceSyncSettingsResponse: {
|
|
9324
|
+
enabled: boolean;
|
|
9325
|
+
changedAt: string | null;
|
|
9326
|
+
changedByLabel: string | null;
|
|
9327
|
+
};
|
|
9328
|
+
SourceSyncPutSettingsRequest: {
|
|
9329
|
+
enabled: boolean;
|
|
9330
|
+
};
|
|
9299
9331
|
/** @description Server-enforced collaboration size limits, published so clients can pre-check. */
|
|
9300
9332
|
CollabSyncLimits: {
|
|
9301
9333
|
maxUpdateBytes: number;
|
|
@@ -17248,14 +17280,7 @@ export interface operations {
|
|
|
17248
17280
|
"application/json": components["schemas"]["SourceSyncDiscoveryRunResponse"];
|
|
17249
17281
|
};
|
|
17250
17282
|
};
|
|
17251
|
-
/** @description Source Sync is
|
|
17252
|
-
404: {
|
|
17253
|
-
headers: {
|
|
17254
|
-
[name: string]: unknown;
|
|
17255
|
-
};
|
|
17256
|
-
content?: never;
|
|
17257
|
-
};
|
|
17258
|
-
/** @description The org has no active Google Drive connection (SOURCE_SYNC_DRIVE_NOT_CONNECTED), or a discovery run is already running (SOURCE_DISCOVERY_ALREADY_RUNNING) */
|
|
17283
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or The org has no active Google Drive connection (SOURCE_SYNC_DRIVE_NOT_CONNECTED), or a discovery run is already running (SOURCE_DISCOVERY_ALREADY_RUNNING) */
|
|
17259
17284
|
409: {
|
|
17260
17285
|
headers: {
|
|
17261
17286
|
[name: string]: unknown;
|
|
@@ -17282,13 +17307,20 @@ export interface operations {
|
|
|
17282
17307
|
"application/json": components["schemas"]["SourceSyncCandidateSetResponse"];
|
|
17283
17308
|
};
|
|
17284
17309
|
};
|
|
17285
|
-
/** @description
|
|
17310
|
+
/** @description The org has no draft candidate set */
|
|
17286
17311
|
404: {
|
|
17287
17312
|
headers: {
|
|
17288
17313
|
[name: string]: unknown;
|
|
17289
17314
|
};
|
|
17290
17315
|
content?: never;
|
|
17291
17316
|
};
|
|
17317
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
|
|
17318
|
+
409: {
|
|
17319
|
+
headers: {
|
|
17320
|
+
[name: string]: unknown;
|
|
17321
|
+
};
|
|
17322
|
+
content?: never;
|
|
17323
|
+
};
|
|
17292
17324
|
};
|
|
17293
17325
|
};
|
|
17294
17326
|
patchSourceCandidateItem: {
|
|
@@ -17330,14 +17362,14 @@ export interface operations {
|
|
|
17330
17362
|
};
|
|
17331
17363
|
content?: never;
|
|
17332
17364
|
};
|
|
17333
|
-
/** @description
|
|
17365
|
+
/** @description The set, item or target document is not the org’s */
|
|
17334
17366
|
404: {
|
|
17335
17367
|
headers: {
|
|
17336
17368
|
[name: string]: unknown;
|
|
17337
17369
|
};
|
|
17338
17370
|
content?: never;
|
|
17339
17371
|
};
|
|
17340
|
-
/** @description The set is no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT), or the item’s scope was already approved (SOURCE_SYNC_CANDIDATE_ITEM_FROZEN) */
|
|
17372
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or The set is no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT), or the item’s scope was already approved (SOURCE_SYNC_CANDIDATE_ITEM_FROZEN) */
|
|
17341
17373
|
409: {
|
|
17342
17374
|
headers: {
|
|
17343
17375
|
[name: string]: unknown;
|
|
@@ -17377,14 +17409,14 @@ export interface operations {
|
|
|
17377
17409
|
"application/json": components["schemas"]["SourceSyncCandidateSetResponse"];
|
|
17378
17410
|
};
|
|
17379
17411
|
};
|
|
17380
|
-
/** @description
|
|
17412
|
+
/** @description The set, the file or the target document is not the org’s */
|
|
17381
17413
|
404: {
|
|
17382
17414
|
headers: {
|
|
17383
17415
|
[name: string]: unknown;
|
|
17384
17416
|
};
|
|
17385
17417
|
content?: never;
|
|
17386
17418
|
};
|
|
17387
|
-
/** @description No active Google Drive connection (SOURCE_SYNC_DRIVE_NOT_CONNECTED), the set is no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT), or the file is already on the list for that document (SOURCE_SYNC_CANDIDATE_ALREADY_IN_SET) */
|
|
17419
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or No active Google Drive connection (SOURCE_SYNC_DRIVE_NOT_CONNECTED), the set is no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT), or the file is already on the list for that document (SOURCE_SYNC_CANDIDATE_ALREADY_IN_SET) */
|
|
17388
17420
|
409: {
|
|
17389
17421
|
headers: {
|
|
17390
17422
|
[name: string]: unknown;
|
|
@@ -17428,14 +17460,14 @@ export interface operations {
|
|
|
17428
17460
|
};
|
|
17429
17461
|
content?: never;
|
|
17430
17462
|
};
|
|
17431
|
-
/** @description
|
|
17463
|
+
/** @description The set is not the org’s */
|
|
17432
17464
|
404: {
|
|
17433
17465
|
headers: {
|
|
17434
17466
|
[name: string]: unknown;
|
|
17435
17467
|
};
|
|
17436
17468
|
content?: never;
|
|
17437
17469
|
};
|
|
17438
|
-
/** @description Stale revision (SOURCE_SYNC_CANDIDATE_SET_STALE), an unresolved widening (SOURCE_SYNC_TREATMENT_UNRESOLVED), a file with no document (SOURCE_SYNC_TARGET_UNRESOLVED), a scope already approved (SOURCE_SYNC_SCOPE_ALREADY_APPROVED), or a set no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT) */
|
|
17470
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or Stale revision (SOURCE_SYNC_CANDIDATE_SET_STALE), an unresolved widening (SOURCE_SYNC_TREATMENT_UNRESOLVED), a file with no document (SOURCE_SYNC_TARGET_UNRESOLVED), a scope already approved (SOURCE_SYNC_SCOPE_ALREADY_APPROVED), or a set no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT) */
|
|
17439
17471
|
409: {
|
|
17440
17472
|
headers: {
|
|
17441
17473
|
[name: string]: unknown;
|
|
@@ -17462,8 +17494,8 @@ export interface operations {
|
|
|
17462
17494
|
"application/json": components["schemas"]["SourceSyncCurrentSynthesisResponse"];
|
|
17463
17495
|
};
|
|
17464
17496
|
};
|
|
17465
|
-
/** @description Source Sync is
|
|
17466
|
-
|
|
17497
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
|
|
17498
|
+
409: {
|
|
17467
17499
|
headers: {
|
|
17468
17500
|
[name: string]: unknown;
|
|
17469
17501
|
};
|
|
@@ -17491,13 +17523,20 @@ export interface operations {
|
|
|
17491
17523
|
"application/json": components["schemas"]["SourceSyncSynthesisResponse"];
|
|
17492
17524
|
};
|
|
17493
17525
|
};
|
|
17494
|
-
/** @description
|
|
17526
|
+
/** @description The batch is not the org’s */
|
|
17495
17527
|
404: {
|
|
17496
17528
|
headers: {
|
|
17497
17529
|
[name: string]: unknown;
|
|
17498
17530
|
};
|
|
17499
17531
|
content?: never;
|
|
17500
17532
|
};
|
|
17533
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
|
|
17534
|
+
409: {
|
|
17535
|
+
headers: {
|
|
17536
|
+
[name: string]: unknown;
|
|
17537
|
+
};
|
|
17538
|
+
content?: never;
|
|
17539
|
+
};
|
|
17501
17540
|
};
|
|
17502
17541
|
};
|
|
17503
17542
|
applySourceSynthesis: {
|
|
@@ -17537,14 +17576,14 @@ export interface operations {
|
|
|
17537
17576
|
};
|
|
17538
17577
|
content?: never;
|
|
17539
17578
|
};
|
|
17540
|
-
/** @description
|
|
17579
|
+
/** @description The batch or an included change is not the org’s */
|
|
17541
17580
|
404: {
|
|
17542
17581
|
headers: {
|
|
17543
17582
|
[name: string]: unknown;
|
|
17544
17583
|
};
|
|
17545
17584
|
content?: never;
|
|
17546
17585
|
};
|
|
17547
|
-
/** @description An included document still has an open question (SOURCE_SYNC_DOC_BLOCKED), or the review or a change is no longer open to apply (SOURCE_SYNC_SYNTHESIS_NOT_OPEN) */
|
|
17586
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or An included document still has an open question (SOURCE_SYNC_DOC_BLOCKED), or the review or a change is no longer open to apply (SOURCE_SYNC_SYNTHESIS_NOT_OPEN) */
|
|
17548
17587
|
409: {
|
|
17549
17588
|
headers: {
|
|
17550
17589
|
[name: string]: unknown;
|
|
@@ -17571,8 +17610,8 @@ export interface operations {
|
|
|
17571
17610
|
"application/json": components["schemas"]["SourceSyncRulesResponse"];
|
|
17572
17611
|
};
|
|
17573
17612
|
};
|
|
17574
|
-
/** @description Source Sync is
|
|
17575
|
-
|
|
17613
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
|
|
17614
|
+
409: {
|
|
17576
17615
|
headers: {
|
|
17577
17616
|
[name: string]: unknown;
|
|
17578
17617
|
};
|
|
@@ -17609,14 +17648,7 @@ export interface operations {
|
|
|
17609
17648
|
};
|
|
17610
17649
|
content?: never;
|
|
17611
17650
|
};
|
|
17612
|
-
/** @description Source Sync is
|
|
17613
|
-
404: {
|
|
17614
|
-
headers: {
|
|
17615
|
-
[name: string]: unknown;
|
|
17616
|
-
};
|
|
17617
|
-
content?: never;
|
|
17618
|
-
};
|
|
17619
|
-
/** @description An active rule already stands for this subject (SOURCE_SYNC_RULE_DUPLICATE); nothing changed */
|
|
17651
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or An active rule already stands for this subject (SOURCE_SYNC_RULE_DUPLICATE); nothing changed */
|
|
17620
17652
|
409: {
|
|
17621
17653
|
headers: {
|
|
17622
17654
|
[name: string]: unknown;
|
|
@@ -17645,13 +17677,20 @@ export interface operations {
|
|
|
17645
17677
|
"application/json": components["schemas"]["SourceSyncRule"];
|
|
17646
17678
|
};
|
|
17647
17679
|
};
|
|
17648
|
-
/** @description
|
|
17680
|
+
/** @description The rule is not the org’s or is already retired */
|
|
17649
17681
|
404: {
|
|
17650
17682
|
headers: {
|
|
17651
17683
|
[name: string]: unknown;
|
|
17652
17684
|
};
|
|
17653
17685
|
content?: never;
|
|
17654
17686
|
};
|
|
17687
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
|
|
17688
|
+
409: {
|
|
17689
|
+
headers: {
|
|
17690
|
+
[name: string]: unknown;
|
|
17691
|
+
};
|
|
17692
|
+
content?: never;
|
|
17693
|
+
};
|
|
17655
17694
|
};
|
|
17656
17695
|
};
|
|
17657
17696
|
listSourceSyncFindings: {
|
|
@@ -17679,8 +17718,8 @@ export interface operations {
|
|
|
17679
17718
|
};
|
|
17680
17719
|
content?: never;
|
|
17681
17720
|
};
|
|
17682
|
-
/** @description Source Sync is
|
|
17683
|
-
|
|
17721
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
|
|
17722
|
+
409: {
|
|
17684
17723
|
headers: {
|
|
17685
17724
|
[name: string]: unknown;
|
|
17686
17725
|
};
|
|
@@ -17726,14 +17765,14 @@ export interface operations {
|
|
|
17726
17765
|
};
|
|
17727
17766
|
content?: never;
|
|
17728
17767
|
};
|
|
17729
|
-
/** @description
|
|
17768
|
+
/** @description The finding is not the org’s or names no source */
|
|
17730
17769
|
404: {
|
|
17731
17770
|
headers: {
|
|
17732
17771
|
[name: string]: unknown;
|
|
17733
17772
|
};
|
|
17734
17773
|
content?: never;
|
|
17735
17774
|
};
|
|
17736
|
-
/** @description The finding already settled on its own (SOURCE_SYNC_FINDING_NOT_OPEN); nothing changed */
|
|
17775
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or The finding already settled on its own (SOURCE_SYNC_FINDING_NOT_OPEN); nothing changed */
|
|
17737
17776
|
409: {
|
|
17738
17777
|
headers: {
|
|
17739
17778
|
[name: string]: unknown;
|
|
@@ -17767,8 +17806,8 @@ export interface operations {
|
|
|
17767
17806
|
};
|
|
17768
17807
|
content?: never;
|
|
17769
17808
|
};
|
|
17770
|
-
/** @description Source Sync is
|
|
17771
|
-
|
|
17809
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
|
|
17810
|
+
409: {
|
|
17772
17811
|
headers: {
|
|
17773
17812
|
[name: string]: unknown;
|
|
17774
17813
|
};
|
|
@@ -17814,8 +17853,8 @@ export interface operations {
|
|
|
17814
17853
|
};
|
|
17815
17854
|
content?: never;
|
|
17816
17855
|
};
|
|
17817
|
-
/** @description Source Sync is
|
|
17818
|
-
|
|
17856
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
|
|
17857
|
+
409: {
|
|
17819
17858
|
headers: {
|
|
17820
17859
|
[name: string]: unknown;
|
|
17821
17860
|
};
|
|
@@ -17848,8 +17887,8 @@ export interface operations {
|
|
|
17848
17887
|
};
|
|
17849
17888
|
content?: never;
|
|
17850
17889
|
};
|
|
17851
|
-
/** @description Source Sync is
|
|
17852
|
-
|
|
17890
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
|
|
17891
|
+
409: {
|
|
17853
17892
|
headers: {
|
|
17854
17893
|
[name: string]: unknown;
|
|
17855
17894
|
};
|
|
@@ -17893,22 +17932,80 @@ export interface operations {
|
|
|
17893
17932
|
};
|
|
17894
17933
|
content?: never;
|
|
17895
17934
|
};
|
|
17896
|
-
/** @description Source Sync is not
|
|
17897
|
-
|
|
17935
|
+
/** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or Workspace-wide access is off or not set up, Drive is not connected or is not a Workspace account, reach is already domain, or Google did not accept the delegation */
|
|
17936
|
+
409: {
|
|
17898
17937
|
headers: {
|
|
17899
17938
|
[name: string]: unknown;
|
|
17900
17939
|
};
|
|
17901
17940
|
content?: never;
|
|
17902
17941
|
};
|
|
17903
|
-
/** @description
|
|
17904
|
-
|
|
17942
|
+
/** @description Google could not be reached to verify the delegation */
|
|
17943
|
+
502: {
|
|
17905
17944
|
headers: {
|
|
17906
17945
|
[name: string]: unknown;
|
|
17907
17946
|
};
|
|
17908
17947
|
content?: never;
|
|
17909
17948
|
};
|
|
17910
|
-
|
|
17911
|
-
|
|
17949
|
+
};
|
|
17950
|
+
};
|
|
17951
|
+
getSourceSyncSettings: {
|
|
17952
|
+
parameters: {
|
|
17953
|
+
query?: never;
|
|
17954
|
+
header?: never;
|
|
17955
|
+
path?: never;
|
|
17956
|
+
cookie?: never;
|
|
17957
|
+
};
|
|
17958
|
+
requestBody?: never;
|
|
17959
|
+
responses: {
|
|
17960
|
+
/** @description The org’s Source Sync switch */
|
|
17961
|
+
200: {
|
|
17962
|
+
headers: {
|
|
17963
|
+
[name: string]: unknown;
|
|
17964
|
+
};
|
|
17965
|
+
content: {
|
|
17966
|
+
"application/json": components["schemas"]["SourceSyncSettingsResponse"];
|
|
17967
|
+
};
|
|
17968
|
+
};
|
|
17969
|
+
/** @description The caller may not manage integrations */
|
|
17970
|
+
403: {
|
|
17971
|
+
headers: {
|
|
17972
|
+
[name: string]: unknown;
|
|
17973
|
+
};
|
|
17974
|
+
content?: never;
|
|
17975
|
+
};
|
|
17976
|
+
};
|
|
17977
|
+
};
|
|
17978
|
+
putSourceSyncSettings: {
|
|
17979
|
+
parameters: {
|
|
17980
|
+
query?: never;
|
|
17981
|
+
header?: never;
|
|
17982
|
+
path?: never;
|
|
17983
|
+
cookie?: never;
|
|
17984
|
+
};
|
|
17985
|
+
requestBody: {
|
|
17986
|
+
content: {
|
|
17987
|
+
"application/json": components["schemas"]["SourceSyncPutSettingsRequest"];
|
|
17988
|
+
};
|
|
17989
|
+
};
|
|
17990
|
+
responses: {
|
|
17991
|
+
/** @description The switch as it now stands */
|
|
17992
|
+
200: {
|
|
17993
|
+
headers: {
|
|
17994
|
+
[name: string]: unknown;
|
|
17995
|
+
};
|
|
17996
|
+
content: {
|
|
17997
|
+
"application/json": components["schemas"]["SourceSyncSettingsResponse"];
|
|
17998
|
+
};
|
|
17999
|
+
};
|
|
18000
|
+
/** @description Invalid body */
|
|
18001
|
+
400: {
|
|
18002
|
+
headers: {
|
|
18003
|
+
[name: string]: unknown;
|
|
18004
|
+
};
|
|
18005
|
+
content?: never;
|
|
18006
|
+
};
|
|
18007
|
+
/** @description The caller may not manage integrations */
|
|
18008
|
+
403: {
|
|
17912
18009
|
headers: {
|
|
17913
18010
|
[name: string]: unknown;
|
|
17914
18011
|
};
|
|
@@ -191,6 +191,7 @@ export const openApiRoutes = {
|
|
|
191
191
|
'/api/source-sync/reach/upgrade': ['POST'],
|
|
192
192
|
'/api/source-sync/rules': ['GET', 'POST'],
|
|
193
193
|
'/api/source-sync/rules/{ruleId}/retire': ['POST'],
|
|
194
|
+
'/api/source-sync/settings': ['GET', 'PUT'],
|
|
194
195
|
'/api/source-sync/standing-orders': ['GET'],
|
|
195
196
|
'/api/source-sync/standing-orders/{scopeKey}': ['PUT'],
|
|
196
197
|
'/api/source-sync/syntheses/current': ['GET'],
|