@collective-intelligence/external-apps-server-sdk 0.2.3 → 0.2.4

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/dist/admin.d.ts CHANGED
@@ -318,6 +318,9 @@ export type ComponentDeploymentMetadata = {
318
318
  principalId: string;
319
319
  timestamp: string;
320
320
  };
321
+ export type ReportReadAs = "starter" | {
322
+ servicePrincipal: string;
323
+ };
321
324
  declare const FeatureFlagRolloutMode: {
322
325
  readonly ENABLED_FOR_ALL: "enabled_for_all";
323
326
  readonly DISABLED_FOR_ALL: "disabled_for_all";
@@ -325,6 +328,11 @@ declare const FeatureFlagRolloutMode: {
325
328
  readonly DISABLED_FOR_ORGANIZATIONS: "disabled_for_organizations";
326
329
  };
327
330
  export type FeatureFlagRolloutMode = typeof FeatureFlagRolloutMode[keyof typeof FeatureFlagRolloutMode];
331
+ export type AiSkillDataAccess = {
332
+ datasets?: "user" | "skill";
333
+ documents?: "user" | "skill";
334
+ knowledge?: "user" | "skill";
335
+ };
328
336
  export type KnowledgeRelationFieldEntry = {
329
337
  autocomplete?: {
330
338
  baseFilters?: Array<{
@@ -554,6 +562,21 @@ export type UpdatePackageInstallationRequestEncoded = {
554
562
  } | unknown;
555
563
  };
556
564
  };
565
+ export type AudiencePersonRef = {
566
+ grantee: {
567
+ kind: "organization";
568
+ } | {
569
+ kind: "user";
570
+ userId: string;
571
+ } | {
572
+ coverage: "direct" | "inherited";
573
+ groupId: string;
574
+ kind: "group";
575
+ };
576
+ granteeName: string | null;
577
+ id: string;
578
+ organizationId: string;
579
+ };
557
580
  export type AssociateToolRequest = {
558
581
  description?: string | null;
559
582
  name?: string | null;
@@ -566,12 +589,13 @@ export type AiSkillDto = {
566
589
  activeVersionId: string | null;
567
590
  approvedVersionId: string | null;
568
591
  archivedAt: string | null;
592
+ audience: Array<AudiencePersonRef>;
569
593
  authoringMode: string;
570
- bindings: Array<AiSkillBindingRefDto>;
571
594
  body: string | null;
572
595
  createdAt: string | null;
573
596
  createdBy: string | null;
574
597
  createdByName: string | null;
598
+ dataAccess: AiSkillDataAccess | null;
575
599
  description: string | null;
576
600
  enabled: boolean;
577
601
  id: string;
@@ -615,25 +639,11 @@ export type AiSkillPackageSummaryDto = {
615
639
  scriptCount: number;
616
640
  totalSizeBytes: number;
617
641
  };
618
- export type AiSkillBindingRefDto = {
619
- grantee: {
620
- kind: "organization";
621
- } | {
622
- kind: "user";
623
- userId: string;
624
- } | {
625
- coverage: "direct" | "inherited";
626
- groupId: string;
627
- kind: "group";
628
- };
629
- granteeName: string | null;
630
- id: string;
631
- organizationId: string;
632
- };
633
642
  export type UpdateAiSkillRequest = {
634
643
  archivedAt?: string | null;
635
644
  authoringMode?: string | null;
636
645
  body?: string | null;
646
+ dataAccess?: AiSkillDataAccess | null;
637
647
  description?: string | null;
638
648
  enabled?: boolean | null;
639
649
  name?: string | null;
@@ -644,29 +654,17 @@ export type UpdateAiSkillRequest = {
644
654
  export type CreateAiSkillRequest = {
645
655
  authoringMode?: string | null;
646
656
  body?: string | null;
657
+ dataAccess?: AiSkillDataAccess;
647
658
  description?: string | null;
648
659
  enabled?: boolean;
649
660
  name: string;
650
661
  organizationId: string;
651
662
  organizationModelDefaultId?: string | null;
652
663
  package?: unknown;
653
- permissions?: Array<AiSkillPermissionInput>;
654
664
  slug: string;
655
665
  toolBindings?: Array<AssociateToolRequest>;
656
666
  toolIds?: Array<string>;
657
667
  };
658
- export type AiSkillPermissionInput = {
659
- grantee: {
660
- kind: "organization";
661
- } | {
662
- kind: "user";
663
- userId: string;
664
- } | {
665
- coverage: "direct" | "inherited";
666
- groupId: string;
667
- kind: "group";
668
- };
669
- };
670
668
  export type UpdateAiEmbeddingModelRequest = {
671
669
  adapterType?: "bedrock" | "cohere" | "gemini" | "gemini_native" | "openai";
672
670
  description?: string | null;
@@ -2654,12 +2652,6 @@ export type OrganizationUsersSearchData = {
2654
2652
  lt?: string;
2655
2653
  lte?: string;
2656
2654
  };
2657
- role?: {
2658
- eq?: "organization_admin" | "organization_operator" | "organization_member";
2659
- in?: Array<"organization_admin" | "organization_operator" | "organization_member">;
2660
- isNull?: boolean;
2661
- notIn?: Array<"organization_admin" | "organization_operator" | "organization_member">;
2662
- };
2663
2655
  updatedAt?: {
2664
2656
  eq?: string;
2665
2657
  gt?: string;
@@ -2676,7 +2668,7 @@ export type OrganizationUsersSearchData = {
2676
2668
  };
2677
2669
  sort?: Array<{
2678
2670
  direction: "asc" | "desc";
2679
- field: "createdAt" | "role" | "updatedAt";
2671
+ field: "createdAt" | "updatedAt";
2680
2672
  }>;
2681
2673
  };
2682
2674
  headers: {
@@ -2702,7 +2694,6 @@ export type OrganizationUsersDeleteData = {
2702
2694
  export type OrganizationUsersUpdateData = {
2703
2695
  body: {
2704
2696
  companyDomainException?: boolean;
2705
- role?: "organization_admin" | "organization_operator" | "organization_member";
2706
2697
  };
2707
2698
  headers: {
2708
2699
  authorization?: string;
@@ -2901,7 +2892,6 @@ export type OrganizationInvitationsCreateData = {
2901
2892
  body: {
2902
2893
  email: string;
2903
2894
  groupIds?: Array<string>;
2904
- organizationRole?: "organization_admin" | "organization_operator" | "organization_member";
2905
2895
  };
2906
2896
  headers: {
2907
2897
  authorization?: string;
@@ -2957,6 +2947,7 @@ export type OrganizationReportDefinitionsCreateData = {
2957
2947
  brief: string;
2958
2948
  name: string;
2959
2949
  organizationModelDefaultId?: string | null;
2950
+ readAs?: ReportReadAs;
2960
2951
  schedule?: {
2961
2952
  cronExpression?: string | null;
2962
2953
  enabled?: boolean;
@@ -3008,6 +2999,7 @@ export type OrganizationReportDefinitionsUpdateData = {
3008
2999
  brief: string;
3009
3000
  name: string;
3010
3001
  organizationModelDefaultId?: string | null;
3002
+ readAs?: ReportReadAs;
3011
3003
  schedule?: {
3012
3004
  cronExpression?: string | null;
3013
3005
  enabled?: boolean;
@@ -3124,7 +3116,7 @@ export type OrganizationAuthenticationConfigureSsoProviderData = {
3124
3116
  credentials?: {
3125
3117
  [key: string]: string;
3126
3118
  };
3127
- defaultRole?: "organization_admin" | "organization_operator" | "organization_member";
3119
+ defaultProfileId?: string | null;
3128
3120
  domains: Array<string>;
3129
3121
  enabled?: boolean;
3130
3122
  loginProviderId?: string;
@@ -3342,7 +3334,6 @@ export type OrganizationExternalAppsListResponses = {
3342
3334
  kind: "organization";
3343
3335
  organizationId: string;
3344
3336
  };
3345
- scopes: Array<string>;
3346
3337
  setupInstructions: string;
3347
3338
  updatedAt: string;
3348
3339
  }>;
@@ -3359,7 +3350,6 @@ export type OrganizationExternalAppsCreateData = {
3359
3350
  * Every accepted callback, including the primary redirect URI.
3360
3351
  */
3361
3352
  redirectUris: Array<string>;
3362
- scopes: Array<string>;
3363
3353
  setupInstructions: string;
3364
3354
  applicationType: "public" | "confidential";
3365
3355
  fqn: string;
@@ -3408,7 +3398,6 @@ export type OrganizationExternalAppsCreateResponses = {
3408
3398
  kind: "organization";
3409
3399
  organizationId: string;
3410
3400
  };
3411
- scopes: Array<string>;
3412
3401
  setupInstructions: string;
3413
3402
  updatedAt: string;
3414
3403
  };
@@ -3437,7 +3426,6 @@ export type OrganizationExternalAppsCreateResponses = {
3437
3426
  kind: "organization";
3438
3427
  organizationId: string;
3439
3428
  };
3440
- scopes: Array<string>;
3441
3429
  setupInstructions: string;
3442
3430
  updatedAt: string;
3443
3431
  };
@@ -3473,7 +3461,6 @@ export type OrganizationExternalAppsGetResponses = {
3473
3461
  kind: "organization";
3474
3462
  organizationId: string;
3475
3463
  };
3476
- scopes: Array<string>;
3477
3464
  setupInstructions: string;
3478
3465
  updatedAt: string;
3479
3466
  };
@@ -3499,7 +3486,6 @@ export type OrganizationExternalAppsUpdateData = {
3499
3486
  kind: "organization";
3500
3487
  organizationId: string;
3501
3488
  };
3502
- scopes?: Array<string>;
3503
3489
  setupInstructions?: string;
3504
3490
  };
3505
3491
  headers: {
@@ -3540,7 +3526,6 @@ export type OrganizationExternalAppsRotateCredentialResponses = {
3540
3526
  kind: "organization";
3541
3527
  organizationId: string;
3542
3528
  };
3543
- scopes: Array<string>;
3544
3529
  setupInstructions: string;
3545
3530
  updatedAt: string;
3546
3531
  };
@@ -3579,11 +3564,7 @@ export type WorkflowAuthoringLayout = {
3579
3564
  viewport?: WorkflowAuthoringViewport;
3580
3565
  };
3581
3566
  export type WorkflowAuthoringDefinition = {
3582
- dataAccess?: {
3583
- datasets?: "user" | "workflow";
3584
- documents?: "user" | "workflow";
3585
- knowledge?: "user" | "workflow";
3586
- };
3567
+ dataAccess?: WorkflowDataAccess;
3587
3568
  edges: Array<WorkflowAuthoringEdge>;
3588
3569
  inputBoundary: {
3589
3570
  templateFqn: string;
@@ -3770,6 +3751,11 @@ export type WorkflowAuthoringEdge = {
3770
3751
  portId: string;
3771
3752
  };
3772
3753
  };
3754
+ export type WorkflowDataAccess = {
3755
+ datasets?: "user" | "workflow";
3756
+ documents?: "user" | "workflow";
3757
+ knowledge?: "user" | "workflow";
3758
+ };
3773
3759
  export type WorkflowSearchData = {
3774
3760
  body: {
3775
3761
  limit: number;
@@ -4219,7 +4205,7 @@ declare const createAdministrationApi: (client: Client$1) => {
4219
4205
  connectionId: string | null;
4220
4206
  connectionName: string | null;
4221
4207
  connectionStatus: string | null;
4222
- defaultRole: "organization_admin" | "organization_operator" | "organization_member";
4208
+ defaultProfileId: string | null;
4223
4209
  domains: Array<string>;
4224
4210
  enabled: boolean;
4225
4211
  id: string;
@@ -4232,7 +4218,7 @@ declare const createAdministrationApi: (client: Client$1) => {
4232
4218
  connectionId: string | null;
4233
4219
  connectionName: string | null;
4234
4220
  connectionStatus: string | null;
4235
- defaultRole: "organization_admin" | "organization_operator" | "organization_member";
4221
+ defaultProfileId: string | null;
4236
4222
  domains: Array<string>;
4237
4223
  enabled: boolean;
4238
4224
  id: string;
@@ -4252,7 +4238,7 @@ declare const createAdministrationApi: (client: Client$1) => {
4252
4238
  connectionId: string | null;
4253
4239
  connectionName: string | null;
4254
4240
  connectionStatus: string | null;
4255
- defaultRole: "organization_admin" | "organization_operator" | "organization_member";
4241
+ defaultProfileId: string | null;
4256
4242
  domains: Array<string>;
4257
4243
  enabled: boolean;
4258
4244
  id: string;
@@ -6230,7 +6216,6 @@ declare const createAdministrationApi: (client: Client$1) => {
6230
6216
  groupIds: Array<string>;
6231
6217
  id: string;
6232
6218
  organizationId: string;
6233
- organizationRole: string;
6234
6219
  status: "pending" | "accepted" | "revoked";
6235
6220
  updatedAt: string | null;
6236
6221
  }>;
@@ -6240,7 +6225,7 @@ declare const createAdministrationApi: (client: Client$1) => {
6240
6225
  createdAt: string | null;
6241
6226
  id: string;
6242
6227
  organizationId: string;
6243
- role: "organization_admin" | "organization_operator" | "organization_member";
6228
+ suspendedAt: string | null;
6244
6229
  updatedAt: string | null;
6245
6230
  userEmail: string | null;
6246
6231
  userId: string;
@@ -6376,6 +6361,7 @@ declare const createAdministrationApi: (client: Client$1) => {
6376
6361
  brief: string;
6377
6362
  name: string;
6378
6363
  organizationModelDefaultId: string | null;
6364
+ readAs: ReportReadAs;
6379
6365
  reportId: string;
6380
6366
  schedule: {
6381
6367
  cronExpression: string | null;
@@ -6421,6 +6407,7 @@ declare const createAdministrationApi: (client: Client$1) => {
6421
6407
  brief: string;
6422
6408
  name: string;
6423
6409
  organizationModelDefaultId: string | null;
6410
+ readAs: ReportReadAs;
6424
6411
  reportId: string;
6425
6412
  schedule: {
6426
6413
  cronExpression: string | null;
@@ -6484,6 +6471,7 @@ declare const createAdministrationApi: (client: Client$1) => {
6484
6471
  brief: string;
6485
6472
  name: string;
6486
6473
  organizationModelDefaultId: string | null;
6474
+ readAs: ReportReadAs;
6487
6475
  reportId: string;
6488
6476
  schedule: {
6489
6477
  cronExpression: string | null;
@@ -6925,125 +6913,124 @@ export interface ExternalAppsAdminNamespace {
6925
6913
  export type ServerAdminClient = AdministrationApi & {
6926
6914
  readonly applications: ExternalAppsAdminNamespace;
6927
6915
  };
6928
- export declare const createAdminClient: (config: ServerAdminClientConfig) => ServerAdminClient, externalAppAdminScope: "applications:admin", serverAdminNamespaces: {
6916
+ export declare const createAdminClient: (config: ServerAdminClientConfig) => ServerAdminClient, serverAdminNamespaces: {
6929
6917
  readonly aiAuthoring: {
6930
- readonly scopes: readonly [
6931
- "ai:admin"
6918
+ readonly capabilities: readonly [
6919
+ "admin.ai"
6932
6920
  ];
6933
6921
  readonly availability: "generated";
6934
6922
  };
6935
6923
  readonly aiConfiguration: {
6936
- readonly scopes: readonly [
6937
- "ai:admin"
6924
+ readonly capabilities: readonly [
6925
+ "tenant.aiModels"
6938
6926
  ];
6939
6927
  readonly availability: "generated";
6940
6928
  };
6941
6929
  readonly aiGovernance: {
6942
- readonly scopes: readonly [
6943
- "ai:admin"
6930
+ readonly capabilities: readonly [
6931
+ "admin.ai"
6944
6932
  ];
6945
6933
  readonly availability: "generated";
6946
6934
  };
6947
6935
  readonly applications: {
6948
6936
  readonly availability: "generated";
6949
- readonly scopes: readonly [
6950
- "applications:admin"
6937
+ readonly capabilities: readonly [
6938
+ "admin.externalApps"
6951
6939
  ];
6952
6940
  };
6953
6941
  readonly audit: {
6954
- readonly scopes: readonly [
6955
- "audit:admin"
6942
+ readonly capabilities: readonly [
6943
+ "admin.workflows"
6956
6944
  ];
6957
6945
  readonly availability: "generated";
6958
6946
  };
6959
6947
  readonly authentication: {
6960
- readonly scopes: readonly [
6961
- "organizations:admin"
6948
+ readonly capabilities: readonly [
6949
+ "admin.organization"
6962
6950
  ];
6963
6951
  readonly availability: "generated";
6964
6952
  };
6965
6953
  readonly connections: {
6966
- readonly scopes: readonly [
6967
- "organizations:admin"
6954
+ readonly capabilities: readonly [
6955
+ "admin.connections"
6968
6956
  ];
6969
6957
  readonly availability: "generated";
6970
6958
  };
6971
6959
  readonly eventsAndNotifications: {
6972
- readonly scopes: readonly [
6973
- "organizations:admin"
6960
+ readonly capabilities: readonly [
6961
+ "admin.eventsHub"
6974
6962
  ];
6975
6963
  readonly availability: "generated";
6976
6964
  };
6977
6965
  readonly groups: {
6978
- readonly scopes: readonly [
6979
- "organizations:admin"
6966
+ readonly capabilities: readonly [
6967
+ "admin.groups"
6980
6968
  ];
6981
6969
  readonly availability: "generated";
6982
6970
  };
6983
6971
  readonly infrastructure: {
6984
- readonly scopes: readonly [
6985
- "infrastructure:admin"
6972
+ readonly capabilities: readonly [
6973
+ "tenant.infrastructure"
6986
6974
  ];
6987
6975
  readonly availability: "generated";
6988
6976
  };
6989
6977
  readonly knowledgeConnectors: {
6990
- readonly scopes: readonly [
6991
- "organizations:admin"
6978
+ readonly capabilities: readonly [
6979
+ "admin.packages"
6992
6980
  ];
6993
6981
  readonly availability: "generated";
6994
6982
  };
6995
6983
  readonly knowledgeIngestion: {
6996
- readonly scopes: readonly [
6997
- "knowledge-schemas:admin"
6984
+ readonly capabilities: readonly [
6985
+ "admin.knowledge"
6998
6986
  ];
6999
6987
  readonly availability: "generated";
7000
6988
  };
7001
6989
  readonly knowledgeSchemas: {
7002
- readonly scopes: readonly [
7003
- "knowledge-schemas:admin"
6990
+ readonly capabilities: readonly [
6991
+ "admin.knowledge"
7004
6992
  ];
7005
6993
  readonly availability: "generated";
7006
6994
  };
7007
6995
  readonly members: {
7008
- readonly scopes: readonly [
7009
- "organizations:admin"
6996
+ readonly capabilities: readonly [
6997
+ "admin.users"
7010
6998
  ];
7011
6999
  readonly availability: "generated";
7012
7000
  };
7013
7001
  readonly organizations: {
7014
- readonly scopes: readonly [
7015
- "organizations:admin"
7002
+ readonly capabilities: readonly [
7003
+ "tenant.organizations"
7016
7004
  ];
7017
7005
  readonly availability: "generated";
7018
7006
  };
7019
7007
  readonly packages: {
7020
- readonly scopes: readonly [
7021
- "packages:publish",
7022
- "packages:install"
7008
+ readonly capabilities: readonly [
7009
+ "admin.packages"
7023
7010
  ];
7024
7011
  readonly availability: "generated";
7025
7012
  };
7026
7013
  readonly reports: {
7027
- readonly scopes: readonly [
7028
- "organizations:admin"
7014
+ readonly capabilities: readonly [
7015
+ "admin.reports"
7029
7016
  ];
7030
7017
  readonly availability: "generated";
7031
7018
  };
7032
7019
  readonly studioAdministration: {
7033
- readonly scopes: readonly [
7034
- "organizations:admin"
7020
+ readonly capabilities: readonly [
7021
+ "admin.studioApps"
7035
7022
  ];
7036
7023
  readonly availability: "generated";
7037
7024
  };
7038
7025
  readonly tenantAdministration: {
7039
- readonly scopes: readonly [
7040
- "organizations:admin"
7026
+ readonly capabilities: readonly [
7027
+ "tenant.settings"
7041
7028
  ];
7042
7029
  readonly availability: "generated";
7043
7030
  };
7044
7031
  readonly workflowAdministration: {
7045
- readonly scopes: readonly [
7046
- "ai:admin"
7032
+ readonly capabilities: readonly [
7033
+ "admin.workflows"
7047
7034
  ];
7048
7035
  readonly availability: "generated";
7049
7036
  };